DATAKIT SDK  V2026.4
Data Structures | Public Types | Public Member Functions | Static Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes
Dtk_Leader Class Referenceabstract

This class graphically represents leader of annotations.
It is part of Dtk_Annotation and Dtk_Dimension. More...

+ Inheritance diagram for Dtk_Leader:

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 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, Dtk_Int32 inByPolygon=DTK_FALSE) 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 Extension Line. More...
 
Dtk_InfoPtr & GetInfo ()
 Retrieves the info. 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_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 &in)
 Calls copy 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

std::unique_ptr< Dtk_Handle > _Private
 
unsigned long count_
 

Detailed Description

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.

Warning
To represent a stand-alone extension line, it is possible to encounter a leader with an extension line, and no main curve.
See also
Use Dtk_LeaderPtr class to handle it.

Member Enumeration Documentation

◆ anonymous enum

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

◆ anonymous enum

anonymous enum
protected
Enumerator
_typeID 
2090  {
2091  _typeID = DTK_TYPE_LEADER
2092  };

◆ IncludeOptions

enum Dtk_Leader::IncludeOptions
Enumerator
IncludeAll 
IncludeNone 
IncludeLeaderCurve 
IncludeLeaderArrowHead 
IncludeLeaderExtensionLine 
IncludeLeaderApplicationZone 
1945  {
1946  IncludeAll = -1,
1947  IncludeNone = 0,
1948  IncludeLeaderCurve = 1,
1949  IncludeLeaderArrowHead = 2,
1950  IncludeLeaderExtensionLine = 4,
1951  IncludeLeaderApplicationZone = 8,
1952  };

◆ 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 
1852  {
1853  //! \image html TerminatorTypeNone.png
1854  TerminatorTypeNone = 0,
1855  //! \image html TerminatorTypeOpenArrow.png
1856  TerminatorTypeOpenArrow,
1857  //! \image html TerminatorTypeClosedArrow.png
1858  TerminatorTypeClosedArrow,
1859  //! \image html TerminatorTypeFillArrow.png
1860  TerminatorTypeFillArrow,
1861  //! \image html TerminatorTypeCrossArrow.png
1862  TerminatorTypeCrossArrow,
1863  //! \image html TerminatorTypeCircle.png
1864  TerminatorTypeCircle,
1865  //! \image html TerminatorTypeFilledCircle.png
1866  TerminatorTypeFilledCircle,
1867  //! \image html TerminatorTypeSquare.png
1868  TerminatorTypeSquare,
1869  //! \image html TerminatorTypeFilledSquare.png
1870  TerminatorTypeFilledSquare,
1871  //! \image html TerminatorTypeSlash.png
1872  TerminatorTypeSlash,
1873  //! \image html TerminatorTypeCrossedCircle.png
1874  TerminatorTypeCrossedCircle,
1875  //! \image html TerminatorTypeXCircle.png
1876  TerminatorTypeXCircle,
1877  //! \image html TerminatorTypeTriangle.png
1878  TerminatorTypeTriangle,
1879  //! \image html TerminatorTypeFilledTriangle.png
1880  TerminatorTypeFilledTriangle,
1881  //! \image html TerminatorTypePlus.png
1882  TerminatorTypePlus,
1883  //! \image html TerminatorTypeXCross.png
1884  TerminatorTypeXCross,
1885  //! \image html TerminatorTypeIntegral.png
1886  TerminatorTypeIntegral,
1887  //! \image html TerminatorTypeCircleCenter.png
1888  TerminatorTypeCircleCenter,
1889  //! \image html TerminatorTypeDoubleOpenArrow.png
1890  TerminatorTypeDoubleOpenArrow,
1891  //! \image html TerminatorTypeDoubleCloseArrow.png
1892  TerminatorTypeDoubleCloseArrow,
1893  //! \image html TerminatorTypeDoubleFillArrow.png
1894  TerminatorTypeDoubleFillArrow,
1895  //! \image html TerminatorTypeDoubleTriangle.png
1896  TerminatorTypeDoubleTriangle,
1897  //! \image html TerminatorTypeTopOpenArrow.png
1898  TerminatorTypeTopOpenArrow,
1899  //! \image html TerminatorTypeBottomOpenArrow.png
1900  TerminatorTypeBottomOpenArrow,
1901  //! \image html TerminatorTypeTopFillArrow.png
1902  TerminatorTypeTopFillArrow,
1903  //! \image html TerminatorTypeBottomFillArrow.png
1904  TerminatorTypeBottomFillArrow,
1905  //! \image html TerminatorTypeDoubleCrossArrow.png
1906  TerminatorTypeDoubleCrossArrow,
1907 
1908  };

◆ LeaderTypeEnum

enum Dtk_Leader::LeaderTypeEnum

Internal leader type - linear or angular -.

Enumerator
TypeUnknown 
TypeLinear 
TypeAngular 
2081  {
2082  TypeUnknown = 0,
2083  TypeLinear,
2084  TypeAngular
2085  };

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 &  in)
protected
See also
Create(const Dtk_Leader& )

