DATAKIT API  V2025.1
Data Structures | Public Types | Public Member Functions | Static Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes | Friends
Dtk_Leader Class Referenceabstract

This is main leader_class.
It is part of Dtk_Annotation and Dtk_Dimension. Here a description of a polyline leader. More...

+ Inheritance diagram for Dtk_Leader:

Data Structures

class  ApplicationZone
 This is the application zone class.
It's used to gather all application zone informations. More...
 
class  ArrowHead
 

Public Types

enum  IncludeOptions {
  IncludeAll = -1, IncludeNone = 0, IncludeLeaderCurve = 1, IncludeLeaderArrowHead = 2,
  IncludeLeaderExtensionLine = 4, IncludeLeaderApplicationZone = 8
}
 
enum  LeaderTerminatorTypeEnum {
  TerminatorTypeNone = 0, TerminatorTypeOpenArrow, TerminatorTypeClosedArrow, TerminatorTypeFillArrow,
  TerminatorTypeCrossArrow, TerminatorTypeCircle, TerminatorTypeFilledCircle, TerminatorTypeSquare,
  TerminatorTypeFilledSquare, TerminatorTypeSlash, TerminatorTypeCrossedCircle, TerminatorTypeXCircle,
  TerminatorTypeTriangle, TerminatorTypeFilledTriangle, TerminatorTypePlus, TerminatorTypeXCross,
  TerminatorTypeIntegral, TerminatorTypeCircleCenter, TerminatorTypeDoubleOpenArrow, TerminatorTypeDoubleCloseArrow,
  TerminatorTypeDoubleFillArrow, TerminatorTypeDoubleTriangle, TerminatorTypeTopOpenArrow, TerminatorTypeBottomOpenArrow,
  TerminatorTypeTopFillArrow, TerminatorTypeBottomFillArrow, TerminatorTypeDoubleCrossArrow
}
 Internal leader terminator type. More...
 
enum  LeaderTypeEnum { TypeUnknown = 0, TypeLinear, TypeAngular }
 Internal leader type - linear or angular -. 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
 
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 &inToBeAssigned)
 Assignment Operator. More...
 
Dtk_Leader & operator= (Dtk_Leader &&inToMoved) DTK_NOEXCEPT
 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)
 
 SetAsDeprecated ("2020.4", "Please use Dtk_PolylinePtr GetExtensionLine() const method instead.") void GetExtensionLine(Dtk_tab< Dtk_pnt > &outExtLine) const
 Get the leader Extendion Line. More...
 
 SetAsDeprecated ("2020.4", "Please use SetExtensionLine( const Dtk_PolylinePtr& inExtLine ) method instead.") void SetExtensionLine(const Dtk_tab< Dtk_pnt > &inExtLine)
 Set the leader Extendion Line. More...
 
void SetExtensionLine (const Dtk_PolylinePtr &inExtLine)
 
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 ()
 Base constructor. 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)
 Copy constructor. More...
 
static Dtk_LeaderPtr Create (Dtk_Leader &&s)
 \MoveConstructor{s} 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)
 
void _copy (const Dtk_Object &s)
 
void _init ()
 
void _reset ()
 
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 &s)
 
 Dtk_Leader (Dtk_Leader &&s) DTK_NOEXCEPT
 
virtual ~Dtk_Leader ()
 Destructor. More...
 

Protected Attributes

Dtk_Handle * _Private
 
unsigned long count_
 

Friends

class Dtk_SmartPtr< Dtk_Leader >
 
std::ostream & operator<< (std::ostream &o, const Dtk_Leader &d)
 

Detailed Description

This is main leader_class.
It is part of Dtk_Annotation and Dtk_Dimension. Here a description of a polyline leader.

Here a description of the leader terminator.

See also
Please use the Dtk_Leader class to handle it.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
protectedinherited
Enumerator
_typeID 
13 { _typeID = DTK_TYPE_OBJECT };

◆ anonymous enum

anonymous enum
protected
Enumerator
_typeID 
2232  {
2233  _typeID = DTK_TYPE_LEADER
2234  };

