Dtk_Node Class Reference

This is the Node Class The Dtk_Node object is used to retrieve informations in a Dtk_ComponentPtr object Is typically used as geometry into a Part. More...

Inheritance diagram for Dtk_Node:

Data Structures
class	FullType
	This is the Node FullType Class The Dtk_Node::FullType object is used to retrieve the full informations about Dtk_Node Type - Primary and SubType -. More...

Public Types
enum	BodyNodeDataTypeEnum {   UnknownType = 0, HasPoints = 1, HasCurves = 2, HasSurfaces = 4,   HasSolids = 8, HasAxis = 16, HasMesh = 32, HasMeshSurfaces = 64 }
enum	NodeDataTypeEnum {   NullType = 0, BodyType, MeshType, AnnotationSetType,   FdtType, DrawingType, KinematicsType, AxisSystemType,   LayerInfosSetType, ColorInfosSetType, MetaDataType, ModelDisplayType,   CameraType, VirtualType, ConstraintType, MaxNodeDataType }

Public Member Functions
void	AddAssociatedEntities (const Dtk_tab< Dtk_NodeConnectorPtr > &inAssociatedEntities)
	Adds associated entities - Dtk_NodeConnectorPtr - to the Dtk_Node. More...
void	AddAssociatedEntity (const Dtk_NodeConnectorPtr &inAssociatedEntity)
	Retrieves the Dtk_Node as a Dtk_KinematicsPtr - if exists -. More...
void	AddChild (const Dtk_NodePtr &inChild)
	Adds a child Dtk_Node to main Node. More...
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_ErrorStatus	GetAssociatedEntities (Dtk_tab< Dtk_NodeConnectorPtr > &outAssociatedEntities)
	Retrieves the entities associated to the Dtk_Node. They are retrieved via Dtk_NodeConnectorPtr. More...
const Dtk_NodePtr	GetChild (const Dtk_Size_t &inPos) const
	Retrieves the ith Dtk_Node - read only -. More...
Dtk_ObjectPtr	GetDtk_AdvancedFeaturePtr ()
	Retrieves the Dtk_Node as a Dtk_AdvancedFeaturePtr - if exists - Internal Use !!! More...
Dtk_AxisSystemPtr	GetDtk_AxisSystemPtr ()
	Retrieves the Dtk_Node as a Dtk_AxisSystemPtr - if exists -. More...
Dtk_BodyPtr	GetDtk_BodyPtr ()
	Retrieves the Dtk_Node as a Dtk_BodyPtr - if exists -. More...
Dtk_CameraPtr	GetDtk_CameraPtr ()
	Retrieves the Dtk_Node as a Dtk_CameraPtr - if exists -. More...
Dtk_ColorInfosSetPtr	GetDtk_ColorInfosSetPtr ()
	Retrieves the Dtk_Node as a Dtk_ColorInfosSetPtr - if exists -. More...
Dtk_ConstraintPtr	GetDtk_ConstraintPtr ()
	Retrieves the Dtk_Node as a Dtk_ConstraintPtr - if exists -. More...
Dtk_DrawingPtr	GetDtk_DrawingPtr ()
	Retrieves the Dtk_Node as a Dtk_DrawingPtr - if exists -. More...
Dtk_FdtPtr	GetDtk_FdtPtr ()
	Retrieves the Dtk_Node as a Dtk_FdtPtr - if exists -. More...
Dtk_FeaturePtr	GetDtk_FeaturePtr ()
	Retrieves the Dtk_Node as a Dtk_FeaturePtr - if exists -. More...
Dtk_KinematicPtr	GetDtk_KinematicPtr ()
	Retrieves the Dtk_Node as a Dtk_KinematicPtr - if exists -. More...
Dtk_LayerInfosSetPtr	GetDtk_LayerInfosSetPtr ()
	Retrieves the Dtk_Node as a Dtk_LayerInfosSetPtr - if exists -. More...
Dtk_MeshPtr	GetDtk_MeshPtr ()
	Retrieves the Dtk_Node as a Dtk_meshPtr - if exists -. More...
Dtk_MetaDataPtr	GetDtk_MetaDataPtr ()
	Retrieves the Dtk_Node as a Dtk_FdtAnnotationSetPtr - if exists -. More...
