DATAKIT SDK  V2026.4
Dtk_AxisSystem Class Reference

This is the Dtk_AxisSystem class. More...

+ Inheritance diagram for Dtk_AxisSystem:

Public Member Functions

virtual Dtk_ErrorStatus _Store (void *)
 
int DtkDynamicType (const int &inId)
 
virtual void dump (FILE *file=stdout)
 
Dtk_InfoPtr get_info () const
 
type_detk get_type_detk () const
 
const Dtk_ID & GetID () const
 Get Internal UniqueID. More...
 
int GetIsHidden () const
 Get the hidden status. More...
 
int GetIsVisible () const
 Get the visibility status. More...
 
const Dtk_transfo & GetMatrix () const
 Get the Matrix of the AxisSystem. More...
 
Dtk_string GetName () const
 Get the Name of the AxisSystem. More...
 
virtual Dtk_Size_t GetSize () const
 
Dtk_InfoPtr & info ()
 
Dtk_bool IsDefault () const
 Get the default status. More...
 
virtual void PrepareTransfo ()
 
 SetAsDeprecated ("2026.4", "Use Create instead") static Dtk_SmartPtr< Dtk_AxisSystem > create()
 
void SetDefaultStatus (Dtk_bool inDefaultStatus)
 Set the default status. More...
 
void SetIsHidden ()
 Set the hidden status. More...
 
void SetIsVisible ()
 Set the visibility status. More...
 
void SetMatrix (const Dtk_transfo &in)
 Get the Matrix of the AxisSystem. More...
 
void SetName (const Dtk_string &in)
 Set the Name of the AxisSystem. More...
 
Dtk_ErrorStatus Transform (const Dtk_transfo &inTransfo)
 Applies a transformation matrix to the entity. //! More...
 

Static Public Member Functions

static Dtk_SmartPtr< Dtk_AxisSystem > Create ()
 Calls default constructor to allocate a new object. More...
 
static Dtk_AxisSystem * DtkDynamicCast (Dtk_Object *inObject)
 

Protected Types

enum  { _typeID = DTK_TYPE_OBJECT }
 
enum  { _typeID = DTK_TYPE_ENTITY }
 

Protected Member Functions

virtual Dtk_Object * Clone ()
 
 Dtk_AxisSystem ()
 
 Dtk_AxisSystem (const Dtk_AxisSystem &p)
 
virtual ~Dtk_AxisSystem ()
 

Protected Attributes

std::unique_ptr< Dtk_Handle > _Private
 
unsigned long count_
 

Detailed Description

This is the Dtk_AxisSystem class.

A Dtk_AxisSystem contains the AxisSystem definition which is defined by its name, status and a matrix

This class lets you use Dtk_AxisSystem.

See also
Use Dtk_AxisSystemPtr class to handle it.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
protectedinherited
Enumerator
_typeID 

◆ anonymous enum

anonymous enum
protectedinherited
Enumerator
_typeID 

Constructor & Destructor Documentation

◆ Dtk_AxisSystem() [1/2]

Dtk_AxisSystem::Dtk_AxisSystem ( )
protected

◆ Dtk_AxisSystem() [2/2]

Dtk_AxisSystem::Dtk_AxisSystem ( const Dtk_AxisSystem &  p)
protected
See also
Create(const Dtk_AxisSystem &)

◆ ~Dtk_AxisSystem()

virtual Dtk_AxisSystem::~Dtk_AxisSystem ( )
protectedvirtual

Member Function Documentation

◆ _Store()

◆ Clone()

virtual Dtk_Object* Dtk_AxisSystem::Clone ( )
protectedvirtual

Implements Dtk_Entity.

880 { return new Dtk_AxisSystem( *this ); }

◆ Create()

static Dtk_SmartPtr<Dtk_AxisSystem> Dtk_AxisSystem::Create ( )
static

Calls default constructor to allocate a new object.

