Dtk_Symbol Class Reference

This is the general symbol class.
It's basically composed of Dtk_CompositeText and geometrical elements. More...

Inheritance diagram for Dtk_Symbol:

Public Types
enum	TypeEnum {   TypeUnknown = -1, TypeNote = 0, TypeDatum, TypeBalloon,   TypeDatumTarget, TypeRoughness, TypeDimension, TypeFlagNote,   TypeGeometricalTolerance, TypeAnnotationTable, TypeCell, TypeTable,   TypeCallout, TypeWelding, TypeCoordinateDimension, TypeGeom,   TypeAxis, TypeAxisSystem, TypeCenterLine, TypeCenterMark,   TypeGrid, TypeRegion, TypeHatching, TypeFullBoltCircle,   TypeCustomSymbol, TypeHoleNote, TypeUrl, TypeArrow }

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	AddGeometricalElement (const Dtk_EntityPtr &inGeomElt)
	Adds a geometrical element to the Dtk_Symbol. More...
Dtk_ErrorStatus	AddLeader (const Dtk_LeaderPtr &leader)
	Adds a leader to the Dtk_Annotation. More...
void	ConvertLeadersToGeometrie ()
	Converts all leaders into Dtk_Symbol into geometrical elements. More...
Dtk_ErrorStatus	CreateFrameAsGeometries ()
	Processes Dtk_Symbol frame as geometrical elements/. 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_frame_type	FrameType () const
	Retrieves the Dtk_Symbol frame type - read only -. More...
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...
Dtk_ErrorStatus	GetAnchorPoints (Dtk_pnt(&outTabPnts)[DTK_NB_ANCHOR_TYPES]) const
	Processes all the Dtk_Symbol anchor points. More...
void	GetFrame (Dtk_Frame &outFrame) const
	Retrieves the Frame - read only -. More...
Dtk_EntityPtr	GetGeomElement (const Dtk_Size_t &inPos) const
	Retrieves the ith geometrical element. More...
const Dtk_ID &	GetID () const
	Get Internal UniqueID. More...
Dtk_LeaderPtr	GetLeader (const Dtk_Size_t &inPos) const
	Gets the i'th leader. More...
virtual Dtk_pnt	GetLocation () const
	Get the annoation location point. More...
const Dtk_anchor_type &	GetLocationAnchorType () const
	Gets the location anchor type - read only -. More...
Dtk_Size_t	GetNumGeometricalElements () const
	Retrieves the geometrical elements number - read only -. More...
Dtk_Size_t	GetNumLeaders () const
	Retrieves the number of leaders. More...
Dtk_Double64	GetOffset () const
	Gets the annotation offset - read only -. More...
Dtk_Double64	GetRotationAngle (const Dtk_dir &inXAxis=Dtk_dir(1, 0, 0), const Dtk_dir &inYAxis=Dtk_dir(0, 1, 0)) const
	Gets the text rotation angle giving a reference base. More...
virtual Dtk_Size_t	GetSize () const
Dtk_dir	GetXAxis () const
	Get the X Axis - read only -. More...
Dtk_dir	GetYAxis () const
	Get the Y Axis - read only -. More...
Dtk_InfoPtr &	info ()
void	MergeWithOtherSymbol (const Dtk_SymbolPtr &inSymbolToBeMerged)
	Merges texts and geometrical element of the given Dtk_Symbol into this Dtk_Symbol. More...
Dtk_Symbol &	operator= (const Dtk_Symbol &in)
	Copy assignment operator. More...
Dtk_Symbol &	operator= (Dtk_Symbol &&in) DTK_NOEXCEPT
	Move assignment operator. More...
virtual void	PrepareTransfo ()
virtual Dtk_ErrorStatus	Reverse ()
	Reverses the Dtk_Annotation. More...
Dtk_ErrorStatus	SetAnchorPoint (const Dtk_pnt &inNewLocation, const Dtk_anchor_type &inLocationAnchorType)
	Sets the Dtk_Symbol anchor point. More...
	SetAsDeprecated ("Undefined", "Use Dtk_TextStyle::Justification()") Dtk_justication_type GetJustification() const
	Get the justification type - read only -. More...
