Dtk_Dimension Class Reference

This is the general dimension. More...

Inheritance diagram for Dtk_Dimension:

Public Types
enum	BasicDimensionTypeEnum {   BasicTypeNone = 0, BasicTypeRectangle, BasicTypeCircle, BasicTypeFlagRight,   BasicTypeOblong }
enum	DimensionTypeEnum {   LinearDimension = 0, AngularDimension, CurvilinearDimension, DiameterDimension,   LinearDiameterDimension, RadiusDimension, LinearRadiusDimension, CumulatedDimension,   ChamferDimension, DistanceDimension, LengthDimension }
enum	ShowDualValueTypeEnum { ShowDualValueNone = 0, ShowDualValueBelow, ShowDualValueFractional, ShowDualValueSydeBySide }

Public Member Functions
virtual Dtk_ErrorStatus	_Store (void *)
void	AddAdditionnalGeometries (const Dtk_tab< Dtk_EntityPtr > &inAdditionnalGeometries)
	Adds some additionnal geometries to the Dtk_2dEntity. More...
void	AddAdditionnalGeometry (const Dtk_EntityPtr &inAdditionnalGeometry)
	Adds an additionnal geometry to the Dtk_2dEntity. More...
void	AddAdditionnalTexts (Dtk_CompositeText inAddtionnalTexts)
	Adds some additionnal texts to the Dtk_2dEntity. More...
Dtk_ErrorStatus	AddLeader (const Dtk_LeaderPtr &leader)
	Adds a leader to the Dtk_Dimension. More...
Dtk_ErrorStatus	AddText (Dtk_Text inText)
	Adds text to the Dtk_Dimension text. More...
BasicDimensionTypeEnum &	BasicDimensionType ()
	Retrieves the Dtk_Dimension Basic status type - get/set -. More...
const BasicDimensionTypeEnum &	BasicDimensionType () const
	Retrieves the Dtk_Dimension Basic status type - read only -. More...
void	ClearLeader ()
	Remove leader-. More...
Dtk_Int32	DtkDynamicType (const Dtk_Int32 &inId)
	Retrieves the dynamic entity type. More...
int	DtkDynamicType (const int &inId)
virtual void	dump (FILE *file=stdout)
Dtk_InfoPtr	get_info () const
type_detk	get_type_detk () const
const Dtk_tab< Dtk_EntityPtr > &	GetAdditionnalGeometries () const
	Retrieves the additionnal geometries of the Dtk_2dEntity. More...
const Dtk_CompositeText &	GetAdditionnalTexts () const
	Retrieves the additionnal texts of the Dtk_2dEntity. More...
BasicDimensionTypeEnum &	GetBasicDimensionType () const
	Get the Dtk_Dimension Basic status type with its Geometries definition- get only -. More...
BasicDimensionTypeEnum &	GetBasicDimensionType (Dtk_tab< Dtk_CurvePtr > &inRelatedGeomElements) const
	Get the Dtk_Dimension Basic status type - get only -. More...
DimensionTypeEnum	GetDimensionType () const
	Retrieves the Dtk_Dimension type - read only -. More...
Dtk_CurvePtr	GetExtraGeometryAsCurve (const Dtk_Size_t &inPos) const
	Gets the ith extra geometrical element - read only -. More...
void	GetFrame (Dtk_Frame &outFrame) const
	Retrieves the Frame - read only -. More...
const Dtk_ID &	GetID () const
	Get Internal UniqueID. More...
Dtk_LeaderPtr	GetLeader (const Dtk_Size_t &inPos) const
	Retrieves the ith leader - read only -. More...
Dtk_Size_t	GetNumExtraGeometries () const
	Gets the extra geometrical elements number - read only -. More...
Dtk_Size_t	GetNumLeaders () const
	Retrieves the leaders number - read only -. More...
virtual Dtk_Size_t	GetSize () const
Dtk_ErrorStatus	GetTextRefPoint (Dtk_pnt &outRefPnt)
const Dtk_CompositeText &	GetTexts () const
	Retrieves the Dtk_Dimension text - read only -. More...