◆ DtkDynamicCast()

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

◆ DtkDynamicType()

int Dtk_AxisSystem::DtkDynamicType ( const int &  inId)
virtual

Reimplemented from Dtk_Entity.

◆ 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_AxisSystem::get_type_detk ( ) const
virtual
Returns
The type of the entity type - DTK_TYPE_AXIS_SYSTEM -

Implements Dtk_Entity.

886  {
887  return DTK_TYPE_AXIS_SYSTEM;
888  }

◆ GetID()

const Dtk_ID& Dtk_Entity::GetID ( ) const
inherited

Get Internal UniqueID.

Returns
InternalID

◆ GetIsHidden()

int Dtk_AxisSystem::GetIsHidden ( ) const

Get the hidden status.

Returns
DTK_TRUE if it is hidden .

◆ GetIsVisible()

int Dtk_AxisSystem::GetIsVisible ( ) const

Get the visibility status.

Returns
DTK_TRUE if it is visible .

◆ GetMatrix()

const Dtk_transfo& Dtk_AxisSystem::GetMatrix ( ) const

Get the Matrix of the AxisSystem.

Returns
the Matrix of this AxisSystem .

◆ GetName()

Dtk_string Dtk_AxisSystem::GetName ( ) const

Get the Name of the AxisSystem.

Returns
the Name of this AxisSystem .

◆ GetSize()

◆ info()

Dtk_InfoPtr& Dtk_Entity::info ( )
inherited

◆ IsDefault()

Dtk_bool Dtk_AxisSystem::IsDefault ( ) const

Get the default status.

Returns
DTK_TRUE if it is Default Axis .

◆ PrepareTransfo()

virtual void Dtk_Entity::PrepareTransfo ( )
virtualinherited

Reimplemented in Dtk_OffsetSurface.

◆ SetAsDeprecated()

Dtk_AxisSystem::SetAsDeprecated ( "2026.4"  ,
"Use Create instead"   
)

◆ SetDefaultStatus()

void Dtk_AxisSystem::SetDefaultStatus ( Dtk_bool  inDefaultStatus)

Set the default status.

Returns
DTK_TRUE if it is hidden .

◆ SetIsHidden()

void Dtk_AxisSystem::SetIsHidden ( )

Set the hidden status.

Returns
DTK_TRUE if it is hidden .

◆ SetIsVisible()

void Dtk_AxisSystem::SetIsVisible ( )

Set the visibility status.

Returns
DTK_TRUE if it is visible .

◆ SetMatrix()

void Dtk_AxisSystem::SetMatrix ( const Dtk_transfo &  in)

Get the Matrix of the AxisSystem.

Parameters
[in]in: Matrix of the AxisSystem
Returns
the Matrix of this AxisSystem .

◆ SetName()

void Dtk_AxisSystem::SetName ( const Dtk_string &  in)

Set the Name of the AxisSystem.

Returns
the Name of this AxisSystem .

◆ Transform()

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

Applies a transformation matrix to the entity. //!

Parameters
inTransfoThe transformation matrix to apply.

Implements Dtk_Entity.

Field Documentation

◆ _Private

std::unique_ptr<Dtk_Handle> Dtk_AxisSystem::_Private
protected

◆ count_

unsigned long Dtk_Object::count_
protectedinherited
Dtk_AxisSystem::Dtk_AxisSystem
Dtk_AxisSystem()
DTK_TYPE_ENTITY
@ DTK_TYPE_ENTITY
Definition: define.h:457
DTK_TYPE_AXIS_SYSTEM
@ DTK_TYPE_AXIS_SYSTEM
Definition: define.h:34
DTK_TYPE_OBJECT
@ DTK_TYPE_OBJECT
Definition: define.h:455
Dtk_Entity::_typeID
@ _typeID
Definition: util_ent_dtk.hpp:371
Dtk_Object::_typeID
@ _typeID
Definition: dtk_object.hpp:10