C3D Toolkit  Kernel - 117982, Vision - 2.9.2.2

The array of spatial points for projection. More...

#include <map_lump.h>

+ Inheritance diagram for MbSpacePoints:
+ Collaboration diagram for MbSpacePoints:

Public Member Functions

 MbSpacePoints (uint _comp, uint16 _style, const MbMatrix3D &_from, const MbName &_name)
 Constructor. More...
 
 MbSpacePoints (uint _comp, uint16 _style, const MbMatrix3D &_from)
 Constructor. More...
 
virtual ~MbSpacePoints ()
 Destructor.
 
virtual MbSpacePointsDuplicate (MbRegDuplicate *iReg=nullptr) const
 Get a copy of the object.
 
Functions for access to data.
uint GetComponent () const
 Get the name of a component.
 
uint16 GetStyle () const
 Get the style.
 
const MbMatrix3DGetMatrixFrom () const
 Get the matrix of transformation to the world coordinate system.
 
const MbNameGetName () const
 Get the name.
 
bool IsHidden () const
 Get the flag of invisibility of curves for projection.
 
void SetHidden (bool h) const
 Set the flag of invisibility of curves for projection.
 
Functions for changing data.
void AddNamedPoint (const MbCartPoint3D &pnt, MbName *nm)
 Add a point with a name. More...
 
template<class Points >
void AddNamedPoints (const Points &pnts, const RPArray< MbName > &nms)
 Add points with names. More...
 
void RemoveNamedPoints ()
 Remove points with names. More...
 
void AdjustMemory ()
 Free the unnecessary memory. More...
 
Access to points.
size_t GetPointsCount () const
 The number of points.
 
void GetPoints (SArray< MbCartPoint3D > &pnts) const
 Get points. More...
 
bool GetPoint (size_t k, MbCartPoint3D &pnt) const
 Get a point. More...
 
Access to names.
size_t GetNamesCount () const
 The number of names.
 
void GetNames (RPArray< MbName > &ns) const
 Get the names. More...
 
const MbNameGetName (size_t k) const
 Get the name. More...
 
- 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.
 
- Public Member Functions inherited from TapeBase
 TapeBase (RegistrableRec regs=noRegistrable)
 Constructor.
 
 TapeBase (const TapeBase &)
 Copy-constructor.
 
virtual ~TapeBase ()
 Destructor.
 
RegistrableRec GetRegistrable () const
 Whether the stream class is registrable.
 
void SetRegistrable (RegistrableRec regs=registrable) const
 Set the state of registration of the stream class.
 
virtual const char * GetPureName (const VersionContainer &) const
 Get the class name.
 
virtual bool IsFamilyRegistrable () const
 Whether the object belongs to a registrable family.
 

Additional Inherited Members

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

Detailed Description

The array of spatial points for projection.

The array of spatial points for projection.

Constructor & Destructor Documentation

◆ MbSpacePoints() [1/2]

MbSpacePoints::MbSpacePoints ( uint  _comp,
uint16  _style,
const MbMatrix3D _from,
const MbName _name 
)
inline

Constructor.

Constructor of an empty array of visible spatial points.

Parameters
[in]_comp- A component in which a set of points is defined.
[in]_style- A style.
[in]_from- A matrix of transformation to the world coordinate system.
[in]_name- A set name.

◆ MbSpacePoints() [2/2]

MbSpacePoints::MbSpacePoints ( uint  _comp,
uint16  _style,
const MbMatrix3D _from 
)
inline

Constructor.

Constructor of an empty array of visible spatial points without name.

Parameters
[in]_comp- A component in which a set of points is defined.
[in]_style- A style.
[in]_from- A matrix of transformation to the world coordinate system.

Member Function Documentation

◆ AddNamedPoint()

void MbSpacePoints::AddNamedPoint ( const MbCartPoint3D pnt,
MbName nm 
)
inline

Add a point with a name.

Add a point with a name.
Generates a warning if the array of names of points has a flag of elements removing.

Parameters
[in]pnt- A point.
[in]nm- A point name.

◆ AddNamedPoints()

template<class Points >
void MbSpacePoints::AddNamedPoints ( const Points &  pnts,
const RPArray< MbName > &  nms 
)
inline

Add points with names.

Add points with names.
The number of points in the array must be equal to the number of names. Otherwise generates a warning.
Points and names are added to the object sequentially by calling the AddNamedPoint.

Parameters
[in]pnts- A point set.
[in]nms- A set of names.

◆ RemoveNamedPoints()

void MbSpacePoints::RemoveNamedPoints ( )
inline

Remove points with names.

Remove points with names.
Clean arrays of points and names.

◆ AdjustMemory()

void MbSpacePoints::AdjustMemory ( )
inline

Free the unnecessary memory.

Free the unnecessary memory.
Free the unnecessary memory in arrays of points and names.

◆ GetPoints()

void MbSpacePoints::GetPoints ( SArray< MbCartPoint3D > &  pnts) const
inline

Get points.

Get points.
Add points into a given array.

Parameters
[out]pnts- An array for adding of points.

◆ GetPoint()

bool MbSpacePoints::GetPoint ( size_t  k,
MbCartPoint3D pnt 
) const
inline

Get a point.

Get a point by an index.

If the index is incorrect i.e. it isn't less than the number of points, a warning is generated.

Parameters
[in]k- A point index.
[out]pnt- Required point.
Returns
returns true if the index is less than the number of points in the set.

◆ GetNames()

void MbSpacePoints::GetNames ( RPArray< MbName > &  ns) const
inline

Get the names.

Get the names.
Add the names into a given array.

Parameters
[out]ns- An array for adding of names.

◆ GetName()

const MbName* MbSpacePoints::GetName ( size_t  k) const
inline

Get the name.

Get the name by an index.

If the index is incorrect i.e. it isn't less than the number of points, nullptr is returned.

Parameters
[in]k- A name index.
Returns
A name by an index from the set of names.

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