Dtk_StoredInfo Class Reference

This is the Dtk_StoredInfo Class.
The Dtk_StoredInfo object is used to store any information stored. More...

Inheritance diagram for Dtk_StoredInfo:

Public Types
enum	MandatoryFlag {   NotMandatory = 0, XYPlane, YZPlane, ZXPlane,   OriginPoint }

Public Member Functions
virtual Dtk_ErrorStatus	_Store (void *)
Dtk_ErrorStatus	AddAttribute (Dtk_string name, Dtk_Val val)
Dtk_ErrorStatus	AddCurveLineTypeDefinition (const Dtk_LineTypeDefinitionPtr &inLineTypeDefinition)
	Add a Dtk_LineTypeDefinition to Dtk_API and set it to current object. More...
Dtk_ErrorStatus	AddCustomerDefinedAttribute (Dtk_string name, Dtk_Val val)
Dtk_ErrorStatus	AddLayer (const Dtk_Int32 &inLayer)
Dtk_ErrorStatus	AddMaterial (const Dtk_MaterialPtr &inMaterial)
Dtk_ErrorStatus	AddPhysicalMaterialInfos (const Dtk_PhysicalMaterialInfosPtr &inMaterial)
Dtk_ErrorStatus	AddRenderInfos (const Dtk_RenderInfosPtr &inRender)
Dtk_Int32	DtkDynamicType (const Dtk_Int32 &inId)
	Retrieves the dynamic entity type. More...
virtual int	DtkDynamicType (const int &inId)=0
virtual void	dump (FILE *file=stdout)
Dtk_Val const *	FindAttribute (const Dtk_string &name) const
Dtk_ErrorStatus	FindAttribute (const Dtk_string &name, Dtk_Val &val) const
type_detk	get_type_detk () const
int	GetActivationFlag () const
Dtk_tab< Dtk_Int32 >	GetActiveChildren () const
int	GetAddedItemFlag () const
int	GetAdditionnalGeometryFlag () const
int	GetBlankedStatus () const
	Retrieves the entity Blanked Status. More...
Dtk_tab< Dtk_Int32 >	GetBuildingInfosIds () const
Dtk_RGB	GetColor () const
	Retrieves the entity color as Dtk_RGBA values. More...
int	GetColorId () const
	Retrieves the entity color index in Dtk_API color table. More...
Dtk_string	GetConfigurationName () const
Dtk_FontLineType	GetCurveLineType () const
	Retrieves the curve LineType - for curve entities -. More...
Dtk_LineTypeDefinitionPtr	GetCurveLineTypeDefinition () const
	Retrieves the definition of the curve LineType - for curve entities -. More...
Dtk_ID	GetCurveLineTypeDefinitionId () const
	Retrieves the Id of Dtk_LineTypeDefinition of the entity in The Dtk_API table. More...
int	GetCurveThickNess () const
Dtk_Double64	GetCurveThickNessInMM () const
	Retrieves the curve thickness - if exists and relevant -. More...
int	GetDefaultChildIndex () const
Dtk_Double64	GetDisplayLineWidth () const
	Retrieves if all wireframe is displayed with same width. More...
int	GetFlexibleFlag () const
int	GetFontId () const
int	GetFormFlag () const
int	GetHierarchy () const
int	GetHierarchyColorFlag () const
int	GetId () const
int	GetInfiniteGeometryFlag () const
	Retrieves the Flag for Infinite Geometry. More...
Dtk_bool	GetIsUpToDate () const
	Retrieves up to date state of current object. More...
int	GetLayer () const
	Retrieves the entity layer. More...
Dtk_tab< Dtk_Int32 >	GetlayerList () const
	Retrieves the layers in which the entity is assigned. More...
enum MandatoryFlag	GetMandatoryFlag () const
	Retrieves the Mandatory Flag. More...
Dtk_MaterialPtr	GetMaterial () const
int	GetMatId () const
Dtk_ErrorStatus	GetMetaData (Dtk_tab< Dtk_MetaDataPtr > &outArray) const
Dtk_string	GetName () const
	Retrieves the entity name. More...
bool	GetOccurrenceDataFlag () const
	Retrieves the OccurrenceData flag. More...
Dtk_string	GetPersistentName () const
	Retrieves the entity persistent name. More...
Dtk_PhysicalMaterialInfosPtr	GetPhysicalMaterialInfos () const
	Retrieves the entity MaterialInfos. More...