◆ IncludeOptions

enum Dtk_Leader::IncludeOptions
Enumerator
IncludeAll 
IncludeNone 
IncludeLeaderCurve 
IncludeLeaderArrowHead 
IncludeLeaderExtensionLine 
IncludeLeaderApplicationZone 
2092  {
2093  IncludeAll = -1,
2094  IncludeNone = 0,
2095  IncludeLeaderCurve = 1,
2096  IncludeLeaderArrowHead = 2,
2097  IncludeLeaderExtensionLine = 4,
2098  IncludeLeaderApplicationZone = 8,
2099  };

◆ LeaderTerminatorTypeEnum

enum Dtk_Leader::LeaderTerminatorTypeEnum

Internal leader terminator type.

Enumerator
TerminatorTypeNone 
TerminatorTypeOpenArrow 
TerminatorTypeClosedArrow 
TerminatorTypeFillArrow 
TerminatorTypeCrossArrow 
TerminatorTypeCircle 
TerminatorTypeFilledCircle 
TerminatorTypeSquare 
TerminatorTypeFilledSquare 
TerminatorTypeSlash 
TerminatorTypeCrossedCircle 
TerminatorTypeXCircle 
TerminatorTypeTriangle 
TerminatorTypeFilledTriangle 
TerminatorTypePlus 
TerminatorTypeXCross 
TerminatorTypeIntegral 
TerminatorTypeCircleCenter 
TerminatorTypeDoubleOpenArrow 
TerminatorTypeDoubleCloseArrow 
TerminatorTypeDoubleFillArrow 
TerminatorTypeDoubleTriangle 
TerminatorTypeTopOpenArrow 
TerminatorTypeBottomOpenArrow 
TerminatorTypeTopFillArrow 
TerminatorTypeBottomFillArrow 
TerminatorTypeDoubleCrossArrow 
1999  {
2001  TerminatorTypeNone = 0,
2003  TerminatorTypeOpenArrow,
2005  TerminatorTypeClosedArrow,
2007  TerminatorTypeFillArrow,
2009  TerminatorTypeCrossArrow,
2011  TerminatorTypeCircle,
2013  TerminatorTypeFilledCircle,
2015  TerminatorTypeSquare,
2017  TerminatorTypeFilledSquare,
2019  TerminatorTypeSlash,
2021  TerminatorTypeCrossedCircle,
2023  TerminatorTypeXCircle,
2025  TerminatorTypeTriangle,
2027  TerminatorTypeFilledTriangle,
2029  TerminatorTypePlus,
2031  TerminatorTypeXCross,
2033  TerminatorTypeIntegral,
2035  TerminatorTypeCircleCenter,
2037  TerminatorTypeDoubleOpenArrow,
2039  TerminatorTypeDoubleCloseArrow,
2041  TerminatorTypeDoubleFillArrow,
2043  TerminatorTypeDoubleTriangle,
2045  TerminatorTypeTopOpenArrow,
2047  TerminatorTypeBottomOpenArrow,
2049  TerminatorTypeTopFillArrow,
2051  TerminatorTypeBottomFillArrow,
2053  TerminatorTypeDoubleCrossArrow,
2054 
2055  };

◆ LeaderTypeEnum

enum Dtk_Leader::LeaderTypeEnum

Internal leader type - linear or angular -.

Enumerator
TypeUnknown 
TypeLinear 
TypeAngular 
2223  {
2224  TypeUnknown = 0,
2225  TypeLinear,
2226  TypeAngular
2227  };

Constructor & Destructor Documentation

◆ Dtk_Leader() [1/5]

Dtk_Leader::Dtk_Leader ( )
protected
See also
Create()

◆ Dtk_Leader() [2/5]

Dtk_Leader::Dtk_Leader ( const Dtk_Leader &  s)
protected
See also
Create(const Dtk_Leader& s)

◆ Dtk_Leader() [3/5]

Dtk_Leader::Dtk_Leader ( Dtk_Leader &&  s)
protected
See also
Create( Dtk_Leader&& s)

