Dtk_LayerFilterInfos Class Reference

This class is used by Dtk_LayerInfosSet to represent a layer filter : its name, description, and selected layers of the set it is contained in. 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 > &outSelectedLayerIndexes) const
	Retrieves all the selected layers into the layer filter. More...
virtual Dtk_Size_t	GetSize () const
Dtk_bool	IsLayerSelected (const Dtk_Size_t inLayerIndex) const
	Tells if the layer is selected or not giving its index. More...
Dtk_ErrorStatus	SelectLayer (const Dtk_Size_t inLayerIndex)
	Selects a given layer in the layer filter. More...
Dtk_ErrorStatus	SelectLayers (const Dtk_tab< Dtk_Size_t > &inLayerIndexes)
	Selects given layers in the layer filter. More...
Dtk_ErrorStatus	UnselectLayer (const Dtk_Size_t inLayerIndex)
	Unselects the given layer in the layer filter. More...
Dtk_ErrorStatus	UnselectLayers (const Dtk_tab< Dtk_Size_t > &inLayerIndexes)
	Unselects the given layers in the layer filter. More...

Static Public Member Functions
static Dtk_LayerFilterInfos *	DtkDynamicCast (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
	Dtk_LayerFilterInfos (const Dtk_LayerFilterInfos &s)
	Copy constructor. More...
	Dtk_LayerFilterInfos (const Dtk_Size_t inNumLayers, Dtk_string inName=L"", Dtk_string inDescription=L"", const Dtk_bool inAreLayersActivatedByDefault=DTK_FALSE)
	Dtk_LayerFilterInfos (Dtk_LayerFilterInfos &&s)
	Move constructor. More...
	~Dtk_LayerFilterInfos ()

Protected Attributes
Dtk_Handle *	_Private
unsigned long	count_

Detailed Description

This class is used by Dtk_LayerInfosSet to represent a layer filter : its name, description, and selected layers of the set it is contained in.

Remarks

The layer indexes used by Dtk_LayerFilterInfos are those of the Dtk_LayerInfosSet it is contained in.

See also

Dtk_LayerInfosSet::CreateLayerFilterInfos

Member Enumeration Documentation

anonymous enum

anonymous enum

protectedinherited

Enumerator
_typeID

{ _typeID = DTK_TYPE_OBJECT }; 

anonymous enum

anonymous enum

protected

Enumerator
_typeID

{ _typeID = DTK_TYPE_LAYER_FILTER_INFOS };

Constructor & Destructor Documentation

Dtk_LayerFilterInfos() [1/3]

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/3]

Dtk_LayerFilterInfos::Dtk_LayerFilterInfos ( const Dtk_LayerFilterInfos &  s )

protected

Copy constructor.

Parameters

s	Object to copy from.

Dtk_LayerFilterInfos() [3/3]

Dtk_LayerFilterInfos::Dtk_LayerFilterInfos ( Dtk_LayerFilterInfos &&  s )

protected

Move constructor.

Parameters

s	Object to move from.

~Dtk_LayerFilterInfos()

Dtk_LayerFilterInfos::~Dtk_LayerFilterInfos ( )

protected

Member Function Documentation

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]

virtual int Dtk_Object::DtkDynamicType ( const int &  inId )

pure virtualinherited

Implemented in Dtk_Shell, Dtk_Body, Dtk_Lump, Dtk_Volume, Dtk_Face, Dtk_Loop, Dtk_Coedge, Dtk_Edge, Dtk_Vertex, Dtk_TopologicalEntity, Dtk_MeshPolyline, Dtk_MeshSurface, 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_Constraint, Dtk_ConstraintReference, Dtk_AxisSystem, Dtk_Preview, Dtk_Entity, Dtk_picture, Dtk_OverrideSet, Dtk_OverrideInfo, Dtk_MainDoc, Dtk_Component, Dtk_Node, Dtk_DocElement, Dtk_Log, and Dtk_Properties.

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 -

{ return DTK_TYPE_LAYER_FILTER_INFOS; }

GetDescription()

void Dtk_LayerFilterInfos::GetDescription

(

Dtk_string &

outLayerFilterDescription

)

const

Retrieves layer filter description.

Parameters

outLayerFilterDescription

the layer filter description.

GetName()

void Dtk_LayerFilterInfos::GetName

(

Dtk_string &

outLayerFilterName

)

const

Retrieves layer filter name.

Parameters

outLayerFilterName

the layer filter name.

GetSelectedLayers()

void Dtk_LayerFilterInfos::GetSelectedLayers

(

Dtk_tab< Dtk_Size_t > &

outSelectedLayerIndexes

)

const

Retrieves all the selected layers into the layer filter.

Parameters

outSelectedLayers

the selected layer indexes.

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.

IsLayerSelected()

Dtk_bool Dtk_LayerFilterInfos::IsLayerSelected

(

const Dtk_Size_t

inLayerIndex

)

const

Tells if the layer is selected or not giving its index.

Parameters

inLayerIndex

the layer index in Dtk_LayerInfosSet layers.

Returns

DTK_FALSE if layer is not selected, DTK_TRUE otherwise.

SelectLayer()

Dtk_ErrorStatus Dtk_LayerFilterInfos::SelectLayer

(

const Dtk_Size_t

inLayerIndex

)

Selects a given layer in the layer filter.

Parameters

inLayerIndex

the layer index to be selected.

Returns

dtkNoError if the layer has been selected

dtkErrorOutOfRange if the index is out of layer set range.

SelectLayers()

Dtk_ErrorStatus Dtk_LayerFilterInfos::SelectLayers

(

const Dtk_tab< Dtk_Size_t > &

inLayerIndexes

)

Selects given layers in the layer filter.

Parameters

inLayerIndexes

An array of layer indexes to be selected.

Returns

dtkNoError if all the desired layers has been selected.

dtkErrorOutOfRange if one of the indices is out of layer set range. Valid indices will still be processed.

UnselectLayer()

Dtk_ErrorStatus Dtk_LayerFilterInfos::UnselectLayer

(

const Dtk_Size_t

inLayerIndex

)

Unselects the given layer in the layer filter.

Parameters

inLayerIndex

the layer index to be unselected.

Returns

dtkNoError if the layer has been unselected.

dtkErrorOutOfRange if the index is out of layer set range.

UnselectLayers()

Dtk_ErrorStatus Dtk_LayerFilterInfos::UnselectLayers

(

const Dtk_tab< Dtk_Size_t > &

inLayerIndexes

)

Unselects the given layers in the layer filter.

Parameters

inLayerIndexes

An array of layer indexes to be unselected.

Returns

dtkNoError if all the desired layers has been unselected.

dtkErrorOutOfRange if one of the indices is out of layer set range. Valid indices will still be processed.

Field Documentation

_Private

Dtk_Handle* Dtk_LayerFilterInfos::_Private

protected

count_

unsigned long Dtk_Object::count_

protectedinherited