Dtk_ModelDisplayPtr	GetDtk_ModelDisplayPtr ()
	Retrieves the Dtk_Node as a Dtk_ModelDisplayPtr - if exists -. More...
Dtk_NodeID	GetEntityID () const
	Retrieves the Dtk_Node EntityID - read only -. More...
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_MaterialPtr	GetMaterial () const
	Retrieves the Dtk_DocElement Dtk_MaterialPtr - 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...
const Dtk_Node::FullType	GetNodeFullType () const
	Retrieves the Node FullType - Primary ans Sub Type - - read only -. More...
type_detk	GetNodeSubType () const
	Retrieves the Node SubType - if relevant - - read only -. More...
NodeDataTypeEnum	GetNodeType () const
	Retrieves the Dtk_Node Node Type - 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_StoredInfoPtr	GetStoredInfos () const
Dtk_string &	Name ()
const Dtk_string &	Name () const
	Retrieves the Dtk_DocElement Name - read only -. More...
Dtk_bool	NodeHasAxis () const
	Return DTK_TRUE if Dtk_Node Type Body contains axis entity. More...
Dtk_bool	NodeHasCurves () const
	Return DTK_TRUE if Dtk_Node Type Body or Mesh contains curves entity. More...
Dtk_bool	NodeHasMesh () const
	Return DTK_TRUE if Dtk_Node Type Body or Mesh contains mesh entity. More...
Dtk_bool	NodeHasMeshSurfaces () const
	Return DTK_TRUE if Dtk_Node Type Body contains mesh surface entity. More...
Dtk_bool	NodeHasPoints () const
	Return DTK_TRUE if Dtk_Node Type Body or Mesh contains points entity. More...
Dtk_bool	NodeHasSolids () const
	Return DTK_TRUE if Dtk_Node Type Body contains solid entity. More...
Dtk_bool	NodeHasSurfaces () const
	Return DTK_TRUE if Dtk_Node Type Body contains surfacic entity. More...
void	ReleasePreview ()
Dtk_ErrorStatus	ReplaceChildNode (const Dtk_Size_t &inPos, const Dtk_NodePtr &inNewChild)
	Replaces a child Dtk_NodePtr by another one. Also updates father lists. More...
	SetAsDeprecated ("Undefined", "No more used") Dtk_FdtAnnotationSetPtr GetDtk_FdtAnnotationSetPtr()
	Retrieves the Dtk_Node as a Dtk_FdtAnnotationSetPtr - if exists -. More...
void	SetInfos (const Dtk_InfoPtr &inInfos)
void	SetMaterial (Dtk_MaterialPtr inMaterial)
void	SetPreview (Dtk_PreviewPtr inPreview)
void	SetReadID (const Dtk_ID &inNewID)
void	SetStoredInfos (const Dtk_StoredInfoPtr &inInfos)

Static Public Member Functions
static Dtk_Node *	DtkDynamicCast (Dtk_Object *s)
	Performs a dynamic cast - doesn't need RTTI -. More...
static Dtk_Int32	NodeDataStringToEnumType (const Dtk_string &type)
static Dtk_string	NodeDataTypeEnumToString (const NodeDataTypeEnum &inEnum)

Protected Types
enum	{ _typeID = DTK_TYPE_DOC_ELEMENT }
enum	{ _typeID = DTK_TYPE_NODE }

Protected Member Functions
void	_AddChild (const Dtk_DocElementPtr &inChild)
	Adds a child Dtk_DocElement to main Element. More...