◆ Dtk_Leader() [4/5]

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 
)
protected
See also
Create(const Dtk_Double64 &,const Dtk_Double64 &, const Dtk_pnt &, const Dtk_Double64 &, const LeaderTerminatorTypeEnum &, const Dtk_pnt &, const Dtk_pnt &, const Dtk_bool &)

◆ Dtk_Leader() [5/5]

Dtk_Leader::Dtk_Leader ( const Dtk_Double64 &  inWidth,
const Dtk_Double64 &  inHeight,
const Dtk_pnt &  inArrowLocation,
const LeaderTerminatorTypeEnum &  inTerminatorType,
const Dtk_tab< Dtk_pnt > &  inPntsArray 
)
protected
See also
Create(const Dtk_Double64 &, const Dtk_Double64 &, const Dtk_pnt &, const LeaderTerminatorTypeEnum &, const Dtk_tab<Dtk_pnt> &)

◆ ~Dtk_Leader()

virtual Dtk_Leader::~Dtk_Leader ( )
protectedvirtual

Destructor.

Member Function Documentation

◆ _CommonAngularCtor()

void Dtk_Leader::_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 
)
protected

◆ _CommonLinearCtor()

void Dtk_Leader::_CommonLinearCtor ( const Dtk_Double64 &  inWidth,
const Dtk_Double64 &  inHeight,
const Dtk_pnt &  inArrowLocation,
const LeaderTerminatorTypeEnum &  inTerminatorType,
const Dtk_tab< Dtk_pnt > &  inPntsArray 
)
protected

◆ _copy()

void Dtk_Object::_copy ( const Dtk_Object &  s)
protectedinherited

◆ _init()

void Dtk_Object::_init ( )
protectedinherited

◆ _reset()

void Dtk_Object::_reset ( )
protectedinherited

◆ Clone()

virtual Dtk_Object* Dtk_Leader::Clone ( )
protectedvirtual
2302 { return new Dtk_Leader( *this ); }

◆ ConvertToGeom()

void Dtk_Leader::ConvertToGeom ( Dtk_tab< Dtk_CurvePtr > &  outGeomsArray,
const IncludeOptions  inConvertToGeomFilter = IncludeAll 
) const

Converts the Dtk_Leader to geometrical elements.

Parameters
outGeomsArrayGeometrical elements array

◆ Create() [1/5]

static Dtk_LeaderPtr Dtk_Leader::Create ( )
static

Base constructor.

◆ Create() [2/5]

static Dtk_LeaderPtr Dtk_Leader::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 
)
static

Angular leader constructor.

Parameters
inWidthArrow width
inHeightArrow height
inArrowLocationArrow location point
inRadiusLeader radius
inTerminatorTypeTerminator type
inEndingPntLeader ending point
inCenterPntCenter point
IsCounterClockwiseDTK_TRUE if the leader angle is counter-clockwise

◆ Create() [3/5]

static Dtk_LeaderPtr Dtk_Leader::Create ( const Dtk_Double64 &  inWidth,
const Dtk_Double64 &  inHeight,
const Dtk_pnt &  inArrowLocation,
const LeaderTerminatorTypeEnum &  inTerminatorType,
const Dtk_tab< Dtk_pnt > &  inPntsArray 
)
static

Linear leader constructor.

Parameters
inWidthArrow width
inHeightArrow height
inArrowLocationArrow location point
inTerminatorTypeTerminator type
inPntsArrayPoints array representing the leader body - in polyline form -

◆ Create() [4/5]

static Dtk_LeaderPtr Dtk_Leader::Create ( const Dtk_Leader &  s)
static

Copy constructor.

Parameters
sObject to copy.

◆ Create() [5/5]

static Dtk_LeaderPtr Dtk_Leader::Create ( Dtk_Leader &&  s)
static

\MoveConstructor{s}

◆ DtkDynamicCast()

static Dtk_Leader* Dtk_Leader::DtkDynamicCast ( Dtk_Object *  s)
static

Performs a dynamic cast - doesn't need RTTI -.

