DATAKIT API  V2025.1
Dtk_FdtSetPackage::Capture Class Referenceabstract
+ Inheritance diagram for Dtk_FdtSetPackage::Capture:

Public Member Functions

void AddArrayVisibleFdtId (Dtk_tab< Dtk_NodeConnectorPtr > inConnectorToVisibleFdt)
 
void AddArrayVisibleGeometry (Dtk_tab< Dtk_NodeConnectorPtr > inConnectorToVisibleGeometry)
 
void AddFdtId (const Dtk_NodeConnectorPtr &inConnectorToVisibleFdt)
 
void AddGeometry (const Dtk_NodeConnectorPtr &inConnectorToVisibleGeometry)
 
void AddVisibleFdtId (const Dtk_NodeConnectorPtr &inConnectorToVisibleFdt)
 Adds a FDT - by its ID - to the Dtk_Capture. More...
 
void AddVisibleGeometry (const Dtk_NodeConnectorPtr &inConnectorToVisibleGeometry)
 Adds a geom - by its ID - to the Dtk_Capture. More...
 
Dtk_Int32 DtkDynamicType (const Dtk_Int32 &inId)
 Retrieves the dynamic entity type. More...
 
Dtk_InfoPtr get_info () const
 
type_detk get_type_detk () const
 
const Dtk_tab< Dtk_NodeConnectorPtr > & GetArrayVisibleFdts () const
 
const Dtk_tab< Dtk_NodeConnectorPtr > & GetArrayVisibleGeometry () const
 
const Dtk_CameraPtrGetCamera () const
 Retrieves the Dtk_Capture camera - read only -. More...
 
const Dtk_EntityPtrGetClippingEntity () const
 Retrieves the Dtk_Capture clipping plane - read only -. More...
 
const Dtk_tab< Dtk_NodeConnectorPtrGetVisibleFdts () const
 
const Dtk_tab< Dtk_NodeConnectorPtrGetVisibleGeometry () const
 
Dtk_InfoPtrinfo ()
 

Static Public Member Functions

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

Protected Types

enum  { _typeID = DTK_TYPE_FDT_SET_CAPTURE }
 

Protected Member Functions

void _Copy (const Capture &inToBeCopied)
 
void _Init ()
 
void _Reset ()
 
 Capture (const Capture &inToBeCopied)
 
 Capture (const Dtk_CameraPtr &inCamera, const Dtk_EntityPtr &inClippingEntity)
 
virtual ~Capture ()
 Destructor. More...
 

Protected Attributes

Dtk_CameraPtr _Camera
 
Dtk_EntityPtr _ClippingEntity
 
Dtk_InfoPtr _Infos
 
Dtk_tab< Dtk_NodeConnectorPtr_VisibleFDTs
 
Dtk_tab< Dtk_NodeConnectorPtr_VisibleGeoms
 

Private Member Functions

virtual int DtkDynamicType (const int &inId)=0
 

Friends

class Dtk_FdtSet
 
class Dtk_SmartPtr< Capture >
 

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
protected
Enumerator
_typeID 

Constructor & Destructor Documentation

◆ Capture() [1/2]

Dtk_FdtSetPackage::Capture::Capture ( const Dtk_CameraPtr inCamera,
const Dtk_EntityPtr inClippingEntity 
)
protected

◆ Capture() [2/2]

Dtk_FdtSetPackage::Capture::Capture ( const Capture inToBeCopied)
protected
139 : Dtk_Object(inToBeCopied) { _Init(); _Copy(inToBeCopied); }

◆ ~Capture()

virtual Dtk_FdtSetPackage::Capture::~Capture ( )
protectedvirtual

Destructor.

141 { _Reset(); }

Member Function Documentation

◆ _Copy()

void Dtk_FdtSetPackage::Capture::_Copy ( const Capture inToBeCopied)
protected

◆ _Init()

void Dtk_FdtSetPackage::Capture::_Init ( )
protected

◆ _Reset()

void Dtk_FdtSetPackage::Capture::_Reset ( )
protected

◆ AddArrayVisibleFdtId()

void Dtk_FdtSetPackage::Capture::AddArrayVisibleFdtId ( Dtk_tab< Dtk_NodeConnectorPtr inConnectorToVisibleFdt)

◆ AddArrayVisibleGeometry()

void Dtk_FdtSetPackage::Capture::AddArrayVisibleGeometry ( Dtk_tab< Dtk_NodeConnectorPtr inConnectorToVisibleGeometry)

◆ AddFdtId()

void Dtk_FdtSetPackage::Capture::AddFdtId ( const Dtk_NodeConnectorPtr inConnectorToVisibleFdt)

◆ AddGeometry()

void Dtk_FdtSetPackage::Capture::AddGeometry ( const Dtk_NodeConnectorPtr inConnectorToVisibleGeometry)

◆ AddVisibleFdtId()

void Dtk_FdtSetPackage::Capture::AddVisibleFdtId ( const Dtk_NodeConnectorPtr inConnectorToVisibleFdt)

Adds a FDT - by its ID - to the Dtk_Capture.

Parameters
inFdtIdThe FDT ID to be linked to the Dtk_Capture.

◆ AddVisibleGeometry()

void Dtk_FdtSetPackage::Capture::AddVisibleGeometry ( const Dtk_NodeConnectorPtr inConnectorToVisibleGeometry)

Adds a geom - by its ID - to the Dtk_Capture.

