DATAKIT API  V2025.1
Dtk_2dEntity Class Referenceabstract

This is the abstract Dtk_2dEntity class.
Gathers Dtk_Annotation and Dtk_Dimension. More...

+ Inheritance diagram for Dtk_2dEntity:

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...
 
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
 
virtual type_detk get_type_detk () const =0
 
const Dtk_tab< Dtk_EntityPtr > & GetAdditionnalGeometries () const
 Retrieves the additionnal geometries of the Dtk_2dEntity. More...
 
const Dtk_CompositeTextGetAdditionnalTexts () const
 Retrieves the additionnal texts of the Dtk_2dEntity. More...
 
const Dtk_IDGetID () const
 Get Internal UniqueID. More...
 
virtual Dtk_Size_t GetSize () const
 
Dtk_InfoPtrinfo ()
 
virtual std::ostream & operator<< (std::ostream &o) const
 
Dtk_2dEntityoperator= (const Dtk_2dEntity &inToBeAssigned)
 Assignment Operator. More...
 
Dtk_2dEntityoperator= (Dtk_2dEntity &&inToBeAssigned) DTK_NOEXCEPT
 \MoveOp{inToBeAssigned} More...
 
virtual void PrepareTransfo ()
 
virtual Dtk_ErrorStatus Transform (const Dtk_transfo &inTransfo)=0
 Applies a transformation matrix to the entity. //! More...
 

Static Public Member Functions

static Dtk_2dEntityDtkDynamicCast (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 }
 

Protected Member Functions

void _Copy (const Dtk_2dEntity &s)
 
void _copy (const Dtk_Entity &s)
 
void _copy (const Dtk_Object &s)
 
void _Init ()
 
void _init ()
 
void _Reset ()
 
void _reset ()
 
virtual Dtk_ObjectClone ()=0
 
 Dtk_2dEntity ()
 Base constructor. More...
 
 Dtk_2dEntity (const Dtk_2dEntity &s)
 Copy constructor. More...
 
 Dtk_2dEntity (Dtk_2dEntity &&s) DTK_NOEXCEPT
 \MoveConstructor{s} More...
 
virtual ~Dtk_2dEntity ()
 Destructor. More...
 

Protected Attributes

Dtk_Handle * _Private
 
unsigned long count_
 

Friends

class Dtk_SmartPtr< Dtk_2dEntity >
 
std::ostream & operator<< (std::ostream &o, const Dtk_2dEntity &d)
 

Detailed Description

This is the abstract Dtk_2dEntity class.
Gathers Dtk_Annotation and Dtk_Dimension.

See also
Please use the Dtk_2dEntity class to handle it.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
protected
Enumerator
_typeID 
1787  {
1789  };

◆ anonymous enum

anonymous enum
protectedinherited
Enumerator
_typeID 

Constructor & Destructor Documentation

◆ ~Dtk_2dEntity()

virtual Dtk_2dEntity::~Dtk_2dEntity ( )
protectedvirtual

Destructor.

◆ Dtk_2dEntity() [1/3]

Dtk_2dEntity::Dtk_2dEntity ( )
protected

Base constructor.

◆ Dtk_2dEntity() [2/3]

Dtk_2dEntity::Dtk_2dEntity ( const Dtk_2dEntity s)
protected

Copy constructor.

Parameters
sObject to copy.

◆ Dtk_2dEntity() [3/3]

Dtk_2dEntity::Dtk_2dEntity ( Dtk_2dEntity &&  s)
protected

\MoveConstructor{s}

Member Function Documentation

◆ _Copy()

void Dtk_2dEntity::_Copy ( const Dtk_2dEntity s)
protected

◆ _copy() [1/2]

void Dtk_Entity::_copy ( const Dtk_Entity s)
protectedinherited

◆ _copy() [2/2]

void Dtk_Object::_copy ( const Dtk_Object s)
protectedinherited

◆ _Init()

void Dtk_2dEntity::_Init ( )
protected

◆ _init()

void Dtk_Entity::_init ( )
protectedinherited

◆ _Reset()

void Dtk_2dEntity::_Reset ( )
protected

◆ _reset()

void Dtk_Entity::_reset ( )
protectedinherited

◆ _Store()

◆ AddAdditionnalGeometries()

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

Adds some additionnal geometries to the Dtk_2dEntity.

