Dtk_DocElement Class Reference

This is the Main Doc Element Class The Dtk_DocElement object is common parent class of the Dtk_Node and the Dtk_Component classes It typically used as geometry into a Part. More...

Inheritance diagram for Dtk_DocElement:

Public Member Functions
void	AddMetaData (const Dtk_MetaDataPtr &inMetaData)
	Adds a Dtk_MetaDataPtr to the Dtk_DocElement. More...
void	AddMetaDataGroup (const Dtk_MetaDataGroupPtr &inMetaDataGroup, Dtk_bool inAddMetadata=DTK_FALSE)
	Adds a Dtk_MetaDataGroupPtr to the Dtk_DocElement. More...
void	AddProperty (const Dtk_PropertiesPtr &inProperty)
	Adds a Dtk_PropertiesPtr to the Dtk_DocElement. More...
Dtk_Int32	DtkDynamicType (const int &inId)
	Retrieves the dynamic entity type. More...
virtual void	dump (FILE *file=stdout)
Dtk_ID	GetFatherID (Dtk_Size_t inIndex) const
	Retrieves Dtk_DocElement ith FatherID - read only -. More...
Dtk_ID	GetID () const
	Retrieves the Dtk_DocElement ID - read only -. More...
Dtk_InfoPtr	GetInfos () const
	Retrieves the Dtk_DocElement Dtk_InfoPtr - read only -. More...
Dtk_MetaDataPtr	GetMetaData (const Dtk_Size_t &inPos) const
	Retrieves the ith Dtk_MetaDataPtr - read only -. More...
Dtk_MetaDataGroupPtr	GetMetaDataGroup (const Dtk_Size_t &inPos) const
	Retrieves the ith Dtk_MetaDataGrouplPtr - read only -. More...
Dtk_Size_t	GetNumChildren () const
	Retrieves the number of the Dtk_DocElement children - read only -. More...
Dtk_Size_t	GetNumFathers () const
	GetNumFather. More...
Dtk_Size_t	GetNumMetaData () const
	Retrieves the number of the Dtk_MetaDataPtr - read only -. More...
Dtk_Size_t	GetNumMetaDataGroup () const
	Retrieves the number of the Dtk_MetaDataGroupPtr - read only -. More...
Dtk_PreviewPtr	GetPreview () const
	Retrieves the Dtk_DocElement Dtk_PreviewPtr - read only -. More...
void	GetReadID (Dtk_ID &outReadID) const
virtual Dtk_Size_t	GetSize () const
Dtk_string &	Name ()
const Dtk_string &	Name () const
	Retrieves the Dtk_DocElement Name - read only -. More...
void	ReleasePreview ()
	SetAsDeprecated ("2026.3", "use GetInfos()->AddRenderInfos and GetInfos()->AddMaterialInfos methods instead.") void SetMaterial(Dtk_MaterialPtr inMaterial)
	SetAsDeprecated ("2026.3", "use GetInfos()->GetRenderInfos and GetInfos()->GetPhysicalMaterialInfos methods instead.") Dtk_MaterialPtr GetMaterial() const
	Retrieves the Dtk_DocElement Dtk_MaterialPtr - read only -. More...
void	SetInfos (const Dtk_InfoPtr &inInfos)
void	SetPreview (Dtk_PreviewPtr inPreview)
void	SetReadID (const Dtk_ID &inNewID)

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

Protected Types
enum	{ _typeID = DTK_TYPE_DOC_ELEMENT }

Protected Member Functions
void	_AddChild (const Dtk_DocElementPtr &inChild)
	Adds a child Dtk_DocElement to main Element. More...
void	_Copy (const Dtk_Node &s)
const Dtk_DocElementPtr	_GetChild (const Dtk_Size_t &inPos) const
	Retrieves the ith Dtk_DocElement - read only -. More...
void	_Init ()
Dtk_ErrorStatus	_ReplaceChild (const Dtk_Size_t &inPos, const Dtk_DocElementPtr &inNewChild)
	Replaces a child by another one. Also update father lists. More...
