Dtk_Volume Class Reference

A Dtk_Volume is a space limited by edges. It contain one or several Dtk_Shell. If two objects have a common face without common edge you have to create 2 volumes. More...

Inheritance diagram for Dtk_Volume:

Public Member Functions
virtual Dtk_ErrorStatus	_Store (void *)
Dtk_ErrorStatus	AddInnerShell (const Dtk_ShellPtr &inShell)
	Add Inner Shell. More...
Dtk_ErrorStatus	AddOpenShell (const Dtk_ShellPtr &inShell)
	Add Open Shell (only one supported) More...
Dtk_ErrorStatus	AddOuterShell (const Dtk_ShellPtr &inShell)
	Add Outer Shell (only one supported) More...
Dtk_ErrorStatus	AddWireShell (const Dtk_ShellPtr &inShell)
	Add Wire Shell. More...
Dtk_ErrorStatus	ComputeBoundingBox (Dtk_pnt &outMin, Dtk_pnt &outMax)
int	DtkDynamicType (const int &inId)
	Get smart pointer type. More...
virtual void	dump (FILE *file=stdout)
Dtk_InfoPtr	get_info () const
enum type_detk	get_type_detk () const
	Return Type of entity. More...
const Dtk_ID &	GetID () const
	Get Internal UniqueID. More...
Dtk_Size_t	GetNumShells () const
	Get Number of Shell in Volume. More...
Dtk_ErrorStatus	GetParentLump (Dtk_LumpPtr &outParentLump) const
	Get Parent Lump. More...
Dtk_ErrorStatus	GetShell (const Dtk_Size_t &inIndex, Dtk_ID &outShellId) const
Dtk_ErrorStatus	GetShell (const Dtk_Size_t &inIndex, Dtk_ShellPtr &outShell) const
	Get Shell. More...
virtual Dtk_Size_t	GetSize () const
Dtk_ID	GetTopoID () const
Dtk_ErrorStatus	GetTopologyStatus () const
Dtk_InfoPtr &	info ()
virtual void	PrepareTransfo ()
Dtk_ErrorStatus	SetParentLump (const Dtk_ID &inParentLumpId)
Dtk_ErrorStatus	SetParentLump (const Dtk_LumpPtr &inParentLump)
	Set Parent Lump. More...
void	SetTopologyStatus (Dtk_ErrorStatus inStatus)
virtual Dtk_ErrorStatus	Transform (const Dtk_transfo &inTransfo)
	Transform object. More...

Static Public Member Functions
static Dtk_VolumePtr	Create (const Dtk_BodyPtr &inParentBody)
	Create a volume in a body. More...
static Dtk_Volume *	DtkDynamicCast (Dtk_Object *inObject)

Protected Types
enum	{ _typeID = DTK_TYPE_TOPOLOGICAL_REPRESENTATION_ITEM }
enum	{ _typeID = DTK_TYPE_ENTITY }
enum	{ _typeID = DTK_TYPE_VOLUME }

Protected Member Functions
void	_Clone (Dtk_TopologicalEntityPtr &outTopo, Dtk_Body *_inParentBody)
void	_copy (const Dtk_Entity &s)
void	_Copy (const Dtk_Volume &inToCopy, Dtk_Body *inParentBody)
void	_init ()
void	_Init ()
void	_reset ()
void	_Reset ()
virtual Dtk_Object *	Clone ()
	Dtk_Volume ()
	Dtk_Volume (const Dtk_Volume &inEdgeTpCopy, Dtk_Body *inParentBody)
Dtk_ErrorStatus	GetParentBody (Dtk_Body *&outParentBody) const
Dtk_ErrorStatus	SetParentBody (const Dtk_BodyPtr &inParentBody)
virtual	~Dtk_Volume ()

Protected Attributes
Dtk_Handle *	_Private
unsigned long	count_

Detailed Description

A Dtk_Volume is a space limited by edges. It contain one or several Dtk_Shell. If two objects have a common face without common edge you have to create 2 volumes.

