This class graphically represents leader of annotations.
It is part of Dtk_Annotation and Dtk_Dimension.
More...
Data Structures | |
class | ApplicationZone |
This is the application zone class. It is used to gather all application zone information. More... | |
class | ArrowHead |
This class graphically represents a leader head. More... | |
Public Member Functions | |
void | ConvertToGeom (Dtk_tab< Dtk_CurvePtr > &outGeomsArray, const IncludeOptions inConvertToGeomFilter=IncludeAll) const |
Converts the Dtk_Leader to geometrical elements. More... | |
Dtk_Int32 | DtkDynamicType (const Dtk_Int32 &inId) |
Retrieves the dynamic entity type. More... | |
virtual int | DtkDynamicType (const int &inId)=0 |
virtual void | dump (FILE *file=stdout) |
Dtk_bool | GetAllAroundSet () const |
OBSOLETE Retrieves the status of the all around property for the current drawing leader. More... | |
void | GetApplicationZone (Dtk_Leader::ApplicationZone &outApplicationZone) const |
Retrieves the Frame - read only -. More... | |
Dtk_Leader::ApplicationZone::ApplicationZoneEnum | GetApplicationZoneType () const |
Retrieves the Frame - read only -. More... | |
ArrowHead & | GetArrowHead () |
const ArrowHead & | GetArrowHead () const |
const Dtk_pnt & | GetArrowLocation () const |
Retrieves The ArrowHead Location point - Get Only -. More... | |
Dtk_PolylinePtr | GetExtensionLine () const |
Get the leader Extendion Line. More... | |
Dtk_InfoPtr & | GetInfo () |
Retrieves the infos. More... | |
Dtk_CurvePtr | GetLeaderCurve () const |
Returns the leader curve. More... | |
LeaderTypeEnum | GetLeaderType () const |
Gets the leader type - read only -. More... | |
virtual Dtk_Size_t | GetSize () const |
double | GetStubDelta () const |
Retrieves the value of the leader stub. More... | |
Dtk_Leader & | operator= (const Dtk_Leader &in) |
Copy assignment operator. More... | |
Dtk_Leader & | operator= (Dtk_Leader &&in) DTK_NOEXCEPT |
Move assignment operator. More... | |
Dtk_ErrorStatus | RetrieveLeader_terminator_infos (Dtk_Double64 &outWidth, Dtk_Double64 &outHeight, Dtk_pnt &outArrowLocation, LeaderTerminatorTypeEnum &outTerminatorType) const |
Retrieves the leader terminator informations. More... | |
void | SetAllAroundSet (const Dtk_bool &inAllAroundSetValue) |
Set the status of the all around property for the current drawing leader. More... | |
void | SetApplicationZoneType (const Dtk_Leader::ApplicationZone::ApplicationZoneEnum &inApplicationZoneType, const Dtk_tab< Dtk_CurvePtr > &inRelatedGeomElements) |
Set the text frame information - get/set -. More... | |
void | SetArrowHead (const ArrowHead &inArroWHead) |
void | SetExtensionLine (const Dtk_PolylinePtr &inExtLine) |
Set the leader Extendion Line. More... | |
void | SetLeaderCurveColor (const Dtk_RGB &inColor) |
Set the leader curve Color. More... | |
void | SetLeaderCurveLineType (const Dtk_FontLineType inCurveLineType) |
Set the leader curve FontLineType . More... | |
void | SetLeaderCurveThicknessInMM (const Dtk_Double64 inCurveThicknessinMM) |
Set the leader curve Thickness in Millimeters. More... | |
void | SetLeaderTerminatorType (const LeaderTerminatorTypeEnum &inTerminatorType) |
Set the Leader Terminator Type. More... | |
void | SetLeaderWidthHeight (const Dtk_Double64 &inWidth, const Dtk_Double64 &inHeight) |
void | SetStubDelta (const double &inStubDelta) |
Set the value of the leader stub. More... | |
Dtk_ErrorStatus | Transform (const Dtk_transfo &inTransfo) |
Applies a transformation matrix to the entity. //! More... | |
Static Public Member Functions | |
static Dtk_LeaderPtr | Create () |
Calls default constructor to allocate a new object. More... | |
static Dtk_LeaderPtr | Create (const Dtk_Double64 &inWidth, const Dtk_Double64 &inHeight, const Dtk_pnt &inArrowLocation, const Dtk_Double64 &inRadius, const LeaderTerminatorTypeEnum &inTerminatorType, const Dtk_pnt &inEndingPnt, const Dtk_pnt &inCenterPnt, const Dtk_bool &IsCounterClockwise) |
Angular leader constructor. More... | |
static Dtk_LeaderPtr | Create (const Dtk_Double64 &inWidth, const Dtk_Double64 &inHeight, const Dtk_pnt &inArrowLocation, const LeaderTerminatorTypeEnum &inTerminatorType, const Dtk_tab< Dtk_pnt > &inPntsArray) |
Linear leader constructor. More... | |
static Dtk_LeaderPtr | Create (const Dtk_Leader &s) |
Calls copy constructor to allocate a new object. More... | |
static Dtk_LeaderPtr | Create (Dtk_Leader &&s) |
Calls move constructor to allocate a new object. More... | |
static Dtk_Leader * | DtkDynamicCast (Dtk_Object *s) |
Performs a dynamic cast - doesn't need RTTI -. More... | |
static Dtk_string | LeaderTerminatorTypeEnumToString (const LeaderTerminatorTypeEnum &inEnum) |
Protected Types | |
enum | { _typeID = DTK_TYPE_OBJECT } |
enum | { _typeID = DTK_TYPE_LEADER } |
Protected Member Functions | |
void | _CommonAngularCtor (const Dtk_Double64 &inWidth, const Dtk_Double64 &inHeight, const Dtk_pnt &inArrowLocation, const Dtk_Double64 &inRadius, const LeaderTerminatorTypeEnum &inTerminatorType, const Dtk_pnt &inEndingPnt, const Dtk_pnt &inCenterPnt, const Dtk_bool &IsCounterClockwise) |
void | _CommonLinearCtor (const Dtk_Double64 &inWidth, const Dtk_Double64 &inHeight, const Dtk_pnt &inArrowLocation, const LeaderTerminatorTypeEnum &inTerminatorType, const Dtk_tab< Dtk_pnt > &inPntsArray) |
virtual Dtk_Object * | Clone () |
Dtk_Leader () | |
Dtk_Leader (const Dtk_Double64 &inWidth, const Dtk_Double64 &inHeight, const Dtk_pnt &inArrowLocation, const Dtk_Double64 &inRadius, const LeaderTerminatorTypeEnum &inTerminatorType, const Dtk_pnt &inEndingPnt, const Dtk_pnt &inCenterPnt, const Dtk_bool &IsCounterClockwise) | |
Dtk_Leader (const Dtk_Double64 &inWidth, const Dtk_Double64 &inHeight, const Dtk_pnt &inArrowLocation, const LeaderTerminatorTypeEnum &inTerminatorType, const Dtk_tab< Dtk_pnt > &inPntsArray) | |
Dtk_Leader (const Dtk_Leader &in) | |
Dtk_Leader (Dtk_Leader &&in) DTK_NOEXCEPT | |
virtual | ~Dtk_Leader () |
Destructor. More... | |
Protected Attributes | |
Dtk_Handle * | _Private |
unsigned long | count_ |
This class graphically represents leader of annotations.
It is part of Dtk_Annotation and Dtk_Dimension.
Its main curve (also called LeaderCurve), is represented using a Dtk_Polyline. The following schema indicated the points order to expect.
The first point of the Dtk_Polyline indicates the location of the ArrowHead / leader terminator. See the following schema for a simple representation of an ArrowHead, with a head of type Dtk_Leader::TerminatorTypeOpenArrow.
In Datakit representation, a leader can also have an extension line, that usually points from the annotation to the model geometry.
Dtk_Dimension is the most common annotation having leaders with an extension line, but it is also possible for a Dtk_Roughness or any other kind of Dtk_Annotation.
Internal leader terminator type.
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protectedvirtual |
Destructor.
|
protected |
|
protected |
|
protectedvirtual |
void Dtk_Leader::ConvertToGeom | ( | Dtk_tab< Dtk_CurvePtr > & | outGeomsArray, |
const IncludeOptions | inConvertToGeomFilter = IncludeAll |
||
) | const |
Converts the Dtk_Leader to geometrical elements.
outGeomsArray | Geometrical elements array |
|
static |
Calls default constructor to allocate a new object.
|
static |
Angular leader constructor.
inWidth | Arrow width |
inHeight | Arrow height |
inArrowLocation | Arrow location point |
inRadius | Leader radius |
inTerminatorType | Terminator type |
inEndingPnt | Leader ending point |
inCenterPnt | Center point |
IsCounterClockwise | DTK_TRUE if the leader angle is counter-clockwise |
|
static |
Linear leader constructor.
inWidth | Arrow width |
inHeight | Arrow height |
inArrowLocation | Arrow location point |
inTerminatorType | Terminator type |
inPntsArray | Points array representing the leader body - in polyline form - |
|
static |
Calls copy constructor to allocate a new object.
s | Object to copy from. |
|
static |
Calls move constructor to allocate a new object.
s | Object to move from. |
|
static |
Performs a dynamic cast - doesn't need RTTI -.
|
pure virtualinherited |
Implemented in Dtk_Shell, Dtk_Body, Dtk_Lump, Dtk_Volume, Dtk_Face, Dtk_Loop, Dtk_Coedge, Dtk_Edge, Dtk_Vertex, Dtk_TopologicalEntity, Dtk_MeshPolyline, Dtk_MeshSurface, Dtk_TransformedSurface, Dtk_FilletSurface, Dtk_OffsetSurface, Dtk_SphericalSurface, Dtk_ToroidalSurface, Dtk_ConicalSurface, Dtk_CylindricalSurface, Dtk_RuledSurface, Dtk_LinearExtrusionSurface, Dtk_StandardRevolutionSurface, Dtk_RevolutionSurface, Dtk_PlaneSurface, Dtk_NurbsSurface, Dtk_Surface, Dtk_Hyperbola, Dtk_Parabola, Dtk_Ellipse, Dtk_Conic, Dtk_Line, Dtk_Polyline, Dtk_NurbsCurve, Dtk_Curve, Dtk_Point, Dtk_Constraint, Dtk_ConstraintReference, Dtk_AxisSystem, Dtk_Preview, Dtk_Entity, Dtk_picture, Dtk_OverrideSet, Dtk_OverrideInfo, Dtk_MainDoc, Dtk_Component, Dtk_Node, Dtk_DocElement, Dtk_Log, and Dtk_Properties.
|
virtualinherited |
Dtk_bool Dtk_Leader::GetAllAroundSet | ( | ) | const |
OBSOLETE Retrieves the status of the all around property for the current drawing leader.
void Dtk_Leader::GetApplicationZone | ( | Dtk_Leader::ApplicationZone & | outApplicationZone | ) | const |
Retrieves the Frame - read only -.
outFrame | The frame |
Dtk_Leader::ApplicationZone::ApplicationZoneEnum Dtk_Leader::GetApplicationZoneType | ( | ) | const |
Retrieves the Frame - read only -.
outFrame | The frame |
ArrowHead& Dtk_Leader::GetArrowHead | ( | ) |
const ArrowHead& Dtk_Leader::GetArrowHead | ( | ) | const |
const Dtk_pnt& Dtk_Leader::GetArrowLocation | ( | ) | const |
Dtk_PolylinePtr Dtk_Leader::GetExtensionLine | ( | ) | const |
Get the leader Extendion Line.
Dtk_InfoPtr& Dtk_Leader::GetInfo | ( | ) |
Retrieves the infos.
Dtk_CurvePtr Dtk_Leader::GetLeaderCurve | ( | ) | const |
Returns the leader curve.
LeaderTypeEnum Dtk_Leader::GetLeaderType | ( | ) | const |
Gets the leader type - read only -.
|
virtualinherited |
Reimplemented in Dtk_Shell, Dtk_Body, Dtk_Lump, Dtk_Volume, Dtk_Face, Dtk_Loop, Dtk_Coedge, Dtk_Edge, Dtk_Vertex, Dtk_mesh_face, Dtk_mesh, Dtk_TransformedSurface, Dtk_FilletSurface, Dtk_OffsetSurface, Dtk_SphericalSurface, Dtk_ToroidalSurface, Dtk_ConicalSurface, Dtk_CylindricalSurface, Dtk_RuledSurface, Dtk_LinearExtrusionSurface, Dtk_StandardRevolutionSurface, Dtk_RevolutionSurface, Dtk_PlaneSurface, Dtk_NurbsSurface, Dtk_Surface, Dtk_Hyperbola, Dtk_Parabola, Dtk_Ellipse, Dtk_Conic, Dtk_Line, Dtk_Polyline, Dtk_NurbsCurve, Dtk_Curve, Dtk_Point, Dtk_Entity, and Dtk_Info.
double Dtk_Leader::GetStubDelta | ( | ) | const |
Retrieves the value of the leader stub.
|
static |
Dtk_Leader& Dtk_Leader::operator= | ( | const Dtk_Leader & | in | ) |
Copy assignment operator.
in | Object to copy from. |
Dtk_Leader& Dtk_Leader::operator= | ( | Dtk_Leader && | in | ) |
Move assignment operator.
in | Object to move from. |
Dtk_ErrorStatus Dtk_Leader::RetrieveLeader_terminator_infos | ( | Dtk_Double64 & | outWidth, |
Dtk_Double64 & | outHeight, | ||
Dtk_pnt & | outArrowLocation, | ||
LeaderTerminatorTypeEnum & | outTerminatorType | ||
) | const |
Retrieves the leader terminator informations.
outWidth | Arrow width |
outHeight | Arrow height |
outArrowLocation | Arrow location point |
outTerminatorType | Terminator type |
void Dtk_Leader::SetAllAroundSet | ( | const Dtk_bool & | inAllAroundSetValue | ) |
Set the status of the all around property for the current drawing leader.
inAllAroundSetValue | as boolean value |
void Dtk_Leader::SetApplicationZoneType | ( | const Dtk_Leader::ApplicationZone::ApplicationZoneEnum & | inApplicationZoneType, |
const Dtk_tab< Dtk_CurvePtr > & | inRelatedGeomElements | ||
) |
Set the text frame information - get/set -.
void Dtk_Leader::SetArrowHead | ( | const ArrowHead & | inArroWHead | ) |
void Dtk_Leader::SetExtensionLine | ( | const Dtk_PolylinePtr & | inExtLine | ) |
Set the leader Extendion Line.
inExtLine | The Dtk_PolylinePtr defining the Extension Line. |
void Dtk_Leader::SetLeaderCurveColor | ( | const Dtk_RGB & | inColor | ) |
Set the leader curve Color.
inColor | The curve Color. |
void Dtk_Leader::SetLeaderCurveLineType | ( | const Dtk_FontLineType | inCurveLineType | ) |
Set the leader curve FontLineType .
inCurveLineType | The curve FontLineType . |
void Dtk_Leader::SetLeaderCurveThicknessInMM | ( | const Dtk_Double64 | inCurveThicknessinMM | ) |
Set the leader curve Thickness in Millimeters.
inCurveThicknessinMM | The curve Thickness in Millimeters. |
void Dtk_Leader::SetLeaderTerminatorType | ( | const LeaderTerminatorTypeEnum & | inTerminatorType | ) |
Set the Leader Terminator Type.
inTerminatorType | The Leader Terminator Type |
void Dtk_Leader::SetLeaderWidthHeight | ( | const Dtk_Double64 & | inWidth, |
const Dtk_Double64 & | inHeight | ||
) |
void Dtk_Leader::SetStubDelta | ( | const double & | inStubDelta | ) |
Set the value of the leader stub.
inStubDelta | as double value. |
Dtk_ErrorStatus Dtk_Leader::Transform | ( | const Dtk_transfo & | inTransfo | ) |
Applies a transformation matrix to the entity. //!
inTransfo | The transformation matrix to apply. |
|
protected |
|
protectedinherited |