CAD Exchanger SDK
cadex::ModelData_Instance Class Reference

Defines an occurrence of assembly or part in a scene graph. More...

Inheritance diagram for cadex::ModelData_Instance:
cadex::ModelData_SceneGraphElement cadex::ModelData_BaseObject

Public Types

typedef cadex::internal::ModelData_InstanceImpl ImplType
 
- Public Types inherited from cadex::ModelData_SceneGraphElement
typedef cadex::internal::ModelData_SceneGraphElementImpl ImplType
 
- Public Types inherited from cadex::ModelData_BaseObject
typedef int IdType
 Defines a type identifier.
 

Public Member Functions

 ModelData_Instance ()
 
 ModelData_Instance (initialized)
 
 ModelData_Instance (ImplType *theImpl)
 
 ModelData_Instance (const Base_UTF16String &theName)
 
 ModelData_Instance (const ModelData_SceneGraphElement &theElement, const Base_UTF16String &theName=Base_UTF16String())
 
 ModelData_Instance (const ModelData_SceneGraphElement &theElement, const ModelData_Transformation &theTrsf, const Base_UTF16String &theName=Base_UTF16String())
 
void SetReference (const ModelData_SceneGraphElement &theElement)
 Sets a referenced object. More...
 
ModelData_SceneGraphElement Reference () const
 Returns the referenced object. More...
 
void SetTransformation (const ModelData_Transformation &theTrsf)
 Sets transformation matrix.
 
bool HasTransformation () const
 Returns true if the instance has an explicitly attached transformation matrix. More...
 
const ModelData_TransformationTransformation () const
 Returns the transformation matrix. More...
 
- Public Member Functions inherited from cadex::ModelData_SceneGraphElement
 ModelData_SceneGraphElement ()
 Constructor. More...
 
void SetAppearance (const ModelData_Appearance &theAppearance)
 
ModelData_Appearance Appearance () const
 
void AddProperties (const ModelData_PropertyTable &theProperties)
 Adds a property table to the element. More...
 
ModelData_PropertyTable Properties () const
 Returns a property table.
 
void AddPMI (const ModelData_PMITable &thePMI)
 Adds a PMI table to the element. More...
 
ModelData_PMITable PMI () const
 Returns a PMI table.
 
void AddToLayer (const ModelData_Layer &theLayer)
 Adds element to layer.
 
void Accept (ModelData_Model::ElementVisitor &theVisitor) const
 Accepts an element visitor. More...
 
- Public Member Functions inherited from cadex::ModelData_BaseObject
 ModelData_BaseObject ()
 Constructor. More...
 
IdType TypeId () const
 Returns an object type id. More...
 
template<typename T >
bool IsOfType () const
 Returns true if the object has a type T. More...
 
void SetName (const Base_UTF16String &theName)
 Sets an object name. More...
 
Base_UTF16String Name () const
 Returns an object name. More...
 
void Nullify ()
 Resets reference to implementation object. More...
 
bool IsNull () const
 Returns true if the object is nullified. More...
 
 operator bool () const
 Casts the object to the bool type. More...
 
internal::ModelData_BaseObjectImpl * Impl () const
 Return a handle to backend (reserved for internal use).
 

Static Public Member Functions

static IdType GetTypeId ()
 

Additional Inherited Members

- Protected Member Functions inherited from cadex::ModelData_SceneGraphElement
 ModelData_SceneGraphElement (const internal::ModelData_BaseObjectImpl *theImpl)
 Constructor (reserved for internal use).
 
 ModelData_SceneGraphElement (const internal::ModelData_BaseObjectImpl *theImpl, const Base_UTF16String &theName)
 Constructor (reserved for internal use).
 
- Protected Member Functions inherited from cadex::ModelData_BaseObject
 ModelData_BaseObject (const internal::ModelData_BaseObjectImpl *theImpl)
 Constructor (reserved for internal use).
 
 ModelData_BaseObject (const internal::ModelData_BaseObjectImpl *theImpl, const Base_UTF16String &theName)
 Constructor (reserved for internal use).
 
template<typename T >
T * GetOrCreateImpl ()
 Reserved for internal use.
 

Detailed Description

Defines an occurrence of assembly or part in a scene graph.

Instance contains a reference to another element part or assembly and is used to share data, e.g. two instances can share the same part adding own transformations.

Examples:
exploring/bom/main.cxx, exploring/layers/main.cxx, exploring/transformations/main.cxx, modeling/assembly/main.cxx, and visualization/qtquick_qml/selectionhandling/main.cxx.

Constructor & Destructor Documentation

◆ ModelData_Instance()

cadex::ModelData_Instance::ModelData_Instance ( )

If theToInitialize is false then creates a null object (see IsNull()).

Member Function Documentation

◆ HasTransformation()

bool cadex::ModelData_Instance::HasTransformation ( ) const

Returns true if the instance has an explicitly attached transformation matrix.

Returns true if the matrix has been assigned with SetTransformation() and false otherwise.

See also
SetTransformation(), Transformation().
Examples:
exploring/transformations/main.cxx.

◆ Reference()

ModelData_SceneGraphElement cadex::ModelData_Instance::Reference ( ) const

Returns the referenced object.

Returns null if the instance does not refer to any object.

See also
SetReference().

◆ SetReference()

void cadex::ModelData_Instance::SetReference ( const ModelData_SceneGraphElement theElement)

Sets a referenced object.

Warning
There must be no cyclic references between theElement and this instance as otherwise there will be memory leaks and infinite loop when visiting the scene graph.

◆ Transformation()

const ModelData_Transformation & cadex::ModelData_Instance::Transformation ( ) const

Returns the transformation matrix.

If the matrix has not been explicitly assigned with SetTransformation() then creates and explicitly assigns an identity matrix.

See also
HasTransformation(), SetTransformation().
Examples:
exploring/transformations/main.cxx.