◆ DtkDynamicType() [1/2]

Dtk_Int32 Dtk_Leader::DtkDynamicType ( const Dtk_Int32 &  inId)

Retrieves the dynamic entity type.

◆ DtkDynamicType() [2/2]

virtual int Dtk_Object::DtkDynamicType ( const int &  inId)
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.

◆ dump()

virtual void Dtk_Object::dump ( FILE *  file = stdout)
virtualinherited

◆ GetAllAroundSet()

Dtk_bool Dtk_Leader::GetAllAroundSet ( ) const

OBSOLETE Retrieves the status of the all around property for the current drawing leader.

Returns
DTK_TRUE or DTK_FALSE
Deprecated:
Use GetApplicationZoneType() const or GetApplicationZone()::GetApplicationZoneType() methods instead.

◆ GetApplicationZone()

void Dtk_Leader::GetApplicationZone ( Dtk_Leader::ApplicationZone &  outApplicationZone) const

Retrieves the Frame - read only -.

Parameters
outFrameThe frame
See also
FrameType() const

◆ GetApplicationZoneType()

Dtk_Leader::ApplicationZone::ApplicationZoneEnum Dtk_Leader::GetApplicationZoneType ( ) const

Retrieves the Frame - read only -.

Parameters
outFrameThe frame
See also
FrameType() const

◆ GetArrowHead() [1/2]

ArrowHead& Dtk_Leader::GetArrowHead ( )

◆ GetArrowHead() [2/2]

const ArrowHead& Dtk_Leader::GetArrowHead ( ) const

◆ GetArrowLocation()

const Dtk_pnt& Dtk_Leader::GetArrowLocation ( ) const

Retrieves The ArrowHead Location point - Get Only -.

Returns
The ArrowHead Location point.

◆ GetExtensionLine()

Dtk_PolylinePtr Dtk_Leader::GetExtensionLine ( ) const

◆ GetInfo()

Dtk_InfoPtr& Dtk_Leader::GetInfo ( )

Retrieves the infos.

Returns
The infos

◆ GetLeaderCurve()

Dtk_CurvePtr Dtk_Leader::GetLeaderCurve ( ) const

Returns the leader curve.

Returns
Dtk_CurvePtr or NULL.

◆ GetLeaderType()

LeaderTypeEnum Dtk_Leader::GetLeaderType ( ) const

Gets the leader type - read only -.

Returns
The leader type

◆ GetSize()

virtual Dtk_Size_t Dtk_Object::GetSize ( ) const
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.

◆ GetStubDelta()

double Dtk_Leader::GetStubDelta ( ) const

Retrieves the value of the leader stub.

Returns
double
Remarks
If the Stub Delta is positive. Then the last leader segment represents the stub.

◆ LeaderTerminatorTypeEnumToString()