void	_copy (const Dtk_Object &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 ()

Protected Attributes
Dtk_Handle *	_Private
unsigned long	count_

Friends
class	Dtk_Component
class	Dtk_SmartPtr< Dtk_Node >

Detailed Description

This is the Node Class The Dtk_Node object is used to retrieve informations in a Dtk_ComponentPtr object Is typically used as geometry into a Part.

See also

Please use the Dtk_Node class to handle it.

Member Enumeration Documentation

anonymous enum

anonymous enum

protectedinherited

Enumerator
_typeID

{ _typeID = DTK_TYPE_DOC_ELEMENT }; 

anonymous enum

anonymous enum

protected

Enumerator
_typeID

{ _typeID = DTK_TYPE_NODE }; 

BodyNodeDataTypeEnum

enum Dtk_Node::BodyNodeDataTypeEnum

Enumerator
UnknownType
HasPoints
HasCurves
HasSurfaces
HasSolids
HasAxis
HasMesh
HasMeshSurfaces

     {
          UnknownType = 0,
          HasPoints     = 1,                         
          HasCurves     = 2,                         
          HasSurfaces   = 4,                          
          HasSolids     = 8,                
          HasAxis = 16,
          HasMesh = 32,
          HasMeshSurfaces = 64
     };

NodeDataTypeEnum

enum Dtk_Node::NodeDataTypeEnum

Enumerator
NullType
BodyType
MeshType
AnnotationSetType
FdtType
DrawingType
KinematicsType
AxisSystemType
LayerInfosSetType
ColorInfosSetType
MetaDataType
ModelDisplayType
CameraType
VirtualType
ConstraintType
MaxNodeDataType

    {
        NullType = 0,
          BodyType,                           // for 3D
          MeshType,                           // for 3D Tesselated
        AnnotationSetType,                  // for FdtAnnotationSet -- Obsolete 
        FdtType,                            // for Fdt
        DrawingType,                        // for 2D
          KinematicsType,                              // Kinematics
          AxisSystemType,                             // AxisPlacement
          LayerInfosSetType,                      // LayerInfosSet
          ColorInfosSetType,                      // ColorInfosSet
          MetaDataType,                       // MetaData 
        ModelDisplayType,                         // Model Display 
        CameraType,                             // Camera
          VirtualType,                        // just for containing children
          ConstraintType,                     // ConstraintType
        MaxNodeDataType
    };

Member Function Documentation

_AddChild()

void Dtk_DocElement::_AddChild ( const Dtk_DocElementPtr &  inChild )

protectedinherited

Adds a child Dtk_DocElement to main Element.

Parameters

inChild

The Dtk_DocElement to be added as a child.

_copy()

void Dtk_Object::_copy ( const Dtk_Object &  s )

protectedinherited

_GetChild()

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

protectedinherited

Retrieves the ith Dtk_DocElement - read only -.

Parameters

inPos

Child element index.

Returns

the inPos'th Dtk_DocElement

_init()

void Dtk_Object::_init ( )

protectedinherited

_ReplaceChild()

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

protectedinherited

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_Object::_reset ( )

protectedinherited

AddAssociatedEntities()

void Dtk_Node::AddAssociatedEntities

(

const Dtk_tab< Dtk_NodeConnectorPtr > &

inAssociatedEntities

)

Adds associated entities - Dtk_NodeConnectorPtr - to the Dtk_Node.

Returns

DtkNoError if success.

Parameters

inAssociatedEntities

AssociatedEntities to be added.

AddAssociatedEntity()

void Dtk_Node::AddAssociatedEntity

(

const Dtk_NodeConnectorPtr &

inAssociatedEntity

)

Retrieves the Dtk_Node as a Dtk_KinematicsPtr - if exists -.

Returns

The Dtk_Node as a Dtk_Kinematic if exists. Null Dtk_Kinematics else.

Remarks

This method is used to retrieve the kinematic info informations - if GetNodeType() method returns KinematicFilterType -.

Adds associated entity - Dtk_NodeConnectorPtr - to the Dtk_Node.

Returns

DtkNoError if success.

Parameters

inAssociatedEntity

AssociatedEntity to be added.

AddChild()

void Dtk_Node::AddChild

(

const Dtk_NodePtr &

inChild

)

Adds a child Dtk_Node to main Node.

Parameters

inChild

The Dtk_Node to be added as a child.

    { _AddChild( Dtk_DocElementPtr::DtkDynamicCast(inChild) ); }

AddMetaData()

void Dtk_DocElement::AddMetaData ( const Dtk_MetaDataPtr &  inMetaData )

inherited

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  )

inherited

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 )

inherited

Adds a Dtk_PropertiesPtr to the Dtk_DocElement.

Parameters

inProperty

The Dtk_PropertiesPtr to be added.

DtkDynamicCast()

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

static

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

