Dtk_CompositeEntity Class Reference

This is the Dtk_CompositeEntity class. More...

Inheritance diagram for Dtk_CompositeEntity:

Public Member Functions
virtual Dtk_ErrorStatus	_Store (void *)
void	AddAdditionnalGeometries (const Dtk_tab< Dtk_EntityPtr > &inAdditionnalGeometries)
	Adds some additionnal geometries to the Dtk_2dEntity. More...
void	AddAdditionnalGeometry (const Dtk_EntityPtr &inAdditionnalGeometry)
	Adds an additionnal geometry to the Dtk_2dEntity. More...
void	AddAdditionnalTexts (Dtk_CompositeText inAddtionnalTexts)
	Adds some additionnal texts to the Dtk_2dEntity. More...
void	AddEntities (const Dtk_tab< Dtk_EntityPtr > &inEltArray)
	Adds an array of Dtk_EntityPtr. More...
Dtk_ErrorStatus	AddEntity (const Dtk_EntityPtr &inElt)
	Adds a Dtk_EntityPtr to the Dtk_CompositeEntity. More...
Dtk_ErrorStatus	AddPicture (const Dtk_picturePtr &inElt)
	Adds a Dtk_picturePtr to the Dtk_CompositeEntity For that, it will check if the Dtk_picturePtr is not NULL. More...
void	AddPictures (const Dtk_tab< Dtk_picturePtr > &inEltArray)
	Adds an array of Dtk_EntityPtr. Calls Dtk_CompositeEntity::AddPicture for each elements. More...
void	Clear ()
	Resets all sub entities. 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_InfoPtr	get_info () const
type_detk	get_type_detk () const
const Dtk_tab< Dtk_EntityPtr > &	GetAdditionnalGeometries () const
	Retrieves the additionnal geometries of the Dtk_2dEntity. More...
const Dtk_CompositeText &	GetAdditionnalTexts () const
	Retrieves the additionnal texts of the Dtk_2dEntity. More...
void	GetAllEntitiesByType (Dtk_tab< Dtk_2dEntityPtr > &out2dEntities, Dtk_tab< Dtk_EntityPtr > &outGeometricalEntities, Dtk_tab< Dtk_picturePtr > &outPictures) const
Dtk_EntityPtr	GetEntity (const Dtk_Size_t &inPos) const
	Retrieves the ith Dtk_EntityPtr. More...
const Dtk_ID &	GetID () const
	Get Internal UniqueID. More...
Dtk_Size_t	GetNumEntities () const
	Retrieves the number of Dtk_EntityPtr in Dtk_CompositeEntity. More...
Dtk_Size_t	GetNumPictures () const
	Retrieves the number of Dtk_picturePtr in Dtk_CompositeEntity. More...
Dtk_picturePtr	GetPicture (const Dtk_Size_t &inPos) const
	Retrieves the ith Dtk_picturePtr. More...
virtual Dtk_Size_t	GetSize () const
Dtk_InfoPtr &	info ()
virtual void	PrepareTransfo ()
Dtk_ErrorStatus	Transform (const Dtk_transfo &inTransfo)
	Applies a transformation matrix to the entity. //! More...

Static Public Member Functions
static Dtk_CompositeEntityPtr	Create ()
	Calls default constructor to allocate a new object. More...
static Dtk_CompositeEntityPtr	Create (const Dtk_CompositeEntity &in)
	Calls copy constructor to allocate a new object. More...
static Dtk_CompositeEntityPtr	Create (Dtk_CompositeEntity &&in)
	Calls move constructor to allocate a new object. More...
static Dtk_CompositeEntity *	DtkDynamicCast (Dtk_Object *s)
	Performs a dynamic cast - doesn't need RTTI -. More...

Protected Types
enum	{ _typeID = DTK_TYPE_2D_ENTITY }
enum	{ _typeID = DTK_TYPE_ENTITY }
enum	{ _typeID = DTK_TYPE_COMPOSITE_ENTITY }

Protected Member Functions
void	_Copy (const Dtk_2dEntity &s)
void	_copy (const Dtk_Entity &s)
void	_init ()
void	_reset ()
virtual Dtk_Object *	Clone ()
	Dtk_CompositeEntity ()
	Dtk_CompositeEntity (const Dtk_CompositeEntity &s)
	Dtk_CompositeEntity (Dtk_CompositeEntity &&s) DTK_NOEXCEPT
	~Dtk_CompositeEntity ()
	Destructor. More...

