Dtk_ReferenceBlock Class Reference

This is the Dtk_ReferenceBlock Class.
It is part of the Dtk_ReferenceFrame entity. More...

Inheritance diagram for Dtk_ReferenceBlock:

Public Member Functions
Dtk_ErrorStatus	AddReference (Dtk_string inFullTextWithMaterialCondition, const Dtk_FdtPtr &inLinkedFdt)
	Add a reference to the Dtk_ReferenceBlock. More...
Dtk_ErrorStatus	AddReference (Dtk_string inReferenceLabel, const DTK_FDT_MODIFIER &inMaterialModifier=DTK_FDT_MODIFIER_NONE, const Dtk_FdtPtr &inLinkedFdt=NULL)
	Add a reference to the Dtk_ReferenceBlock. More...
Dtk_string	ConvertToDtk_String () const
	Converts the Dtk_ReferenceBlock into a Dtk_string - used for Dtk_Symbol conversion -. 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_ErrorStatus	GetAnchorPoints (Dtk_pnt(&outTabPoints)[DTK_NB_ANCHOR_TYPES], const Dtk_Double64 &inOffSet=0.0) const
	Processes all the Dtk_ReferenceBlock anchor points. More...
Dtk_Oriented2dBBox	GetInnerBoundingBox () const
Dtk_FdtPtr	GetLinkedtFdt (const Dtk_Size_t &inReferencePos) const
	Retrieves the Linked Fdt. More...
DTK_FDT_MODIFIER	GetMaterialModifier (const Dtk_Size_t &inReferencePos) const
	Retrieves the material modifier related to the ith reference. More...
Dtk_Size_t	GetNumReferences () const
	Retrieves the references number. More...
Dtk_Oriented2dBBox	GetOuterBoundingBox () const
const Dtk_string &	GetReferenceLabel (const Dtk_Size_t &inReferencePos) const
	Retrieves the ith reference label - read only -. More...
virtual Dtk_Size_t	GetSize () const
Dtk_ReferenceBlock &	operator= (const Dtk_ReferenceBlock &in)
	Full featured constructor. More...
Dtk_ReferenceBlock &	operator= (Dtk_ReferenceBlock &&in) DTK_NOEXCEPT
	Move assignment operator. More...
Dtk_ErrorStatus	SetAnchorPoint (const Dtk_pnt &inNewLocation, const Dtk_anchor_type &inLocationAnchorType=DTK_ANCHOR_BOTTOM_LEFT, const Dtk_Double64 &inOffSet=0.0)
	Sets the Dtk_ReferenceBlock anchor point. More...
void	SetInnerBoundingBox (const Dtk_Oriented2dBBox &inInnerBBox)
	Set the inner Bounding Box. More...
void	SetOuterBoundingBox (const Dtk_Oriented2dBBox &inOuterBBox) const
	Set the outer Bounding Box. More...
Dtk_ErrorStatus	SetXAxis (const Dtk_dir &ref_dir)
	Sets the X Axis for the Dtk_CompositeText and included Dtk_Texts. More...
Dtk_ErrorStatus	SetYAxis (const Dtk_dir &axis_dir)
	Sets the Y Axis for the Dtk_CompositeText and included Dtk_Texts. More...
Dtk_ErrorStatus	Transform (const Dtk_transfo &inTransfo)
	Applies a transformation matrix to the entity. //! More...
void	Translate (const Dtk_dir &inTranslationDir)
	Translates the Dtk_ReferenceBlock - internal use only -. More...

Static Public Member Functions
static Dtk_ReferenceBlockPtr	Create (const Dtk_Oriented2dBBox &inInnerBBox, const Dtk_Oriented2dBBox &inOuterBBox)
	Calls full featured constructor to allocate a new object. More...
static Dtk_ReferenceBlockPtr	Create (const Dtk_ReferenceBlock &in)
	Calls copy constructor to allocate a new object. More...
static Dtk_ReferenceBlockPtr	Create (Dtk_ReferenceBlock &&in)
	Calls move constructor to allocate a new object. More...
static Dtk_ReferenceBlock *	DtkDynamicCast (Dtk_Object *s)
	Performs a dynamic cast - doesn't need RTTI -. More...

Protected Types
enum	{ _typeID = DTK_TYPE_OBJECT }
enum	{ _typeID = DTK_TYPE_REFERENCE }

Protected Member Functions
void	_ConcatenateMaterialModifierToText (const Dtk_Size_t &inReferencePos, const DTK_FDT_MODIFIER &inMaterialModifier)
	Internal use only. More...
void	_ReplaceFirstMaterialModifer (const Dtk_Size_t &inReferencePos, const DTK_FDT_MODIFIER &inMaterialModifier)
	Internal use only. More...