See also

Use Dtk_VolumePtr class to handle it.

Member Enumeration Documentation

anonymous enum

anonymous enum

protectedinherited

Enumerator
_typeID

{ _typeID = DTK_TYPE_TOPOLOGICAL_REPRESENTATION_ITEM }; 

anonymous enum

anonymous enum

protectedinherited

Enumerator
_typeID

{ _typeID = DTK_TYPE_ENTITY };

anonymous enum

anonymous enum

protected

Enumerator
_typeID

{ _typeID = DTK_TYPE_VOLUME }; 

Constructor & Destructor Documentation

Dtk_Volume() [1/2]

Dtk_Volume::Dtk_Volume ( const Dtk_Volume &  inEdgeTpCopy, Dtk_Body *  inParentBody  )

protected

Dtk_Volume() [2/2]

Dtk_Volume::Dtk_Volume ( )

protected

~Dtk_Volume()

virtual Dtk_Volume::~Dtk_Volume ( )

protectedvirtual

Member Function Documentation

_Clone()

void Dtk_Volume::_Clone ( Dtk_TopologicalEntityPtr &  outTopo, Dtk_Body *  _inParentBody  )

protectedvirtual

Implements Dtk_TopologicalEntity.

_copy()

void Dtk_Entity::_copy ( const Dtk_Entity &  s )

protectedinherited

_Copy()

void Dtk_Volume::_Copy ( const Dtk_Volume &  inToCopy, Dtk_Body *  inParentBody  )

protected

_init()

void Dtk_Entity::_init ( )

protectedinherited

_Init()

void Dtk_Volume::_Init ( )

protected

_reset()

void Dtk_Entity::_reset ( )

protectedinherited

_Reset()

void Dtk_Volume::_Reset ( )

protected

_Store()

virtual Dtk_ErrorStatus Dtk_Volume::_Store ( void *  )

virtual

Reimplemented from Dtk_Entity.

AddInnerShell()

Dtk_ErrorStatus Dtk_Volume::AddInnerShell

(

const Dtk_ShellPtr &

inShell

)

Add Inner Shell.

Parameters

[in]

inShell

: pointer on inner shell

Returns

Dtk_ErrorStatus: dtkNoError if OK

AddOpenShell()

Dtk_ErrorStatus Dtk_Volume::AddOpenShell

(

const Dtk_ShellPtr &

inShell

)

Add Open Shell (only one supported)

Parameters

[in]

inShell

: pointer on outer shell

Returns

Dtk_ErrorStatus: dtkNoError if OK error if body has already a closed (inner or outer )shell

AddOuterShell()

Dtk_ErrorStatus Dtk_Volume::AddOuterShell

(

const Dtk_ShellPtr &

inShell

)

Add Outer Shell (only one supported)

Parameters

[in]

inShell

: pointer on outer shell

Returns

Dtk_ErrorStatus: dtkNoError if OK error if body has already an open shell or an outer shell

AddWireShell()

Dtk_ErrorStatus Dtk_Volume::AddWireShell

(

const Dtk_ShellPtr &

inShell

)

Add Wire Shell.

Parameters

[in]

inShell

: pointer on inner shell

Returns

Dtk_ErrorStatus: dtkNoError if OK

Clone()

virtual Dtk_Object* Dtk_TopologicalEntity::Clone ( )

protectedvirtualinherited

Implements Dtk_Entity.

{return NULL;}

ComputeBoundingBox()

Dtk_ErrorStatus Dtk_Volume::ComputeBoundingBox	(	Dtk_pnt &	outMin,
		Dtk_pnt &	outMax
	)

Create()

static Dtk_VolumePtr Dtk_Volume::Create ( const Dtk_BodyPtr &  inParentBody )

static

Create a volume in a body.

Parameters

[in]

inParentBody

: parent body

Returns

Dtk_VolumePtr created

DtkDynamicCast()

