This is the generic Info class. More...
Inheritance diagram for Dtk_Info:Public Types | |
| enum | MandatoryFlag { NotMandatory = 0, XYPlane, YZPlane, ZXPlane, OriginPoint } |
Static Public Member Functions | |
| 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_SmartPtr< Dtk_Info > | create (Dtk_Info &&in) |
| Calls move constructor to allocate a new object. More... | |
| static Dtk_Info * | DtkDynamicCast (Dtk_Object *s) |
Protected Types | |
| enum | { _typeID = DTK_TYPE_INFO } |
Protected Member Functions | |
| void | _copy (const Dtk_Info &s) |
| void | _init () |
| void | _reset () |
| virtual Dtk_Object * | Clone () |
| Dtk_Info () | |
| Dtk_Info (const Dtk_Info &s) | |
| Dtk_Info (Dtk_Info &&s) DTK_NOEXCEPT | |
Protected Attributes | |
| Dtk_MaterialPtr | _Material |
| Dtk_Handle * | _Private |
| unsigned long | count_ |
This is the generic Info class.
This class provides informations about Color/Layer/BlankedStatus/Name etc... This class also provides additionnal information specific to the owning entity
|
protected |
|
protected |
|
protected |
| Dtk_Info::~Dtk_Info | ( | ) |
|
protected |
|
protected |
|
protected |
|
virtual |
| Dtk_ErrorStatus Dtk_Info::AddAttribute | ( | Dtk_string | name, |
| Dtk_Val | val | ||
| ) |
| Dtk_ErrorStatus Dtk_Info::AddCurveLineTypeDefinition | ( | const Dtk_LineTypeDefinitionPtr & | inLineTypeDefinition | ) |
Add a Dtk_LineTypeDefinition to Dtk_API and set it to current object.
| Dtk_ErrorStatus Dtk_Info::AddCustomerDefinedAttribute | ( | Dtk_string | name, |
| Dtk_Val | val | ||
| ) |
| Dtk_ErrorStatus Dtk_Info::AddLayer | ( | const Dtk_Int32 & | inLayer | ) |
| Dtk_ErrorStatus Dtk_Info::AddMaterial | ( | const Dtk_MaterialPtr & | inMaterial | ) |
| Dtk_ErrorStatus Dtk_Info::AddPhysicalMaterialInfos | ( | const Dtk_PhysicalMaterialInfosPtr & | inMaterial | ) |
| Dtk_ErrorStatus Dtk_Info::AddRenderInfos | ( | const Dtk_RenderInfosPtr & | inRender | ) |
|
protectedvirtual |
Reimplemented in Dtk_StoredInfo.
|
static |
Calls default constructor to allocate a new object.
|
static |
Calls copy constructor to allocate a new object.
| in | Object to copy from. |
|
static |
Calls move constructor to allocate a new object.
| in | Object to move from. |
|
static |
| int Dtk_Info::DtkDynamicType | ( | const Dtk_Int32 & | 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.
|
virtualinherited |
| Dtk_Val const* Dtk_Info::FindAttribute | ( | const Dtk_string & | name | ) | const |
| Dtk_ErrorStatus Dtk_Info::FindAttribute | ( | const Dtk_string & | name, |
| Dtk_Val & | val | ||
| ) | const |
| int Dtk_Info::GetActivationFlag | ( | ) | const |
| int Dtk_Info::GetAddedItemFlag | ( | ) | const |
| int Dtk_Info::GetAdditionnalGeometryFlag | ( | ) | const |
| int Dtk_Info::GetBlankedStatus | ( | ) | const |
Retrieves the entity Blanked Status.
| Dtk_RGB Dtk_Info::GetColor | ( | ) | const |
Retrieves the entity color as Dtk_RGBA values.
Sample:
| int Dtk_Info::GetColorId | ( | ) | const |
| Dtk_string Dtk_Info::GetConfigurationName | ( | ) | const |
| Dtk_FontLineType Dtk_Info::GetCurveLineType | ( | ) | const |
Retrieves the curve LineType - for curve entities -.
| Dtk_LineTypeDefinitionPtr Dtk_Info::GetCurveLineTypeDefinition | ( | ) | const |
Retrieves the definition of the curve LineType - for curve entities -.
Returns null pointer if not set.
| Dtk_ID Dtk_Info::GetCurveLineTypeDefinitionId | ( | ) | const |
Retrieves the Id of Dtk_LineTypeDefinition of the entity in The Dtk_API table.
| int Dtk_Info::GetCurveThickNess | ( | ) | const |
| Dtk_Double64 Dtk_Info::GetCurveThickNessInMM | ( | ) | const |
Retrieves the curve thickness - if exists and relevant -.
| int Dtk_Info::GetDefaultChildIndex | ( | ) | const |
| int Dtk_Info::GetFlexibleFlag | ( | ) | const |
| int Dtk_Info::GetFontId | ( | ) | const |
| int Dtk_Info::GetFormFlag | ( | ) | const |
| int Dtk_Info::GetHierarchy | ( | ) | const |
| int Dtk_Info::GetHierarchyColorFlag | ( | ) | const |
| int Dtk_Info::GetId | ( | ) | const |
| int Dtk_Info::GetInfiniteGeometryFlag | ( | ) | const |
| Dtk_bool Dtk_Info::GetIsUpToDate | ( | ) | const |
Retrieves up to date state of current object.
| int Dtk_Info::GetLayer | ( | ) | const |
Retrieves the entity layer.
Retrieves the layers in which the entity is assigned.
| enum MandatoryFlag Dtk_Info::GetMandatoryFlag | ( | ) | const |
Retrieves the Mandatory Flag.
| Dtk_MaterialPtr Dtk_Info::GetMaterial | ( | ) | const |
| int Dtk_Info::GetMatId | ( | ) | const |
| Dtk_ErrorStatus Dtk_Info::GetMetaData | ( | Dtk_tab< Dtk_MetaDataPtr > & | outArray | ) | const |
| Dtk_string Dtk_Info::GetName | ( | ) | const |
Retrieves the entity name.
| Dtk_string Dtk_Info::GetPersistentName | ( | ) | const |
| Dtk_PhysicalMaterialInfosPtr Dtk_Info::GetPhysicalMaterialInfos | ( | ) | const |
Retrieves the entity MaterialInfos.
| Dtk_ID Dtk_Info::GetPhysicalMaterialInfosId | ( | ) | const |
Retrieves the Id of MaterialInfos of the entity in The Dtk_API table.
| Dtk_PointType Dtk_Info::GetPointSymbolType | ( | ) | const |
Retrieves the Symbol Type - for point only -.
| Dtk_ErrorStatus Dtk_Info::GetProperties | ( | Dtk_tab< Dtk_PropertiesPtr > & | outArray | ) | const |
| int Dtk_Info::GetRefEntityFlag | ( | ) | const |
| Dtk_ErrorStatus Dtk_Info::GetReferenceSet | ( | Dtk_tab< Dtk_string > & | outArray, |
| Dtk_Int32 | inRemovePrefix = DTK_FALSE |
||
| ) | const |
| Dtk_RenderInfosPtr Dtk_Info::GetRenderInfos | ( | ) | const |
Retrieves the entity RenderInfos of the entity.
| Dtk_ID Dtk_Info::GetRenderInfosId | ( | ) | const |
Retrieves the Id of RenderInfos of the entity in The Dtk_API table.
|
virtual |
Reimplemented from Dtk_Object.
| int Dtk_Info::GetSubordFlag | ( | ) | const |
| int Dtk_Info::GetUse | ( | ) | const |
| Dtk_UUID Dtk_Info::GetUuid | ( | ) | const |
| int Dtk_Info::GetViewId | ( | ) | const |
| Dtk_ErrorStatus Dtk_Info::ListAllAttributes | ( | Dtk_tab< Dtk_string > & | tab_keys | ) | const |
| Dtk_ErrorStatus Dtk_Info::ListAllAttributesWithVal | ( | Dtk_tab< Dtk_pair< Dtk_string, Dtk_Val > > & | tab | ) | const |
| Dtk_ErrorStatus Dtk_Info::ListAllCustomerDefinedAttributesWithVal | ( | Dtk_tab< Dtk_pair< Dtk_string, Dtk_Val > > & | tab | ) | const |
| Dtk_ErrorStatus Dtk_Info::ListAttributes | ( | const Dtk_string & | substring, |
| Dtk_tab< Dtk_string > & | tab_keys | ||
| ) | const |
| Dtk_ErrorStatus Dtk_Info::RemoveAttribute | ( | const Dtk_string & | name | ) |
| Dtk_ErrorStatus Dtk_Info::SetActivationFlag | ( | const Dtk_Int32 & | inActivation | ) |
| Dtk_ErrorStatus Dtk_Info::SetActiveChildren | ( | const Dtk_tab< Dtk_Int32 > & | inIndices | ) |
| Dtk_ErrorStatus Dtk_Info::SetAddedItemFlag | ( | const Dtk_Int32 & | inAddedItem | ) |
| Dtk_ErrorStatus Dtk_Info::SetAdditionnalGeometryFlag | ( | const Dtk_Int32 & | inAdditionnalGeom | ) |
| Dtk_ErrorStatus Dtk_Info::SetBlankedStatus | ( | const Dtk_Int32 & | inBlankedStatus | ) |
| Dtk_ErrorStatus Dtk_Info::SetBuildingInfosIds | ( | const Dtk_tab< Dtk_Int32 > | inBuildingInfos | ) |
| Dtk_ErrorStatus Dtk_Info::SetColor | ( | const Dtk_RGB & | inColor | ) |
| Dtk_ErrorStatus Dtk_Info::SetColor | ( | const int & | R, |
| const int & | G, | ||
| const int & | B | ||
| ) |
| Dtk_ErrorStatus Dtk_Info::SetColorId | ( | const Dtk_Int32 & | inColorId | ) |
| Dtk_ErrorStatus Dtk_Info::SetConfigurationName | ( | const Dtk_string & | inName | ) |
| Dtk_ErrorStatus Dtk_Info::SetCurveLineType | ( | const Dtk_Int32 & | inCurveLineType | ) |
Set line type of current object thanks to Dtk_FontLineType enumeration.
| Dtk_ErrorStatus Dtk_Info::SetCurveLineTypeDefinitionId | ( | const Dtk_ID & | inLineTypeDefinitionId | ) |
Set Dtk_LineTypeDefinition of current object via it's id in Dtk_API table.
| Dtk_ErrorStatus Dtk_Info::SetCurveThickNess | ( | const Dtk_Int32 & | inCurveThickNess | ) |
| Dtk_ErrorStatus Dtk_Info::SetCurveThickNessInMM | ( | const Dtk_Double64 | inCurveThickNessInMM | ) |
| Dtk_ErrorStatus Dtk_Info::SetDefaultChildIndex | ( | const Dtk_Int32 & | inIndex | ) |
| Dtk_ErrorStatus Dtk_Info::SetFlexibleFlag | ( | const Dtk_Int32 & | inIsFlexible | ) |
| Dtk_ErrorStatus Dtk_Info::SetFontId | ( | const Dtk_Int32 & | inFontId | ) |
| Dtk_ErrorStatus Dtk_Info::SetFormFlag | ( | const Dtk_Int32 & | inFormFlag | ) |
| Dtk_ErrorStatus Dtk_Info::SetHierarchy | ( | const Dtk_Int32 & | inHierarchy | ) |
| Dtk_ErrorStatus Dtk_Info::SetHierarchyColorFlag | ( | const Dtk_Int32 & | inHierarchy | ) |
| Dtk_ErrorStatus Dtk_Info::SetId | ( | const Dtk_Int32 & | inId | ) |
| Dtk_ErrorStatus Dtk_Info::SetInfiniteGeometryFlag | ( | const Dtk_Int32 & | inInfiniteGeometryFlag | ) |
| void Dtk_Info::SetIsUpToDate | ( | const Dtk_bool | isUpToDate | ) |
Set if current object is up to date or not.
| isUpToDate | DTK_TRUE if object is up to date, DTK_FALSE if not. Anything else will set state to unknown. |
| Dtk_ErrorStatus Dtk_Info::SetLayer | ( | const Dtk_Int32 & | inLayer | ) |
| Dtk_ErrorStatus Dtk_Info::SetMandatoryFlag | ( | const enum MandatoryFlag & | inMandatoryFlag | ) |
| Dtk_ErrorStatus Dtk_Info::SetMatId | ( | const Dtk_Int32 & | inMatId | ) |
| Dtk_ErrorStatus Dtk_Info::SetMetaData | ( | Dtk_tab< Dtk_MetaDataPtr > & | inArray | ) |
| Dtk_ErrorStatus Dtk_Info::SetName | ( | Dtk_string | inName | ) |
| Dtk_ErrorStatus Dtk_Info::SetPersistentName | ( | Dtk_string | inName | ) |
| Dtk_ErrorStatus Dtk_Info::SetPhysicalMaterialInfosId | ( | const Dtk_ID & | inMaterialId | ) |
| Dtk_ErrorStatus Dtk_Info::SetPointSymbolType | ( | const Dtk_PointType | inPointSymbolType | ) |
| Dtk_ErrorStatus Dtk_Info::SetRefEntityFlag | ( | const Dtk_Int32 & | inRefEntityFlag | ) |
| Dtk_ErrorStatus Dtk_Info::SetRenderInfosId | ( | const Dtk_ID & | inRenderId | ) |
| Dtk_ErrorStatus Dtk_Info::SetSubordFlag | ( | const Dtk_Int32 & | inSubordFlag | ) |
| Dtk_ErrorStatus Dtk_Info::SetUse | ( | const Dtk_Int32 & | inUse | ) |
| Dtk_ErrorStatus Dtk_Info::SetUuid | ( | const Dtk_UUID & | inUuid | ) |
| Dtk_ErrorStatus Dtk_Info::SetViewId | ( | const Dtk_Int32 & | inViewId | ) |
|
protected |
|
protected |
|
protectedinherited |