virtual Dtk_Object *	Clone ()
	Dtk_ReferenceBlock (const Dtk_Oriented2dBBox &inInnerBBox, const Dtk_Oriented2dBBox &inOuterBBox)
	Dtk_ReferenceBlock (const Dtk_ReferenceBlock &in)
	Dtk_ReferenceBlock (Dtk_ReferenceBlock &&in) DTK_NOEXCEPT
	~Dtk_ReferenceBlock ()
	Destructor. More...

Protected Attributes
Dtk_Handle *	_Private
unsigned long	count_

Detailed Description

This is the Dtk_ReferenceBlock Class.
It is part of the Dtk_ReferenceFrame entity.

See also

Use Dtk_ReferenceBlockPtr class to handle it.

Member Enumeration Documentation

anonymous enum

anonymous enum

protectedinherited

Enumerator
_typeID

{ _typeID = DTK_TYPE_OBJECT }; 

anonymous enum

anonymous enum

protected

Enumerator
_typeID

          {
          _typeID = DTK_TYPE_REFERENCE
     };

Constructor & Destructor Documentation

Dtk_ReferenceBlock() [1/3]

Dtk_ReferenceBlock::Dtk_ReferenceBlock ( const Dtk_Oriented2dBBox &  inInnerBBox, const Dtk_Oriented2dBBox &  inOuterBBox  )

protected

See also

Create( const Dtk_Oriented2dBBox& , const Dtk_Oriented2dBBox& )

Dtk_ReferenceBlock() [2/3]

Dtk_ReferenceBlock::Dtk_ReferenceBlock ( const Dtk_ReferenceBlock &  in )

protected

See also

Create( const Dtk_ReferenceBlock & )

Dtk_ReferenceBlock() [3/3]

Dtk_ReferenceBlock::Dtk_ReferenceBlock ( Dtk_ReferenceBlock &&  in )

protected

See also

Create( Dtk_ReferenceBlock && )

~Dtk_ReferenceBlock()

Dtk_ReferenceBlock::~Dtk_ReferenceBlock ( )

protected

Destructor.

Member Function Documentation

_ConcatenateMaterialModifierToText()

void Dtk_ReferenceBlock::_ConcatenateMaterialModifierToText ( const Dtk_Size_t &  inReferencePos, const DTK_FDT_MODIFIER &  inMaterialModifier  )

protected

Internal use only.

_ReplaceFirstMaterialModifer()

void Dtk_ReferenceBlock::_ReplaceFirstMaterialModifer ( const Dtk_Size_t &  inReferencePos, const DTK_FDT_MODIFIER &  inMaterialModifier  )

protected

Internal use only.

AddReference() [1/2]

Dtk_ErrorStatus Dtk_ReferenceBlock::AddReference	(	Dtk_string	inFullTextWithMaterialCondition,
		const Dtk_FdtPtr &	inLinkedFdt
	)

Add a reference to the Dtk_ReferenceBlock.

Parameters

inFullTextWithMaterialCondition	The reference label. May contain also material modifier.
inLinkedFdt	The FDT to be linked - NULL by default -.

Returns

DtkNoError if OK.

AddReference() [2/2]

Dtk_ErrorStatus Dtk_ReferenceBlock::AddReference	(	Dtk_string	inReferenceLabel,
		const DTK_FDT_MODIFIER &	inMaterialModifier = DTK_FDT_MODIFIER_NONE,
		const Dtk_FdtPtr &	inLinkedFdt = NULL
	)

Add a reference to the Dtk_ReferenceBlock.

Parameters

inReferenceLabel	The reference label.
inMaterialModifier	The reference material modifier.
inLinkedFdt	The FDT to be linked - NULL by default -.

Returns

DtkNoError if OK.

Clone()

virtual Dtk_Object* Dtk_ReferenceBlock::Clone ( )

protectedvirtual

{ return new Dtk_ReferenceBlock(*this); }

ConvertToDtk_String()

Dtk_string Dtk_ReferenceBlock::ConvertToDtk_String

(

)

const

Converts the Dtk_ReferenceBlock into a Dtk_string - used for Dtk_Symbol conversion -.

Returns

The converted Dtk_string

Create() [1/3]

static Dtk_ReferenceBlockPtr Dtk_ReferenceBlock::Create ( const Dtk_Oriented2dBBox &  inInnerBBox, const Dtk_Oriented2dBBox &  inOuterBBox  )

static

Calls full featured constructor to allocate a new object.

Create() [2/3]

static Dtk_ReferenceBlockPtr Dtk_ReferenceBlock::Create ( const Dtk_ReferenceBlock &  in )

static

Calls copy constructor to allocate a new object.

Parameters

in	Object to copy from.

Create() [3/3]

static Dtk_ReferenceBlockPtr Dtk_ReferenceBlock::Create ( Dtk_ReferenceBlock &&  in )

static

Calls move constructor to allocate a new object.

Parameters

in	Object to move from.

DtkDynamicCast()

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

static

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

DtkDynamicType() [1/2]

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

GetAnchorPoints()