static Dtk_string Dtk_Leader::LeaderTerminatorTypeEnumToString ( const LeaderTerminatorTypeEnum &  inEnum)
static
2057  {
2058  switch( inEnum )
2059  {
2060  case TerminatorTypeNone: return L"TerminatorTypeNone";
2061  case TerminatorTypeOpenArrow: return L"TerminatorTypeOpenArrow";
2062  case TerminatorTypeClosedArrow: return L"TerminatorTypeClosedArrow";
2063  case TerminatorTypeFillArrow: return L"TerminatorTypeFillArrow";
2064  case TerminatorTypeCrossArrow: return L"TerminatorTypeCrossArrow";
2065  case TerminatorTypeCircle: return L"TerminatorTypeCircle";
2066  case TerminatorTypeFilledCircle: return L"TerminatorTypeFilledCircle";
2067  case TerminatorTypeSquare: return L"TerminatorTypeSquare";
2068  case TerminatorTypeFilledSquare: return L"TerminatorTypeFilledSquare";
2069  case TerminatorTypeSlash: return L"TerminatorTypeSlash";
2070  case TerminatorTypeCrossedCircle: return L"TerminatorTypeCrossedCircle";
2071  case TerminatorTypeXCircle: return L"TerminatorTypeXCircle";
2072  case TerminatorTypeTriangle: return L"TerminatorTypeTriangle";
2073  case TerminatorTypeFilledTriangle: return L"TerminatorTypeFilledTriangle";
2074  case TerminatorTypePlus: return L"TerminatorTypePlus";
2075  case TerminatorTypeXCross: return L"TerminatorTypeXCross";
2076  case TerminatorTypeIntegral: return L"TerminatorTypeIntegral";
2077  case TerminatorTypeCircleCenter: return L"TerminatorTypeCircleCenter";
2078  case TerminatorTypeDoubleOpenArrow: return L"TerminatorTypeDoubleOpenArrow";
2079  case TerminatorTypeDoubleCloseArrow: return L"TerminatorTypeDoubleCloseArrow";
2080  case TerminatorTypeDoubleFillArrow: return L"TerminatorTypeDoubleFillArrow";
2081  case TerminatorTypeDoubleTriangle: return L"TerminatorTypeDoubleTriangle";
2082  case TerminatorTypeTopOpenArrow: return L"TerminatorTypeTopOpenArrow";
2083  case TerminatorTypeBottomOpenArrow: return L"TerminatorTypeBottomOpenArrow";
2084  case TerminatorTypeTopFillArrow: return L"TerminatorTypeTopFillArrow";
2085  case TerminatorTypeBottomFillArrow: return L"TerminatorTypeBottomFillArrow";
2086  case TerminatorTypeDoubleCrossArrow: return L"TerminatorTypeDoubleCrossArrow";
2087 
2088  default: return L"Unknown";
2089  }
2090  }

◆ operator=() [1/2]

Dtk_Leader& Dtk_Leader::operator= ( const Dtk_Leader &  inToBeAssigned)

Assignment Operator.

Parameters
inToBeAssignedObject to copy.

◆ operator=() [2/2]

Dtk_Leader& Dtk_Leader::operator= ( Dtk_Leader &&  inToMoved)

Assignment Operator.

Parameters
inToMovedObject to copy.

◆ RetrieveLeader_terminator_infos()

Dtk_ErrorStatus Dtk_Leader::RetrieveLeader_terminator_infos ( Dtk_Double64 &  outWidth,
Dtk_Double64 &  outHeight,
Dtk_pnt &  outArrowLocation,
LeaderTerminatorTypeEnum &  outTerminatorType 
) const

Retrieves the leader terminator informations.

Parameters
outWidthArrow width
outHeightArrow height
outArrowLocationArrow location point
outTerminatorTypeTerminator type
Returns
dtkNoError if OK

◆ SetAllAroundSet()

void Dtk_Leader::SetAllAroundSet ( const Dtk_bool &  inAllAroundSetValue)

Set the status of the all around property for the current drawing leader.

Parameters
inAllAroundSetValueas boolean value

◆ SetApplicationZoneType()

void Dtk_Leader::SetApplicationZoneType ( const Dtk_Leader::ApplicationZone::ApplicationZoneEnum &  inApplicationZoneType,
const Dtk_tab< Dtk_CurvePtr > &  inRelatedGeomElements 
)

Set the text frame information - get/set -.

Returns
The text frame type
See also
FrameType() const

◆ SetArrowHead()

void Dtk_Leader::SetArrowHead ( const ArrowHead &  inArroWHead)

◆ SetAsDeprecated() [1/2]

Dtk_Leader::SetAsDeprecated ( "2020.4"  ,
"Please use Dtk_PolylinePtr GetExtensionLine() const method instead."   
) const &

Get the leader Extendion Line.

Parameters
outExtLineThe Dtk_pnt Array defining the Extension Line

◆ SetAsDeprecated() [2/2]

Dtk_Leader::SetAsDeprecated ( "2020.4"  ,
"Please use SetExtensionLine( const Dtk_PolylinePtr& inExtLine ) method instead."   
) const &

Set the leader Extendion Line.

Parameters
inExtLineThe Dtk_pnt Array defining the Extension Line

◆ SetExtensionLine()