DtkDynamicType()

Dtk_Int32 Dtk_Node::DtkDynamicType ( const int &  inId )

virtual

Retrieves the dynamic entity type.

Reimplemented from Dtk_DocElement.

dump()

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

virtualinherited

GetAssociatedEntities()

Dtk_ErrorStatus Dtk_Node::GetAssociatedEntities

(

Dtk_tab< Dtk_NodeConnectorPtr > &

outAssociatedEntities

)

Retrieves the entities associated to the Dtk_Node. They are retrieved via Dtk_NodeConnectorPtr.

Returns

DtkNoError if success.

Parameters

outAssociatedEntities

The associatedEntities to be retrieved.

GetChild()

const Dtk_NodePtr Dtk_Node::GetChild

(

const Dtk_Size_t &

inPos

)

const

Retrieves the ith Dtk_Node - read only -.

Parameters

inPos

Child node index.

Returns

the inPos'th Dtk_Node

    { return Dtk_NodePtr::DtkDynamicCast( _GetChild(inPos) ); }

GetDtk_AdvancedFeaturePtr()

Dtk_ObjectPtr Dtk_Node::GetDtk_AdvancedFeaturePtr

(

)

Retrieves the Dtk_Node as a Dtk_AdvancedFeaturePtr - if exists - Internal Use !!!

Returns

The Dtk_Node as a Dtk_FeaturePtr if exists. Null Dtk_FeaturePtr else.

Remarks

GetDtk_AxisSystemPtr()

Dtk_AxisSystemPtr Dtk_Node::GetDtk_AxisSystemPtr

(

)

Retrieves the Dtk_Node as a Dtk_AxisSystemPtr - if exists -.

Returns

The Dtk_Node as a Dtk_AxisSystemPtr if exists. Null Dtk_AxisSystemPtr else.

Remarks

This method is used to retrieve the axis placement informations - if GetNodeType() method returns AxisSystemType -.

GetDtk_BodyPtr()

Dtk_BodyPtr Dtk_Node::GetDtk_BodyPtr

(

)

Retrieves the Dtk_Node as a Dtk_BodyPtr - if exists -.

Returns

The Dtk_Node as a Dtk_BodyPtr if exists. Null Dtk_BodyPtr else.

Remarks

This method is used to retrieve the body
informations - if GetNodeType() method returns BodyType -.

GetDtk_CameraPtr()

Dtk_CameraPtr Dtk_Node::GetDtk_CameraPtr

(

)

Retrieves the Dtk_Node as a Dtk_CameraPtr - if exists -.

Returns

The Dtk_Node as a Dtk_CameraPtr if exists. Null Dtk_CameraPtr else.

Remarks

This method is used to retrieve the camera entity informations - if GetNodeType() method returns CameraType -.

GetDtk_ColorInfosSetPtr()

Dtk_ColorInfosSetPtr Dtk_Node::GetDtk_ColorInfosSetPtr

(

)

Retrieves the Dtk_Node as a Dtk_ColorInfosSetPtr - if exists -.

Returns

The Dtk_Node as a Dtk_ColorInfosSetPtr if exists. Null Dtk_ColorInfosSetPtr else.

Remarks

This method is used to retrieve the color infos set informations - if GetNodeType() method returns ColorInfosSetType -.

GetDtk_ConstraintPtr()

Dtk_ConstraintPtr Dtk_Node::GetDtk_ConstraintPtr

(

)

Retrieves the Dtk_Node as a Dtk_ConstraintPtr - if exists -.

Returns

The Dtk_Node as a Dtk_ConstraintPtr if exists. Null Dtk_ConstraintPtr else.

Remarks

This method is used to retrieve the Constraint entity informations - if GetNodeType() method returns ConstraintType -.

GetDtk_DrawingPtr()

Dtk_DrawingPtr Dtk_Node::GetDtk_DrawingPtr

(

)

Retrieves the Dtk_Node as a Dtk_DrawingPtr - if exists -.

Returns

The Dtk_Node as a Dtk_DrawingPtr if exists. Null Dtk_DrawingPtr else.

Remarks

This method is used to retrieve the drawing
informations - if GetNodeType() method returns DrawingType -.

GetDtk_FdtPtr()

Dtk_FdtPtr Dtk_Node::GetDtk_FdtPtr

(

)

Retrieves the Dtk_Node as a Dtk_FdtPtr - if exists -.

Returns

The Dtk_Node as a Dtk_FdtPtr if exists. Null Dtk_FdtPtr else.

Remarks

This method is used to retrieve the FDT
informations - if GetNodeType() method returns FdtType -.

GetDtk_FeaturePtr()

Dtk_FeaturePtr Dtk_Node::GetDtk_FeaturePtr

(

)

Retrieves the Dtk_Node as a Dtk_FeaturePtr - if exists -.

Returns

The Dtk_Node as a Dtk_FeaturePtr if exists. Null Dtk_FeaturePtr else.

Remarks

This method is used to retrieve the feature
informations - if GetNodeType() method returns Virtual Type or Body Type-.

GetDtk_KinematicPtr()

Dtk_KinematicPtr Dtk_Node::GetDtk_KinematicPtr

(

)

Retrieves the Dtk_Node as a Dtk_KinematicPtr - if exists -.

Returns

The Dtk_Node as a Dtk_KinematicsPtr if exists. Null Dtk_KinematicPtr else.

Remarks

This method is used to retrieve the Kinematics
informations - if GetNodeType() method returns KinematicsType -.

GetDtk_LayerInfosSetPtr()

Dtk_LayerInfosSetPtr Dtk_Node::GetDtk_LayerInfosSetPtr

(

)

Retrieves the Dtk_Node as a Dtk_LayerInfosSetPtr - if exists -.

Returns

The Dtk_Node as a Dtk_LayerInfosSetPtr if exists. Null Dtk_LayerInfosSetPtr else.

Remarks

This method is used to retrieve the layer infos set informations - if GetNodeType() method returns LayerInfosSetType -.

GetDtk_MeshPtr()

Dtk_MeshPtr Dtk_Node::GetDtk_MeshPtr

(

)

Retrieves the Dtk_Node as a Dtk_meshPtr - if exists -.

Returns

The Dtk_Node as a Dtk_meshPtr if exists. Null Dtk_meshPtr else.

Remarks

This method is used to retrieve the mesh
informations - if GetNodeType() method returns MeshType -.

GetDtk_MetaDataPtr()

Dtk_MetaDataPtr Dtk_Node::GetDtk_MetaDataPtr

(

)

Retrieves the Dtk_Node as a Dtk_FdtAnnotationSetPtr - if exists -.

Returns

The Dtk_Node as a MetaDataPtr if exists. Null MetaDataPtr else.

Remarks

This method is used to retrieve the MetaData
informations - if GetNodeType() method returns MetaDataType -.

GetDtk_ModelDisplayPtr()

Dtk_ModelDisplayPtr Dtk_Node::GetDtk_ModelDisplayPtr

(

)

Retrieves the Dtk_Node as a Dtk_ModelDisplayPtr - if exists -.

Returns

The Dtk_Node as a Dtk_ModelDisplayPtr if exists. Null Dtk_ModelDisplayPtr else.

Remarks

This method is used to retrieve the display model entity (camera capture) informations - if GetNodeType() method returns ModelDisplayType -.

GetEntityID()

Dtk_NodeID Dtk_Node::GetEntityID

(

)

const

Retrieves the Dtk_Node EntityID - read only -.

Returns

The Entity ID of Node.

GetFatherID()

Dtk_ID Dtk_DocElement::GetFatherID ( Dtk_Size_t  inIndex ) const

inherited

Retrieves Dtk_DocElement ith FatherID - read only -.

Returns

The ith FatherID.

GetID()

Dtk_ID Dtk_DocElement::GetID ( ) const

inherited

Retrieves the Dtk_DocElement ID - read only -.

Returns

The element ID.

GetInfos()

Dtk_InfoPtr Dtk_DocElement::GetInfos ( ) const

inherited

Retrieves the Dtk_DocElement Dtk_InfoPtr - read only -.

Returns

The element Dtk_InfoPtr.

GetMaterial()

Dtk_MaterialPtr Dtk_DocElement::GetMaterial ( ) const

inherited

Retrieves the Dtk_DocElement Dtk_MaterialPtr - read only -.

Returns

The element Dtk_MaterialPtrif if exists .

GetMetaData()

Dtk_MetaDataPtr Dtk_DocElement::GetMetaData ( const Dtk_Size_t &  inPos ) const

inherited

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

inherited

Retrieves the ith Dtk_MetaDataGrouplPtr - read only -.

Parameters

inPos

Group index.

Returns

the inPos'th Dtk_MetaDataGrouplPtr

GetNodeFullType()

const Dtk_Node::FullType Dtk_Node::GetNodeFullType

(

)

const

Retrieves the Node FullType - Primary ans Sub Type - - read only -.

Returns

The Node FullType.

GetNodeSubType()

type_detk Dtk_Node::GetNodeSubType

(

)

const

Retrieves the Node SubType - if relevant - - read only -.

Returns

The Node SubType.

Deprecated:

See also

Dtk_Node::GetNodeFullType()

GetNodeType()

NodeDataTypeEnum Dtk_Node::GetNodeType

(

)

const

Retrieves the Dtk_Node Node Type - read only -.

Returns

The Node Type.

Deprecated:

See also

Dtk_Node::GetNodeFullType()

GetNumChildren()

Dtk_Size_t Dtk_DocElement::GetNumChildren ( ) const

inherited

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

Returns

The Children number.

GetNumFathers()

Dtk_Size_t Dtk_DocElement::GetNumFathers ( ) const

inherited

GetNumFather.

Returns

Number of fathers

GetNumMetaData()

Dtk_Size_t Dtk_DocElement::GetNumMetaData ( ) const

inherited

Retrieves the number of the Dtk_MetaDataPtr - read only -.

Returns

The Metadata number.

GetNumMetaDataGroup()

Dtk_Size_t Dtk_DocElement::GetNumMetaDataGroup ( ) const

inherited

Retrieves the number of the Dtk_MetaDataGroupPtr - read only -.

Returns

The Group number.

GetPreview()

Dtk_PreviewPtr Dtk_DocElement::GetPreview ( ) const

inherited

Retrieves the Dtk_DocElement Dtk_PreviewPtr - read only -.

Returns

The element Dtk_PreviewPtr if exists.

GetReadID()

void Dtk_DocElement::GetReadID ( Dtk_ID &  outReadID ) const

inherited

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.

GetStoredInfos()

Dtk_StoredInfoPtr Dtk_Node::GetStoredInfos

(

)

const

Name() [1/2]

Dtk_string& Dtk_DocElement::Name ( )

inherited

Name() [2/2]

const Dtk_string& Dtk_DocElement::Name ( ) const

inherited

Retrieves the Dtk_DocElement Name - read only -.

Returns

The Element Name.

NodeDataStringToEnumType()

static Dtk_Int32 Dtk_Node::NodeDataStringToEnumType ( const Dtk_string &  type )

static

     {
          if( type == L"NullType" )
               return NullType;
          else if( type == L"BodyType" )
               return BodyType;
          else if( type == L"MeshType" )
               return MeshType;
          else if( type == L"AnnotationSetType" )
               return AnnotationSetType;
          else if( type == L"FdtType" )
               return FdtType;
          else if( type == L"DrawingType" )
               return DrawingType;
          else if( type == L"KinematicsType" )
               return KinematicsType;
          else if( type == L"AxisSystemType" )
               return AxisSystemType;
          else if (type == L"LayerInfosSetType")
               return LayerInfosSetType;
          else if (type == L"ColorInfosSetType")
               return ColorInfosSetType;
          else if( type == L"MetaDataType" )
               return MetaDataType;
          else if( type == L"VirtualType" )
               return VirtualType;
        else if (type == L"ModelDisplayType")
            return ModelDisplayType;
        else if (type == L"CameraType")
            return CameraType;
        else if (type == L"ConstraintType")
            return ConstraintType;
          else return -1;          
     }

NodeDataTypeEnumToString()

static Dtk_string Dtk_Node::NodeDataTypeEnumToString ( const NodeDataTypeEnum &  inEnum )