Dtk_ID	GetPhysicalMaterialInfosId () const
	Retrieves the Id of MaterialInfos of the entity in The Dtk_API table. More...
Dtk_PointType	GetPointSymbolType () const
	Retrieves the Symbol Type - for point only -. More...
int	GetRefEntityFlag () const
	Retrieves the Flag for Reference Entity (Reference planes , axis, point. More...
Dtk_ErrorStatus	GetReferenceSet (Dtk_tab< Dtk_string > &outArray, Dtk_Int32 inRemovePrefix=DTK_FALSE) const
Dtk_RenderInfosPtr	GetRenderInfos () const
	Retrieves the entity RenderInfos of the entity. More...
Dtk_ID	GetRenderInfosId () const
	Retrieves the Id of RenderInfos of the entity in The Dtk_API table. More...
virtual Dtk_Size_t	GetSize () const
int	GetSubordFlag () const
int	GetUse () const
Dtk_UUID	GetUuid () const
	Retrieves the entity UniqueID if any. More...
int	GetViewId () const
Dtk_ErrorStatus	ListAllAttributes (Dtk_tab< Dtk_string > &tab_keys) const
Dtk_ErrorStatus	ListAllAttributesWithVal (Dtk_tab< Dtk_pair< Dtk_string, Dtk_Val > > &tab) const
Dtk_ErrorStatus	ListAllCustomerDefinedAttributesWithVal (Dtk_tab< Dtk_pair< Dtk_string, Dtk_Val > > &tab) const
Dtk_ErrorStatus	ListAttributes (const Dtk_string &substring, Dtk_tab< Dtk_string > &tab_keys) const
Dtk_ErrorStatus	RemoveAttribute (const Dtk_string &name)
Dtk_ErrorStatus	SetActivationFlag (const Dtk_Int32 &inActivation)
Dtk_ErrorStatus	SetActiveChildren (const Dtk_tab< Dtk_Int32 > &inIndices)
Dtk_ErrorStatus	SetAddedItemFlag (const Dtk_Int32 &inAddedItem)
Dtk_ErrorStatus	SetAdditionnalGeometryFlag (const Dtk_Int32 &inAdditionnalGeom)
	SetAsDeprecated ("v2026.2", "use GetMetaData() methods instead.") Dtk_ErrorStatus GetProperties(Dtk_tab< Dtk_PropertiesPtr > &outArray) const
Dtk_ErrorStatus	SetBlankedStatus (const Dtk_Int32 &inBlankedStatus)
Dtk_ErrorStatus	SetBuildingInfosIds (const Dtk_tab< Dtk_Int32 > inBuildingInfos)
Dtk_ErrorStatus	SetColor (const Dtk_RGB &inColor)
Dtk_ErrorStatus	SetColor (const int &R, const int &G, const int &B)
Dtk_ErrorStatus	SetColorId (const Dtk_Int32 &inColorId)
Dtk_ErrorStatus	SetConfigurationName (const Dtk_string &inName)
Dtk_ErrorStatus	SetCurveLineType (const Dtk_Int32 &inCurveLineType)
	Set line type of current object thanks to Dtk_FontLineType enumeration. More...
Dtk_ErrorStatus	SetCurveLineTypeDefinitionId (const Dtk_ID &inLineTypeDefinitionId)
	Set Dtk_LineTypeDefinition of current object via it's id in Dtk_API table. More...
Dtk_ErrorStatus	SetCurveThickNess (const Dtk_Int32 &inCurveThickNess)
Dtk_ErrorStatus	SetCurveThickNessInMM (const Dtk_Double64 inCurveThickNessInMM)
Dtk_ErrorStatus	SetDefaultChildIndex (const Dtk_Int32 &inIndex)
Dtk_ErrorStatus	SetDisplayLineWidth (const Dtk_Double64 &inDisplayLineWidth)
Dtk_ErrorStatus	SetFlexibleFlag (const Dtk_Int32 &inIsFlexible)
Dtk_ErrorStatus	SetFontId (const Dtk_Int32 &inFontId)
Dtk_ErrorStatus	SetFormFlag (const Dtk_Int32 &inFormFlag)
Dtk_ErrorStatus	SetHierarchy (const Dtk_Int32 &inHierarchy)
Dtk_ErrorStatus	SetHierarchyColorFlag (const Dtk_Int32 &inHierarchy)
Dtk_ErrorStatus	SetId (const Dtk_Int32 &inId)
Dtk_ErrorStatus	SetInfiniteGeometryFlag (const Dtk_Int32 &inInfiniteGeometryFlag)
void	SetIsUpToDate (const Dtk_bool isUpToDate)
	Set if current object is up to date or not. More...
Dtk_ErrorStatus	SetLayer (const Dtk_Int32 &inLayer)
Dtk_ErrorStatus	SetMandatoryFlag (const enum MandatoryFlag &inMandatoryFlag)
Dtk_ErrorStatus	SetMatId (const Dtk_Int32 &inMatId)
Dtk_ErrorStatus	SetMetaData (Dtk_tab< Dtk_MetaDataPtr > &inArray)
Dtk_ErrorStatus	SetName (Dtk_string inName)
Dtk_ErrorStatus	SetOccurrenceDataFlag ()
Dtk_ErrorStatus	SetPersistentName (Dtk_string inName)
Dtk_ErrorStatus	SetPhysicalMaterialInfosId (const Dtk_ID &inMaterialId)
Dtk_ErrorStatus	SetPointSymbolType (const Dtk_PointType inPointSymbolType)
Dtk_ErrorStatus	SetRefEntityFlag (const Dtk_Int32 &inRefEntityFlag)
Dtk_ErrorStatus	SetRenderInfosId (const Dtk_ID &inRenderId)
Dtk_ErrorStatus	SetSubordFlag (const Dtk_Int32 &inSubordFlag)
Dtk_ErrorStatus	SetUse (const Dtk_Int32 &inUse)
Dtk_ErrorStatus	SetUuid (const Dtk_UUID &inUuid)
Dtk_ErrorStatus	SetViewId (const Dtk_Int32 &inViewId)

Static Public Member Functions
static Dtk_StoredInfoPtr	Create ()
	Calls default constructor to allocate a new object. More...
static Dtk_SmartPtr< Dtk_Info >	create ()
	Calls default constructor to allocate a new object. More...
static Dtk_SmartPtr< Dtk_Info >	create (const Dtk_Info &in)
	Calls copy constructor to allocate a new object. More...
static Dtk_StoredInfoPtr	Create (const Dtk_StoredInfo &in)
	Calls copy constructor to allocate a new object. More...
static Dtk_SmartPtr< Dtk_Info >	create (Dtk_Info &&in)
	Calls move constructor to allocate a new object. More...
static Dtk_StoredInfo *	DtkDynamicCast (Dtk_Object *o)
	Performs a dynamic cast - doesn't need RTTI -. More...

Protected Types
enum	{ _typeID = DTK_TYPE_STOREDINFO }

Protected Member Functions
void	_copy (const Dtk_Info &s)
void	_init ()
void	_reset ()
virtual Dtk_Object *	Clone ()
	Dtk_StoredInfo ()
	Base Constructor. More...
	Dtk_StoredInfo (const Dtk_StoredInfo &o)
	Copy Constructor. More...
	~Dtk_StoredInfo ()
	Destructor. More...

Protected Attributes
Dtk_MaterialPtr	_Material
Dtk_Handle *	_Private
unsigned long	count_

Detailed Description

This is the Dtk_StoredInfo Class.
The Dtk_StoredInfo object is used to store any information stored.

See also

Use Dtk_StoredInfoPtr class to handle it.

Member Enumeration Documentation

anonymous enum

anonymous enum

protected

Enumerator
_typeID

{ _typeID = DTK_TYPE_STOREDINFO };

MandatoryFlag

enum Dtk_Info::MandatoryFlag

inherited

Enumerator
NotMandatory
XYPlane
YZPlane
ZXPlane
OriginPoint

     {
          NotMandatory = 0,
          XYPlane,
          YZPlane,
          ZXPlane,
          OriginPoint
     };

Constructor & Destructor Documentation

Dtk_StoredInfo() [1/2]

Dtk_StoredInfo::Dtk_StoredInfo ( )

protected

Base Constructor.

Dtk_StoredInfo() [2/2]

Dtk_StoredInfo::Dtk_StoredInfo ( const Dtk_StoredInfo &  o )

protected

Copy Constructor.

~Dtk_StoredInfo()

Dtk_StoredInfo::~Dtk_StoredInfo ( )

protected

Destructor.

Member Function Documentation

_copy()

void Dtk_Info::_copy ( const Dtk_Info &  s )

protectedinherited

_init()

void Dtk_Info::_init ( )

protectedinherited

_reset()

void Dtk_Info::_reset ( )

protectedinherited

_Store()

virtual Dtk_ErrorStatus Dtk_Info::_Store ( void *  )

virtualinherited

AddAttribute()

Dtk_ErrorStatus Dtk_Info::AddAttribute ( Dtk_string  name, Dtk_Val  val  )

inherited

AddCurveLineTypeDefinition()

Dtk_ErrorStatus Dtk_Info::AddCurveLineTypeDefinition ( const Dtk_LineTypeDefinitionPtr &  inLineTypeDefinition )

inherited

Add a Dtk_LineTypeDefinition to Dtk_API and set it to current object.

AddCustomerDefinedAttribute()

Dtk_ErrorStatus Dtk_Info::AddCustomerDefinedAttribute ( Dtk_string  name, Dtk_Val  val  )

inherited

AddLayer()

Dtk_ErrorStatus Dtk_Info::AddLayer ( const Dtk_Int32 &  inLayer )

inherited

AddMaterial()

Dtk_ErrorStatus Dtk_Info::AddMaterial ( const Dtk_MaterialPtr &  inMaterial )

inherited

Deprecated:

use AddRenderInfos and AddMaterialInfos methods instead

AddPhysicalMaterialInfos()

Dtk_ErrorStatus Dtk_Info::AddPhysicalMaterialInfos ( const Dtk_PhysicalMaterialInfosPtr &  inMaterial )

inherited

AddRenderInfos()

Dtk_ErrorStatus Dtk_Info::AddRenderInfos ( const Dtk_RenderInfosPtr &  inRender )

inherited

Clone()

virtual Dtk_Object* Dtk_StoredInfo::Clone ( )

protectedvirtual

Reimplemented from Dtk_Info.

     {
          return new Dtk_StoredInfo(*this);
     }

Create() [1/2]

static Dtk_StoredInfoPtr Dtk_StoredInfo::Create ( )

static

Calls default constructor to allocate a new object.

create() [1/3]

static Dtk_SmartPtr<Dtk_Info> Dtk_Info::create ( )

staticinherited

Calls default constructor to allocate a new object.

create() [2/3]

static Dtk_SmartPtr<Dtk_Info> Dtk_Info::create ( const Dtk_Info &  in )

staticinherited

Calls copy constructor to allocate a new object.

Parameters

in	Object to copy from.

Create() [2/2]

static Dtk_StoredInfoPtr Dtk_StoredInfo::Create ( const Dtk_StoredInfo &  in )

static

Calls copy constructor to allocate a new object.

Parameters

in	Object to copy from.

create() [3/3]

static Dtk_SmartPtr<Dtk_Info> Dtk_Info::create ( Dtk_Info &&  in )

staticinherited

Calls move constructor to allocate a new object.

Parameters

in	Object to move from.

DtkDynamicCast()

static Dtk_StoredInfo* Dtk_StoredInfo::DtkDynamicCast ( Dtk_Object *  o )

static

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

DtkDynamicType() [1/2]

Dtk_Int32 Dtk_StoredInfo::DtkDynamicType

(

const Dtk_Int32 &

inId

)

Retrieves the dynamic entity type.

DtkDynamicType() [2/2]

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

pure virtualinherited

Implemented in Dtk_Shell, Dtk_Body, Dtk_Lump, Dtk_Volume, Dtk_Face, Dtk_Loop, Dtk_Coedge, Dtk_Edge, Dtk_Vertex, Dtk_TopologicalEntity, Dtk_MeshPolyline, 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, Dtk_AxisSystem, Dtk_Preview, Dtk_Entity, Dtk_picture, Dtk_OverrideSet, Dtk_OverrideInfo, Dtk_MainDoc, Dtk_Component, Dtk_Node, Dtk_DocElement, Dtk_Log, and Dtk_Properties.

dump()

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

virtualinherited

FindAttribute() [1/2]

Dtk_Val const* Dtk_Info::FindAttribute ( const Dtk_string &  name ) const

inherited

FindAttribute() [2/2]

Dtk_ErrorStatus Dtk_Info::FindAttribute ( const Dtk_string &  name, Dtk_Val &  val  ) const

inherited

get_type_detk()

type_detk Dtk_StoredInfo::get_type_detk

(

)

const

     {
          return DTK_TYPE_STOREDINFO;
     }

GetActivationFlag()

int Dtk_Info::GetActivationFlag ( ) const

inherited

GetActiveChildren()

Dtk_tab<Dtk_Int32> Dtk_Info::GetActiveChildren ( ) const

inherited

GetAddedItemFlag()

int Dtk_Info::GetAddedItemFlag ( ) const

inherited

GetAdditionnalGeometryFlag()

int Dtk_Info::GetAdditionnalGeometryFlag ( ) const

inherited

GetBlankedStatus()

int Dtk_Info::GetBlankedStatus ( ) const

inherited

Retrieves the entity Blanked Status.

Returns

-1 If Undefined - or no blanked status set - .

0 If Visible.

1 If Invisible

2 If Construction Geometry

See also

SetBlankedStatus(const int &inBlankedStatus)

GetBuildingInfosIds()

Dtk_tab<Dtk_Int32> Dtk_Info::GetBuildingInfosIds ( ) const

inherited

GetColor()

Dtk_RGB Dtk_Info::GetColor ( ) const

inherited

Retrieves the entity color as Dtk_RGBA values.

Returns

the Dtk_RGBA value is succeeds. Dtk_RGB(-1,-1,-1) otherwise - no color found for example -.

Sample:

//Get Dtk_InfoPtr class
Dtk_InfoPtr infos = inNode->GetInfos(); //inNode is a Dtk_Node in this sample
Dtk_RGB MyColor = infos->GetColor(); //returned RGB is (-1,-1,-1,-1)
infos->SetColor( Dtk_RGB( 128, 50, 255, 255 ) ); //Red=128 / Green=50 / Blue=255 / Alpha = 255
MyColor = infos->GetColor(); // no RGB is (128,50,255,255)

See also

SetColor(const Dtk_RGB & inColor)

SetColor(const int&R,const int&G,const int&B)

GetColorId()

int Dtk_Info::GetColorId ( ) const

inherited

Retrieves the entity color index in Dtk_API color table.

Returns

the color index

GetConfigurationName()

Dtk_string Dtk_Info::GetConfigurationName ( ) const

inherited

GetCurveLineType()

Dtk_FontLineType Dtk_Info::GetCurveLineType ( ) const

inherited

Retrieves the curve LineType - for curve entities -.

Returns

The curve LineType - Dtk_FontLineType::DTK_SOLIDLINE if not type set -.

GetCurveLineTypeDefinition()

Dtk_LineTypeDefinitionPtr Dtk_Info::GetCurveLineTypeDefinition ( ) const

inherited

Retrieves the definition of the curve LineType - for curve entities -.

Returns

null pointer if not set.

GetCurveLineTypeDefinitionId()

Dtk_ID Dtk_Info::GetCurveLineTypeDefinitionId ( ) const

inherited

Retrieves the Id of Dtk_LineTypeDefinition of the entity in The Dtk_API table.

Returns

The id or 0 if None.

GetCurveThickNess()

int Dtk_Info::GetCurveThickNess ( ) const

inherited

Deprecated:

Use GetCurveThickNessInMM() const method instead.

GetCurveThickNessInMM()

Dtk_Double64 Dtk_Info::GetCurveThickNessInMM ( ) const

inherited

Retrieves the curve thickness - if exists and relevant -.

Returns

The curve thickness in millimeters if succeeds, -1.0 otherwise.

See also

SetCurveThickNessInMM( const Dtk_Double64 inCurveThickNessInMM )

GetDefaultChildIndex()

int Dtk_Info::GetDefaultChildIndex ( ) const

inherited

GetDisplayLineWidth()

Dtk_Double64 Dtk_Info::GetDisplayLineWidth ( ) const

inherited

Retrieves if all wireframe is displayed with same width.

Returns

The curve width in millimeter if succeeds, 0.0 otherwise.

See also

SetDisplayLineWidth( const Dtk_Double64 inDisplayLineWidth )

GetFlexibleFlag()

int Dtk_Info::GetFlexibleFlag ( ) const

inherited

GetFontId()

int Dtk_Info::GetFontId ( ) const

inherited

GetFormFlag()

int Dtk_Info::GetFormFlag ( ) const

inherited

GetHierarchy()

int Dtk_Info::GetHierarchy ( ) const

inherited

GetHierarchyColorFlag()

int Dtk_Info::GetHierarchyColorFlag ( ) const

inherited

GetId()

int Dtk_Info::GetId ( ) const

inherited

GetInfiniteGeometryFlag()

int Dtk_Info::GetInfiniteGeometryFlag ( ) const

inherited

Retrieves the Flag for Infinite Geometry.

Returns

1 if infinite geometr, 0 otherwise.

GetIsUpToDate()

Dtk_bool Dtk_Info::GetIsUpToDate ( ) const

inherited

Retrieves up to date state of current object.

Returns

-1 if unknown, DTK_TRUE if object is up to date, DTK_FALSE if not up to date. Default is unknown.

GetLayer()

int Dtk_Info::GetLayer ( ) const

inherited

Retrieves the entity layer.

Returns

The layer ID if succeed or -1 otherwise - If Undefined or no layer set -.

See also

SetLayer(const Dtk_Int32 & inLayer);

GetlayerList()

Dtk_tab<Dtk_Int32> Dtk_Info::GetlayerList ( ) const

inherited

Retrieves the layers in which the entity is assigned.

Returns

The list of layer numbers.

Remarks

The list can be empty.

See also

AddLayer(const Dtk_Int32 & inLayer);

GetMandatoryFlag()

enum MandatoryFlag Dtk_Info::GetMandatoryFlag ( ) const

inherited

Retrieves the Mandatory Flag.

Returns

Mandatory flag

GetMaterial()

Dtk_MaterialPtr Dtk_Info::GetMaterial ( ) const

inherited

Deprecated:

use GetRenderInfos and GetPhysicalMaterialInfos methods instead

GetMatId()

int Dtk_Info::GetMatId ( ) const

inherited

GetMetaData()

Dtk_ErrorStatus Dtk_Info::GetMetaData ( Dtk_tab< Dtk_MetaDataPtr > &  outArray ) const

inherited

GetName()

Dtk_string Dtk_Info::GetName ( ) const

inherited

Retrieves the entity name.

Returns

the name if succeeds, empty string otherwise.

See also

SetName( const Dtk_string &inName )

GetOccurrenceDataFlag()

bool Dtk_Info::GetOccurrenceDataFlag ( ) const

inherited

Retrieves the OccurrenceData flag.

Returns

true if the instance references a modified version of the prototype.

GetPersistentName()

Dtk_string Dtk_Info::GetPersistentName ( ) const

inherited

Retrieves the entity persistent name.

Returns

the persistent name if succeeds, empty string otherwise.

GetPhysicalMaterialInfos()

Dtk_PhysicalMaterialInfosPtr Dtk_Info::GetPhysicalMaterialInfos ( ) const

inherited

Retrieves the entity MaterialInfos.

Returns

the Dtk_MaterialInfosPtr if succeeds or NULL otherwise.

GetPhysicalMaterialInfosId()

Dtk_ID Dtk_Info::GetPhysicalMaterialInfosId ( ) const

inherited

Retrieves the Id of MaterialInfos of the entity in The Dtk_API table.

Returns

the id or 0 if None.

GetPointSymbolType()

Dtk_PointType Dtk_Info::GetPointSymbolType ( ) const

inherited

Retrieves the Symbol Type - for point only -.

Returns

The Symbol Type - Dtk_PointType::DTK_PT_UNSPECIFIED if no type set -.

GetRefEntityFlag()

int Dtk_Info::GetRefEntityFlag ( ) const

inherited

Retrieves the Flag for Reference Entity (Reference planes , axis, point.

Returns

1 if reference entity, 0 otherwise.

GetReferenceSet()

Dtk_ErrorStatus Dtk_Info::GetReferenceSet ( Dtk_tab< Dtk_string > &  outArray, Dtk_Int32  inRemovePrefix = DTK_FALSE  ) const

inherited

GetRenderInfos()

Dtk_RenderInfosPtr Dtk_Info::GetRenderInfos ( ) const

inherited

Retrieves the entity RenderInfos of the entity.

Returns

the Dtk_RenderInfosPtr or NULL if None.

See also

GetRenderInfos()

GetRenderInfosId()

Dtk_ID Dtk_Info::GetRenderInfosId ( ) const

inherited

Retrieves the Id of RenderInfos of the entity in The Dtk_API table.

Returns

the id or 0 if None.

See also

GetRenderInfosId()

GetSize()

virtual Dtk_Size_t Dtk_Info::GetSize ( ) const

virtualinherited

Reimplemented from Dtk_Object.

GetSubordFlag()

int Dtk_Info::GetSubordFlag ( ) const

inherited

GetUse()

int Dtk_Info::GetUse ( ) const

inherited

GetUuid()

Dtk_UUID Dtk_Info::GetUuid ( ) const

inherited

Retrieves the entity UniqueID if any.

GetViewId()

int Dtk_Info::GetViewId ( ) const

inherited

ListAllAttributes()

Dtk_ErrorStatus Dtk_Info::ListAllAttributes ( Dtk_tab< Dtk_string > &  tab_keys ) const

inherited

ListAllAttributesWithVal()

Dtk_ErrorStatus Dtk_Info::ListAllAttributesWithVal ( Dtk_tab< Dtk_pair< Dtk_string, Dtk_Val > > &  tab ) const

inherited

ListAllCustomerDefinedAttributesWithVal()

Dtk_ErrorStatus Dtk_Info::ListAllCustomerDefinedAttributesWithVal ( Dtk_tab< Dtk_pair< Dtk_string, Dtk_Val > > &  tab ) const

inherited

ListAttributes()

Dtk_ErrorStatus Dtk_Info::ListAttributes ( const Dtk_string &  substring, Dtk_tab< Dtk_string > &  tab_keys  ) const

inherited

RemoveAttribute()

Dtk_ErrorStatus Dtk_Info::RemoveAttribute ( const Dtk_string &  name )

inherited

SetActivationFlag()

Dtk_ErrorStatus Dtk_Info::SetActivationFlag ( const Dtk_Int32 &  inActivation )

inherited

SetActiveChildren()

Dtk_ErrorStatus Dtk_Info::SetActiveChildren ( const Dtk_tab< Dtk_Int32 > &  inIndices )

inherited

SetAddedItemFlag()

Dtk_ErrorStatus Dtk_Info::SetAddedItemFlag ( const Dtk_Int32 &  inAddedItem )

inherited

SetAdditionnalGeometryFlag()

Dtk_ErrorStatus Dtk_Info::SetAdditionnalGeometryFlag ( const Dtk_Int32 &  inAdditionnalGeom )

inherited

SetAsDeprecated()

Dtk_Info::SetAsDeprecated ( "v2026.2"  , "use GetMetaData() methods instead."    ) const &

inherited

Deprecated:

Use GetMetaData() const method instead.

SetBlankedStatus()

Dtk_ErrorStatus Dtk_Info::SetBlankedStatus ( const Dtk_Int32 &  inBlankedStatus )

inherited

SetBuildingInfosIds()

Dtk_ErrorStatus Dtk_Info::SetBuildingInfosIds ( const Dtk_tab< Dtk_Int32 >  inBuildingInfos )

inherited

SetColor() [1/2]

Dtk_ErrorStatus Dtk_Info::SetColor ( const Dtk_RGB &  inColor )

inherited

SetColor() [2/2]

Dtk_ErrorStatus Dtk_Info::SetColor ( const int &  R, const int &  G, const int &  B  )

inherited

SetColorId()

Dtk_ErrorStatus Dtk_Info::SetColorId ( const Dtk_Int32 &  inColorId )

inherited

SetConfigurationName()

Dtk_ErrorStatus Dtk_Info::SetConfigurationName ( const Dtk_string &  inName )

inherited

SetCurveLineType()

Dtk_ErrorStatus Dtk_Info::SetCurveLineType ( const Dtk_Int32 &  inCurveLineType )

inherited

Set line type of current object thanks to Dtk_FontLineType enumeration.

SetCurveLineTypeDefinitionId()

Dtk_ErrorStatus Dtk_Info::SetCurveLineTypeDefinitionId ( const Dtk_ID &  inLineTypeDefinitionId )

inherited

Set Dtk_LineTypeDefinition of current object via it's id in Dtk_API table.

SetCurveThickNess()

Dtk_ErrorStatus Dtk_Info::SetCurveThickNess ( const Dtk_Int32 &  inCurveThickNess )

inherited

SetCurveThickNessInMM()

Dtk_ErrorStatus Dtk_Info::SetCurveThickNessInMM ( const Dtk_Double64  inCurveThickNessInMM )

inherited

SetDefaultChildIndex()

Dtk_ErrorStatus Dtk_Info::SetDefaultChildIndex ( const Dtk_Int32 &  inIndex )

inherited

SetDisplayLineWidth()

Dtk_ErrorStatus Dtk_Info::SetDisplayLineWidth ( const Dtk_Double64 &  inDisplayLineWidth )

inherited

SetFlexibleFlag()

Dtk_ErrorStatus Dtk_Info::SetFlexibleFlag ( const Dtk_Int32 &  inIsFlexible )

inherited

SetFontId()

Dtk_ErrorStatus Dtk_Info::SetFontId ( const Dtk_Int32 &  inFontId )

inherited

SetFormFlag()

Dtk_ErrorStatus Dtk_Info::SetFormFlag ( const Dtk_Int32 &  inFormFlag )

inherited

SetHierarchy()

Dtk_ErrorStatus Dtk_Info::SetHierarchy ( const Dtk_Int32 &  inHierarchy )

inherited

SetHierarchyColorFlag()

Dtk_ErrorStatus Dtk_Info::SetHierarchyColorFlag ( const Dtk_Int32 &  inHierarchy )

inherited

SetId()

Dtk_ErrorStatus Dtk_Info::SetId ( const Dtk_Int32 &  inId )

inherited

SetInfiniteGeometryFlag()

Dtk_ErrorStatus Dtk_Info::SetInfiniteGeometryFlag ( const Dtk_Int32 &  inInfiniteGeometryFlag )

inherited

SetIsUpToDate()

void Dtk_Info::SetIsUpToDate ( const Dtk_bool  isUpToDate )

inherited

Set if current object is up to date or not.

Parameters

isUpToDate

DTK_TRUE if object is up to date, DTK_FALSE if not. Anything else will set state to unknown.

SetLayer()

Dtk_ErrorStatus Dtk_Info::SetLayer ( const Dtk_Int32 &  inLayer )

inherited

SetMandatoryFlag()

Dtk_ErrorStatus Dtk_Info::SetMandatoryFlag ( const enum MandatoryFlag &  inMandatoryFlag )

inherited

SetMatId()

Dtk_ErrorStatus Dtk_Info::SetMatId ( const Dtk_Int32 &  inMatId )

inherited

SetMetaData()

Dtk_ErrorStatus Dtk_Info::SetMetaData ( Dtk_tab< Dtk_MetaDataPtr > &  inArray )

inherited

SetName()

Dtk_ErrorStatus Dtk_Info::SetName ( Dtk_string  inName )

inherited

SetOccurrenceDataFlag()

Dtk_ErrorStatus Dtk_Info::SetOccurrenceDataFlag ( )

inherited

SetPersistentName()

Dtk_ErrorStatus Dtk_Info::SetPersistentName ( Dtk_string  inName )

inherited

SetPhysicalMaterialInfosId()

Dtk_ErrorStatus Dtk_Info::SetPhysicalMaterialInfosId ( const Dtk_ID &  inMaterialId )

inherited

SetPointSymbolType()

Dtk_ErrorStatus Dtk_Info::SetPointSymbolType ( const Dtk_PointType  inPointSymbolType )

inherited

SetRefEntityFlag()

Dtk_ErrorStatus Dtk_Info::SetRefEntityFlag ( const Dtk_Int32 &  inRefEntityFlag )

inherited

SetRenderInfosId()

Dtk_ErrorStatus Dtk_Info::SetRenderInfosId ( const Dtk_ID &  inRenderId )

inherited

SetSubordFlag()

Dtk_ErrorStatus Dtk_Info::SetSubordFlag ( const Dtk_Int32 &  inSubordFlag )

inherited

SetUse()

Dtk_ErrorStatus Dtk_Info::SetUse ( const Dtk_Int32 &  inUse )

inherited

SetUuid()

Dtk_ErrorStatus Dtk_Info::SetUuid ( const Dtk_UUID &  inUuid )

inherited

SetViewId()

Dtk_ErrorStatus Dtk_Info::SetViewId ( const Dtk_Int32 &  inViewId )

inherited

Field Documentation

_Material

Dtk_MaterialPtr Dtk_Info::_Material

protectedinherited

_Private

Dtk_Handle* Dtk_StoredInfo::_Private

protected

count_

unsigned long Dtk_Object::count_

protectedinherited