Marker with properties of a geometric object. More...

#include <marker.h>

Inheritance diagram for MbMarker:

Collaboration diagram for MbMarker:

Public Member Functions
	MbMarker (const MbMarker &)
	Copy constructor.

	MbMarker (const MbCartPoint3D &, const MbVector3D &)
	Constructor by a point and a vector.

	MbMarker (const MbCartPoint3D &, const MbVector3D &, const MbVector3D &)
	Constructor by a point and vectors.

virtual	~MbMarker ()
	Destructor.

MbeSpaceType	IsA () const override
	Get the type of the object.

MbeSpaceType	Type () const override
	Get the group object type.

MbSpaceItem &	Duplicate (MbRegDuplicate *=nullptr) const override
	Create a copy of the object. More...

void	Transform (const MbMatrix3D &, MbRegTransform *=nullptr) override
	Convert the object according to the matrix. More...

void	Move (const MbVector3D &, MbRegTransform *=nullptr) override
	Move an object along a vector. More...

void	Rotate (const MbAxis3D &, double angle, MbRegTransform *=nullptr) override
	Rotate an object around an axis at a given angle. More...

bool	IsSame (const MbSpaceItem &other, double accuracy=LENGTH_EPSILON) const override
	Determine whether an object is equal. More...

bool	IsSimilar (const MbSpaceItem &init) const override
	Determine whether an object is similar. More...

bool	SetEqual (const MbSpaceItem &init) override
	Make objects equal if they are similar. More...

double	DistanceToPoint (const MbCartPoint3D &) const override
	Determine the distance to the point. More...

void	AddYourGabaritTo (MbCube &r) const override
	Expand sent bounding box (a.k.a. gabarit), so that it included the object. More...

void	CalculateMesh (const MbStepData &stepData, const MbFormNote &note, MbMesh &mesh) const override
	Build polygonal copy mesh. More...

MbProperty &	CreateProperty (MbePrompt n) const override
	Create your own property with the name.

void	GetProperties (MbProperties &properties) override
	Outstanding properties of the object. More...

void	SetProperties (const MbProperties &properties) override
	Change the properties of an object. More...

void	GetBasisPoints (MbControlData3D &) const override
	Get control points of object.

void	SetBasisPoints (const MbControlData3D &) override
	Change the object by control points.

Functions of marker.
const MbCartPoint3D &	GetOrigin () const
	Get point of marker.

const MbVector3D &	GetAxisX () const
	Get axis of marker.

const MbVector3D &	GetAxisZ () const
	Get the second axis of marker.

void	SetNullX ()
	Set the X-axis to null.

MbMarker &	InvertZ ()
	Invert the Z-axis.

Public Member Functions inherited from MbLegend
virtual	~MbLegend ()
	Destructor.

MbeSpaceType	Family () const override
	Get family of objects.

void	CalculateLocalGabarit (const MbMatrix3D &into, MbCube &cube) const override
	To compute bounding box in a local coordinate system. More...

Public Member Functions inherited from MbSpaceItem
virtual	~MbSpaceItem ()
	Destructor.

void	PrepareWrite () const
	Register object. More...

MbeRefType	RefType () const override
	Get a registration type (for copying, duplication).

bool	IsFamilyRegistrable () const override
	Whether the object belongs to a registrable family.

virtual void	Refresh ()
	Translate all the time (mutable) data objects in an inconsistent (initial) state.

void	CalculateWire (const MbStepData &stepData, MbMesh &mesh) const

void	CalculateWire (double sag, MbMesh &mesh) const

virtual void	GetBasisItems (RPArray< MbSpaceItem > &)
	Outstanding reference objects in a container sent.

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.

Public Member Functions inherited from MbRefItem
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 MbLegend
	MbLegend ()
	Constructor.

Protected Member Functions inherited from MbSpaceItem
	MbSpaceItem ()
	Default constructor.

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

Detailed Description

Marker with properties of a geometric object.

Definition: The marker is a triple of objects: a point and a pair of orthonormalized vectors. For example, in the COMPAS-3D system marker sets the "connecting point", which is used as geometric connector for conjugation and positioning of solids in space.

The term "Marker" is taken from the book "Geometric constraint solving in kinematics" (G.Kramera ).

With the help of marker it is possible to set auxiliary constructions and to transmit geometry of kinematic compounds or conjugations. The marker always belongs to some subspace, for example, to LSC of solid.
For the marker the following requirement is always satisfied: its vectors (as opposed to the local coordinate system) are always orthonormalized. Z-axis is always normalized, X-axis is always
orthogonal to Z (it could be that X = 0). Marker can set any geometric objects which are easy to set by point or vectors, this is a unified form of writing of objects as point, line, plane, right orthonormal CS etc. When adding a radius to a marker it is used as a compressed form of writing of cylinder, circle, sphere, torus etc.

See also: #MtMarker, #MtUnifiedGeom, MtMatingGeometry, #MtMatingGeom

Member Function Documentation

◆ Duplicate()

MbSpaceItem& MbMarker::Duplicate ( MbRegDuplicate * iReg = nullptr ) const

overridevirtual

Create a copy of the object.

Create a copy of an object using the registrator. Registrator is used to prevent multiple copy of the object. If the object contains references to the other objects, then nested objects are copied as well. It is allowed not to pass registrator into the function. Then new copy of object will be created. While copying of single object or set of not connected objects, it is allowed not to use registrator. Registrator should be used if it is required to copy several connected objects. It is possible, that objects connection is based on the references to common objects. Then, while copying without using of registrator, it is possible to obtain set of copies, that contain references to the different copies of the same nested object, that leads to loss of connection between copies.