void	SetFrameType (const Dtk_frame_type &inFrameType, Dtk_tab< Dtk_CurvePtr > inRelatedGeomElements)
	Set the Dtk_Symbol frame information - get/set -. More...
Dtk_ErrorStatus	SetLocation (const Dtk_pnt &inLocation)
	Sets the location point of the Dtk_Symbol. More...
Dtk_ErrorStatus	SetLocation (const Dtk_pnt &location, const Dtk_anchor_type &inAnchorType)
	Sets the location point of the Dtk_Annotation. More...
Dtk_ErrorStatus	SetOffset (const Dtk_Double64 &inOffset)
	Sets the offset of the Dtk_Symbol. More...
Dtk_ErrorStatus	SetRotationAngle (const Dtk_Double64 &inRotationAngle)
	Sets the annotation angle using the annotation base. More...
TypeEnum &	SymbolType ()
	Retrieves the Dtk_Symbol type - get/set -. More...
const TypeEnum &	SymbolType () const
	Retrieves the Dtk_Symbol type - read only -. More...
Dtk_CompositeText &	Texts ()
	Retrieves the Dtk_CompositeText included into the Dtk_Symbol - get/set -. More...
const Dtk_CompositeText &	Texts () const
	Retrieves the Dtk_CompositeText included into the Dtk_Symbol - read only -. More...
Dtk_ErrorStatus	Transform (const Dtk_transfo &inTransfo)
	Applies a transformation matrix to the entity. //! More...

Static Public Member Functions
static Dtk_SymbolPtr	Create ()
	Calls default constructor to allocate a new object. More...
static Dtk_SymbolPtr	Create (const Dtk_2dEntityPtr &inToBeConverted, const Dtk_bool &inTextAutoFlip=DTK_FALSE, const Dtk_bool &inKeepLeaderAsLeader=DTK_FALSE)
	Create from Dtk_2dEntityPtr. More...
static Dtk_SymbolPtr	Create (const Dtk_AnnotationPtr &inToBeConverted, const Dtk_bool &inTextAutoFlip=DTK_FALSE)
	Create from Dtk_AnnotationPtr. More...
static Dtk_SymbolPtr	Create (const Dtk_CompositeEntityPtr &inToBeConverted, const Dtk_bool &inTextAutoFlip)
	Create from Dtk_CompositeEntityPtr. More...
static Dtk_SymbolPtr	Create (const Dtk_DatumTargetPtr &inToBeConverted, const Dtk_bool &inTextAutoFlip=DTK_FALSE)
	Create from Dtk_DatumTargetPtr. More...
static Dtk_SymbolPtr	Create (const Dtk_DimensionPtr &inToBeConverted, const Dtk_bool &inKeepLeaderAsLeader=DTK_FALSE)
	Create from Dtk_DimensionPtr. More...
static Dtk_SymbolPtr	Create (const Dtk_GeometricalTolerancePtr &inToBeConverted, const Dtk_bool &inTextAutoFlip=DTK_FALSE)
	Create from Dtk_GeometricalTolerancePtr. More...
static Dtk_SymbolPtr	Create (const Dtk_GridPtr &inToBeConverted, const Dtk_bool &inTextAutoFlip=DTK_FALSE)
	Create from Dtk_GridPtr. More...
static Dtk_SymbolPtr	Create (const Dtk_pnt &inLocation, const Dtk_anchor_type &inLocationAnchorType)
	Calls full featured constructor to allocate a new object. More...
static Dtk_SymbolPtr	Create (const Dtk_RegionPtr &inToBeConverted, const Dtk_bool &inTextAutoFlip=DTK_FALSE)
	Create from Dtk_RegionPtr. More...
static Dtk_SymbolPtr	Create (const Dtk_RoughnessPtr &inToBeConverted, const Dtk_bool &inTextAutoFlip=DTK_FALSE)
	Create from Dtk_RoughnessPtr. More...
