DATAKIT API  V2025.1
Dtk_Vertex Class Reference

Vertex indicates bound of an edge. Vertex has Dtk_Point as geometry value. More...

+ Inheritance diagram for Dtk_Vertex:

Public Member Functions

virtual Dtk_ErrorStatus _Store (void *)
 Internal Use. More...
 
Dtk_ErrorStatus AddParentEdge (const Dtk_EdgePtr &inParentEdge)
 Add parent Edge. More...
 
Dtk_ErrorStatus AddParentEdge (const Dtk_ID &inParentEdgeId)
 Add parent Edge. More...
 
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...
 
Dtk_PointPtr GetGeom () const
 Return associated geometry. More...
 
const Dtk_IDGetID () const
 Get Internal UniqueID. More...
 
Dtk_Size_t GetNumParentEdges () const
 Return Number of Parent Edge. More...
 
Dtk_ErrorStatus GetParentEdge (const Dtk_Size_t &inIndex, Dtk_EdgePtr &outParentEdge) const
 Return parent edge at inIndex. More...
 
virtual Dtk_Size_t GetSize () const
 Internal Use. More...
 
Dtk_ErrorStatus GetTolerance (Dtk_Double64 &outTolerance)
 Get Tolerance. More...
 
Dtk_ID GetTopoID () const
 
Dtk_InfoPtrinfo ()
 
virtual void PrepareTransfo ()
 
 SetAsDeprecated ("2022.1", "GetTolerance(Dtk_Double64 &outTolerance) method instead.") Dtk_Double64 GetTolerance()
 Get Tolerance. More...
 
void SetGeom (const Dtk_PointPtr &inPoint)
 Set Geometry. More...
 
Dtk_ErrorStatus SetParentBody (const Dtk_BodyPtr &inParentBody)
 
void SetTolerance (Dtk_Double64 inTol)
 Set Tolerance. More...
 
virtual Dtk_ErrorStatus Transform (const Dtk_transfo &inTransfo)
 Transform object. More...
 

Static Public Member Functions

static Dtk_VertexPtr Create (const Dtk_BodyPtr &inParentBody)
 Create a vertex in a body. More...
 
static Dtk_VertexDtkDynamicCast (Dtk_Object *inObject)
 Cast object in vertex. More...
 

Protected Types

enum  { _typeID = DTK_TYPE_TOPOLOGICAL_REPRESENTATION_ITEM }
 
enum  { _typeID = DTK_TYPE_VERTEX }
 

Protected Member Functions

void _Clone (Dtk_TopologicalEntityPtr &outTopo, Dtk_Body *_inParentBody)
 
void _copy (const Dtk_Entity &s)
 
void _copy (const Dtk_Object &s)
 
void _Copy (const Dtk_Vertex &inTopo, Dtk_Body *inParentBody)
 
void _init ()
 
void _Init ()
 
void _reset ()
 
void _Reset ()
 
virtual Dtk_ObjectClone ()
 
 Dtk_Vertex ()
 
 Dtk_Vertex (const Dtk_Vertex &inTopo, Dtk_Body *inParentBody)
 
virtual ~Dtk_Vertex ()
 

Protected Attributes

Dtk_Handle * _Private
 
unsigned long count_
 

Friends

class Dtk_SmartPtr< Dtk_Vertex >
 
class Dtk_TopologicalEntity
 

Detailed Description

Vertex indicates bound of an edge. Vertex has Dtk_Point as geometry value.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
protectedinherited
Enumerator
_typeID 

◆ anonymous enum

anonymous enum
protected
Enumerator
_typeID 

Constructor & Destructor Documentation

◆ Dtk_Vertex() [1/2]

Dtk_Vertex::Dtk_Vertex ( )
protected

◆ Dtk_Vertex() [2/2]

Dtk_Vertex::Dtk_Vertex ( const Dtk_Vertex inTopo,
Dtk_Body inParentBody 
)
protected

◆ ~Dtk_Vertex()

virtual Dtk_Vertex::~Dtk_Vertex ( )
protectedvirtual

Member Function Documentation

◆ _Clone()

void Dtk_Vertex::_Clone ( Dtk_TopologicalEntityPtr outTopo,
Dtk_Body _inParentBody 
)
protectedvirtual

Implements Dtk_TopologicalEntity.

◆ _copy() [1/2]

void Dtk_Entity::_copy ( const Dtk_Entity s)
protectedinherited

◆ _copy() [2/2]

void Dtk_Object::_copy ( const Dtk_Object s)
protectedinherited

◆ _Copy()

void Dtk_Vertex::_Copy ( const Dtk_Vertex inTopo,
Dtk_Body inParentBody 
)
protected

◆ _init()

void Dtk_Entity::_init ( )
protectedinherited

◆ _Init()

void Dtk_Vertex::_Init ( )
protected

◆ _reset()

void Dtk_Entity::_reset ( )
protectedinherited

◆ _Reset()

void Dtk_Vertex::_Reset ( )
protected

◆ _Store()

virtual Dtk_ErrorStatus Dtk_Vertex::_Store ( void *  )
virtual

Internal Use.