◆ Dtk_Leader() [3/5]

Dtk_Leader::Dtk_Leader ( Dtk_Leader &&  in)
protected

◆ 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

◆ Clone()

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

◆ ConvertToGeom()

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

Converts the Dtk_Leader to geometrical elements.

Parameters
outGeomsArrayGeometrical elements array

◆ Create() [1/4]

static Dtk_LeaderPtr Dtk_Leader::Create ( )
static

Calls default constructor to allocate a new object.

◆ Create() [2/4]

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/4]

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/4]

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

Calls copy constructor to allocate a new object.

Parameters
inObject to copy from.

◆ 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

Get the leader Extension Line.

Returns
The Dtk_PolylinePtr defining the Extension Line.

◆ GetInfo()

Dtk_InfoPtr& Dtk_Leader::GetInfo ( )

Retrieves the info.

Returns
The info

◆ 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, the last leader segment represents the stub.

◆ LeaderTerminatorTypeEnumToString()

static Dtk_string Dtk_Leader::LeaderTerminatorTypeEnumToString ( const LeaderTerminatorTypeEnum &  inEnum)
static
1910  {
1911  switch( inEnum )
1912  {
1913  case TerminatorTypeNone: return L"TerminatorTypeNone";
1914  case TerminatorTypeOpenArrow: return L"TerminatorTypeOpenArrow";
1915  case TerminatorTypeClosedArrow: return L"TerminatorTypeClosedArrow";
1916  case TerminatorTypeFillArrow: return L"TerminatorTypeFillArrow";
1917  case TerminatorTypeCrossArrow: return L"TerminatorTypeCrossArrow";
1918  case TerminatorTypeCircle: return L"TerminatorTypeCircle";
1919  case TerminatorTypeFilledCircle: return L"TerminatorTypeFilledCircle";
1920  case TerminatorTypeSquare: return L"TerminatorTypeSquare";
1921  case TerminatorTypeFilledSquare: return L"TerminatorTypeFilledSquare";
1922  case TerminatorTypeSlash: return L"TerminatorTypeSlash";
1923  case TerminatorTypeCrossedCircle: return L"TerminatorTypeCrossedCircle";
1924  case TerminatorTypeXCircle: return L"TerminatorTypeXCircle";
1925  case TerminatorTypeTriangle: return L"TerminatorTypeTriangle";
1926  case TerminatorTypeFilledTriangle: return L"TerminatorTypeFilledTriangle";
1927  case TerminatorTypePlus: return L"TerminatorTypePlus";
1928  case TerminatorTypeXCross: return L"TerminatorTypeXCross";
1929  case TerminatorTypeIntegral: return L"TerminatorTypeIntegral";
1930  case TerminatorTypeCircleCenter: return L"TerminatorTypeCircleCenter";
1931  case TerminatorTypeDoubleOpenArrow: return L"TerminatorTypeDoubleOpenArrow";
1932  case TerminatorTypeDoubleCloseArrow: return L"TerminatorTypeDoubleCloseArrow";
1933  case TerminatorTypeDoubleFillArrow: return L"TerminatorTypeDoubleFillArrow";
1934  case TerminatorTypeDoubleTriangle: return L"TerminatorTypeDoubleTriangle";
1935  case TerminatorTypeTopOpenArrow: return L"TerminatorTypeTopOpenArrow";
1936  case TerminatorTypeBottomOpenArrow: return L"TerminatorTypeBottomOpenArrow";
1937  case TerminatorTypeTopFillArrow: return L"TerminatorTypeTopFillArrow";
1938  case TerminatorTypeBottomFillArrow: return L"TerminatorTypeBottomFillArrow";
1939  case TerminatorTypeDoubleCrossArrow: return L"TerminatorTypeDoubleCrossArrow";
1940 
1941  default: return L"Unknown";
1942  }
1943  }

◆ 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)

◆ SetExtensionLine()

void Dtk_Leader::SetExtensionLine ( const Dtk_PolylinePtr &  inExtLine)

Set the leader Extendion Line.

Parameters
inExtLineThe Dtk_PolylinePtr defining the Extension Line.

◆ 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, 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.

Field Documentation

◆ _Private

std::unique_ptr<Dtk_Handle> Dtk_Leader::_Private
protected

◆ count_