static Dtk_SymbolPtr	Create (const Dtk_Symbol &in)
	Calls copy constructor to allocate a new object. More...
static Dtk_SymbolPtr	Create (const Dtk_TablePtr &inToBeConverted, const Dtk_bool &inTextAutoFlip=DTK_FALSE)
	Create from Dtk_TablePtr. More...
static Dtk_SymbolPtr	Create (const Dtk_WeldingPtr &inToBeConverted, const Dtk_bool &inTextAutoFlip)
	Create from Dtk_WeldingPtr. More...
static Dtk_SymbolPtr	Create (Dtk_Symbol &&in)
	Calls move constructor to allocate a new object. More...
static Dtk_Symbol *	DtkDynamicCast (Dtk_Object *s)
	Performs a dynamic cast - doesn't need RTTI -. More...
static const Dtk_string	TypeEnumToString (const TypeEnum &inEnum)

Protected Types
enum	{ _typeID = DTK_TYPE_2D_ENTITY }
enum	{ _typeID = DTK_TYPE_ENTITY }
enum	{ _typeID = DTK_TYPE_SYMBOL }
enum	{ _typeID = DTK_TYPE_ANNOTATION }

Protected Member Functions
void	_Copy (const Dtk_2dEntity &s)
void	_copy (const Dtk_Entity &s)
Dtk_ErrorStatus	_CreateDatumFeatureFrameAsGeometries (Dtk_pnt(&inTabPoints)[DTK_NB_ANCHOR_TYPES])
	Internal use only. More...
void	_init ()
void	_reset ()
virtual Dtk_Object *	Clone ()
	Dtk_Symbol ()
	Dtk_Symbol (const Dtk_CompositeEntity &inToBeConverted, const Dtk_bool &inTextAutoFlip=DTK_FALSE)
	Dtk_Symbol (const Dtk_DatumTarget &inToBeConverted, const Dtk_bool &inTextAutoFlip=DTK_FALSE)
	Dtk_Symbol (const Dtk_Dimension &inToBeConverted, const Dtk_bool &inKeepLeaderAsLeader)
	Dtk_Symbol (const Dtk_GeometricalTolerance &inToBeConverteds, const Dtk_bool &inTextAutoFlip=DTK_FALSE)
	Dtk_Symbol (const Dtk_Grid &inGrid, const Dtk_bool &text_auto_flip=DTK_FALSE)
	Dtk_Symbol (const Dtk_Region &inRegion, const Dtk_bool &text_auto_flip)
	Dtk_Symbol (const Dtk_Roughness &inToBeConverted, const Dtk_bool &inTextAutoFlip=DTK_FALSE)
	Dtk_Symbol (const Dtk_Symbol &s)
	Dtk_Symbol (const Dtk_Welding &inToBeConverted, const Dtk_bool &inTextAutoFlip=DTK_FALSE)
	Dtk_Symbol (Dtk_Symbol &&s) DTK_NOEXCEPT
	Dtk_Symbol (Dtk_Table &inToBeConverted, const Dtk_bool &inTextAutoFlip=DTK_FALSE)
	~Dtk_Symbol ()
	Destructor. More...

Protected Attributes
Dtk_Handle *	_Private
unsigned long	count_

Detailed Description

This is the general symbol class.
It's basically composed of Dtk_CompositeText and geometrical elements.

See also

Use Dtk_SymbolPtr class to handle it.

Member Enumeration Documentation

anonymous enum

anonymous enum

protectedinherited

Enumerator
_typeID

anonymous enum

anonymous enum

protectedinherited

Enumerator
_typeID

anonymous enum

anonymous enum

protected

Enumerator
_typeID

anonymous enum

anonymous enum

protectedinherited

Enumerator
_typeID

TypeEnum

enum Dtk_Symbol::TypeEnum