Reimplemented from Dtk_Entity.

◆ AddParentEdge() [1/2]

Dtk_ErrorStatus Dtk_Vertex::AddParentEdge ( const Dtk_EdgePtr inParentEdge)

Add parent Edge.

Parameters
[in]inParentEdge: pointer of parent edge
Returns
Dtk_ErrorStatus: dtkNoError if OK

◆ AddParentEdge() [2/2]

Dtk_ErrorStatus Dtk_Vertex::AddParentEdge ( const Dtk_ID inParentEdgeId)

Add parent Edge.

Parameters
[in]inParentEdgeId: UUID of parent edge
Returns
Dtk_ErrorStatus: dtkNoError if OK

◆ Clone()

virtual Dtk_Object* Dtk_TopologicalEntity::Clone ( )
protectedvirtualinherited

Implements Dtk_Entity.

37 {return NULL;}

◆ Create()

static Dtk_VertexPtr Dtk_Vertex::Create ( const Dtk_BodyPtr inParentBody)
static

Create a vertex in a body.

Parameters
[in]inParentBody: parent body
Returns
static Dtk_VertexPtr

◆ DtkDynamicCast()

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

Cast object in vertex.

Parameters
[in]inObject: object to cast
Returns
static Dtk_Vertex or NULL

◆ DtkDynamicType()

int Dtk_Vertex::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_Vertex::get_type_detk ( ) const
virtual

Return Type of entity.

Returns
enum type_detk

Reimplemented from Dtk_TopologicalEntity.

◆ GetGeom()

Dtk_PointPtr Dtk_Vertex::GetGeom ( ) const

Return associated geometry.

Returns
Dtk_PointPtr

◆ GetID()

const Dtk_ID& Dtk_Entity::GetID ( ) const
inherited

Get Internal UniqueID.

Returns
InternalID

◆ GetNumParentEdges()

Dtk_Size_t Dtk_Vertex::GetNumParentEdges ( ) const

Return Number of Parent Edge.

Returns
Dtk_Size_t

◆ GetParentEdge()

Dtk_ErrorStatus Dtk_Vertex::GetParentEdge ( const Dtk_Size_t inIndex,
Dtk_EdgePtr outParentEdge 
) const

Return parent edge at inIndex.

Parameters
[in]inIndex: index of parent edge
[out]outParentEdge: pointer of parent edge
Returns
Dtk_ErrorStatus: dtkNoError if OK

◆ GetSize()

virtual Dtk_Size_t Dtk_Vertex::GetSize ( ) const
virtual

Internal Use.

Reimplemented from Dtk_Entity.

◆ GetTolerance()

Dtk_ErrorStatus Dtk_Vertex::GetTolerance ( Dtk_Double64 outTolerance)

Get Tolerance.

Parameters
[out]outTolerance: vertex tolerance
Returns
dtkNoError if value set or dtkWarningDefaultValue if default

◆ GetTopoID()

Dtk_ID Dtk_Vertex::GetTopoID ( ) const
virtual

Reimplemented from Dtk_TopologicalEntity.

◆ info()

Dtk_InfoPtr& Dtk_Entity::info ( )
inherited

◆ PrepareTransfo()

virtual void Dtk_Entity::PrepareTransfo ( )
virtualinherited

Reimplemented in Dtk_OffsetSurface.

◆ SetAsDeprecated()

Dtk_Vertex::SetAsDeprecated ( "2022.1"  ,
"GetTolerance(Dtk_Double64 &outTolerance) method instead."   
)

Get Tolerance.

Deprecated:
Returns
double Tolerance

◆ SetGeom()

void Dtk_Vertex::SetGeom ( const Dtk_PointPtr inPoint)

Set Geometry.

Parameters
[in]inPoint: Point
Returns
void

◆ SetParentBody()

Dtk_ErrorStatus Dtk_Vertex::SetParentBody ( const Dtk_BodyPtr inParentBody)
virtual

Reimplemented from Dtk_TopologicalEntity.

◆ SetTolerance()

void Dtk_Vertex::SetTolerance ( Dtk_Double64  inTol)

Set Tolerance.

Parameters
[in]inTol: Tolerance

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

Friends And Related Function Documentation

◆ Dtk_SmartPtr< Dtk_Vertex >

friend class Dtk_SmartPtr< Dtk_Vertex >
friend

◆ Dtk_TopologicalEntity

friend class Dtk_TopologicalEntity
friend

Field Documentation

◆ _Private

Dtk_Handle* Dtk_Vertex::_Private
protected

◆ count_

unsigned long Dtk_Object::count_
protectedinherited
DTK_TYPE_VERTEX
@ DTK_TYPE_VERTEX
Definition: define.h:125
Dtk_TopologicalEntity::_typeID
@ _typeID
Definition: util_topology_dtk.hpp:29
DTK_TYPE_TOPOLOGICAL_REPRESENTATION_ITEM
@ DTK_TYPE_TOPOLOGICAL_REPRESENTATION_ITEM
Definition: define.h:167
Dtk_Vertex::_typeID
@ _typeID
Definition: util_topology_dtk.hpp:69