C3D Toolkit  Kernel - 117982, Vision - 2.9.2.2
ItModelInstance Class Referenceabstract

Interface of the component instance. More...

#include <conv_model_document.h>

+ Inheritance diagram for ItModelInstance:
+ Collaboration diagram for ItModelInstance:

Public Member Functions

virtual bool GetPlacement (MbPlacement3D &) const =0
 Get the placement of this instance in parent's coordinates.
 
virtual bool IsAssembly () const =0
 Is it an assembly?
 
virtual bool IsEmpty () const =0
 Is it neither an assembly nor a part?
 
virtual ModelAssemblyPtr CreateAssembly (const MbPlacement3D &place, const c3d::ItemsSPtrVector &componentItems, const c3d::string_t &fileName)=0
 Create an empty assembly while importing and increase the reference counter by 1.
More...
 
virtual ModelPartPtr CreatePart (const MbPlacement3D &place, const c3d::ItemsSPtrVector &componentItems, const c3d::string_t &fileName)=0
 Create a part while importing. More...
 
virtual ModelAssemblyPtr GetInstanceAssembly ()=0
 Get an assembly for export. More...
 
virtual ModelPartPtr GetInstancePart ()=0
 Get the detail for export. More...
 
virtual bool SetAssembly (const MbPlacement3D &place, const ItModelAssembly *existing)=0
 Create a subassembly and its instance while importing. More...
 
virtual bool SetPart (const MbPlacement3D &place, const ItModelPart *existing)=0
 Create a part while importing and its instance. More...
 
- Public Member Functions inherited from ItModelInstanceProperties
virtual bool SetAttributes (const c3d::AttrSPtrVector &)=0
 Attributes. More...
 
virtual c3d::AttrSPtrVector GetAttributes () const =0
 Get attributes.
 
virtual void GetRequirements (AnnotationSptrVector &, eTextForm) const =0
 Technical requirements. More...
 
virtual void SetRequirements (const AnnotationSptrVector &)=0
 Set technical requirements.
 
- Public Member Functions inherited from MbRefItem
virtual MbeRefType RefType () const
 Registration type (for copying, duplication).
 
refcount_t GetUseCount () const
 Get count of references (get count of owners of an object).
 
refcount_t AddRef () const
 Increase count of references by one.
 
refcount_t DecRef () const
 Decrease count of references by one.
 
refcount_t Release () const
 Decrease count of references by one and if count of references became zero, then remove itself.
 

Additional Inherited Members

- Protected Member Functions inherited from MbRefItem
 MbRefItem ()
 Constructor without parameters.
 

Detailed Description

Interface of the component instance.

Member Function Documentation

◆ CreateAssembly()

virtual ModelAssemblyPtr ItModelInstance::CreateAssembly ( const MbPlacement3D place,
const c3d::ItemsSPtrVector &  componentItems,
const c3d::string_t fileName 
)
pure virtual

Create an empty assembly while importing and increase the reference counter by 1.

Parameters
[in]place- LCS of the assembly in the parent's model.
[in]fileName- Assembly name.
Returns
Instance of an assembly if the operation succeeded, nullptr - otherwise.

◆ CreatePart()

virtual ModelPartPtr ItModelInstance::CreatePart ( const MbPlacement3D place,
const c3d::ItemsSPtrVector &  componentItems,
const c3d::string_t fileName 
)
pure virtual

Create a part while importing.

Increase the reference counter of a part by 1.

Parameters
[in]place- LCS of a part.
[in]solids- Solids included in the part.
[in]fileName- Solid's name.
Returns
Instance of the part if the operation succeeded, nullptr - otherwise.

◆ GetInstanceAssembly()

virtual ModelAssemblyPtr ItModelInstance::GetInstanceAssembly ( )
pure virtual

Get an assembly for export.

Returns
Instance of an assembly if the operation succeeded, nullptr - otherwise.

◆ GetInstancePart()

virtual ModelPartPtr ItModelInstance::GetInstancePart ( )
pure virtual

Get the detail for export.

Returns
Instance of the part if the operation succeeded, nullptr - otherwise.

◆ SetAssembly()

virtual bool ItModelInstance::SetAssembly ( const MbPlacement3D place,
const ItModelAssembly existing 
)
pure virtual

Create a subassembly and its instance while importing.

Parameters
[in]place- LCS of the assembly in the parent's model.
[in]existing- An assembly to insert.
Returns
true if the operation succeeded, false - otherwise.

◆ SetPart()

virtual bool ItModelInstance::SetPart ( const MbPlacement3D place,
const ItModelPart existing 
)
pure virtual

Create a part while importing and its instance.

Parameters
[in]place- LCS of a part in the parent's model.
[in]existing- Detail to insert.
Returns
true if the operation succeeded, false - otherwise.

The documentation for this class was generated from the following file: