DATAKIT API  V2025.1
Dtk_GraphicalData Class Referenceabstract

This is the Dtk_GraphicalData Class.
The Dtk_GraphicalDataPtr object is used to store preview data It contains graphical information.
. More...

+ Inheritance diagram for Dtk_GraphicalData:

Public Member Functions

DtkErrorStatus AddDrawing (Dtk_DrawingPtr inDrawing)
 Add One Drawing. More...
 
DtkErrorStatus AddMesh (Dtk_MeshPtr inMesh)
 Add One Mesh. 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_CameraPtr GetDefaultCamera ()
 Get Default Camera. More...
 
Dtk_DrawingPtr GetDrawing (Dtk_Size_t inNum)
 Get Number of Drawing. More...
 
Dtk_tab< Dtk_DrawingPtrGetDrawings ()
 Get Drawings. More...
 
Dtk_MeshPtr GetMesh (Dtk_Size_t inNum)
 Get Number of Drawing. More...
 
Dtk_tab< Dtk_MeshPtrGetMeshes ()
 Get Meshes. More...
 
Dtk_Size_t GetNumDrawings ()
 Get Number of Drawing. More...
 
Dtk_Size_t GetNumMeshes ()
 Get Number of Meshes. More...
 
virtual Dtk_Size_t GetSize () const
 
DtkErrorStatus SetDefaultCamera (Dtk_CameraPtr inDefaultCamera)
 Set Default Camera. More...
 
DtkErrorStatus SetDrawings (Dtk_tab< Dtk_DrawingPtr > inDrawings)
 Set Drawings. More...
 
DtkErrorStatus SetMeshes (Dtk_tab< Dtk_MeshPtr > inMeshes)
 Set Meshes. More...
 

Static Public Member Functions

static Dtk_GraphicalDataPtr Create ()
 Create a Dtk_GraphicalDataPtr. More...
 
static Dtk_GraphicalDataDtkDynamicCast (Dtk_Object *s)
 Performs a dynamic cast - doesn't need RTTI -. More...
 

Protected Types

enum  { _typeID = DTK_TYPE_GRAPHICAL_DATA }
 

Protected Member Functions

void _Copy (const Dtk_GraphicalData &inToBeCopied)
 
void _copy (const Dtk_Object &s)
 
void _init ()
 
void _Init ()
 
void _reset ()
 
void _Reset ()
 
 Dtk_GraphicalData ()
 
 Dtk_GraphicalData (const Dtk_GraphicalData &inToBeCopied)
 Copy constructor. More...
 
virtual ~Dtk_GraphicalData ()
 Destructor. More...
 

Protected Attributes

Dtk_Handle * _Private
 
unsigned long count_
 

Friends

class Dtk_SmartPtr< Dtk_GraphicalData >
 

Detailed Description

This is the Dtk_GraphicalData Class.
The Dtk_GraphicalDataPtr object is used to store preview data It contains graphical information.
.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
protected
Enumerator
_typeID 
33  {
35  };

Constructor & Destructor Documentation

◆ Dtk_GraphicalData() [1/2]

Dtk_GraphicalData::Dtk_GraphicalData ( const Dtk_GraphicalData inToBeCopied)
protected

Copy constructor.

Parameters
inToBeCopiedObject to copy.

◆ Dtk_GraphicalData() [2/2]

Dtk_GraphicalData::Dtk_GraphicalData ( )
protected
See also
CreateMetaData
CreateParameterMetaData

◆ ~Dtk_GraphicalData()

virtual Dtk_GraphicalData::~Dtk_GraphicalData ( )
protectedvirtual

Destructor.

Member Function Documentation

◆ _Copy()

void Dtk_GraphicalData::_Copy ( const Dtk_GraphicalData inToBeCopied)
protected

◆ _copy()

void Dtk_Object::_copy ( const Dtk_Object s)
protectedinherited

◆ _init()

void Dtk_Object::_init ( )
protectedinherited

◆ _Init()