Enumerator
TypeUnknown
TypeNote
TypeDatum
TypeBalloon
TypeDatumTarget
TypeRoughness
TypeDimension
TypeFlagNote
TypeGeometricalTolerance
TypeAnnotationTable
TypeCell
TypeTable
TypeCallout
TypeWelding
TypeCoordinateDimension
TypeGeom
TypeAxis
TypeAxisSystem
TypeCenterLine
TypeCenterMark
TypeGrid
TypeRegion
TypeHatching
TypeFullBoltCircle
TypeCustomSymbol
TypeHoleNote
TypeUrl
TypeArrow

Constructor & Destructor Documentation

Dtk_Symbol() [1/12]

Dtk_Symbol::Dtk_Symbol ( const Dtk_Dimension &  inToBeConverted, const Dtk_bool &  inKeepLeaderAsLeader  )

protected

See also

Create(const Dtk_Dimension &)

Dtk_Symbol() [2/12]

Dtk_Symbol::Dtk_Symbol ( Dtk_Table &  inToBeConverted, const Dtk_bool &  inTextAutoFlip = DTK_FALSE  )

protected

See also

Create(const Dtk_Table &, const Dtk_bool &)

Dtk_Symbol() [3/12]

Dtk_Symbol::Dtk_Symbol ( const Dtk_GeometricalTolerance &  inToBeConverteds, const Dtk_bool &  inTextAutoFlip = DTK_FALSE  )

protected

See also

Create(const Dtk_GeometricalTolerance &, const Dtk_bool &)

Dtk_Symbol() [4/12]

Dtk_Symbol::Dtk_Symbol ( const Dtk_Roughness &  inToBeConverted, const Dtk_bool &  inTextAutoFlip = DTK_FALSE  )

protected

See also

Create(const Dtk_Roughness &, const Dtk_bool &)

Dtk_Symbol() [5/12]

Dtk_Symbol::Dtk_Symbol ( const Dtk_DatumTarget &  inToBeConverted, const Dtk_bool &  inTextAutoFlip = DTK_FALSE  )

protected

See also

Create(const Dtk_DatumTarget &, const Dtk_bool &)

Dtk_Symbol() [6/12]

Dtk_Symbol::Dtk_Symbol ( const Dtk_Welding &  inToBeConverted, const Dtk_bool &  inTextAutoFlip = DTK_FALSE  )

protected

See also

Create(const Dtk_Welding &, const Dtk_bool &)

Dtk_Symbol() [7/12]

Dtk_Symbol::Dtk_Symbol ( const Dtk_CompositeEntity &  inToBeConverted, const Dtk_bool &  inTextAutoFlip = DTK_FALSE  )

protected

See also

Create( const Dtk_CompositeEntityPtr&, const Dtk_bool& inTextAutoFlip)

Dtk_Symbol() [8/12]

Dtk_Symbol::Dtk_Symbol ( const Dtk_Grid &  inGrid, const Dtk_bool &  text_auto_flip = DTK_FALSE  )

protected

See also

Create( const Dtk_GridPtr&, const Dtk_bool& )

Dtk_Symbol() [9/12]

Dtk_Symbol::Dtk_Symbol ( const Dtk_Region &  inRegion, const Dtk_bool &  text_auto_flip  )

protected

See also

Create( const Dtk_Region&, const Dtk_bool& )

Dtk_Symbol() [10/12]

Dtk_Symbol::Dtk_Symbol ( )

protected

See also

Create()

Dtk_Symbol() [11/12]

Dtk_Symbol::Dtk_Symbol ( const Dtk_Symbol &  s )

protected

See also

Create(const Dtk_Symbol &)

Dtk_Symbol() [12/12]

Dtk_Symbol::Dtk_Symbol ( Dtk_Symbol &&  s )

protected

See also

Create( Dtk_Symbol&& )

~Dtk_Symbol()

Dtk_Symbol::~Dtk_Symbol ( )

protected

Destructor.

Member Function Documentation

_Copy()

void Dtk_2dEntity::_Copy ( const Dtk_2dEntity &  s )

protectedinherited

_copy()

void Dtk_Entity::_copy ( const Dtk_Entity &  s )

protectedinherited

_CreateDatumFeatureFrameAsGeometries()