void	_Reset ()
	Dtk_DocElement (const Dtk_ID &inID, Dtk_string inName)
virtual	~Dtk_DocElement ()
	Destructor. More...

Protected Attributes
Dtk_Handle *	_Private
unsigned long	count_

Detailed Description

This is the Main Doc Element Class The Dtk_DocElement object is common parent class of the Dtk_Node and the Dtk_Component classes It typically used as geometry into a Part.

See also

Use Dtk_DocElementPtr class to handle it.

Member Enumeration Documentation

anonymous enum

anonymous enum

protected

Enumerator
_typeID

{ _typeID = DTK_TYPE_DOC_ELEMENT }; 

Constructor & Destructor Documentation

Dtk_DocElement()

Dtk_DocElement::Dtk_DocElement ( const Dtk_ID &  inID, Dtk_string  inName  )

protected

~Dtk_DocElement()

virtual Dtk_DocElement::~Dtk_DocElement ( )

protectedvirtual

Destructor.

Member Function Documentation

_AddChild()

void Dtk_DocElement::_AddChild ( const Dtk_DocElementPtr &  inChild )

protected

Adds a child Dtk_DocElement to main Element.

Parameters

inChild

The Dtk_DocElement to be added as a child.

_Copy()

void Dtk_DocElement::_Copy ( const Dtk_Node &  s )

protected

_GetChild()

const Dtk_DocElementPtr Dtk_DocElement::_GetChild ( const Dtk_Size_t &  inPos ) const

protected

Retrieves the ith Dtk_DocElement - read only -.

Parameters

inPos

Child element index.

Returns

the inPos'th Dtk_DocElement

_Init()

void Dtk_DocElement::_Init ( )

protected

_ReplaceChild()

Dtk_ErrorStatus Dtk_DocElement::_ReplaceChild ( const Dtk_Size_t &  inPos, const Dtk_DocElementPtr &  inNewChild  )

protected

Replaces a child by another one. Also update father lists.

Parameters

inPos	Old Child element index.
inNewChild	The Dtk_DocElement replacing the old one

Internal use only

Returns

the DtkNoerrror if success.

the dtkErrorOutOfRange if bad inPos parameter.

the dtkErrorNullPointer if inNewChild is NULL.

_Reset()

void Dtk_DocElement::_Reset ( )

protected

AddMetaData()

void Dtk_DocElement::AddMetaData

(

const Dtk_MetaDataPtr &

inMetaData

)

Adds a Dtk_MetaDataPtr to the Dtk_DocElement.

Parameters

inMetaData

The Dtk_MetaDataPtr to be added.

AddMetaDataGroup()

void Dtk_DocElement::AddMetaDataGroup	(	const Dtk_MetaDataGroupPtr &	inMetaDataGroup,
		Dtk_bool	inAddMetadata = DTK_FALSE
	)

Adds a Dtk_MetaDataGroupPtr to the Dtk_DocElement.

Parameters

inMetaDataGroup	The Dtk_MetaDataGroupPtr to be added.
inAddMetadata	If we also add the metadata of the group to the Dtk_DocElement

AddProperty()

void Dtk_DocElement::AddProperty

(

const Dtk_PropertiesPtr &

inProperty

)

Adds a Dtk_PropertiesPtr to the Dtk_DocElement.

Parameters

inProperty

The Dtk_PropertiesPtr to be added.

DtkDynamicCast()

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

static

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

DtkDynamicType()

Dtk_Int32 Dtk_DocElement::DtkDynamicType ( const int &  inId )

virtual

Retrieves the dynamic entity type.

Implements Dtk_Object.

Reimplemented in Dtk_Component, and Dtk_Node.

dump()

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

virtualinherited

GetFatherID()

Dtk_ID Dtk_DocElement::GetFatherID

(

Dtk_Size_t

inIndex

)

const

Retrieves Dtk_DocElement ith FatherID - read only -.

