C3D Toolkit  Kernel - 117926, Vision - 2.7.0.28

Implementation of model document which has regular structure. More...

#include <conv_model_document.h>

+ Inheritance diagram for C3dModelDocument:
+ Collaboration diagram for C3dModelDocument:

Public Member Functions

 C3dModelDocument (SPtr< C3DPmiToItem > pmiToContent=SPtr< C3DPmiToItem >())
 Conscructor.
 
virtual ~C3dModelDocument ()
 Descructor.
 
virtual bool IsAssembly () const
 Is it an assembly?
 
virtual bool IsEmpty () const
 Is it neither an assembly nor a part?
 
virtual void SetContent (MbItem *)
 Prototype of a new interface function - get the placement the model is defined in. More...
 
virtual MbItemGetContent ()
 Prototype of a new interface function - get the filling.
 
virtual ModelAssemblyPtr CreateAssembly (const c3d::ItemsSPtrVector &componentItems, const c3d::string_t &fileName)
 Create a document with a new assembly while importing. More...
 
virtual ModelPartPtr CreatePart (const c3d::ItemsSPtrVector &componentItems, const c3d::string_t &fileName)
 Create a document with a new part while importing. More...
 
virtual ModelAssemblyPtr GetInstanceAssembly ()
 Get an assembly for export. More...
 
virtual ModelPartPtr GetInstancePart ()
 Get the detail for export. More...
 
virtual bool FinishImport (IProgressIndicator *)
 Complete the import and save the document. More...
 
virtual map_of_visual_items GetAnnotationItems (eTextForm) const
 Get elements of annotation, corresponding items of geometric model. More...
 
virtual void SetAnnotationItems (const map_of_visual_items &vi)
 Set sizes.
 
virtual void OpenDocument ()
 Open a document.

 
SPtr< C3DPmiToItemPmiInContent () const
 If PMI is included into model item.
 
void RegisterAnnotation (c3d::ItemSPtr component, const AnnotationSptrVector &annotation, const AnnotationSptrVector &requirements)
 Register annotation object.
 
- 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

Implementation of model document which has regular structure.

Member Function Documentation

◆ SetContent()

virtual void C3dModelDocument::SetContent ( MbItem )
virtual

Prototype of a new interface function - get the placement the model is defined in.

Prototype of a new interface function - set a model to fill.

Implements ItModelDocument.

◆ CreateAssembly()

virtual ModelAssemblyPtr C3dModelDocument::CreateAssembly ( const c3d::ItemsSPtrVector &  componentItems,
const c3d::string_t fileName 
)
virtual

Create a document with a new assembly while importing.

Increase the reference counter of the resultant document by 1.

Parameters
[in]fileName- Assembly name.
[in]solids- Solids to add into the assembly.
Returns
Instance of an assembly if the operation succeeded, nullptr - otherwise.

Implements ItModelDocument.

◆ CreatePart()

virtual ModelPartPtr C3dModelDocument::CreatePart ( const c3d::ItemsSPtrVector &  componentItems,
const c3d::string_t fileName 
)
virtual

Create a document with a new part while importing.

Increase the reference counter of the resultant document by 1.

Parameters
[in]solids- Solids to add into a part.
[in]fileName- A part name.
Returns
Instance of the part if the operation succeeded, nullptr - otherwise.

Implements ItModelDocument.

◆ GetInstanceAssembly()

virtual ModelAssemblyPtr C3dModelDocument::GetInstanceAssembly ( )
virtual

Get an assembly for export.

Increase the reference counter of the resultant assembly by 1.

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

Implements ItModelDocument.

◆ GetInstancePart()

virtual ModelPartPtr C3dModelDocument::GetInstancePart ( )
virtual

Get the detail for export.

Increase the reference counter of the resultant part by 1.

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

Implements ItModelDocument.

◆ FinishImport()

virtual bool C3dModelDocument::FinishImport ( IProgressIndicator indicator)
virtual

Complete the import and save the document.

Returns
true if the operation succeeded, false - otherwise.
Parameters
[in]indicatorAn object indicating a process progress.

Implements ItModelDocument.

◆ GetAnnotationItems()

virtual map_of_visual_items C3dModelDocument::GetAnnotationItems ( eTextForm  ) const
virtual

Get elements of annotation, corresponding items of geometric model.

Parameters
[in]eTextForm- Text representation form.
Returns
Vector of annotation objects.

Implements ItModelDocument.


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