Dtk_ErrorStatus Dtk_Symbol::_CreateDatumFeatureFrameAsGeometries ( Dtk_pnt(&)  inTabPoints[DTK_NB_ANCHOR_TYPES] )

protected

Internal use only.

_init()

void Dtk_Entity::_init ( )

protectedinherited

_reset()

void Dtk_Entity::_reset ( )

protectedinherited

_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

AddGeometricalElement()

Dtk_ErrorStatus Dtk_Symbol::AddGeometricalElement

(

const Dtk_EntityPtr &

inGeomElt

)

Adds a geometrical element to the Dtk_Symbol.

Parameters

inGeomElt

The geometrical element to be added.

Returns

DtkNoError if OK.

AddLeader()

Dtk_ErrorStatus Dtk_Annotation::AddLeader ( const Dtk_LeaderPtr &  leader )

inherited

Adds a leader to the Dtk_Annotation.

Parameters

leader

The leader to be added

Returns

dtkNoError is OK

Remarks

If Added leader is NULL, so no leader is added.

Clone()

virtual Dtk_Object* Dtk_Symbol::Clone ( )

protectedvirtual

Implements Dtk_Annotation.

ConvertLeadersToGeometrie()

void Dtk_Symbol::ConvertLeadersToGeometrie

(

)

Converts all leaders into Dtk_Symbol into geometrical elements.

Create() [1/15]

static Dtk_SymbolPtr Dtk_Symbol::Create ( )

static

Calls default constructor to allocate a new object.

Create() [2/15]

static Dtk_SymbolPtr Dtk_Symbol::Create ( const Dtk_2dEntityPtr &  inToBeConverted, const Dtk_bool &  inTextAutoFlip = DTK_FALSE, const Dtk_bool &  inKeepLeaderAsLeader = DTK_FALSE  )

static

Create from Dtk_2dEntityPtr.

Parameters

inToBeConverted	Entity to be converted.
inTextAutoFlip	For internal use only - except for Dtk_Dimension -.
inKeepLeaderAsLeader	to keep the leader definition put the value DTK_TRUE - only for Dtk_Dimension -.

Returns

the created Dtk_SymbolPtr

Create() [3/15]

static Dtk_SymbolPtr Dtk_Symbol::Create ( const Dtk_AnnotationPtr &  inToBeConverted, const Dtk_bool &  inTextAutoFlip = DTK_FALSE  )

static

Create from Dtk_AnnotationPtr.

Parameters

inToBeConverted	Entity to be converted.
inTextAutoFlip	For internal use only.

Returns

the created Dtk_SymbolPtr

Create() [4/15]

static Dtk_SymbolPtr Dtk_Symbol::Create ( const Dtk_CompositeEntityPtr &  inToBeConverted, const Dtk_bool &  inTextAutoFlip  )

static

Create from Dtk_CompositeEntityPtr.

Parameters

inToBeConverted	Entity to be converted.
inTextAutoFlip	For internal use only.

Returns

the created Dtk_SymbolPtr

Create() [5/15]

static Dtk_SymbolPtr Dtk_Symbol::Create ( const Dtk_DatumTargetPtr &  inToBeConverted, const Dtk_bool &  inTextAutoFlip = DTK_FALSE  )

static

Create from Dtk_DatumTargetPtr.

Parameters

inToBeConverted	Entity to be converted.
inTextAutoFlip	For internal use only.

Returns

the created Dtk_SymbolPtr

Create() [6/15]

static Dtk_SymbolPtr Dtk_Symbol::Create ( const Dtk_DimensionPtr &  inToBeConverted, const Dtk_bool &  inKeepLeaderAsLeader = DTK_FALSE  )

static

Create from Dtk_DimensionPtr.

Parameters

inToBeConverted	Entity to be converted.
inKeepLeaderAsLeader	to keep the leader definition put the value DTK_TRUE.

Returns

the created Dtk_SymbolPtr

Create() [7/15]

static Dtk_SymbolPtr Dtk_Symbol::Create ( const Dtk_GeometricalTolerancePtr &  inToBeConverted, const Dtk_bool &  inTextAutoFlip = DTK_FALSE  )

