Dtk_LayerInfosSet Class Reference

This is the Layer Info Set class. This is the main Layer Class.
It gathers all information about layers and layer filters. Please use the Dtk_LayerInfosSetPtr class to handle it... More...

Inheritance diagram for Dtk_LayerInfosSet:

Public Member Functions
Dtk_LayerFilterInfosPtr	CreateLayerFilterInfos (Dtk_string inName=L"", Dtk_string inDescription=L"", const Dtk_bool inAreLayersActivatedByDefault=DTK_FALSE, const Dtk_bool IsDefaultLayerFilter=DTK_FALSE)
	Create a layer filter. 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)
type_detk	get_type_detk () const
Dtk_ErrorStatus	GetDefaultLayer (Dtk_Size_t &outDefaultLayer) const
	Gets the default layer number. More...
Dtk_ErrorStatus	GetDefaultLayerFilter (Dtk_Size_t &outDefaultLayerFilter) const
	Gets the default layer filter number. More...
Dtk_LayerFilterInfosPtr	GetLayerFilterByPos (const Dtk_Size_t inLayerFilterPos) const
	Gets a layer filter giving its number. More...
Dtk_ErrorStatus	GetLayerID (const Dtk_Size_t inLayerPos, Dtk_ID &outLayerID) const
	Gets the LayerID giving its number. More...
Dtk_ErrorStatus	GetLayerName (const Dtk_Size_t inLayerPos, Dtk_string &outLayerName) const
	Gets the LayerName giving its number. More...
Dtk_ErrorStatus	GetLayerNameById (const Dtk_ID inLayerID, Dtk_string &outLayerName) const
	Gets the LayerName giving the ID found iby infos->GetLayer(). More...
Dtk_Size_t	GetNumLayerFilters () const
	Retrieves the number of layer filters. More...
Dtk_Size_t	GetNumLayers () const
	Retrieves the number of layers. More...
virtual Dtk_Size_t	GetSize () const
Dtk_ErrorStatus	SetDefaultLayer (const Dtk_Size_t inDefaultLayer)
	Sets the default layer number. More...
Dtk_ErrorStatus	SetLayerID (const Dtk_Size_t inLayerPos, const Dtk_ID &inLayerID)
	Sets the LayerID giving its number. More...
Dtk_ErrorStatus	SetLayerName (const Dtk_Size_t inLayerPos, const Dtk_string &inLayerName)
	Sets the LayerName giving its number. More...

Static Public Member Functions
static Dtk_LayerInfosSetPtr	Create (const Dtk_Size_t inNumLayers)
	Base constructor. More...
static Dtk_LayerInfosSet *	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_INFOS_SET }

Protected Member Functions
void	_copy (const Dtk_Object &s)
void	_init ()
void	_reset ()
virtual Dtk_Object *	Clone ()
	Dtk_LayerInfosSet (const Dtk_LayerInfosSet &s)
	Dtk_LayerInfosSet (const Dtk_Size_t inNumLayers)
	~Dtk_LayerInfosSet ()
	Destructor. More...

Protected Attributes
Dtk_Handle *	_Private
unsigned long	count_

Friends
class	Dtk_SmartPtr< Dtk_LayerInfosSet >

Detailed Description

This is the Layer Info Set class. This is the main Layer Class.
It gathers all information about layers and layer filters. Please use the Dtk_LayerInfosSetPtr class to handle it...

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_INFOS_SET };

Constructor & Destructor Documentation

Dtk_LayerInfosSet() [1/2]

Dtk_LayerInfosSet::Dtk_LayerInfosSet ( const Dtk_Size_t  inNumLayers )

protected

See also

Create()

Dtk_LayerInfosSet() [2/2]

Dtk_LayerInfosSet::Dtk_LayerInfosSet ( const Dtk_LayerInfosSet &  s )

protected

See also

Create(const Dtk_FdtAnnotationSet&)

~Dtk_LayerInfosSet()

Dtk_LayerInfosSet::~Dtk_LayerInfosSet ( )

protected

Destructor.

Member Function Documentation

_copy()

void Dtk_Object::_copy ( const Dtk_Object &  s )

protectedinherited

_init()

void Dtk_Object::_init ( )

protectedinherited

_reset()

void Dtk_Object::_reset ( )

protectedinherited

Clone()

virtual Dtk_Object* Dtk_LayerInfosSet::Clone ( )

protectedvirtual

{ return new Dtk_LayerInfosSet(*this); }

Create()

static Dtk_LayerInfosSetPtr Dtk_LayerInfosSet::Create ( const Dtk_Size_t  inNumLayers )

static

Base constructor.

CreateLayerFilterInfos()

Dtk_LayerFilterInfosPtr Dtk_LayerInfosSet::CreateLayerFilterInfos	(	Dtk_string	inName = L"",
		Dtk_string	inDescription = L"",
		const Dtk_bool	inAreLayersActivatedByDefault = DTK_FALSE,
		const Dtk_bool	IsDefaultLayerFilter = DTK_FALSE
	)

Create a layer filter.

Parameters