Parameters
inAdditionnalGeometriesThe geometries to be added

◆ AddAdditionnalGeometry()

void Dtk_2dEntity::AddAdditionnalGeometry ( const Dtk_EntityPtr inAdditionnalGeometry)

Adds an additionnal geometry to the Dtk_2dEntity.

Parameters
inAdditionnalGeometryThe geometry to be added

◆ AddAdditionnalTexts()

void Dtk_2dEntity::AddAdditionnalTexts ( Dtk_CompositeText  inAddtionnalTexts)

Adds some additionnal texts to the Dtk_2dEntity.

Parameters
inAddtionnalTextsThe texts to be added

◆ Clone()

virtual Dtk_Object* Dtk_2dEntity::Clone ( )
protectedpure virtual

◆ DtkDynamicCast()

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

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

◆ DtkDynamicType() [1/2]

Dtk_Int32 Dtk_2dEntity::DtkDynamicType ( const Dtk_Int32 inId)

Retrieves the dynamic entity type.

◆ DtkDynamicType() [2/2]

◆ dump()

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

◆ get_info()

Dtk_InfoPtr Dtk_Entity::get_info ( ) const
inherited

◆ get_type_detk()

virtual type_detk Dtk_2dEntity::get_type_detk ( ) const
pure virtual

◆ GetAdditionnalGeometries()

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

Retrieves the additionnal geometries of the Dtk_2dEntity.

Returns
The additionnal geometries array - read only -.

◆ GetAdditionnalTexts()

const Dtk_CompositeText& Dtk_2dEntity::GetAdditionnalTexts ( ) const

Retrieves the additionnal texts of the Dtk_2dEntity.

Returns
The additionnal texts - read only -.

◆ GetID()

const Dtk_ID& Dtk_Entity::GetID ( ) const
inherited

Get Internal UniqueID.

Returns
InternalID

◆ GetSize()

◆ info()

Dtk_InfoPtr& Dtk_Entity::info ( )
inherited

◆ operator<<()

virtual std::ostream& Dtk_2dEntity::operator<< ( std::ostream &  o) const
virtual
1846  {
1847  return o << "Dtk_2dEntity Base class";
1848  }

◆ operator=() [1/2]

Dtk_2dEntity& Dtk_2dEntity::operator= ( const Dtk_2dEntity inToBeAssigned)

Assignment Operator.

Parameters
inToBeAssignedObject to copy.

◆ operator=() [2/2]

Dtk_2dEntity& Dtk_2dEntity::operator= ( Dtk_2dEntity &&  inToBeAssigned)

\MoveOp{inToBeAssigned}

◆ PrepareTransfo()

virtual void Dtk_Entity::PrepareTransfo ( )
virtualinherited

Reimplemented in Dtk_OffsetSurface.

◆ Transform()

virtual Dtk_ErrorStatus Dtk_2dEntity::Transform ( const Dtk_transfo inTransfo)
pure virtual

Applies a transformation matrix to the entity. //!

Parameters
inTransfoThe transformation matrix to apply.

Implements Dtk_Entity.

Implemented in Dtk_Annotation, Dtk_Region, Dtk_CompositeEntity, Dtk_Symbol, Dtk_GeometricalTolerance, Dtk_Dimension, Dtk_Grid, Dtk_Table, Dtk_DatumTarget, Dtk_Welding, and Dtk_Roughness.

Friends And Related Function Documentation

◆ Dtk_SmartPtr< Dtk_2dEntity >

friend class Dtk_SmartPtr< Dtk_2dEntity >
friend

◆ operator<<

std::ostream& operator<< ( std::ostream &  o,
const Dtk_2dEntity d 
)
friend

Field Documentation

◆ _Private

Dtk_Handle* Dtk_2dEntity::_Private
protected

◆ count_

unsigned long Dtk_Object::count_
protectedinherited
DTK_TYPE_ENTITY
@ DTK_TYPE_ENTITY
Definition: define.h:466
Dtk_Entity::_typeID
@ _typeID
Definition: util_ent_dtk.hpp:333
Dtk_2dEntity::_typeID
@ _typeID
Definition: util_draw_dtk.hpp:1788
DTK_TYPE_2D_ENTITY
@ DTK_TYPE_2D_ENTITY
Definition: define.h:471