static

Create from Dtk_GeometricalTolerancePtr.

Parameters

inToBeConverted	Entity to be converted.
inTextAutoFlip	For internal use only.

Returns

the created Dtk_SymbolPtr

Create() [8/15]

static Dtk_SymbolPtr Dtk_Symbol::Create ( const Dtk_GridPtr &  inToBeConverted, const Dtk_bool &  inTextAutoFlip = DTK_FALSE  )

static

Create from Dtk_GridPtr.

Parameters

inToBeConverted	Entity to be converted.
inTextAutoFlip	For internal use only.

Returns

the created Dtk_SymbolPtr

Create() [9/15]

static Dtk_SymbolPtr Dtk_Symbol::Create ( const Dtk_pnt &  inLocation, const Dtk_anchor_type &  inLocationAnchorType  )

static

Calls full featured constructor to allocate a new object.

Parameters

inLocation	The symbol location point
inLocationAnchorType	The anchor type related to the location.

Returns

the created Dtk_SymbolPtr

Create() [10/15]

static Dtk_SymbolPtr Dtk_Symbol::Create ( const Dtk_RegionPtr &  inToBeConverted, const Dtk_bool &  inTextAutoFlip = DTK_FALSE  )

static

Create from Dtk_RegionPtr.

Parameters

inToBeConverted	Entity to be converted.
inTextAutoFlip	For internal use only.

Returns

the created Dtk_SymbolPtr

Create() [11/15]

static Dtk_SymbolPtr Dtk_Symbol::Create ( const Dtk_RoughnessPtr &  inToBeConverted, const Dtk_bool &  inTextAutoFlip = DTK_FALSE  )

static

Create from Dtk_RoughnessPtr.

Parameters

inToBeConverted	Entity to be converted.
inTextAutoFlip	For internal use only.

Returns

the created Dtk_SymbolPtr

Create() [12/15]

static Dtk_SymbolPtr Dtk_Symbol::Create ( const Dtk_Symbol &  in )

static

Calls copy constructor to allocate a new object.

Parameters

in	Object to copy from.

Create() [13/15]

static Dtk_SymbolPtr Dtk_Symbol::Create ( const Dtk_TablePtr &  inToBeConverted, const Dtk_bool &  inTextAutoFlip = DTK_FALSE  )

static

Create from Dtk_TablePtr.

Parameters

inToBeConverted	Entity to be converted.
inTextAutoFlip	For internal use only.

Returns

the created Dtk_SymbolPtr

Create() [14/15]

static Dtk_SymbolPtr Dtk_Symbol::Create ( const Dtk_WeldingPtr &  inToBeConverted, const Dtk_bool &  inTextAutoFlip  )

static

Create from Dtk_WeldingPtr.

Parameters

inToBeConverted	Entity to be converted.
inTextAutoFlip	For internal use only.

Returns

the created Dtk_SymbolPtr

Create() [15/15]

static Dtk_SymbolPtr Dtk_Symbol::Create ( Dtk_Symbol &&  in )

static

Calls move constructor to allocate a new object.

Parameters

in	Object to move from.

CreateFrameAsGeometries()

Dtk_ErrorStatus Dtk_Symbol::CreateFrameAsGeometries

(

)

Processes Dtk_Symbol frame as geometrical elements/.

Returns

dtkNoError if OK

DtkDynamicCast()

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

static

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

DtkDynamicType() [1/2]

Dtk_Int32 Dtk_Symbol::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

FrameType()

Dtk_frame_type Dtk_Symbol::FrameType

(

)

const

Retrieves the Dtk_Symbol frame type - read only -.

Returns

The frame type.

See also

FrameType()

get_info()

Dtk_InfoPtr Dtk_Entity::get_info ( ) const

inherited

get_type_detk()

type_detk Dtk_Symbol::get_type_detk ( ) const

virtual

Returns

The type of the entity type - DTK_TYPE_SYMBOL -

Implements Dtk_Annotation.

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

GetAnchorPoints()