inName	the layer filter name - Empty name by default -.
inAreLayersActivatedByDefault	The default value of the layer selection. DTK_TRUE means that all layers are selected. DTK_FALSE means that no layer is selected - DTK_FALSE by default -.
IsDefaultLayerFilter	Tells if the new layer filter is the default one - DTK_FALSE by default -.

Returns

the newly created layer filter.

Remarks

The newly created layer filter is automatically stored into the Dtk_LayerInfosSet.

DtkDynamicCast()

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

static

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

DtkDynamicType() [1/2]

Dtk_Int32 Dtk_LayerInfosSet::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_LayerInfosSet::get_type_detk

(

)

const

Returns

The type of the entity type - DTK_TYPE_LAYER_INFOS_SET -

{ return DTK_TYPE_LAYER_INFOS_SET; }

GetDefaultLayer()

Dtk_ErrorStatus Dtk_LayerInfosSet::GetDefaultLayer

(

Dtk_Size_t &

outDefaultLayer

)

const

Gets the default layer number.

Parameters

outDefaultLayer

the layer number or -1 if any error.

Returns

dtkNoError if success.

dtkErrorOutOfRange if no default layer.

GetDefaultLayerFilter()

Dtk_ErrorStatus Dtk_LayerInfosSet::GetDefaultLayerFilter

(

Dtk_Size_t &

outDefaultLayerFilter

)

const

Gets the default layer filter number.

Parameters

outDefaultLayerFilter

the layer filter number or -1 if any error.

Returns

dtkNoError if success.

dtkErrorOutOfRange if no default layer filter.

GetLayerFilterByPos()

Dtk_LayerFilterInfosPtr Dtk_LayerInfosSet::GetLayerFilterByPos

(

const Dtk_Size_t

inLayerFilterPos

)

const

Gets a layer filter giving its number.

Parameters

inLayerFilterPos

the layer filter number.

Returns

the asked layer filter if success or a NULL Dtk_LayerFilterInfosPtr if any error.

GetLayerID()

Dtk_ErrorStatus Dtk_LayerInfosSet::GetLayerID	(	const Dtk_Size_t	inLayerPos,
		Dtk_ID &	outLayerID
	)		const

Gets the LayerID giving its number.

Parameters

inLayerPos	the layer number.
outLayerID	the layer id or inLayerPos if not given.

Returns

dtkNoError if success.

dtkErrorOutOfRange if bad layer number.

GetLayerName()

Dtk_ErrorStatus Dtk_LayerInfosSet::GetLayerName	(	const Dtk_Size_t	inLayerPos,
		Dtk_string &	outLayerName
	)		const

Gets the LayerName giving its number.

Parameters

inLayerPos	the layer number.
outLayerName	the layer name or empty string if any error.

Returns

dtkNoError if success.

dtkErrorOutOfRange if bad layer number.

dtkErrorNullPointer if no layer name.

GetLayerNameById()

Dtk_ErrorStatus Dtk_LayerInfosSet::GetLayerNameById	(	const Dtk_ID	inLayerID,
		Dtk_string &	outLayerName
	)		const

Gets the LayerName giving the ID found iby infos->GetLayer().

Parameters

inLayerID	the layer ID.
outLayerName	the layer name or empty string if any error.

Returns

dtkNoError if success.

dtkErrorOutOfRange if bad layer ID.

dtkErrorNullPointer if no layer name.

GetNumLayerFilters()

Dtk_Size_t Dtk_LayerInfosSet::GetNumLayerFilters

(

)

const

Retrieves the number of layer filters.

Returns

the number of layer filters.

GetNumLayers()

Dtk_Size_t Dtk_LayerInfosSet::GetNumLayers

(

)

const

Retrieves the number of layers.

Returns

the number of layers.

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.

SetDefaultLayer()

Dtk_ErrorStatus Dtk_LayerInfosSet::SetDefaultLayer

(

const Dtk_Size_t

inDefaultLayer

)

Sets the default layer number.

Parameters

inDefaultLayer

the layer number.

Returns

dtkNoError if success.

dtkErrorOutOfRange if bad layer number.

SetLayerID()

Dtk_ErrorStatus Dtk_LayerInfosSet::SetLayerID	(	const Dtk_Size_t	inLayerPos,
		const Dtk_ID &	inLayerID
	)

Sets the LayerID giving its number.

Parameters

inLayerPos	the layer number.
inLayerID	the layer id.

Returns

dtkNoError if success.

dtkErrorOutOfRange if bad layer number.

SetLayerName()

Dtk_ErrorStatus Dtk_LayerInfosSet::SetLayerName	(	const Dtk_Size_t	inLayerPos,
		const Dtk_string &	inLayerName
	)

Sets the LayerName giving its number.

Parameters

inLayerPos	the layer number.
inLayerName	the layer name.

Returns

dtkNoError if success.

dtkErrorOutOfRange if bad layer number.

Friends And Related Function Documentation

Dtk_SmartPtr< Dtk_LayerInfosSet >

friend class Dtk_SmartPtr< Dtk_LayerInfosSet >

friend

Field Documentation

_Private

Dtk_Handle* Dtk_LayerInfosSet::_Private

protected

count_

unsigned long Dtk_Object::count_

protectedinherited