Protected Attributes
Dtk_Handle *	_Private
unsigned long	count_

Detailed Description

This is the Dtk_CompositeEntity class.

See also

Use Dtk_CompositeEntityPtr class to handle it.

Member Enumeration Documentation

anonymous enum

anonymous enum

protectedinherited

Enumerator
_typeID

          {
          _typeID = DTK_TYPE_2D_ENTITY
     };

anonymous enum

anonymous enum

protectedinherited

Enumerator
_typeID

{ _typeID = DTK_TYPE_ENTITY };

anonymous enum

anonymous enum

protected

Enumerator
_typeID

          {
          _typeID = DTK_TYPE_COMPOSITE_ENTITY
     };

Constructor & Destructor Documentation

Dtk_CompositeEntity() [1/3]

Dtk_CompositeEntity::Dtk_CompositeEntity ( )

protected

See also

Create()

Dtk_CompositeEntity() [2/3]

Dtk_CompositeEntity::Dtk_CompositeEntity ( const Dtk_CompositeEntity &  s )

protected

See also

Create(const Dtk_CompositeEntity&)

Dtk_CompositeEntity() [3/3]

Dtk_CompositeEntity::Dtk_CompositeEntity ( Dtk_CompositeEntity &&  s )

protected

See also

Create( Dtk_CompositeEntity&& )

~Dtk_CompositeEntity()

Dtk_CompositeEntity::~Dtk_CompositeEntity ( )

protected

Destructor.

Member Function Documentation

_Copy()

void Dtk_2dEntity::_Copy ( const Dtk_2dEntity &  s )

protectedinherited

_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.

AddAdditionnalGeometries()

void Dtk_2dEntity::AddAdditionnalGeometries ( const Dtk_tab< Dtk_EntityPtr > &  inAdditionnalGeometries )

inherited

Adds some additionnal geometries to the Dtk_2dEntity.

Parameters

inAdditionnalGeometries

The geometries to be added

AddAdditionnalGeometry()

void Dtk_2dEntity::AddAdditionnalGeometry ( const Dtk_EntityPtr &  inAdditionnalGeometry )

inherited

Adds an additionnal geometry to the Dtk_2dEntity.

Parameters

inAdditionnalGeometry

The geometry to be added

AddAdditionnalTexts()

void Dtk_2dEntity::AddAdditionnalTexts ( Dtk_CompositeText  inAddtionnalTexts )

inherited

Adds some additionnal texts to the Dtk_2dEntity.

Parameters

inAddtionnalTexts

The texts to be added

AddEntities()

void Dtk_CompositeEntity::AddEntities

(

const Dtk_tab< Dtk_EntityPtr > &

inEltArray

)

Adds an array of Dtk_EntityPtr.

Calls Dtk_CompositeEntity::AddEntity for each elements.

Parameters

inEltArray

Array of Dtk_EntityPtr to be added.

Returns

DtkNoError if OK.

AddEntity()

Dtk_ErrorStatus Dtk_CompositeEntity::AddEntity

(

const Dtk_EntityPtr &

inElt

)

Adds a Dtk_EntityPtr to the Dtk_CompositeEntity.

For that, it will check if the Dtk_EntityPtr is not NULL and if it has a handled type.
The handled types are Dtk_CurvePtr / Dtk_PointPtr / Dtk_2dEntityPtr / Dtk_HatchingPtr.

Parameters

inElt

The Dtk_EntityPtr to be added.

Returns

DtkNoError if OK.

dtkErrorNullPointer if inElt.IsNULL().

dtkErrorTypeNotsupported if the entity type is not supported.

AddPicture()

Dtk_ErrorStatus Dtk_CompositeEntity::AddPicture

(

const Dtk_picturePtr &

inElt

)

Adds a Dtk_picturePtr to the Dtk_CompositeEntity For that, it will check if the Dtk_picturePtr is not NULL.

Parameters

inElt

The Dtk_picturePtr to be added.

Returns

DtkNoError if OK.

dtkErrorNullPointer if inElt.IsNULL().

AddPictures()

void Dtk_CompositeEntity::AddPictures

(

const Dtk_tab< Dtk_picturePtr > &

inEltArray

)

