DATAKIT API  V2025.1
Dtk_LayerFilterInfos Class Referenceabstract

Please use the Dtk_LayerFilterInfosPtr class to handle it... More...

+ Inheritance diagram for Dtk_LayerFilterInfos:

Public Member Functions

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)
 
type_detk get_type_detk () const
 
void GetDescription (Dtk_string &outLayerFilterDescription) const
 Retrieves layer filter description. More...
 
void GetName (Dtk_string &outLayerFilterName) const
 Retrieves layer filter name. More...
 
void GetSelectedLayers (Dtk_tab< Dtk_Size_t > &outSelectedLayers) const
 Retrieves all the selected layers into the layer filter. More...
 
virtual Dtk_Size_t GetSize () const
 
Dtk_bool IsLayerSelected (const Dtk_Size_t inLayerPos) const
 Tells if the asked layer is selected or not giving its number. More...
 
void SelectLayer (const Dtk_Size_t inNumLayer)
 Select the given layer number in the layer filter. More...
 
void SelectLayers (const Dtk_tab< Dtk_Size_t > &inNumLayers)
 Select the given layers in the layer filter. More...
 
void UnselectLayer (const Dtk_Size_t inLayerPos)
 Unselect the given layer number in the layer filter. More...
 
void UnselectLayers (const Dtk_tab< Dtk_Size_t > &inNumLayers)
 Unselect the given layers in the layer filter. More...
 

Static Public Member Functions

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

Protected Types

enum  { _typeID = DTK_TYPE_OBJECT }
 
enum  { _typeID = DTK_TYPE_LAYER_FILTER_INFOS }
 

Protected Member Functions

void _Copy (const Dtk_LayerFilterInfos &s)
 
void _copy (const Dtk_Object &s)
 
void _init ()
 
void _Init (const Dtk_Size_t inNumLayers)
 
void _reset ()
 
void _Reset ()
 
 Dtk_LayerFilterInfos (const Dtk_LayerFilterInfos &s)
 
 Dtk_LayerFilterInfos (const Dtk_Size_t inNumLayers, Dtk_string inName=L"", Dtk_string inDescription=L"", const Dtk_bool inAreLayersActivatedByDefault=DTK_FALSE)
 
 ~Dtk_LayerFilterInfos ()
 

Protected Attributes

Dtk_Handle * _Private
 
unsigned long count_
 

Friends

class Dtk_LayerInfosSet
 
class Dtk_SmartPtr< Dtk_LayerFilterInfos >
 

Detailed Description

Please use the Dtk_LayerFilterInfosPtr class to handle it...

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
protectedinherited
Enumerator
_typeID 

◆ anonymous enum

anonymous enum
protected
Enumerator
_typeID 

Constructor & Destructor Documentation

◆ Dtk_LayerFilterInfos() [1/2]

Dtk_LayerFilterInfos::Dtk_LayerFilterInfos ( const Dtk_Size_t  inNumLayers,
Dtk_string  inName = L"",
Dtk_string  inDescription = L"",
const Dtk_bool  inAreLayersActivatedByDefault = DTK_FALSE 
)
protected

◆ Dtk_LayerFilterInfos() [2/2]

Dtk_LayerFilterInfos::Dtk_LayerFilterInfos ( const Dtk_LayerFilterInfos s)
protected

◆ ~Dtk_LayerFilterInfos()

Dtk_LayerFilterInfos::~Dtk_LayerFilterInfos ( )
protected

Member Function Documentation

◆ _Copy()

void Dtk_LayerFilterInfos::_Copy ( const Dtk_LayerFilterInfos s)
protected

◆ _copy()

void Dtk_Object::_copy ( const Dtk_Object s)
protectedinherited

◆ _init()

void Dtk_Object::_init ( )
protectedinherited

◆ _Init()

void Dtk_LayerFilterInfos::_Init ( const Dtk_Size_t  inNumLayers)
protected

◆ _reset()

void Dtk_Object::_reset ( )
protectedinherited

◆ _Reset()

void Dtk_LayerFilterInfos::_Reset ( )
protected

◆ DtkDynamicCast()

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

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

◆ DtkDynamicType() [1/2]

Dtk_Int32 Dtk_LayerFilterInfos::DtkDynamicType ( const Dtk_Int32 inId)

Retrieves the dynamic entity type.

◆ DtkDynamicType() [2/2]

◆ dump()

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

◆ get_type_detk()

type_detk Dtk_LayerFilterInfos::get_type_detk ( ) const
Returns
The type of the entity type - DTK_TYPE_LAYER_FILTER_INFOS -
416 { return DTK_TYPE_LAYER_FILTER_INFOS; }

◆ GetDescription()

void Dtk_LayerFilterInfos::GetDescription ( Dtk_string outLayerFilterDescription) const

Retrieves layer filter description.

Parameters
outLayerFilterDescriptionthe layer filter description.

◆ GetName()

void Dtk_LayerFilterInfos::GetName ( Dtk_string outLayerFilterName) const

Retrieves layer filter name.

Parameters
outLayerFilterNamethe layer filter name.

◆ GetSelectedLayers()

void Dtk_LayerFilterInfos::GetSelectedLayers ( Dtk_tab< Dtk_Size_t > &  outSelectedLayers) const

Retrieves all the selected layers into the layer filter.

Parameters
outSelectedLayersthe selected layer numbers.

◆ GetSize()

◆ IsLayerSelected()

Dtk_bool Dtk_LayerFilterInfos::IsLayerSelected ( const Dtk_Size_t  inLayerPos) const

Tells if the asked layer is selected or not giving its number.

Parameters
inLayerPosthe layer index in Dtk_LayerInfosSet layers.
Returns
DTK_FALSE if layer is not selected, DTK_TRUE otherwise.

◆ SelectLayer()

void Dtk_LayerFilterInfos::SelectLayer ( const Dtk_Size_t  inNumLayer)

Select the given layer number in the layer filter.

Parameters
inNumLayerthe layer number to be selected.

◆ SelectLayers()

void Dtk_LayerFilterInfos::SelectLayers ( const Dtk_tab< Dtk_Size_t > &  inNumLayers)

Select the given layers in the layer filter.

Parameters
inNumLayersAn array of layer numbers to be selected.

◆ UnselectLayer()

void Dtk_LayerFilterInfos::UnselectLayer ( const Dtk_Size_t  inLayerPos)

Unselect the given layer number in the layer filter.

Parameters
inNumLayerthe layer number to be unselected.

◆ UnselectLayers()

void Dtk_LayerFilterInfos::UnselectLayers ( const Dtk_tab< Dtk_Size_t > &  inNumLayers)

Unselect the given layers in the layer filter.

Parameters
inNumLayersAn array of layer numbers to be unselected.

Friends And Related Function Documentation

◆ Dtk_LayerInfosSet

friend class Dtk_LayerInfosSet
friend

◆ Dtk_SmartPtr< Dtk_LayerFilterInfos >

friend class Dtk_SmartPtr< Dtk_LayerFilterInfos >
friend

Field Documentation

◆ _Private

Dtk_Handle* Dtk_LayerFilterInfos::_Private
protected

◆ count_

unsigned long Dtk_Object::count_
protectedinherited
Dtk_LayerFilterInfos::_typeID
@ _typeID
Definition: util_ent_dtk.hpp:398
DTK_TYPE_OBJECT
@ DTK_TYPE_OBJECT
Definition: define.h:464
DTK_TYPE_LAYER_FILTER_INFOS
@ DTK_TYPE_LAYER_FILTER_INFOS
Definition: define.h:504
Dtk_Object::_typeID
@ _typeID
Definition: dtk_object.hpp:13