static

    {
        switch( inEnum )
        {
        case NullType: return L"NullType";
          case BodyType: return L"BodyType";
          case MeshType: return L"MeshType";
        case AnnotationSetType: return L"AnnotationSetType";
        case FdtType: return L"FdtType";
        case DrawingType: return L"DrawingType";
          case KinematicsType: return L"KinematicsType";
          case AxisSystemType: return L"AxisSystemType";
          case LayerInfosSetType: return L"LayerInfosSetType";
          case ColorInfosSetType: return L"ColorInfosSetType";
          case MetaDataType: return L"MetaDataType";
        case VirtualType: return L"VirtualType";
        case ModelDisplayType : return L"ModelDisplayType";
        case CameraType : return L"CameraType";
        case ConstraintType: return L"Constraint";
        default: return L"Unknown";
        }
    }

NodeHasAxis()

Dtk_bool Dtk_Node::NodeHasAxis

(

)

const

Return DTK_TRUE if Dtk_Node Type Body contains axis entity.

NodeHasCurves()

Dtk_bool Dtk_Node::NodeHasCurves

(

)

const

Return DTK_TRUE if Dtk_Node Type Body or Mesh contains curves entity.

NodeHasMesh()

Dtk_bool Dtk_Node::NodeHasMesh

(

)

const

Return DTK_TRUE if Dtk_Node Type Body or Mesh contains mesh entity.

NodeHasMeshSurfaces()

Dtk_bool Dtk_Node::NodeHasMeshSurfaces

(

)

const

Return DTK_TRUE if Dtk_Node Type Body contains mesh surface entity.

NodeHasPoints()

Dtk_bool Dtk_Node::NodeHasPoints

(

)

const

Return DTK_TRUE if Dtk_Node Type Body or Mesh contains points entity.

NodeHasSolids()

Dtk_bool Dtk_Node::NodeHasSolids

(

)

const

Return DTK_TRUE if Dtk_Node Type Body contains solid entity.

NodeHasSurfaces()

Dtk_bool Dtk_Node::NodeHasSurfaces

(

)

const

Return DTK_TRUE if Dtk_Node Type Body contains surfacic entity.

ReleasePreview()

void Dtk_DocElement::ReleasePreview ( )

inherited

ReplaceChildNode()

Dtk_ErrorStatus Dtk_Node::ReplaceChildNode	(	const Dtk_Size_t &	inPos,
		const Dtk_NodePtr &	inNewChild
	)

Replaces a child Dtk_NodePtr by another one. Also updates father lists.

Parameters

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

Internal use only

Returns

the DtkNoerrror if success.

the dtkErrorOutOfRange if bad inPos parameter.

the dtkErrorNullPointer if inNewChild is NULL.

    { return _ReplaceChild( inPos, Dtk_DocElementPtr::DtkDynamicCast(inNewChild) ); }

SetAsDeprecated()

Dtk_Node::SetAsDeprecated	(	"Undefined"	,
		"No more used"
	)

Retrieves the Dtk_Node as a Dtk_FdtAnnotationSetPtr - if exists -.

Deprecated:

Returns

The Dtk_Node as a Dtk_FdtAnnotationSetPtr if exists. Null Dtk_FdtAnnotationSetPtr else.

Remarks

This method is used to retrieve the FDT
informations - if GetNodeType() method returns AnnotationSetType -.

SetInfos()

void Dtk_DocElement::SetInfos ( const Dtk_InfoPtr &  inInfos )

inherited

SetMaterial()

void Dtk_DocElement::SetMaterial ( Dtk_MaterialPtr  inMaterial )

inherited

SetPreview()

void Dtk_DocElement::SetPreview ( Dtk_PreviewPtr  inPreview )

inherited

SetReadID()

void Dtk_DocElement::SetReadID ( const Dtk_ID &  inNewID )

inherited

SetStoredInfos()

void Dtk_Node::SetStoredInfos

(

const Dtk_StoredInfoPtr &

inInfos

)

Friends And Related Function Documentation

Dtk_Component

friend class Dtk_Component

friend

Dtk_SmartPtr< Dtk_Node >

friend class Dtk_SmartPtr< Dtk_Node >

friend

Field Documentation

_Private

Dtk_Handle* Dtk_Node::_Private

protected

count_

unsigned long Dtk_Object::count_

protectedinherited