C3D Toolkit  Kernel - 117982, Vision - 2.9.2.2

A data for constructing a set of sections and cutaways of shells. More...

#include <map_section.h>

+ Collaboration diagram for MbSectionMap:

Public Member Functions

 MbSectionMap ()
 Constructor of an empty object.
 
 ~MbSectionMap ()
 Destructor.
 
void ReserveShell (size_t count)
 Reserve a place for shells. More...
 
void AddShell (MbFaceShell *secShell)
 Add a shell. More...
 
bool IsEmpty () const
 Whether the object is empty. More...
 
void SetIndex (ptrdiff_t i)
 Set an index. More...
 
void GetContoursArray (PArray< MbContour > &arCont) const
 Get the array of contours. More...
 
ptrdiff_t GetIndex () const
 Get the current index.
 
MbVEFVestigesGetSectionMap ()
 Mapping. More...
 
PArray< MbCompContourArray > & GetSectionBounds ()
 Disordered set of contours.
 
void SetEmpty ()
 Clean a section view. More...
 
void SetMessage (MbResultType &type)
 Set a result code. More...
 
MbResultType GetMessage () const
 Get the result code. More...
 
void Transform (const MbMatrix &matr)
 Transform. More...
 
template<class Shells >
void DetachShellArray (Shells &shells)
 Detach the array of shells. More...
 
const RPArray< MbFaceShell > & GetShellArray () const
 Get the array of shells.
 
void SetAnnObjectStore (ItAnnObjectStore *objStore)
 Set a storage. More...
 
ItAnnObjectStoreGetAnnObjectStore () const
 Get the storage of annotation objects.
 
RPArray< MbSymbol > * GetSymbolObjects () const
 Get conventional notations. More...
 
void SetSymbolObjects (RPArray< MbSymbol > &arInit)
 Add conventional notations. More...
 
ItSymbolObjectStoreGetSymbolObjectStore () const
 Get the storage of conventional notations.
 
void SetSymbolObjectStore (ItSymbolObjectStore *objStore)
 Set a storage. More...
 
void SetSpacePoints (RPArray< MbSpacePoints > &points)
 Add spatial points. More...
 
void SetSpaceCurves (RPArray< MbSpaceCurves > &curves)
 Add spatial curves. More...
 
bool IsSpacePoints () const
 Whether any point is in the object. More...
 
bool IsSpaceCurves () const
 Whether any curve is in an object. More...
 
const RPArray< MbSpacePoints > * GetSpacePoints () const
 Get spatial points.
 
const RPArray< MbSpaceCurves > * GetSpaceCurves () const
 Get spatial curves.
 

Protected Attributes

MbVEFVestigessecMap
 Mapping. A set of vestiges.
 
PArray< MbCompContourArraysecBounds
 Disordered set of cutting contours.
 
ptrdiff_t secIndex
 A current index.
 
MbResultType secMessage
 A result of the construction.
 
RPArray< MbFaceShellsecShells
 Mapped shells (trimmed). Fill in the end of construction.
 
ItAnnObjectStoreannObjStore
 A storage of annotation objects.
 
RPArray< MbSymbol > * symbolObjects
 Conventional notations.
 
ItSymbolObjectStoresymbolObjStore
 A set of conventional notations.
 
RPArray< MbSpacePoints > * pointsData
 Spatial points.
 
RPArray< MbSpaceCurves > * curvesData
 Spatial curves.
 

Detailed Description

A data for constructing a set of sections and cutaways of shells.

A data for constructing a set of sections and cutaways of shells.

Member Function Documentation

◆ ReserveShell()

void MbSectionMap::ReserveShell ( size_t  count)

Reserve a place for shells.

Reserve a place for mapping shells.

Parameters
[in]count- A number of places for reservation.

◆ AddShell()

void MbSectionMap::AddShell ( MbFaceShell secShell)
inline

Add a shell.

