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

Interface of the assembly. More...

#include <conv_model_document.h>

+ Inheritance diagram for ItModelAssembly:
+ Collaboration diagram for ItModelAssembly:

Public Member Functions

virtual c3d::path_string PureFileName () const =0
 Get the file name of an assembly without the path and the extension for export. More...
 
virtual ModelInstancePtr PrepareInstance ()=0
 Get an empty interface of the insertion for creation of subassembly or a part while importing. More...
 
virtual ModelInstancePtr NextInstance (bool includeInvisible)=0
 Get the interface of the next insertion for creation of a subassembly or a part while exporting. More...
 
virtual bool GetPlacement (MbPlacement3D &) const
 Get the placement, which all the items of the component use for transformation.
 
virtual void GetItems (c3d::ItemsSPtrVector &items, MbeGettingItemType itemType, bool includeInvisible) const =0
 Get objects from the assembly root while exporting. More...
 
virtual void AddItems (const c3d::ItemsSPtrVector &items)=0
 Add objects to the assembly root while importing. More...
 
virtual AnnotationSptrVector GetAnnotationItems (eTextForm, bool) const
 Get elements of annotation from the assembly. More...
 
virtual void SetAnnotationItems (const AnnotationSptrVector &)=0
 Set elements of annotation in the assembly. 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 assembly.

The object should be created in the CreateAssembly method of the implementations of the ItModelDocument and ItModelInstance interfaces. Own Items of the detail should be arguments of the constructor.

Member Function Documentation

◆ PureFileName()

virtual c3d::path_string ItModelAssembly::PureFileName ( ) const
pure virtual

Get the file name of an assembly without the path and the extension for export.

Returns
An assembly file name.

◆ PrepareInstance()

virtual ModelInstancePtr ItModelAssembly::PrepareInstance ( )
pure virtual

Get an empty interface of the insertion for creation of subassembly or a part while importing.

Increase the reference counter by 1.

Returns
Interface of the instance if the operation succeeded and nullptr otherwise.

◆ NextInstance()

virtual ModelInstancePtr ItModelAssembly::NextInstance ( bool  includeInvisible)
pure virtual

Get the interface of the next insertion for creation of a subassembly or a part while exporting.

Returns
Interface of the insertion if the operation succeeded and nullptr otherwise.

◆ GetItems()

virtual void ItModelAssembly::GetItems ( c3d::ItemsSPtrVector &  items,
MbeGettingItemType  itemType,
bool  includeInvisible 
) const
pure virtual

Get objects from the assembly root while exporting.

Parameters
[out]items- Array to fill (consist of objects of classes MbSolid, MbCurve3D, MbCartPoint3D).
[in]includeInvisible- If true, then all the solids are returned, including invisible ones, if false - only visible ones.

◆ AddItems()

virtual void ItModelAssembly::AddItems ( const c3d::ItemsSPtrVector &  items)
pure virtual

Add objects to the assembly root while importing.

Parameters
[in]items- Objects to add to the model (solids, curves and points).

◆ GetAnnotationItems()

virtual AnnotationSptrVector ItModelAssembly::GetAnnotationItems ( eTextForm  ,
bool   
) const
inlinevirtual

Get elements of annotation from the assembly.

Parameters
[in]eTextForm- Text representation form.
[in]includeInvisible- If true, all the annotation objects are returned, including invisible ones, if false - only visible ones.
Returns
Vector of annotation objects.

◆ SetAnnotationItems()

virtual void ItModelAssembly::SetAnnotationItems ( const AnnotationSptrVector &  )
pure virtual

Set elements of annotation in the assembly.

Parameters
[in]sourceDim- Elements of annotation.

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