void Dtk_Leader::SetExtensionLine ( const Dtk_PolylinePtr &  inExtLine)

◆ SetLeaderCurveColor()

void Dtk_Leader::SetLeaderCurveColor ( const Dtk_RGB &  inColor)

Set the leader curve Color.

Parameters
inColorThe curve Color.

◆ SetLeaderCurveLineType()

void Dtk_Leader::SetLeaderCurveLineType ( const Dtk_FontLineType  inCurveLineType)

Set the leader curve FontLineType .

Parameters
inCurveLineTypeThe curve FontLineType .

◆ SetLeaderCurveThicknessInMM()

void Dtk_Leader::SetLeaderCurveThicknessInMM ( const Dtk_Double64  inCurveThicknessinMM)

Set the leader curve Thickness in Millimeters.

Parameters
inCurveThicknessinMMThe curve Thickness in Millimeters.

◆ SetLeaderTerminatorType()

void Dtk_Leader::SetLeaderTerminatorType ( const LeaderTerminatorTypeEnum &  inTerminatorType)

Set the Leader Terminator Type.

Parameters
inTerminatorTypeThe Leader Terminator Type

◆ SetLeaderWidthHeight()

void Dtk_Leader::SetLeaderWidthHeight ( const Dtk_Double64 &  inWidth,
const Dtk_Double64 &  inHeight 
)

◆ SetStubDelta()

void Dtk_Leader::SetStubDelta ( const double &  inStubDelta)

Set the value of the leader stub.

Parameters
inStubDeltaas double value
Remarks
If the Stub Delta is positive. Then the last leader segment represents the stub.

◆ Transform()

Dtk_ErrorStatus Dtk_Leader::Transform ( const Dtk_transfo &  inTransfo)

Applies a transformation matrix to the entity. //!

Parameters
inTransfoThe transformation matrix to apply.

Friends And Related Function Documentation

◆ Dtk_SmartPtr< Dtk_Leader >

friend class Dtk_SmartPtr< Dtk_Leader >
friend

◆ operator<<

std::ostream& operator<< ( std::ostream &  o,
const Dtk_Leader &  d 
)
friend

Field Documentation

◆ _Private

Dtk_Handle* Dtk_Leader::_Private
protected

◆ count_