Dtk_ErrorStatus Dtk_Symbol::GetAnchorPoints ( Dtk_pnt(&)  outTabPnts[DTK_NB_ANCHOR_TYPES] ) const

virtual

Processes all the Dtk_Symbol anchor points.

Parameters

outTabPnts

The resulting anchor point array.

Returns

dtkNoError if OK

Implements Dtk_Annotation.

GetFrame()

void Dtk_Symbol::GetFrame

(

Dtk_Frame &

outFrame

)

const

Retrieves the Frame - read only -.

Parameters

outFrame

The frame

See also

FrameType() const

GetGeomElement()

Dtk_EntityPtr Dtk_Symbol::GetGeomElement

(

const Dtk_Size_t &

inPos

)

const

Retrieves the ith geometrical element.

Parameters

inPos

The geoemtrical element index

Returns

The inPos'th geometrical element.

GetID()

const Dtk_ID& Dtk_Entity::GetID ( ) const

inherited

Get Internal UniqueID.

Returns

InternalID

GetLeader()

Dtk_LeaderPtr Dtk_Annotation::GetLeader ( const Dtk_Size_t &  inPos ) const

inherited

Gets the i'th leader.

Parameters

inPos

The leader position - 0 indexed -

Returns

The inPos'th leader

GetLocation()

virtual Dtk_pnt Dtk_Annotation::GetLocation ( ) const

virtualinherited

Get the annoation location point.

Returns

The location point

GetLocationAnchorType()

const Dtk_anchor_type& Dtk_Annotation::GetLocationAnchorType ( ) const

inherited

Gets the location anchor type - read only -.

Returns

The location anchor type.

GetNumGeometricalElements()

Dtk_Size_t Dtk_Symbol::GetNumGeometricalElements

(

)

const

Retrieves the geometrical elements number - read only -.

Returns

The geometrical elements number.

GetNumLeaders()

Dtk_Size_t Dtk_Annotation::GetNumLeaders ( ) const

inherited

Retrieves the number of leaders.

Returns

The number of leaders

GetOffset()

Dtk_Double64 Dtk_Annotation::GetOffset ( ) const

inherited

Gets the annotation offset - read only -.

Returns

The annotation offset.

Warning

For internal use only

GetRotationAngle()

Dtk_Double64 Dtk_Annotation::GetRotationAngle ( const Dtk_dir &  inXAxis = Dtk_dir(1, 0, 0), const Dtk_dir &  inYAxis = Dtk_dir(0, 1, 0)  ) const

inherited

Gets the text rotation angle giving a reference base.

Parameters

inXAxis	The reference X Axis - default value = (1,0,0) -
inYAxis	The reference Y Axis - default value = (0,1,0) -

Returns

The rotation angle.

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.

GetXAxis()

Dtk_dir Dtk_Annotation::GetXAxis ( ) const

inherited

Get the X Axis - read only -.

Returns

The X Axis.

GetYAxis()

Dtk_dir Dtk_Annotation::GetYAxis ( ) const

inherited

Get the Y Axis - read only -.

Returns

The Y Axis.

info()

Dtk_InfoPtr& Dtk_Entity::info ( )

inherited

MergeWithOtherSymbol()

void Dtk_Symbol::MergeWithOtherSymbol

(

const Dtk_SymbolPtr &

inSymbolToBeMerged

)

Merges texts and geometrical element of the given Dtk_Symbol into this Dtk_Symbol.

Parameters

inSymbolToBeMerged

Dtk_Symbol to be merged into.

operator=() [1/2]

Dtk_Symbol& Dtk_Symbol::operator=

(

const Dtk_Symbol &

in

)

Copy assignment operator.

Parameters

in	Object to copy from.

operator=() [2/2]

Dtk_Symbol& Dtk_Symbol::operator=

(

Dtk_Symbol &&

in

)

Move assignment operator.

Parameters

in	Object to move from.

PrepareTransfo()

virtual void Dtk_Entity::PrepareTransfo ( )

virtualinherited

Reimplemented in Dtk_OffsetSurface.

Reverse()