Adds an array of Dtk_EntityPtr. Calls Dtk_CompositeEntity::AddPicture for each elements.

Parameters

inEltArray

Array of Dtk_picturePtr to be added.

Returns

DtkNoError if OK.

Clear()

void Dtk_CompositeEntity::Clear

(

)

Resets all sub entities.

Clone()

virtual Dtk_Object* Dtk_CompositeEntity::Clone ( )

protectedvirtual

Implements Dtk_2dEntity.

{ return new Dtk_CompositeEntity(*this); }

Create() [1/3]

static Dtk_CompositeEntityPtr Dtk_CompositeEntity::Create ( )

static

Calls default constructor to allocate a new object.

Create() [2/3]

static Dtk_CompositeEntityPtr Dtk_CompositeEntity::Create ( const Dtk_CompositeEntity &  in )

static

Calls copy constructor to allocate a new object.

Parameters

in	Object to copy from.

Create() [3/3]

static Dtk_CompositeEntityPtr Dtk_CompositeEntity::Create ( Dtk_CompositeEntity &&  in )

static

Calls move constructor to allocate a new object.

Parameters

in	Object to move from.

DtkDynamicCast()

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

static

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

DtkDynamicType() [1/2]

Dtk_Int32 Dtk_CompositeEntity::DtkDynamicType

(

const Dtk_Int32 &

inId

)

Retrieves the dynamic entity type.

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

get_info()

Dtk_InfoPtr Dtk_Entity::get_info ( ) const

inherited

get_type_detk()

type_detk Dtk_CompositeEntity::get_type_detk ( ) const

virtual

Returns

The type of the entity type - DTK_TYPE_VIEW -

Implements Dtk_2dEntity.

     {
          return DTK_TYPE_COMPOSITE_ENTITY;
     }

GetAdditionnalGeometries()

const Dtk_tab< Dtk_EntityPtr >& Dtk_2dEntity::GetAdditionnalGeometries ( ) const

inherited

Retrieves the additionnal geometries of the Dtk_2dEntity.

Returns

The additionnal geometries array - read only -.

GetAdditionnalTexts()

const Dtk_CompositeText& Dtk_2dEntity::GetAdditionnalTexts ( ) const

inherited

Retrieves the additionnal texts of the Dtk_2dEntity.

Returns

The additionnal texts - read only -.

GetAllEntitiesByType()

void Dtk_CompositeEntity::GetAllEntitiesByType	(	Dtk_tab< Dtk_2dEntityPtr > &	out2dEntities,
		Dtk_tab< Dtk_EntityPtr > &	outGeometricalEntities,
		Dtk_tab< Dtk_picturePtr > &	outPictures
	)		const

GetEntity()

Dtk_EntityPtr Dtk_CompositeEntity::GetEntity

(

const Dtk_Size_t &

inPos

)

const

Retrieves the ith Dtk_EntityPtr.

Parameters

inPos

Dtk_EntityPtr index.

Returns

the inPos'th Dtk_EntityPtr.

GetID()

const Dtk_ID& Dtk_Entity::GetID ( ) const

inherited

Get Internal UniqueID.

Returns

InternalID

GetNumEntities()

Dtk_Size_t Dtk_CompositeEntity::GetNumEntities

(

)

const

Retrieves the number of Dtk_EntityPtr in Dtk_CompositeEntity.

Returns

size of the array

GetNumPictures()

Dtk_Size_t Dtk_CompositeEntity::GetNumPictures

(

)

const

Retrieves the number of Dtk_picturePtr in Dtk_CompositeEntity.

Returns

size of the array

GetPicture()

Dtk_picturePtr Dtk_CompositeEntity::GetPicture

(

const Dtk_Size_t &

inPos

)

const

Retrieves the ith Dtk_picturePtr.

Parameters

inPos

Dtk_picturePtr index.

Returns

the inPos'th Dtk_picturePtr.

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.

Transform()

Dtk_ErrorStatus Dtk_CompositeEntity::Transform ( const Dtk_transfo &  inTransfo )

virtual

Applies a transformation matrix to the entity. //!

Parameters

inTransfo

The transformation matrix to apply.

Implements Dtk_2dEntity.

Field Documentation

_Private

Dtk_Handle* Dtk_CompositeEntity::_Private

protected

count_

unsigned long Dtk_Object::count_

protectedinherited