Parameters
inFdtIdThe geom ID to be linked to the Dtk_Capture.

◆ DtkDynamicCast()

static Capture* Dtk_FdtSetPackage::Capture::DtkDynamicCast ( Dtk_Object s)
static

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

160  {
161  if(s->DtkDynamicType(_typeID))
162  return static_cast<Capture*>(s);
163  return NULL;
164  }

◆ DtkDynamicType()

Dtk_Int32 Dtk_FdtSetPackage::Capture::DtkDynamicType ( const Dtk_Int32 inId)

Retrieves the dynamic entity type.

152  {
153  if(inId == _typeID)
154  return 1;
155  return Dtk_Object::DtkDynamicType(inId);
156  }

◆ get_info()

Dtk_InfoPtr Dtk_FdtSetPackage::Capture::get_info ( ) const
147 {return _Infos;}

◆ get_type_detk()

type_detk Dtk_FdtSetPackage::Capture::get_type_detk ( ) const
Returns
The type of the entity type - DTK_TYPE_FDT_SET_CAPTURE -
166 { return DTK_TYPE_FDT_SET_CAPTURE; }

◆ GetArrayVisibleFdts()

const Dtk_tab<Dtk_NodeConnectorPtr>& Dtk_FdtSetPackage::Capture::GetArrayVisibleFdts ( ) const
189 { return _VisibleFDTs; }

◆ GetArrayVisibleGeometry()

const Dtk_tab<Dtk_NodeConnectorPtr>& Dtk_FdtSetPackage::Capture::GetArrayVisibleGeometry ( ) const
190 { return _VisibleGeoms; }

◆ GetCamera()

const Dtk_CameraPtr& Dtk_FdtSetPackage::Capture::GetCamera ( ) const

Retrieves the Dtk_Capture camera - read only -.

Returns
The camera.
171 {return _Camera;}

◆ GetClippingEntity()

const Dtk_EntityPtr& Dtk_FdtSetPackage::Capture::GetClippingEntity ( ) const

Retrieves the Dtk_Capture clipping plane - read only -.

Returns
The clipping plane.
175 {return _ClippingEntity;}

◆ GetVisibleFdts()

const Dtk_tab<Dtk_NodeConnectorPtr> Dtk_FdtSetPackage::Capture::GetVisibleFdts ( ) const
185 { return _VisibleFDTs; }

◆ GetVisibleGeometry()

const Dtk_tab<Dtk_NodeConnectorPtr> Dtk_FdtSetPackage::Capture::GetVisibleGeometry ( ) const
186 { return _VisibleGeoms; }

◆ info()

Dtk_InfoPtr& Dtk_FdtSetPackage::Capture::info ( )
148 {return _Infos;}

Friends And Related Function Documentation

◆ Dtk_FdtSet

friend class Dtk_FdtSet
friend

◆ Dtk_SmartPtr< Capture >

friend class Dtk_SmartPtr< Capture >
friend

Field Documentation

◆ _Camera

Dtk_CameraPtr Dtk_FdtSetPackage::Capture::_Camera
protected

◆ _ClippingEntity

Dtk_EntityPtr Dtk_FdtSetPackage::Capture::_ClippingEntity
protected

◆ _Infos

Dtk_InfoPtr Dtk_FdtSetPackage::Capture::_Infos
protected

◆ _VisibleFDTs

Dtk_tab<Dtk_NodeConnectorPtr> Dtk_FdtSetPackage::Capture::_VisibleFDTs
protected

◆ _VisibleGeoms

Dtk_tab<Dtk_NodeConnectorPtr> Dtk_FdtSetPackage::Capture::_VisibleGeoms
protected
Dtk_FdtSetPackage::Capture::_ClippingEntity
Dtk_EntityPtr _ClippingEntity
Definition: dtk_fdt_set.hpp:130
Dtk_FdtSetPackage::Capture::_Copy
void _Copy(const Capture &inToBeCopied)
Dtk_FdtSetPackage::Capture::_typeID
@ _typeID
Definition: dtk_fdt_set.hpp:143
Dtk_FdtSetPackage::Capture::_Reset
void _Reset()
Dtk_FdtSetPackage::Capture::_VisibleGeoms
Dtk_tab< Dtk_NodeConnectorPtr > _VisibleGeoms
Definition: dtk_fdt_set.hpp:133
Dtk_FdtSetPackage::Capture::_Infos
Dtk_InfoPtr _Infos
Definition: dtk_fdt_set.hpp:129
Dtk_FdtSetPackage::Capture::_Camera
Dtk_CameraPtr _Camera
Definition: dtk_fdt_set.hpp:131
Dtk_FdtSetPackage::Capture::_Init
void _Init()
Dtk_Object::DtkDynamicType
virtual int DtkDynamicType(const int &inId)=0
Dtk_Object::Dtk_Object
Dtk_Object()
Dtk_FdtSetPackage::Capture::_VisibleFDTs
Dtk_tab< Dtk_NodeConnectorPtr > _VisibleFDTs
Definition: dtk_fdt_set.hpp:132
Dtk_FdtSetPackage::Capture::Capture
Capture(const Dtk_CameraPtr &inCamera, const Dtk_EntityPtr &inClippingEntity)
DTK_TYPE_FDT_SET_CAPTURE
@ DTK_TYPE_FDT_SET_CAPTURE
Definition: define.h:460