Returns

The ith FatherID.

GetID()

Dtk_ID Dtk_DocElement::GetID

(

)

const

Retrieves the Dtk_DocElement ID - read only -.

Returns

The element ID.

GetInfos()

Dtk_InfoPtr Dtk_DocElement::GetInfos

(

)

const

Retrieves the Dtk_DocElement Dtk_InfoPtr - read only -.

Returns

The element Dtk_InfoPtr.

GetMetaData()

Dtk_MetaDataPtr Dtk_DocElement::GetMetaData

(

const Dtk_Size_t &

inPos

)

const

Retrieves the ith Dtk_MetaDataPtr - read only -.

Parameters

inPos

Metadata index.

Returns

the inPos'th Dtk_MetaDataPtr

GetMetaDataGroup()

Dtk_MetaDataGroupPtr Dtk_DocElement::GetMetaDataGroup

(

const Dtk_Size_t &

inPos

)

const

Retrieves the ith Dtk_MetaDataGrouplPtr - read only -.

Parameters

inPos

Group index.

Returns

the inPos'th Dtk_MetaDataGrouplPtr

GetNumChildren()

Dtk_Size_t Dtk_DocElement::GetNumChildren

(

)

const

Retrieves the number of the Dtk_DocElement children - read only -.

Returns

The Children number.

GetNumFathers()

Dtk_Size_t Dtk_DocElement::GetNumFathers

(

)

const

GetNumFather.

Returns

Number of fathers

GetNumMetaData()

Dtk_Size_t Dtk_DocElement::GetNumMetaData

(

)

const

Retrieves the number of the Dtk_MetaDataPtr - read only -.

Returns

The Metadata number.

GetNumMetaDataGroup()

Dtk_Size_t Dtk_DocElement::GetNumMetaDataGroup

(

)

const

Retrieves the number of the Dtk_MetaDataGroupPtr - read only -.

Returns

The Group number.

GetPreview()

Dtk_PreviewPtr Dtk_DocElement::GetPreview

(

)

const

Retrieves the Dtk_DocElement Dtk_PreviewPtr - read only -.

Returns

The element Dtk_PreviewPtr if exists.

GetReadID()

void Dtk_DocElement::GetReadID

(

Dtk_ID &

outReadID

)

const

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.

Name() [1/2]

Dtk_string& Dtk_DocElement::Name

(

)

Name() [2/2]

const Dtk_string& Dtk_DocElement::Name

(

)

const

Retrieves the Dtk_DocElement Name - read only -.

Returns

The Element Name.

ReleasePreview()

void Dtk_DocElement::ReleasePreview

(

)

SetAsDeprecated() [1/2]

Dtk_DocElement::SetAsDeprecated	(	"2026.3"	,
		"use GetInfos()->AddRenderInfos and GetInfos()->AddMaterialInfos methods instead."
	)

Deprecated:

use GetInfos()->AddRenderInfos and GetInfos()->AddMaterialInfos methods instead

SetAsDeprecated() [2/2]

Dtk_DocElement::SetAsDeprecated	(	"2026.3"	,
		"use GetInfos()->GetRenderInfos and GetInfos()->GetPhysicalMaterialInfos methods instead."
	)		const

Retrieves the Dtk_DocElement Dtk_MaterialPtr - read only -.

Returns

The element Dtk_MaterialPtrif if exists

Deprecated:

use GetInfos()->GetRenderInfos and GetInfos()->GetPhysicalMaterialInfos methods instead

SetInfos()

void Dtk_DocElement::SetInfos

(

const Dtk_InfoPtr &

inInfos

)

SetPreview()

void Dtk_DocElement::SetPreview

(

Dtk_PreviewPtr

inPreview

)

SetReadID()

void Dtk_DocElement::SetReadID

(

const Dtk_ID &

inNewID

)

Field Documentation

_Private

Dtk_Handle* Dtk_DocElement::_Private

protected

count_

unsigned long Dtk_Object::count_

protectedinherited