Dtk_Annotation Class Reference

This is abstract Dtk_Annotation class. More...

Inheritance diagram for Dtk_Annotation:

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_Annotation. 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
virtual type_detk	get_type_detk () const =0
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...
virtual Dtk_ErrorStatus	GetAnchorPoints (Dtk_pnt(&outTabPnts)[DTK_NB_ANCHOR_TYPES]) const =0
	Processes all the Dtk_Annotation anchor points. 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	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 ()
Dtk_Annotation &	operator= (const Dtk_Annotation &in)
	Copy assignment operator. More...
Dtk_Annotation &	operator= (Dtk_Annotation &&in) DTK_NOEXCEPT
	Move assignment operator. More...
virtual void	PrepareTransfo ()
virtual Dtk_ErrorStatus	Reverse ()
	Reverses the Dtk_Annotation. More...
virtual Dtk_ErrorStatus	SetAnchorPoint (const Dtk_pnt &inNewLocation, const Dtk_anchor_type &inLocationAnchorType)=0
	Sets the Dtk_Annotation anchor point. More...
	SetAsDeprecated ("Undefined", "Use Dtk_TextStyle::Justification()") Dtk_justication_type GetJustification() const
	Get the justification type - read only -. More...
virtual Dtk_ErrorStatus	SetLocation (const Dtk_pnt &inLocation)=0
	Sets the location point of the Dtk_Annotation. More...
Dtk_ErrorStatus	SetLocation (const Dtk_pnt &location, const Dtk_anchor_type &inAnchorType)
	Sets the location point of the Dtk_Annotation. More...
virtual Dtk_ErrorStatus	SetOffset (const Dtk_Double64 &inOffset)=0
	Sets the offset of the Dtk_Annotation. More...
virtual Dtk_ErrorStatus	SetRotationAngle (const Dtk_Double64 &inRotationAngle)
	Sets the annotation angle using the annotation base. More...
virtual Dtk_ErrorStatus	Transform (const Dtk_transfo &inTransfo)=0
	Applies a transformation matrix to the entity. //! More...

Static Public Member Functions
static Dtk_Annotation *	DtkDynamicCast (Dtk_Object *s)
	Performs a dynamic cast - doesn't need RTTI -. More...

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

Protected Member Functions
void	_Copy (const Dtk_2dEntity &s)
void	_copy (const Dtk_Entity &s)
void	_init ()
void	_reset ()
virtual Dtk_Object *	Clone ()=0
	Dtk_Annotation ()
	Default constructor. More...
	Dtk_Annotation (const Dtk_Annotation &in)
	Copy constructor. More...
	Dtk_Annotation (const Dtk_pnt &inLocationPnt, const Dtk_InfoPtr &inInfos, Dtk_tab< Dtk_LeaderPtr > inLeadersArray=Dtk_tab< Dtk_LeaderPtr >(), const Dtk_Double64 &inAngle=0.0, const Dtk_Double64 &inOffSet=0.0, const Dtk_anchor_type &inAnchorType=DTK_ANCHOR_BOTTOM_LEFT, const Dtk_justication_type &inJustificationType=DTK_JUSTIFY_LEFT)
	Full featured constructor. More...
	Dtk_Annotation (Dtk_Annotation &&in) DTK_NOEXCEPT
	Move constructor. More...
virtual	~Dtk_Annotation ()
	Destructor. More...

Protected Attributes
Dtk_Handle *	_Private
unsigned long	count_

Detailed Description

This is abstract Dtk_Annotation class.

See also

Use Dtk_AnnotationPtr 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_ANNOTATION
     };

Constructor & Destructor Documentation

~Dtk_Annotation()

virtual Dtk_Annotation::~Dtk_Annotation ( )

protectedvirtual

Destructor.

Dtk_Annotation() [1/4]

Dtk_Annotation::Dtk_Annotation ( )

protected

Default constructor.

Dtk_Annotation() [2/4]

Dtk_Annotation::Dtk_Annotation ( const Dtk_Annotation &  in )

protected

Copy constructor.

Parameters

in	Object to copy from.

Dtk_Annotation() [3/4]

Dtk_Annotation::Dtk_Annotation ( Dtk_Annotation &&  in )

protected

Move constructor.

Parameters

in	Object to move from.

Dtk_Annotation() [4/4]

Dtk_Annotation::Dtk_Annotation ( const Dtk_pnt &  inLocationPnt, const Dtk_InfoPtr &  inInfos, Dtk_tab< Dtk_LeaderPtr >  inLeadersArray = Dtk_tab< Dtk_LeaderPtr >(), const Dtk_Double64 &  inAngle = 0.0, const Dtk_Double64 &  inOffSet = 0.0, const Dtk_anchor_type &  inAnchorType = DTK_ANCHOR_BOTTOM_LEFT, const Dtk_justication_type &  inJustificationType = DTK_JUSTIFY_LEFT  )

protected

Full featured constructor.

Parameters

inLocationPnt	Location of the Dtk_Annotation
inInfos	Infos
inLeadersArray	Addittional leaders array
inAngle	Angle
inOffSet	Offset
inAnchorType	Annotation anchor type
inJustificationType	Annotation justification type

Member Function Documentation

_Copy()

void Dtk_2dEntity::_Copy ( const Dtk_2dEntity &  s )