Add a shell into the set of shells.
A shell is added even if it is equal to nullptr.
If a shell isn't null it is captured.

Parameters
[in]secShell- A shell.

◆ IsEmpty()

bool MbSectionMap::IsEmpty ( ) const

Whether the object is empty.

Whether the object is empty.

Returns
returns true if the object doesn't contain shells, contours and mapping vestiges.

◆ SetIndex()

void MbSectionMap::SetIndex ( ptrdiff_t  i)
inline

Set an index.

Set an index.

Parameters
[in]i- New index value.

◆ GetContoursArray()

void MbSectionMap::GetContoursArray ( PArray< MbContour > &  arCont) const

Get the array of contours.

Add contours of all sets into a given array.

Parameters
[out]arCont- A set of contours.

◆ GetSectionMap()

MbVEFVestiges& MbSectionMap::GetSectionMap ( )
inline

Mapping.

Get the set of vestiges.

Returns
A set of arrays of vestiges.

◆ SetEmpty()

void MbSectionMap::SetEmpty ( )

Clean a section view.

Clean arrays of vestiges and sets of contours, release shells and clean the array of shells.

◆ SetMessage()

void MbSectionMap::SetMessage ( MbResultType type)
inline

Set a result code.

Set a result code of the construction.

Parameters
[in]type- Operation result code.

◆ GetMessage()

MbResultType MbSectionMap::GetMessage ( ) const
inline

Get the result code.

Get the result code of the construction.

Returns
Operation result code.

◆ Transform()

void MbSectionMap::Transform ( const MbMatrix matr)

Transform.

Transform the object by a matrix.

Parameters
[in]matr- A transformation matrix.

◆ DetachShellArray()

template<class Shells >
void MbSectionMap::DetachShellArray ( Shells &  shells)
inline

Detach the array of shells.

Detach the array of shells and put them into a given array.

Parameters
[out]shells- An array for shells.

◆ SetAnnObjectStore()

void MbSectionMap::SetAnnObjectStore ( ItAnnObjectStore objStore)
inline

Set a storage.

Set a storage of annotation objects.
Detach the old storage and catch a new one.

Parameters
[out]objStore- A new storage of annotation objects.

◆ GetSymbolObjects()

RPArray<MbSymbol>* MbSectionMap::GetSymbolObjects ( ) const
inline

Get conventional notations.

Get the array of conventional notations.

Returns
Conventional notations.

◆ SetSymbolObjects()

void MbSectionMap::SetSymbolObjects ( RPArray< MbSymbol > &  arInit)

Add conventional notations.

Add the information about conventional notations.
Add the given conventional notations into the array of conventional notations.

Parameters
[in]arInit- Conventional notations.

◆ SetSymbolObjectStore()

void MbSectionMap::SetSymbolObjectStore ( ItSymbolObjectStore objStore)
inline

Set a storage.

Set a storage of conventional notations.
Detach the old storage and catch a new one.

Parameters
[out]objStore- A new storage of conventional notations.

◆ SetSpacePoints()

void MbSectionMap::SetSpacePoints ( RPArray< MbSpacePoints > &  points)

Add spatial points.

Add spatial points.
Add new points into the array of points.

Parameters
[in]points- Points.

◆ SetSpaceCurves()

void MbSectionMap::SetSpaceCurves ( RPArray< MbSpaceCurves > &  curves)

Add spatial curves.

Add spatial curves.
Add new curves into the array of curves.

Parameters
[in]curves- Curves.

◆ IsSpacePoints()

bool MbSectionMap::IsSpacePoints ( ) const
inline

Whether any point is in the object.

Whether any spatial point is in the object.

Returns
returns true if the array of points isn't null and isn't empty.

◆ IsSpaceCurves()

bool MbSectionMap::IsSpaceCurves ( ) const
inline

Whether any curve is in an object.

Whether any spatial curve is in an object.

Returns
returns true if the array of curves isn't null and isn't empty.

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