Dtk_ErrorStatus Dtk_ReferenceBlock::GetAnchorPoints	(	Dtk_pnt(&)	outTabPoints[DTK_NB_ANCHOR_TYPES],
		const Dtk_Double64 &	inOffSet = 0.0
	)		const

Processes all the Dtk_ReferenceBlock anchor points.

Parameters

outTabPnts	The resulting anchor point array.
inOffSet	- internal use only -.

Returns

dtkNoError if OK

GetInnerBoundingBox()

Dtk_Oriented2dBBox Dtk_ReferenceBlock::GetInnerBoundingBox

(

)

const

GetLinkedtFdt()

Dtk_FdtPtr Dtk_ReferenceBlock::GetLinkedtFdt

(

const Dtk_Size_t &

inReferencePos

)

const

Retrieves the Linked Fdt.

Returns

The linked Fdt

GetMaterialModifier()

DTK_FDT_MODIFIER Dtk_ReferenceBlock::GetMaterialModifier

(

const Dtk_Size_t &

inReferencePos

)

const

Retrieves the material modifier related to the ith reference.

Parameters

inReferencePos

The reference index.

Returns

the related material modifier.

GetNumReferences()

Dtk_Size_t Dtk_ReferenceBlock::GetNumReferences

(

)

const

Retrieves the references number.

Returns

The number of references included into the Dtk_ReferenceBlock.

GetOuterBoundingBox()

Dtk_Oriented2dBBox Dtk_ReferenceBlock::GetOuterBoundingBox

(

)

const

GetReferenceLabel()

const Dtk_string& Dtk_ReferenceBlock::GetReferenceLabel

(

const Dtk_Size_t &

inReferencePos

)

const

Retrieves the ith reference label - read only -.

Parameters

inReferencePos

The reference index

Returns

the ith reference label

See also

GetReferenceLabel(const Dtk_Size_t &)

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.

operator=() [1/2]

Dtk_ReferenceBlock& Dtk_ReferenceBlock::operator=

(

const Dtk_ReferenceBlock &

in

)

Full featured constructor.

Parameters

inFullTextWithMaterialCondition	The Transformation Matrix
inLinkedFdt	The FDT to be linked.

Returns

the created Dtk_ReferenceBlockPtr

Copy assignment operator.

Parameters

in	Object to copy from.

operator=() [2/2]

Dtk_ReferenceBlock& Dtk_ReferenceBlock::operator=

(

Dtk_ReferenceBlock &&

in

)

Move assignment operator.

Parameters

in	Object to move from.

SetAnchorPoint()

Dtk_ErrorStatus Dtk_ReferenceBlock::SetAnchorPoint	(	const Dtk_pnt &	inNewLocation,
		const Dtk_anchor_type &	inLocationAnchorType = DTK_ANCHOR_BOTTOM_LEFT,
		const Dtk_Double64 &	inOffSet = 0.0
	)

Sets the Dtk_ReferenceBlock anchor point.

Parameters

inNewLocation	The new location point.
inLocationAnchorType	The anchor type related to the new location.
inOffSet	For internal use only.

Returns

dtkNoError if OK

SetInnerBoundingBox()

void Dtk_ReferenceBlock::SetInnerBoundingBox

(

const Dtk_Oriented2dBBox &

inInnerBBox

)

Set the inner Bounding Box.

Parameters

inInnerBBox

The inner Bounding Box.

SetOuterBoundingBox()

void Dtk_ReferenceBlock::SetOuterBoundingBox

(

const Dtk_Oriented2dBBox &

inOuterBBox

)

const

Set the outer Bounding Box.

Parameters

inOuterBBox

The outer Bounding Box.

SetXAxis()

Dtk_ErrorStatus Dtk_ReferenceBlock::SetXAxis

(

const Dtk_dir &

ref_dir

)

Sets the X Axis for the Dtk_CompositeText and included Dtk_Texts.

Parameters

inXAxis

The new X Axis

Returns

dtkNoError if OK

SetYAxis()

Dtk_ErrorStatus Dtk_ReferenceBlock::SetYAxis

(

const Dtk_dir &

axis_dir

)

Sets the Y Axis for the Dtk_CompositeText and included Dtk_Texts.

Parameters

inYAxis

The new Y Axis

Returns

dtkNoError if OK

Transform()

Dtk_ErrorStatus Dtk_ReferenceBlock::Transform

(

const Dtk_transfo &

inTransfo

)

Applies a transformation matrix to the entity. //!

Parameters

inTransfo

The transformation matrix to apply.

Translate()

void Dtk_ReferenceBlock::Translate

(

const Dtk_dir &

inTranslationDir

)

Translates the Dtk_ReferenceBlock - internal use only -.

Parameters

inTranslationDir

the translation vector.

Field Documentation

_Private

Dtk_Handle* Dtk_ReferenceBlock::_Private

protected

count_

unsigned long Dtk_Object::count_

protectedinherited