protectedinherited

_copy()

void Dtk_Entity::_copy ( const Dtk_Entity &  s )

protectedinherited

_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

AddLeader()

Dtk_ErrorStatus Dtk_Annotation::AddLeader

(

const Dtk_LeaderPtr &

leader

)

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_Annotation::Clone ( )

protectedpure virtual

Implements Dtk_2dEntity.

Implemented in Dtk_Region, Dtk_Symbol, Dtk_GeometricalTolerance, Dtk_Grid, Dtk_Table, Dtk_DatumTarget, Dtk_Welding, and Dtk_Roughness.

DtkDynamicCast()

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

static

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

DtkDynamicType() [1/2]

Dtk_Int32 Dtk_Annotation::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()

virtual type_detk Dtk_Annotation::get_type_detk ( ) const

pure virtual

Implements Dtk_2dEntity.

Implemented in Dtk_Region, Dtk_Symbol, Dtk_GeometricalTolerance, Dtk_Grid, Dtk_Table, Dtk_DatumTarget, Dtk_Welding, and Dtk_Roughness.

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

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

pure virtual

Processes all the Dtk_Annotation anchor points.

Parameters

outTabPnts

The resulting anchor point array.

Returns

dtkNoError if OK

Implemented in Dtk_Region, Dtk_Symbol, Dtk_GeometricalTolerance, Dtk_Grid, Dtk_Table, Dtk_DatumTarget, Dtk_Roughness, and Dtk_Welding.

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

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

virtual

Get the annoation location point.

Returns

The location point

GetLocationAnchorType()

const Dtk_anchor_type& Dtk_Annotation::GetLocationAnchorType

(

)

const

Gets the location anchor type - read only -.

Returns

The location anchor type.

GetNumLeaders()

Dtk_Size_t Dtk_Annotation::GetNumLeaders

(

)

const

Retrieves the number of leaders.

Returns

The number of leaders

GetOffset()

Dtk_Double64 Dtk_Annotation::GetOffset

(

)

const

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

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

Get the X Axis - read only -.

Returns

The X Axis.

GetYAxis()

Dtk_dir Dtk_Annotation::GetYAxis

(

)

const

Get the Y Axis - read only -.

Returns

The Y Axis.

info()

Dtk_InfoPtr& Dtk_Entity::info ( )

inherited

operator=() [1/2]

Dtk_Annotation& Dtk_Annotation::operator=

(

const Dtk_Annotation &

in

)

Copy assignment operator.

Parameters

in	Object to copy from.

operator=() [2/2]

Dtk_Annotation& Dtk_Annotation::operator=

(

Dtk_Annotation &&

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

virtual

Reverses the Dtk_Annotation.

Reimplemented in Dtk_DatumTarget.

SetAnchorPoint()

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

pure virtual

Sets the Dtk_Annotation anchor point.

Parameters

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

Returns

dtkNoError if OK

Implemented in Dtk_Region, Dtk_Symbol, Dtk_GeometricalTolerance, Dtk_Grid, Dtk_Table, Dtk_DatumTarget, Dtk_Welding, and Dtk_Roughness.

SetAsDeprecated()

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

Get the justification type - read only -.

Returns

The justification type

Deprecated:

use the Dtk_TextStyle::Justification() instead

SetLocation() [1/2]

virtual Dtk_ErrorStatus Dtk_Annotation::SetLocation ( const Dtk_pnt &  inLocation )

pure virtual

Sets the location point of the Dtk_Annotation.

The location point is related to the anchor type

Parameters

inLocation

the location point

Returns

dtkNoError if OK

Implemented in Dtk_Region, Dtk_Symbol, Dtk_GeometricalTolerance, Dtk_Grid, Dtk_Table, Dtk_DatumTarget, Dtk_Welding, and Dtk_Roughness.

SetLocation() [2/2]

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

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

virtual Dtk_ErrorStatus Dtk_Annotation::SetOffset ( const Dtk_Double64 &  inOffset )

pure virtual

Sets the offset of the Dtk_Annotation.

The Offset is used to process bounding frames.

Parameters

inOffset

The offset

Returns

dtkNoError if OK

Warning

For internal use only

Implemented in Dtk_Region, Dtk_Symbol, Dtk_GeometricalTolerance, Dtk_Grid, Dtk_Table, Dtk_DatumTarget, Dtk_Welding, and Dtk_Roughness.

SetRotationAngle()

virtual Dtk_ErrorStatus Dtk_Annotation::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 in Dtk_Symbol, Dtk_GeometricalTolerance, Dtk_Table, Dtk_DatumTarget, Dtk_Welding, and Dtk_Roughness.

Transform()

virtual Dtk_ErrorStatus Dtk_Annotation::Transform ( const Dtk_transfo &  inTransfo )

pure virtual

Applies a transformation matrix to the entity. //!

Parameters

inTransfo

The transformation matrix to apply.

Implements Dtk_2dEntity.

Implemented in Dtk_Region, Dtk_Symbol, Dtk_GeometricalTolerance, Dtk_Grid, Dtk_Table, Dtk_DatumTarget, Dtk_Welding, and Dtk_Roughness.

Field Documentation

_Private

Dtk_Handle* Dtk_Annotation::_Private

protected

count_

unsigned long Dtk_Object::count_

protectedinherited