Dtk_SelectionSet Class Reference

Dtk_SelectionSet represents a Selection Set entity which enables selecting a group of entities in a CAD Model. More...

Inheritance diagram for Dtk_SelectionSet:

Public Member Functions
virtual Dtk_ErrorStatus	_Store (void *)
Dtk_ErrorStatus	AddNodeConnector (const Dtk_NodeConnectorPtr &inNodeConnector)
	Adds a new Node Connector to the pool of connectors related to the Selection Set object. More...
Dtk_ErrorStatus	AddSelectionSet (const Dtk_SelectionSetPtr &inSelectionSet)
	Adds a sub SelectionSet related to the Selection Set object. More...
Dtk_Int32	DtkDynamicType (const Dtk_Int32 &inId)
	Retrieves the dynamic entity type. More...
int	DtkDynamicType (const int &inId)
virtual void	dump (FILE *file=stdout)
Dtk_ErrorStatus	Dump (FILE *inFile)
	Dump the Selection Set entities. More...
Dtk_InfoPtr	get_info () const
type_detk	get_type_detk () const
const Dtk_ID &	GetID () const
	Get Internal UniqueID. More...
Dtk_string	GetName () const
	Returns the name of the Selection Set entity. More...
Dtk_NodeConnectorPtr	GetNodeConnectorByPos (const Dtk_Size_t &inPos) const
	Returns the connector of Selection Set defined by its position. More...
Dtk_tab< Dtk_NodeConnectorPtr >	GetNodeConnectors () const
	Returns the array of connectors specifying the group of entities defined in the Selection Set object. More...
Dtk_Size_t	GetNodeConnectorsNb () const
	Returns the Number of connectors specifying the group of entities defined in the Selection Set object. More...
Dtk_tab< Dtk_SelectionSetPtr >	GetSelectionSet () const
	Returns the array of sub SelectionSet specifying the group of entities defined in the Selection Set object. More...
Dtk_SelectionSetPtr	GetSelectionSetByPos (const Dtk_Size_t &inPos) const
	Returns the SelectionSet of Selection Set defined by its position. More...
Dtk_Size_t	GetSelectionSetsNb () const
	Returns the Number of SelectionSet specifying the group of entities defined in the Selection Set object. More...
virtual Dtk_Size_t	GetSize () const
Dtk_InfoPtr &	info ()
virtual void	PrepareTransfo ()
void	SetName (const Dtk_string &inName)
	Sets the name of the Selection Set entity. More...
Dtk_ErrorStatus	Transform (const Dtk_transfo &inTransfo)

Static Public Member Functions
static Dtk_SelectionSetPtr	Create ()
	Calls default constructor to allocate a new object. More...
static Dtk_SelectionSet *	DtkDynamicCast (Dtk_Object *s)
	Performs a dynamic cast - doesn't need RTTI -. More...
static Dtk_SelectionSetPtr	Release (Dtk_SelectionSetPtr inSelectionSet)
	Delete object. More...

Protected Types
enum	{ _typeID = DTK_TYPE_SELECTION_SET }
enum	{ _typeID = DTK_TYPE_ENTITY }

Protected Member Functions
void	_copy (const Dtk_Entity &s)
void	_init ()
void	_reset ()
virtual Dtk_Object *	Clone ()
	Dtk_SelectionSet ()
	Default constructor. More...
	Dtk_SelectionSet (const Dtk_SelectionSet &selectionSet)
	Copy constructor. More...
	~Dtk_SelectionSet ()
	Destructor. More...

Protected Attributes
Dtk_Handle *	_Private
unsigned long	count_

Detailed Description

Dtk_SelectionSet represents a Selection Set entity which enables selecting a group of entities in a CAD Model.

See also

Use Dtk_SelectionSetPtr class to handle it.

Member Enumeration Documentation

anonymous enum

anonymous enum

protected

Enumerator
_typeID

          {
          _typeID = DTK_TYPE_SELECTION_SET
     };

anonymous enum

anonymous enum

protectedinherited

Enumerator
_typeID

{ _typeID = DTK_TYPE_ENTITY };

Constructor & Destructor Documentation

Dtk_SelectionSet() [1/2]

Dtk_SelectionSet::Dtk_SelectionSet ( )

protected

Default constructor.

Dtk_SelectionSet() [2/2]

Dtk_SelectionSet::Dtk_SelectionSet ( const Dtk_SelectionSet &  selectionSet )

protected

Copy constructor.

Parameters

selectionSet

the Dtk_SelectionSet to be copied

~Dtk_SelectionSet()

Dtk_SelectionSet::~Dtk_SelectionSet ( )

protected

Destructor.

Member Function Documentation

_copy()

void Dtk_Entity::_copy ( const Dtk_Entity &  s )

protectedinherited

_init()

void Dtk_Entity::_init ( )

protectedinherited

_reset()

void Dtk_Entity::_reset ( )

protectedinherited

_Store()

virtual Dtk_ErrorStatus Dtk_Entity::_Store ( void *  )

virtualinherited

Reimplemented in Dtk_Shell, Dtk_Body, Dtk_Lump, Dtk_Volume, Dtk_Face, Dtk_Loop, Dtk_Coedge, Dtk_Edge, Dtk_Vertex, 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, and Dtk_Point.

AddNodeConnector()

Dtk_ErrorStatus Dtk_SelectionSet::AddNodeConnector

(

const Dtk_NodeConnectorPtr &

inNodeConnector

)