void Dtk_GraphicalData::_Init ( )
protected

◆ _reset()

void Dtk_Object::_reset ( )
protectedinherited

◆ _Reset()

void Dtk_GraphicalData::_Reset ( )
protected

◆ AddDrawing()

DtkErrorStatus Dtk_GraphicalData::AddDrawing ( Dtk_DrawingPtr  inDrawing)

Add One Drawing.

◆ AddMesh()

DtkErrorStatus Dtk_GraphicalData::AddMesh ( Dtk_MeshPtr  inMesh)

Add One Mesh.

◆ Create()

static Dtk_GraphicalDataPtr Dtk_GraphicalData::Create ( )
static

Create a Dtk_GraphicalDataPtr.

Returns
the constructed Dtk_GraphicalDataPtr.

◆ DtkDynamicCast()

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

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

69  {
70  if( s->DtkDynamicType( _typeID ) ) return static_cast< Dtk_GraphicalData* >( s );
71  return NULL;
72  }

◆ DtkDynamicType() [1/2]

Dtk_Int32 Dtk_GraphicalData::DtkDynamicType ( const Dtk_Int32 inId)

Retrieves the dynamic entity type.

62  {
63  if( inId == _typeID ) return 1;
64  return Dtk_Object::DtkDynamicType( inId );
65  }

◆ DtkDynamicType() [2/2]

◆ dump()

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

◆ GetDefaultCamera()

Dtk_CameraPtr Dtk_GraphicalData::GetDefaultCamera ( )

Get Default Camera.

◆ GetDrawing()

Dtk_DrawingPtr Dtk_GraphicalData::GetDrawing ( Dtk_Size_t  inNum)

Get Number of Drawing.

◆ GetDrawings()

Dtk_tab<Dtk_DrawingPtr> Dtk_GraphicalData::GetDrawings ( )

Get Drawings.

◆ GetMesh()

Dtk_MeshPtr Dtk_GraphicalData::GetMesh ( Dtk_Size_t  inNum)

Get Number of Drawing.

◆ GetMeshes()

Dtk_tab<Dtk_MeshPtr> Dtk_GraphicalData::GetMeshes ( )

Get Meshes.

◆ GetNumDrawings()

Dtk_Size_t Dtk_GraphicalData::GetNumDrawings ( )

Get Number of Drawing.

◆ GetNumMeshes()

Dtk_Size_t Dtk_GraphicalData::GetNumMeshes ( )

Get Number of Meshes.

◆ GetSize()

◆ SetDefaultCamera()

DtkErrorStatus Dtk_GraphicalData::SetDefaultCamera ( Dtk_CameraPtr  inDefaultCamera)

Set Default Camera.

◆ SetDrawings()

DtkErrorStatus Dtk_GraphicalData::SetDrawings ( Dtk_tab< Dtk_DrawingPtr inDrawings)

Set Drawings.

◆ SetMeshes()

DtkErrorStatus Dtk_GraphicalData::SetMeshes ( Dtk_tab< Dtk_MeshPtr inMeshes)

Set Meshes.

Friends And Related Function Documentation

◆ Dtk_SmartPtr< Dtk_GraphicalData >

friend class Dtk_SmartPtr< Dtk_GraphicalData >
friend

Field Documentation

◆ _Private

Dtk_Handle* Dtk_GraphicalData::_Private
protected

◆ count_

unsigned long Dtk_Object::count_
protectedinherited
Dtk_GraphicalData::_typeID
@ _typeID
Definition: dtk_graphical.hpp:34
DTK_TYPE_GRAPHICAL_DATA
@ DTK_TYPE_GRAPHICAL_DATA
Definition: define.h:506
Dtk_GraphicalData
This is the Dtk_GraphicalData Class. The Dtk_GraphicalDataPtr object is used to store preview data It...
Definition: dtk_graphical.hpp:27
Dtk_Object::DtkDynamicType
virtual int DtkDynamicType(const int &inId)=0