unsigned long Dtk_Object::count_
protectedinherited
Dtk_Leader::TerminatorTypeDoubleCrossArrow
@ TerminatorTypeDoubleCrossArrow
Definition: util_draw_dtk.hpp:1906
Dtk_Leader::TerminatorTypeCrossArrow
@ TerminatorTypeCrossArrow
Definition: util_draw_dtk.hpp:1862
Dtk_Leader::TerminatorTypeDoubleTriangle
@ TerminatorTypeDoubleTriangle
Definition: util_draw_dtk.hpp:1896
Dtk_Leader::_typeID
@ _typeID
Definition: util_draw_dtk.hpp:2091
Dtk_Leader::IncludeLeaderArrowHead
@ IncludeLeaderArrowHead
Definition: util_draw_dtk.hpp:1949
Dtk_Leader::IncludeLeaderExtensionLine
@ IncludeLeaderExtensionLine
Definition: util_draw_dtk.hpp:1950
Dtk_Leader::IncludeLeaderCurve
@ IncludeLeaderCurve
Definition: util_draw_dtk.hpp:1948
Dtk_Leader::TerminatorTypeTriangle
@ TerminatorTypeTriangle
Definition: util_draw_dtk.hpp:1878
Dtk_Leader::TerminatorTypeCircle
@ TerminatorTypeCircle
Definition: util_draw_dtk.hpp:1864
DTK_TYPE_OBJECT
@ DTK_TYPE_OBJECT
Definition: define.h:455
Dtk_Leader::TerminatorTypeFilledTriangle
@ TerminatorTypeFilledTriangle
Definition: util_draw_dtk.hpp:1880
Dtk_Leader::TerminatorTypeDoubleCloseArrow
@ TerminatorTypeDoubleCloseArrow
Definition: util_draw_dtk.hpp:1892
Dtk_Leader::TerminatorTypeFilledCircle
@ TerminatorTypeFilledCircle
Definition: util_draw_dtk.hpp:1866
Dtk_Leader::TypeUnknown
@ TypeUnknown
Definition: util_draw_dtk.hpp:2082
Dtk_Leader::IncludeLeaderApplicationZone
@ IncludeLeaderApplicationZone
Definition: util_draw_dtk.hpp:1951
Dtk_Leader::TerminatorTypeBottomOpenArrow
@ TerminatorTypeBottomOpenArrow
Definition: util_draw_dtk.hpp:1900
Dtk_Leader::TerminatorTypeBottomFillArrow
@ TerminatorTypeBottomFillArrow
Definition: util_draw_dtk.hpp:1904
DTK_TYPE_LEADER
@ DTK_TYPE_LEADER
Definition: define.h:463
Dtk_Leader::TerminatorTypeSlash
@ TerminatorTypeSlash
Definition: util_draw_dtk.hpp:1872
Dtk_Leader::TypeLinear
@ TypeLinear
Definition: util_draw_dtk.hpp:2083
Dtk_Leader::TerminatorTypeIntegral
@ TerminatorTypeIntegral
Definition: util_draw_dtk.hpp:1886
Dtk_Leader::TerminatorTypeXCircle
@ TerminatorTypeXCircle
Definition: util_draw_dtk.hpp:1876
Dtk_Leader::TerminatorTypeSquare
@ TerminatorTypeSquare
Definition: util_draw_dtk.hpp:1868
Dtk_Leader::IncludeNone
@ IncludeNone
Definition: util_draw_dtk.hpp:1947
Dtk_Leader::Dtk_Leader
Dtk_Leader()
Dtk_Leader::TerminatorTypeDoubleFillArrow
@ TerminatorTypeDoubleFillArrow
Definition: util_draw_dtk.hpp:1894
Dtk_Leader::TerminatorTypeTopOpenArrow
@ TerminatorTypeTopOpenArrow
Definition: util_draw_dtk.hpp:1898
Dtk_Leader::TerminatorTypeTopFillArrow
@ TerminatorTypeTopFillArrow
Definition: util_draw_dtk.hpp:1902
Dtk_Leader::TerminatorTypeClosedArrow
@ TerminatorTypeClosedArrow
Definition: util_draw_dtk.hpp:1858
Dtk_Object::_typeID
@ _typeID
Definition: dtk_object.hpp:10
Dtk_Leader::TerminatorTypeCircleCenter
@ TerminatorTypeCircleCenter
Definition: util_draw_dtk.hpp:1888
Dtk_Leader::TypeAngular
@ TypeAngular
Definition: util_draw_dtk.hpp:2084
Dtk_Leader::TerminatorTypePlus
@ TerminatorTypePlus
Definition: util_draw_dtk.hpp:1882
Dtk_Leader::TerminatorTypeXCross
@ TerminatorTypeXCross
Definition: util_draw_dtk.hpp:1884
Dtk_Leader::IncludeAll
@ IncludeAll
Definition: util_draw_dtk.hpp:1946
Dtk_Leader::TerminatorTypeFilledSquare
@ TerminatorTypeFilledSquare
Definition: util_draw_dtk.hpp:1870
Dtk_Leader::TerminatorTypeDoubleOpenArrow
@ TerminatorTypeDoubleOpenArrow
Definition: util_draw_dtk.hpp:1890
Dtk_Leader::TerminatorTypeFillArrow
@ TerminatorTypeFillArrow
Definition: util_draw_dtk.hpp:1860
Dtk_Leader::TerminatorTypeCrossedCircle
@ TerminatorTypeCrossedCircle
Definition: util_draw_dtk.hpp:1874
Dtk_Leader::TerminatorTypeNone
@ TerminatorTypeNone
Definition: util_draw_dtk.hpp:1854
Dtk_Leader::TerminatorTypeOpenArrow
@ TerminatorTypeOpenArrow
Definition: util_draw_dtk.hpp:1856