virtual Dtk_ErrorStatus Dtk_Annotation::Reverse ( )

virtualinherited

Reverses the Dtk_Annotation.

Reimplemented in Dtk_DatumTarget.

SetAnchorPoint()

Dtk_ErrorStatus Dtk_Symbol::SetAnchorPoint ( const Dtk_pnt &  inNewLocation, const Dtk_anchor_type &  inLocationAnchorType  )

virtual

Sets the Dtk_Symbol anchor point.

Parameters

inNewLocation	The new location point.
inLocationAnchorType	The anchor type related to the new location.

Returns

dtkNoError if OK

Implements Dtk_Annotation.

SetAsDeprecated()

Dtk_Annotation::SetAsDeprecated ( "Undefined"  , "Use Dtk_TextStyle::Justification()"    ) const

inherited

Get the justification type - read only -.

Returns

The justification type

Deprecated:

use the Dtk_TextStyle::Justification() instead

SetFrameType()

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

Set the Dtk_Symbol frame information - get/set -.

Returns

The Dtk_Symbol frame type

See also

FrameType() const

SetLocation() [1/2]

Dtk_ErrorStatus Dtk_Symbol::SetLocation ( const Dtk_pnt &  inLocation )

virtual

Sets the location point of the Dtk_Symbol.

The location point is related to the anchor type

Parameters

inLocation

the location point

Returns

dtkNoError if OK

Implements Dtk_Annotation.

SetLocation() [2/2]

Dtk_ErrorStatus Dtk_Annotation::SetLocation ( const Dtk_pnt &  location, const Dtk_anchor_type &  inAnchorType  )

inherited

Sets the location point of the Dtk_Annotation.

The location point is related to the anchor type

Parameters

location	the location point
inAnchorType	The anchor type related to the new location.

Returns

dtkNoError if OK

SetOffset()

Dtk_ErrorStatus Dtk_Symbol::SetOffset ( const Dtk_Double64 &  inOffset )

virtual

Sets the offset of the Dtk_Symbol.

The Offset is used to process bounding frames.

Parameters

inOffset

The offset

Returns

dtkNoError if OK

Warning

For internal use only

Implements Dtk_Annotation.

SetRotationAngle()

Dtk_ErrorStatus Dtk_Symbol::SetRotationAngle ( const Dtk_Double64 &  inRotationAngle )

virtual

Sets the annotation angle using the annotation base.

Parameters

inRotationAngle

The rotation angle to be set

Returns

dtkNoError if OK

Reimplemented from Dtk_Annotation.

SymbolType() [1/2]

TypeEnum& Dtk_Symbol::SymbolType

(

)

Retrieves the Dtk_Symbol type - get/set -.

Returns

The Dtk_Symbol type.

See also

SymbolType() const

SymbolType() [2/2]

const TypeEnum& Dtk_Symbol::SymbolType

(

)

const

Retrieves the Dtk_Symbol type - read only -.

Returns

The Dtk_Symbol type.

See also

SymbolType()

Texts() [1/2]

Dtk_CompositeText& Dtk_Symbol::Texts

(

)

Retrieves the Dtk_CompositeText included into the Dtk_Symbol - get/set -.

Returns

The Dtk_CompositeText.

See also

Texts() const

Texts() [2/2]

const Dtk_CompositeText& Dtk_Symbol::Texts

(

)

const

Retrieves the Dtk_CompositeText included into the Dtk_Symbol - read only -.

Returns

The Dtk_CompositeText.

See also

Texts()

Transform()

Dtk_ErrorStatus Dtk_Symbol::Transform ( const Dtk_transfo &  inTransfo )

virtual

Applies a transformation matrix to the entity. //!

Parameters

inTransfo

The transformation matrix to apply.

Implements Dtk_Annotation.

TypeEnumToString()

static const Dtk_string Dtk_Symbol::TypeEnumToString ( const TypeEnum &  inEnum )

static

Field Documentation

_Private

Dtk_Handle* Dtk_Symbol::_Private

protected

count_

unsigned long Dtk_Object::count_

protectedinherited