unsigned long Dtk_Object::count_
protectedinherited
Dtk_Leader::TerminatorTypeDoubleCrossArrow
@ TerminatorTypeDoubleCrossArrow
Definition: util_draw_dtk.hpp:2053
Dtk_Leader::TerminatorTypeCrossArrow
@ TerminatorTypeCrossArrow
Definition: util_draw_dtk.hpp:2009
Dtk_Leader::TerminatorTypeDoubleTriangle
@ TerminatorTypeDoubleTriangle
Definition: util_draw_dtk.hpp:2043
Dtk_Leader::_typeID
@ _typeID
Definition: util_draw_dtk.hpp:2233
Dtk_Leader::IncludeLeaderArrowHead
@ IncludeLeaderArrowHead
Definition: util_draw_dtk.hpp:2096
Dtk_Leader::IncludeLeaderExtensionLine
@ IncludeLeaderExtensionLine
Definition: util_draw_dtk.hpp:2097
Dtk_Leader::IncludeLeaderCurve
@ IncludeLeaderCurve
Definition: util_draw_dtk.hpp:2095
Dtk_Leader::TerminatorTypeTriangle
@ TerminatorTypeTriangle
Definition: util_draw_dtk.hpp:2025
Dtk_Leader::TerminatorTypeCircle
@ TerminatorTypeCircle
Definition: util_draw_dtk.hpp:2011
DTK_TYPE_OBJECT
@ DTK_TYPE_OBJECT
Definition: define.h:464
Dtk_Leader::TerminatorTypeFilledTriangle
@ TerminatorTypeFilledTriangle
Definition: util_draw_dtk.hpp:2027
Dtk_Leader::TerminatorTypeDoubleCloseArrow
@ TerminatorTypeDoubleCloseArrow
Definition: util_draw_dtk.hpp:2039
Dtk_Leader::TerminatorTypeFilledCircle
@ TerminatorTypeFilledCircle
Definition: util_draw_dtk.hpp:2013
Dtk_Leader::TypeUnknown
@ TypeUnknown
Definition: util_draw_dtk.hpp:2224
Dtk_Leader::IncludeLeaderApplicationZone
@ IncludeLeaderApplicationZone
Definition: util_draw_dtk.hpp:2098
Dtk_Leader::TerminatorTypeBottomOpenArrow
@ TerminatorTypeBottomOpenArrow
Definition: util_draw_dtk.hpp:2047
Dtk_Leader::TerminatorTypeBottomFillArrow
@ TerminatorTypeBottomFillArrow
Definition: util_draw_dtk.hpp:2051
DTK_TYPE_LEADER
@ DTK_TYPE_LEADER
Definition: define.h:472
Dtk_Leader::TerminatorTypeSlash
@ TerminatorTypeSlash
Definition: util_draw_dtk.hpp:2019
Dtk_Leader::TypeLinear
@ TypeLinear
Definition: util_draw_dtk.hpp:2225
Dtk_Leader::TerminatorTypeIntegral
@ TerminatorTypeIntegral
Definition: util_draw_dtk.hpp:2033
Dtk_Leader::TerminatorTypeXCircle
@ TerminatorTypeXCircle
Definition: util_draw_dtk.hpp:2023
Dtk_Leader::TerminatorTypeSquare
@ TerminatorTypeSquare
Definition: util_draw_dtk.hpp:2015
Dtk_Leader::IncludeNone
@ IncludeNone
Definition: util_draw_dtk.hpp:2094
Dtk_Leader::Dtk_Leader
Dtk_Leader()
Dtk_Leader::TerminatorTypeDoubleFillArrow
@ TerminatorTypeDoubleFillArrow
Definition: util_draw_dtk.hpp:2041
Dtk_Leader::TerminatorTypeTopOpenArrow
@ TerminatorTypeTopOpenArrow
Definition: util_draw_dtk.hpp:2045
Dtk_Leader::TerminatorTypeTopFillArrow
@ TerminatorTypeTopFillArrow
Definition: util_draw_dtk.hpp:2049
Dtk_Leader::TerminatorTypeClosedArrow
@ TerminatorTypeClosedArrow
Definition: util_draw_dtk.hpp:2005
Dtk_Object::_typeID
@ _typeID
Definition: dtk_object.hpp:13
Dtk_Leader::TerminatorTypeCircleCenter
@ TerminatorTypeCircleCenter
Definition: util_draw_dtk.hpp:2035
Dtk_Leader::TypeAngular
@ TypeAngular
Definition: util_draw_dtk.hpp:2226
Dtk_Leader::TerminatorTypePlus
@ TerminatorTypePlus
Definition: util_draw_dtk.hpp:2029
Dtk_Leader::TerminatorTypeXCross
@ TerminatorTypeXCross
Definition: util_draw_dtk.hpp:2031
Dtk_Leader::IncludeAll
@ IncludeAll
Definition: util_draw_dtk.hpp:2093
Dtk_Leader::TerminatorTypeFilledSquare
@ TerminatorTypeFilledSquare
Definition: util_draw_dtk.hpp:2017
Dtk_Leader::TerminatorTypeDoubleOpenArrow
@ TerminatorTypeDoubleOpenArrow
Definition: util_draw_dtk.hpp:2037
Dtk_Leader::TerminatorTypeFillArrow
@ TerminatorTypeFillArrow
Definition: util_draw_dtk.hpp:2007
Dtk_Leader::TerminatorTypeCrossedCircle
@ TerminatorTypeCrossedCircle
Definition: util_draw_dtk.hpp:2021
Dtk_Leader::TerminatorTypeNone
@ TerminatorTypeNone
Definition: util_draw_dtk.hpp:2001
Dtk_Leader::TerminatorTypeOpenArrow
@ TerminatorTypeOpenArrow
Definition: util_draw_dtk.hpp:2003