static Dtk_Volume* Dtk_Volume::DtkDynamicCast ( Dtk_Object *  inObject )

static

DtkDynamicType()

int Dtk_Volume::DtkDynamicType ( const int &  inId )

virtual

Get smart pointer type.

Parameters

[in]

inId

:

Returns

int

Reimplemented from Dtk_TopologicalEntity.

dump()

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

virtualinherited

get_info()

Dtk_InfoPtr Dtk_Entity::get_info ( ) const

inherited

get_type_detk()

enum type_detk Dtk_Volume::get_type_detk ( ) const

virtual

Return Type of entity.

Returns

enum type_detk

Reimplemented from Dtk_TopologicalEntity.

GetID()

const Dtk_ID& Dtk_Entity::GetID ( ) const

inherited

Get Internal UniqueID.

Returns

InternalID

GetNumShells()

Dtk_Size_t Dtk_Volume::GetNumShells

(

)

const

Get Number of Shell in Volume.

Returns

Number of Shell in Volume

GetParentBody()

Dtk_ErrorStatus Dtk_Volume::GetParentBody ( Dtk_Body *&  outParentBody ) const

protected

GetParentLump()

Dtk_ErrorStatus Dtk_Volume::GetParentLump

(

Dtk_LumpPtr &

outParentLump

)

const

Get Parent Lump.

Parameters

[out]

outParentLump

: parent lump

Returns

Dtk_ErrorStatus: dtkNoError if OK

GetShell() [1/2]

Dtk_ErrorStatus Dtk_Volume::GetShell	(	const Dtk_Size_t &	inIndex,
		Dtk_ID &	outShellId
	)		const

GetShell() [2/2]

Dtk_ErrorStatus Dtk_Volume::GetShell	(	const Dtk_Size_t &	inIndex,
		Dtk_ShellPtr &	outShell
	)		const

Get Shell.

Parameters

[in]	inIndex	: index of shell
[out]	outShell	: pointer on shell

Returns

Dtk_ErrorStatus: dtkNoError if OK

GetSize()

virtual Dtk_Size_t Dtk_Volume::GetSize ( ) const

virtual

Reimplemented from Dtk_Entity.

GetTopoID()

Dtk_ID Dtk_Volume::GetTopoID ( ) const

virtual

Reimplemented from Dtk_TopologicalEntity.

GetTopologyStatus()

Dtk_ErrorStatus Dtk_Volume::GetTopologyStatus

(

)

const

info()

Dtk_InfoPtr& Dtk_Entity::info ( )

inherited

PrepareTransfo()

virtual void Dtk_Entity::PrepareTransfo ( )

virtualinherited

Reimplemented in Dtk_OffsetSurface.

SetParentBody()

Dtk_ErrorStatus Dtk_Volume::SetParentBody ( const Dtk_BodyPtr &  inParentBody )

protectedvirtual

Reimplemented from Dtk_TopologicalEntity.

SetParentLump() [1/2]

Dtk_ErrorStatus Dtk_Volume::SetParentLump

(

const Dtk_ID &

inParentLumpId

)

SetParentLump() [2/2]

Dtk_ErrorStatus Dtk_Volume::SetParentLump

(

const Dtk_LumpPtr &

inParentLump

)

Set Parent Lump.

Parameters

[in]

inParentLump

: parent lump

Returns

Dtk_ErrorStatus: dtkNoError if OK

SetTopologyStatus()

void Dtk_Volume::SetTopologyStatus

(

Dtk_ErrorStatus

inStatus

)

Transform()

virtual Dtk_ErrorStatus Dtk_TopologicalEntity::Transform ( const Dtk_transfo &  inTransfo )

virtualinherited

Transform object.

Parameters

[in]

inTransfo

: matrix to apply

Returns

Dtk_ErrorStatus

Implements Dtk_Entity.

Field Documentation

_Private

Dtk_Handle* Dtk_Volume::_Private

protected

count_

unsigned long Dtk_Object::count_

protectedinherited