Dtk_ErrorStatus	GetTextVerticalOffSet (double &outOffSet)
Dtk_InfoPtr &	info ()
Dtk_bool	IsFakeDimension () const
	Tells if the Dtk_Dimension is a Fake one or not. More...
virtual void	PrepareTransfo ()
	SetAsDeprecated ("2025.4", "Use Dtk_ErrorStatus Dtk_Leader::SetExtensionLine(const Dtk_PolylinePtr &) and Dtk_ErrorStatus AddLeader( const Dtk_LeaderPtr& leader ) instead") Dtk_ErrorStatus AddLeaderWithExtensionLine_Deprecated254(const Dtk_LeaderPtr &inLeader
	Adds a leader with an extension line to the Dtk_Dimension. More...
	SetAsDeprecated ("2025.4", "Use Dtk_ErrorStatus Dtk_Leader::SetExtensionLine(const Dtk_PolylinePtr &) and Dtk_ErrorStatus AddLeader( const Dtk_LeaderPtr& leader ) instead") Dtk_ErrorStatus AddLeaderWithExtensionLine_Deprecated254(const Dtk_LeaderPtr &inLeader
	Adds a leader with an extension line to the Dtk_Dimension. More...
	SetAsDeprecated ("2025.4", "Use Dtk_LeaderPtr GetLeader(const Dtk_Size_t &inPos) and Dtk_ErrorStatus Dtk_Leader::GetExtensionLine() instead") Dtk_CurvePtr GetExtensionLineAsCurve_Deprecated254(const Dtk_Size_t &inPos) const
	Retrieves the ith extension line found in the leaders - read only -. More...
	SetAsDeprecated ("2025.4", "Use Dtk_LeaderPtr GetLeader(const Dtk_Size_t &inPos) and Dtk_ErrorStatus Dtk_Leader::GetExtensionLine() instead") Dtk_ErrorStatus ConvertExtensionLineToGeometries_Deprecated254(const Dtk_Size_t &inExtLinePos
	Converts the ith extension line found in the leaders into geometrical elements. More...
	SetAsDeprecated ("2025.4", "Use Dtk_LeaderPtr GetNumLeaders() and Dtk_ErrorStatus Dtk_Leader::GetExtensionLine() instead") Dtk_Size_t GetNumExtensionLines_Deprecated254() const
	Retrieves the extension lines number - read only -. More...
void	SetBasicDimensionType (const BasicDimensionTypeEnum &inBasicDimensionTypeEnum) const
	Set the Dtk_Dimension Basic status type - set only -. More...
void	SetBasicDimensionType (const BasicDimensionTypeEnum &inBasicDimensionTypeEnum, Dtk_tab< Dtk_CurvePtr > inRelatedGeomElements) const
	Set the Dtk_Dimension Basic status type with its Geometries definition- set only -. More...
void	SetFakeDimensionStatus (const Dtk_bool inIsFakeDimension)
	Sets the Fake Dimension Status. More...
void	SetFrameType (const Dtk_frame_type &inFrameType, Dtk_tab< Dtk_CurvePtr > inRelatedGeomElements)
	Set the Dtk_Dimension frame information - get/set -. More...
ShowDualValueTypeEnum &	ShowDualValueType ()
	Retrieves the Dtk_Dimension show dual value type - get/set -. More...
const ShowDualValueTypeEnum &	ShowDualValueType () const
	Retrieves the Dtk_Dimension show dual value type - read only -. More...
Dtk_ErrorStatus	Transform (const Dtk_transfo &inTransfo)
	Applies a transformation matrix to the entity. //! More...

Static Public Member Functions
static Dtk_DimensionPtr	Create ()
	Calls default constructor to allocate a new object. More...
static Dtk_DimensionPtr	Create (const DimensionTypeEnum &inDimensionType, Dtk_CompositeText inTexts)
	Calls full featured constructor to allocate a new object. More...
static Dtk_DimensionPtr	Create (const Dtk_Dimension &in)
	Calls copy constructor to allocate a new object. More...
static Dtk_Dimension *	DtkDynamicCast (Dtk_Object *s)
	Performs a dynamic cast - doesn't need RTTI -. More...

Data Fields
Dtk_tab< Dtk_CurvePtr > &outGeomsArray	const
Polyline_detk *const &	inExtensionLine
const Dtk_tab< Dtk_pnt > &	inExtensionLinePnts

Protected Types
enum	{ _typeID = DTK_TYPE_2D_ENTITY }
enum	{ _typeID = DTK_TYPE_ENTITY }
enum	{ _typeID = DTK_TYPE_DIMENSION }

Protected Member Functions
virtual Dtk_Object *	Clone ()
	Dtk_Dimension ()
	Dtk_Dimension (const DimensionTypeEnum &inDimensionType, Dtk_CompositeText inTexts)
	Dtk_Dimension (const Dtk_Dimension &in)
	Dtk_Dimension (Dtk_Dimension &&in) DTK_NOEXCEPT
	~Dtk_Dimension ()

Protected Attributes
std::unique_ptr< Dtk_Handle >	_Private
unsigned long	count_

Detailed Description

This is the general dimension.

See also

Use Dtk_DimensionPtr class to handle it.

Member Enumeration Documentation

anonymous enum

anonymous enum

protectedinherited

Enumerator
_typeID

          {
          _typeID = DTK_TYPE_2D_ENTITY
     };

anonymous enum

anonymous enum

protectedinherited

Enumerator
_typeID

{ _typeID = DTK_TYPE_ENTITY };

anonymous enum

anonymous enum

protected

Enumerator
_typeID

          {
          _typeID = DTK_TYPE_DIMENSION
     };

BasicDimensionTypeEnum

enum Dtk_Dimension::BasicDimensionTypeEnum

Enumerator
BasicTypeNone
BasicTypeRectangle
BasicTypeCircle
BasicTypeFlagRight
BasicTypeOblong

                                 {
          BasicTypeNone = 0,
          BasicTypeRectangle,
          BasicTypeCircle,
          BasicTypeFlagRight,
          BasicTypeOblong
     };

DimensionTypeEnum

enum Dtk_Dimension::DimensionTypeEnum

Enumerator
LinearDimension
AngularDimension
CurvilinearDimension
DiameterDimension
LinearDiameterDimension
RadiusDimension
LinearRadiusDimension
CumulatedDimension
ChamferDimension
DistanceDimension
LengthDimension

                            {
          //! \image html LinearDimension.png
          LinearDimension = 0,
          //! \image html AngularDimension.png
          AngularDimension,
          //! \image html CurvilinearDimension.png
          CurvilinearDimension,
          //! \image html DiameterDimension.png
          DiameterDimension,
          //! \image html LinearDiameterDimension.png
          LinearDiameterDimension,
          //! \image html RadiusDimension.png
          RadiusDimension,
          //! \image html LinearRadiusDimension.png
          LinearRadiusDimension,
          //! \image html CumulatedDimension.png
          CumulatedDimension,
          //! \image html ChamferDimension.png
          ChamferDimension,
          //! \image html LinearDimension.png
          DistanceDimension,
          //! \image html LinearDimension.png
          LengthDimension
     };

ShowDualValueTypeEnum

enum Dtk_Dimension::ShowDualValueTypeEnum

Enumerator
ShowDualValueNone
ShowDualValueBelow
ShowDualValueFractional
ShowDualValueSydeBySide

                                {
          ShowDualValueNone = 0,
          ShowDualValueBelow,
          ShowDualValueFractional,
          ShowDualValueSydeBySide
     };

Constructor & Destructor Documentation

~Dtk_Dimension()

Dtk_Dimension::~Dtk_Dimension ( )

protected

Dtk_Dimension() [1/4]

Dtk_Dimension::Dtk_Dimension ( )

protected

See also

Create()

Dtk_Dimension() [2/4]

Dtk_Dimension::Dtk_Dimension ( const Dtk_Dimension &  in )

protected

See also

Create(const Dtk_Dimension &)

Dtk_Dimension() [3/4]

Dtk_Dimension::Dtk_Dimension ( Dtk_Dimension &&  in )

protected

Dtk_Dimension() [4/4]

Dtk_Dimension::Dtk_Dimension ( const DimensionTypeEnum &  inDimensionType, Dtk_CompositeText  inTexts  )

protected

Member Function Documentation

_Store()

virtual Dtk_ErrorStatus Dtk_Entity::_Store ( void *  )

virtualinherited

Reimplemented in Dtk_Shell, Dtk_Body, Dtk_Lump, Dtk_Volume, Dtk_Face, Dtk_Loop, Dtk_Coedge, Dtk_Edge, Dtk_Vertex, 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, and Dtk_Point.

AddAdditionnalGeometries()

void Dtk_2dEntity::AddAdditionnalGeometries ( const Dtk_tab< Dtk_EntityPtr > &  inAdditionnalGeometries )

inherited

Adds some additionnal geometries to the Dtk_2dEntity.

Parameters

inAdditionnalGeometries

The geometries to be added

AddAdditionnalGeometry()

void Dtk_2dEntity::AddAdditionnalGeometry ( const Dtk_EntityPtr &  inAdditionnalGeometry )

inherited

Adds an additionnal geometry to the Dtk_2dEntity.

Parameters

inAdditionnalGeometry

The geometry to be added

AddAdditionnalTexts()

void Dtk_2dEntity::AddAdditionnalTexts ( Dtk_CompositeText  inAddtionnalTexts )

inherited

Adds some additionnal texts to the Dtk_2dEntity.

Parameters

inAddtionnalTexts

The texts to be added

AddLeader()

Dtk_ErrorStatus Dtk_Dimension::AddLeader

(

const Dtk_LeaderPtr &

leader

)

Adds a leader to the Dtk_Dimension.

Parameters

inLeader

The leader to add.

Returns

DtkNoError if OK.

AddText()

Dtk_ErrorStatus Dtk_Dimension::AddText

(

Dtk_Text

inText

)

Adds text to the Dtk_Dimension text.

Parameters

inText

Text to be added.

Returns

DtkNoError if OK.

BasicDimensionType() [1/2]

BasicDimensionTypeEnum& Dtk_Dimension::BasicDimensionType

(

)

Retrieves the Dtk_Dimension Basic status type - get/set -.

Returns

The Dtk_Dimension basic status type.

See also

BasicDimensionType() const

BasicDimensionType() [2/2]

const BasicDimensionTypeEnum& Dtk_Dimension::BasicDimensionType

(

)

const

Retrieves the Dtk_Dimension Basic status type - read only -.

Returns

The Dtk_Dimension basic status type.

See also

BasicDimensionType()

ClearLeader()

void Dtk_Dimension::ClearLeader

(

)

Remove leader-.

Clone()

virtual Dtk_Object* Dtk_Dimension::Clone ( )

protectedvirtual

Implements Dtk_2dEntity.

{ return new Dtk_Dimension(*this); }

Create() [1/3]

static Dtk_DimensionPtr Dtk_Dimension::Create ( )

static

Calls default constructor to allocate a new object.

Create() [2/3]

static Dtk_DimensionPtr Dtk_Dimension::Create ( const DimensionTypeEnum &  inDimensionType, Dtk_CompositeText  inTexts  )

static

Calls full featured constructor to allocate a new object.

Parameters

inDimensionType	The Dtk_Dimension type
inTexts	The Dtk_Dimension texts

Create() [3/3]

static Dtk_DimensionPtr Dtk_Dimension::Create ( const Dtk_Dimension &  in )

static

Calls copy constructor to allocate a new object.

Parameters

in	Object to copy from.

DtkDynamicCast()

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

static

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

DtkDynamicType() [1/2]

Dtk_Int32 Dtk_Dimension::DtkDynamicType

(

const Dtk_Int32 &

inId

)

Retrieves the dynamic entity type.

DtkDynamicType() [2/2]

int Dtk_Entity::DtkDynamicType ( const int &  inId )

virtualinherited

Implements Dtk_Object.

Reimplemented in Dtk_Shell, Dtk_Body, Dtk_Lump, Dtk_Volume, Dtk_Face, Dtk_Loop, Dtk_Coedge, Dtk_Edge, Dtk_Vertex, Dtk_TopologicalEntity, 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, and Dtk_AxisSystem.

dump()

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

virtualinherited

get_info()

Dtk_InfoPtr Dtk_Entity::get_info ( ) const

inherited

get_type_detk()

type_detk Dtk_Dimension::get_type_detk ( ) const

virtual

Returns

The type of the entity type - DTK_TYPE_DIMENSION -.

Implements Dtk_2dEntity.

     {
          return DTK_TYPE_DIMENSION;
     }

GetAdditionnalGeometries()

const Dtk_tab< Dtk_EntityPtr >& Dtk_2dEntity::GetAdditionnalGeometries ( ) const

inherited

Retrieves the additionnal geometries of the Dtk_2dEntity.

Returns

The additionnal geometries array - read only -.

GetAdditionnalTexts()

const Dtk_CompositeText& Dtk_2dEntity::GetAdditionnalTexts ( ) const

inherited

Retrieves the additionnal texts of the Dtk_2dEntity.

Returns

The additionnal texts - read only -.

GetBasicDimensionType() [1/2]

BasicDimensionTypeEnum& Dtk_Dimension::GetBasicDimensionType

(

)

const

Get the Dtk_Dimension Basic status type with its Geometries definition- get only -.

Returns

The Dtk_Dimension basic status type.

See also

GetBasicDimensionType()

GetBasicDimensionType() [2/2]

BasicDimensionTypeEnum& Dtk_Dimension::GetBasicDimensionType

(

Dtk_tab< Dtk_CurvePtr > &

inRelatedGeomElements

)

const

Get the Dtk_Dimension Basic status type - get only -.

Returns

The Dtk_Dimension basic status type.

See also

GetBasicDimensionType()

GetDimensionType()

DimensionTypeEnum Dtk_Dimension::GetDimensionType

(

)

const

Retrieves the Dtk_Dimension type - read only -.

Returns

The Dtk_Dimension type.

GetExtraGeometryAsCurve()

Dtk_CurvePtr Dtk_Dimension::GetExtraGeometryAsCurve

(

const Dtk_Size_t &

inPos

)

const

Gets the ith extra geometrical element - read only -.

Parameters

inPos

The extra geometrical element index.

Returns

The extra geometrical element.

GetFrame()

void Dtk_Dimension::GetFrame

(

Dtk_Frame &

outFrame

)

const

Retrieves the Frame - read only -.

Parameters

outFrame

The frame

See also

FrameType() const

GetID()

const Dtk_ID& Dtk_Entity::GetID ( ) const

inherited

Get Internal UniqueID.

Returns

InternalID

GetLeader()

Dtk_LeaderPtr Dtk_Dimension::GetLeader

(

const Dtk_Size_t &

inPos

)

const

Retrieves the ith leader - read only -.

Parameters

inPos

The leader index.

Returns

The ith leader.

GetNumExtraGeometries()

Dtk_Size_t Dtk_Dimension::GetNumExtraGeometries

(

)

const

Gets the extra geometrical elements number - read only -.

Returns

The extra geometrical elements number.

GetNumLeaders()

Dtk_Size_t Dtk_Dimension::GetNumLeaders

(

)

const

Retrieves the leaders number - read only -.

Returns

The Dtk_Dimension leaders number.

GetSize()

virtual Dtk_Size_t Dtk_Entity::GetSize ( ) const

virtualinherited

Reimplemented from Dtk_Object.

Reimplemented in Dtk_Shell, Dtk_Body, Dtk_Lump, Dtk_Volume, Dtk_Face, Dtk_Loop, Dtk_Coedge, Dtk_Edge, Dtk_Vertex, 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, and Dtk_Point.

GetTextRefPoint()

Dtk_ErrorStatus Dtk_Dimension::GetTextRefPoint

(

Dtk_pnt &

outRefPnt

)

GetTexts()

const Dtk_CompositeText& Dtk_Dimension::GetTexts

(

)

const

Retrieves the Dtk_Dimension text - read only -.

Returns

The Dtk_Dimension text.

GetTextVerticalOffSet()

Dtk_ErrorStatus Dtk_Dimension::GetTextVerticalOffSet

(

double &

outOffSet

)

info()

Dtk_InfoPtr& Dtk_Entity::info ( )

inherited

IsFakeDimension()

Dtk_bool Dtk_Dimension::IsFakeDimension

(

)

const

Tells if the Dtk_Dimension is a Fake one or not.

Returns

DTK_TRUE if it's a fake Dimension, DTK_FALSE else.

See also

SetFakeDimensionStatus()

PrepareTransfo()

virtual void Dtk_Entity::PrepareTransfo ( )

virtualinherited

Reimplemented in Dtk_OffsetSurface.

SetAsDeprecated() [1/5]

Dtk_Dimension::SetAsDeprecated	(	"2025.4"	,
		"Use Dtk_ErrorStatus Dtk_Leader::SetExtensionLine(const Dtk_PolylinePtr &) and Dtk_ErrorStatus AddLeader( const Dtk_LeaderPtr& leader ) instead"
	)		const &

Adds a leader with an extension line to the Dtk_Dimension.

Parameters

inLeader	the leader to add
inExtensionLine	The additional extension line - optional -

Returns

DtkNoError if OK.

Remarks

This function is used for backward compatibility only.

See also

AddLeaderWithExtensionLine(const Dtk_LeaderPtr &, const Dtk_tab<Dtk_pnt> &)

Deprecated:

Use Dtk_ErrorStatus Dtk_Leader::SetExtensionLine(const Dtk_PolylinePtr &) and Dtk_ErrorStatus AddLeader( const Dtk_LeaderPtr& leader ) instead

SetAsDeprecated() [2/5]

Dtk_Dimension::SetAsDeprecated	(	"2025.4"	,
		"Use Dtk_ErrorStatus Dtk_Leader::SetExtensionLine(const Dtk_PolylinePtr &) and Dtk_ErrorStatus AddLeader( const Dtk_LeaderPtr& leader ) instead"
	)		const &

Adds a leader with an extension line to the Dtk_Dimension.

Parameters

inLeader	the leader to add.
inExtensionLinePnts	The additional extension line - optional - in points array form.

Returns

DtkNoError if OK.

Deprecated:

Use Dtk_ErrorStatus Dtk_Leader::SetExtensionLine(const Dtk_PolylinePtr &) and Dtk_ErrorStatus AddLeader( const Dtk_LeaderPtr& leader ) instead

SetAsDeprecated() [3/5]

Dtk_Dimension::SetAsDeprecated	(	"2025.4"	,
		"Use Dtk_LeaderPtr GetLeader(const Dtk_Size_t &inPos) and Dtk_ErrorStatus Dtk_Leader::GetExtensionLine() instead"
	)		const &

Retrieves the ith extension line found in the leaders - read only -.

Parameters

inPos

The extension line index.

Returns

The ith extension line as a Dtk_CurvePtr.

Deprecated:

Use Dtk_LeaderPtr GetLeader(const Dtk_Size_t &inPos) and Dtk_ErrorStatus Dtk_Leader::GetExtensionLine() instead

SetAsDeprecated() [4/5]

Dtk_Dimension::SetAsDeprecated	(	"2025.4"	,
		"Use Dtk_LeaderPtr GetLeader(const Dtk_Size_t &inPos) and Dtk_ErrorStatus Dtk_Leader::GetExtensionLine() instead"
	)		const &

Converts the ith extension line found in the leaders into geometrical elements.

Parameters

inExtLinePos	The extension line index.
outGeomsArray	The geometrical elements array to populate.

Returns

dtkErrorNullPointer if there is less than [inExtLinePos + 1] extension lines, dtkNoError otherwise.

Deprecated:

Use Dtk_LeaderPtr GetLeader(const Dtk_Size_t &inPos) and Dtk_ErrorStatus Dtk_Leader::GetExtensionLine() instead

SetAsDeprecated() [5/5]

Dtk_Dimension::SetAsDeprecated	(	"2025.4"	,
		"Use Dtk_LeaderPtr GetNumLeaders() and Dtk_ErrorStatus Dtk_Leader::GetExtensionLine() instead"
	)		const

Retrieves the extension lines number - read only -.

Returns

The number of Dtk_Dimension leaders having an extension line.

Deprecated:

Use Dtk_LeaderPtr GetNumLeaders() and Dtk_ErrorStatus Dtk_Leader::GetExtensionLine() instead

SetBasicDimensionType() [1/2]

void Dtk_Dimension::SetBasicDimensionType

(

const BasicDimensionTypeEnum &

inBasicDimensionTypeEnum

)

const

Set the Dtk_Dimension Basic status type - set only -.

See also

SetBasicDimensionType()

SetBasicDimensionType() [2/2]

void Dtk_Dimension::SetBasicDimensionType	(	const BasicDimensionTypeEnum &	inBasicDimensionTypeEnum,
		Dtk_tab< Dtk_CurvePtr >	inRelatedGeomElements
	)		const

Set the Dtk_Dimension Basic status type with its Geometries definition- set only -.

See also

SetBasicDimensionType()

SetFakeDimensionStatus()

void Dtk_Dimension::SetFakeDimensionStatus

(

const Dtk_bool

inIsFakeDimension

)

Sets the Fake Dimension Status.

Parameters

inIsFakeDimension

DTK_TRUE if it's a fake Dimension, DTK_FALSE else.

See also

IsFakeDimension()

SetFrameType()

void Dtk_Dimension::SetFrameType	(	const Dtk_frame_type &	inFrameType,
		Dtk_tab< Dtk_CurvePtr >	inRelatedGeomElements
	)

Set the Dtk_Dimension frame information - get/set -.

Returns

The Dtk_Dimension frame type

See also

FrameType() const

ShowDualValueType() [1/2]

ShowDualValueTypeEnum& Dtk_Dimension::ShowDualValueType

(

)

Retrieves the Dtk_Dimension show dual value type - get/set -.

Returns

The Dtk_Dimension show dual type such as Below, Fractional, or Side-by-Side.

See also

ShowDualValueType()

ShowDualValueType() [2/2]

const ShowDualValueTypeEnum& Dtk_Dimension::ShowDualValueType

(

)

const

Retrieves the Dtk_Dimension show dual value type - read only -.

Returns

The Dtk_Dimension show dual type such as Below, Fractional, or Side-by-Side.

See also

ShowDualValueType() const

Transform()

Dtk_ErrorStatus Dtk_Dimension::Transform ( const Dtk_transfo &  inTransfo )

virtual

Applies a transformation matrix to the entity. //!

Parameters

inTransfo

The transformation matrix to apply.

Implements Dtk_2dEntity.

Field Documentation

_Private

std::unique_ptr<Dtk_Handle> Dtk_Dimension::_Private

protected

const

Dtk_tab<Dtk_CurvePtr>& outGeomsArray Dtk_Dimension::const

count_

unsigned long Dtk_Object::count_

protectedinherited

inExtensionLine

Polyline_detk* const& Dtk_Dimension::inExtensionLine

inExtensionLinePnts

const Dtk_tab<Dtk_pnt>& Dtk_Dimension::inExtensionLinePnts