Parameters

[in] iReg - Registrator.

Returns: A copy of the object.

Implements MbSpaceItem.

◆ Transform()

void MbMarker::Transform	(	const MbMatrix3D &	matr,
		MbRegTransform *	iReg = `nullptr`
	)

overridevirtual

Convert the object according to the matrix.

Convert the original object according to the matrix using the registrator. If object contains references to the other geometric objects, then nested objects are transformed according to the matrix. Registrator is needed to prevent multiple object copying. It is allowed to use function without registrator, if it is needed to transform single object. If it is needed to transform a set of connected objects, then one should use registrator to prevent repeating transformation of nested objects, because of the possible situation when several objects contain references to the same common objects, that require to be transformed.

Parameters

[in]	matr	- Transformation matrix.
[in]	iReg	- Registrator.

Implements MbSpaceItem.

◆ Move()

void MbMarker::Move	(	const MbVector3D &	to,
		MbRegTransform *	iReg = `nullptr`
	)

overridevirtual

Move an object along a vector.

Move an object along a geometric vector using the registrator. If object contains references to the other geometric objects then the move operation is applied to the nested objects. Registrator is needed to prevent multiple copying of the object. It is allowed to use function without registrator, if it is needed to transform a single object. If it is needed to transform a set of connected objects, then one should use registrator to prevent repeating transformation of nested objects, because of the possible situation when several objects contain references to the same common objects, that require to be moved.

Parameters

[in]	to	- Shift vector.
[in]	iReg	- Registrator.

Implements MbSpaceItem.

◆ Rotate()

void MbMarker::Rotate	(	const MbAxis3D &	axis,
		double	angle,
		MbRegTransform *	iReg = `nullptr`
	)

overridevirtual

Rotate an object around an axis at a given angle.

Rotate an object around an axis at a given angle with the registrator. If object contains references to the other geometric objects then the rotation operation is applied to the nested objects. Registrator is needed to prevent multiple copying of the object. It is allowed to use function without registrator, if it is needed to transform a single object. If it is needed to transform a set of connected objects, then one should use registrator to prevent repeating transformation of nested objects, because of the possible situation when several objects contain references to the same common objects, that require to be rotated.

Parameters

[in]	axis	- The axis of rotation.
[in]	angle	- Rotation.
[in]	iReg	- Registrator.

Implements MbSpaceItem.

◆ IsSame()

bool MbMarker::IsSame	(	const MbSpaceItem &	other,
		double	accuracy = `LENGTH_EPSILON`
	)		const

overridevirtual

Determine whether an object is equal.

Still considered objects of the same type, all data is the same (equal).

Parameters

[in]	item	- The object to compare.
[in]	accuracy	- The accuracy to compare.

Returns: Whether the objects are equal.

Implements MbSpaceItem.

◆ IsSimilar()

bool MbMarker::IsSimilar ( const MbSpaceItem & item ) const

overridevirtual

Determine whether an object is similar.

Such are considered the same objects whose data are similar.

Parameters

[in] item - The object to compare.

Returns: Whether the objects are similar.

Reimplemented from MbSpaceItem.

◆ SetEqual()

bool MbMarker::SetEqual ( const MbSpaceItem & item )

overridevirtual

Make objects equal if they are similar.

You can still make only a similar objects.

Parameters

[in] item - The object to initialize.

Returns: Object is changed.

Implements MbSpaceItem.

◆ DistanceToPoint()

double MbMarker::DistanceToPoint ( const MbCartPoint3D & point ) const

overridevirtual

Determine the distance to the point.

Parameters

[in] point - Point.

Returns: Distance to point

Implements MbSpaceItem.

◆ AddYourGabaritTo()

void MbMarker::AddYourGabaritTo ( MbCube & cube ) const

overridevirtual

Expand sent bounding box (a.k.a. gabarit), so that it included the object.

Expand sent bounding box, so that it included the object.

Parameters

[in,out] cube - The bounding box to expand.

Implements MbSpaceItem.

◆ CalculateMesh()

void MbMarker::CalculateMesh	(	const MbStepData &	stepData,
		const MbFormNote &	note,
		MbMesh &	mesh
	)		const

overridevirtual

Build polygonal copy mesh.

Build a polygonal copy of the object that is represented by polygons or/and fasets.

Parameters

[in]	stepData	- Data for еру step calculation for polygonal object.
[in]	note	- Way for polygonal object constructing.
[in,out]	mesh	- The builded polygonal object.

Implements MbSpaceItem.

◆ GetProperties()

void MbMarker::GetProperties ( MbProperties & properties )

overridevirtual

Outstanding properties of the object.

Issue internal data (properties) of the object for viewing and modification.

Parameters

[in] properties - Container for the internal data of the object.

Implements MbSpaceItem.

◆ SetProperties()

void MbMarker::SetProperties ( const MbProperties & properties )

overridevirtual

Change the properties of an object.

Changing the internal data (properties) of the object you are copying the corresponding values from the sent object.

Parameters

[in] properties - Container for the internal data of the object.

Implements MbSpaceItem.

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

marker.h

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ Duplicate()

◆ Transform()

◆ Move()

◆ Rotate()

◆ IsSame()

◆ IsSimilar()

◆ SetEqual()

◆ DistanceToPoint()

◆ AddYourGabaritTo()

◆ CalculateMesh()

◆ GetProperties()

◆ SetProperties()