Adds a new Node Connector to the pool of connectors related to the Selection Set object.

AddSelectionSet()

Dtk_ErrorStatus Dtk_SelectionSet::AddSelectionSet

(

const Dtk_SelectionSetPtr &

inSelectionSet

)

Adds a sub SelectionSet related to the Selection Set object.

Clone()

virtual Dtk_Object* Dtk_SelectionSet::Clone ( )

protectedvirtual

Implements Dtk_Entity.

{ return new Dtk_SelectionSet(*this); }

Create()

static Dtk_SelectionSetPtr Dtk_SelectionSet::Create ( )

static

Calls default constructor to allocate a new object.

DtkDynamicCast()

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

static

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

     { 
          if(s->DtkDynamicType(_typeID)) 
               return static_cast<Dtk_SelectionSet*>(s); 
          return NULL; 
     } 

DtkDynamicType() [1/2]

Dtk_Int32 Dtk_SelectionSet::DtkDynamicType

(

const Dtk_Int32 &

inId

)

Retrieves the dynamic entity type.

     { 
          if (inId == _typeID)
          {
               return 1; 
          }
          return Dtk_Object::DtkDynamicType(inId); 
     }

DtkDynamicType() [2/2]

int Dtk_Entity::DtkDynamicType ( const int &  inId )

virtualinherited

Implements Dtk_Object.

Reimplemented in Dtk_Shell, Dtk_Body, Dtk_Lump, Dtk_Volume, Dtk_Face, Dtk_Loop, Dtk_Coedge, Dtk_Edge, Dtk_Vertex, Dtk_TopologicalEntity, 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, and Dtk_AxisSystem.

dump()

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

virtualinherited

Dump()

Dtk_ErrorStatus Dtk_SelectionSet::Dump

(

FILE *

inFile

)

Dump the Selection Set entities.

Parameters

inFile

the output file

Sample

Dtk_string fileName = ...;
File * file = fileName.ouvrir_fichier(DTK_W);
 
Dtk_SelectionSetPtr selectionSet;
// Read the Selection Set 
selectionSet.Dump(file);

get_info()

Dtk_InfoPtr Dtk_Entity::get_info ( ) const

inherited

get_type_detk()

type_detk Dtk_SelectionSet::get_type_detk ( ) const

virtual

Returns

The type of the entity type - DTK_TYPE_SELECTION_SET -

Implements Dtk_Entity.

{ return DTK_TYPE_SELECTION_SET; }

GetID()

const Dtk_ID& Dtk_Entity::GetID ( ) const

inherited

Get Internal UniqueID.

Returns

InternalID

GetName()

Dtk_string Dtk_SelectionSet::GetName

(

)

const

Returns the name of the Selection Set entity.

GetNodeConnectorByPos()

Dtk_NodeConnectorPtr Dtk_SelectionSet::GetNodeConnectorByPos

(

const Dtk_Size_t &

inPos

)

const

Returns the connector of Selection Set defined by its position.

GetNodeConnectors()

Dtk_tab<Dtk_NodeConnectorPtr> Dtk_SelectionSet::GetNodeConnectors

(

)

const

Returns the array of connectors specifying the group of entities defined in the Selection Set object.

GetNodeConnectorsNb()

Dtk_Size_t Dtk_SelectionSet::GetNodeConnectorsNb

(

)

const

Returns the Number of connectors specifying the group of entities defined in the Selection Set object.

GetSelectionSet()

Dtk_tab<Dtk_SelectionSetPtr> Dtk_SelectionSet::GetSelectionSet

(

)

const

Returns the array of sub SelectionSet specifying the group of entities defined in the Selection Set object.

GetSelectionSetByPos()

Dtk_SelectionSetPtr Dtk_SelectionSet::GetSelectionSetByPos

(

const Dtk_Size_t &

inPos

)

const

Returns the SelectionSet of Selection Set defined by its position.

GetSelectionSetsNb()

Dtk_Size_t Dtk_SelectionSet::GetSelectionSetsNb

(

)

const

Returns the Number of SelectionSet specifying the group of entities defined in the Selection Set object.

GetSize()

virtual Dtk_Size_t Dtk_Entity::GetSize ( ) const

virtualinherited

Reimplemented from Dtk_Object.

Reimplemented in Dtk_Shell, Dtk_Body, Dtk_Lump, Dtk_Volume, Dtk_Face, Dtk_Loop, Dtk_Coedge, Dtk_Edge, Dtk_Vertex, 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, and Dtk_Point.

info()

Dtk_InfoPtr& Dtk_Entity::info ( )

inherited

PrepareTransfo()

virtual void Dtk_Entity::PrepareTransfo ( )

virtualinherited

Reimplemented in Dtk_OffsetSurface.

Release()

static Dtk_SelectionSetPtr Dtk_SelectionSet::Release ( Dtk_SelectionSetPtr  inSelectionSet )

static

Delete object.

SetName()

void Dtk_SelectionSet::SetName

(

const Dtk_string &

inName

)

Sets the name of the Selection Set entity.

Parameters

inName

name

Transform()

Dtk_ErrorStatus Dtk_SelectionSet::Transform ( const Dtk_transfo &  inTransfo )

virtual

Implements Dtk_Entity.

Field Documentation

_Private

Dtk_Handle* Dtk_SelectionSet::_Private

protected

count_

unsigned long Dtk_Object::count_

protectedinherited