Three-dimensional wire frame. More...

#include <wire_frame.h>

Inheritance diagram for MbWireFrame:

Collaboration diagram for MbWireFrame:

Public Member Functions
	MbWireFrame ()
	Constructor without parameters.

	MbWireFrame (const MbCurve3D &, const MbCreator *=nullptr)
	Constructor by a curve and creator.

	MbWireFrame (const RPArray< MbCurve3D > &, const MbCreator *=nullptr)
	Constructor by a set of curves and creator.

	MbWireFrame (const c3d::SpaceCurvesSPtrVector &, const MbCreator *=nullptr)
	Constructor by a set of curves and creator.

	MbWireFrame (const MbEdge &, const MbCreator *=nullptr, bool same=true)
	Constructor by an edge and creator.

	MbWireFrame (const RPArray< MbEdge > &, const MbCreator *=nullptr, bool same=true)
	Constructor by a set of edges and creator.

	MbWireFrame (const c3d::WireEdgesSPtrVector &, const MbCreator *=nullptr, bool same=true)
	Constructor by a set of edges and creator.

	MbWireFrame (const c3d::WireEdgesSPtrVector &, const MbWireFrame &oldFrame, const MbCreator *=nullptr)
	Constructor by a set of edges and creator.

virtual	~MbWireFrame ()
	Destructor.

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

MbSpaceItem &	Duplicate (MbRegDuplicate *iReg=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 &, double accuracy=LENGTH_EPSILON) const override
	Determine whether an object is equal. More...

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

bool	SetEqual (const MbSpaceItem &) 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 &) const override
	Expand sent bounding box (a.k.a. gabarit), so that it included the object. More...

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

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

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

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

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

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

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

bool	GetPlacement (MbPlacement3D &) const override
	Get the coordinate system of an item if it is exist. More...

bool	RebuildItem (MbeCopyMode sameShell, RPArray< MbSpaceItem > items, IProgressIndicator progInd) override
	Reconstruct object according to the history tree. More...

MbItem *	CreateMesh (const MbStepData &stepData, const MbFormNote &note, MbRegDuplicate *iReg) const override
	Create polygonal object. More...

Common functions of a frame.
size_t	GetEdgesCount () const
	Get the number of edges of the frame.

const MbEdge *	GetEdge (size_t i) const
	Get the item by index.

MbEdge *	SetEdge (size_t i)
	Get the item by index for the possible editing.

template<class EdgesVector >
void	GetEdges (EdgesVector &dstEdges) const
	Get edges.

template<class EdgesVector >
void	SetEdges (EdgesVector &dstEdges)
	Get edges for the possible editing.

void	AddEdge (const MbCurve3D &, bool sense=true)
	Add an edge by a curve and its orientation in relation to an edge.

void	AddEdge (const MbEdge &, bool same=true)
	Add an edge (an original, not a copy).

template<class WireEdgesVector >
void	AddEdges (const WireEdgesVector &, bool same=true)
	Add an array of edges (originals, not copies).

void	InsertEdge (size_t index, const MbEdge &item, bool same=true)
	Insert an edge by index (an original, not a copy).

MbEdge *	DetachEdge (size_t index)
	Detach an edge by index.

void	DeleteEdges ()
	Delete all edges.

bool	DeleteEdge (size_t index)
	Delete an edge by index.

bool	DeleteEdge (MbEdge *)
	Delete an edge if it already exists.

void	GetVerticesArray (RPArray< MbVertex > &)
	Get an array of frame edges vertices.

void	GetVerticesArray (RPArray< const MbVertex > &) const
	Get an array of frame edges vertices.

size_t	GetVertexIndex (const MbVertex &find) const
	Get vertex index.

MbVertex *	GetVertex (size_t index) const
	Get vertex by index.

size_t	GetEdgeIndex (const MbEdge &find) const
	Get edge index.

template<class VerticesSet >
void	GetVerticesSet (VerticesSet &dstVertices) const
	Get vertices.

const MbVertex *	GetBegVertex () const
	Get the start vertex of a frame.

const MbVertex *	GetEndVertex () const
	Get the end vertex of a frame.

const MbVertex *	FindVertexByName (const MbName &) const
	Find vertex by name.

const MbEdge *	FindEdgeByName (const MbName &) const
	Find edge by name.

bool	CuttingEdge (MbEdge *&targetEdge, SArray< double > &params, bool beginSafe, double eps, RPArray< MbEdge > &edges)
	Split the edge using the curve parameters into several pieces. More...

bool	IsClosed ()
	Is frame closed?

bool	IsMultiWireFrame ()
	Is frame multiply connected?

size_t	GetPartsCount ()
	A number of connected parts of a frame.

bool	IsPlanar () const
	Is the object planar?

bool	MakePlaneCurves (RPArray< MbCurve > &curves, MbPlacement3D &place) const
	Get planar coordinate system if the space curve is planar (after the using call DeleteItem for two-dimensional curves)

bool	MakeSurfaceCurves (RPArray< MbCurve > &curves, MbSurface *&surface) const
	Get a surface curve if a space curve is on a surface (after the using call DeleteItem for two-dimensional curves)

bool	MakeCurves (RPArray< MbCurve3D > &curves) const
	Construct contours of curves copies. More...

template<class CurvesVector >
void	GetCurves (CurvesVector &) const
	Put originals of curves into an array.

bool	IsNormalizeWire () const
	Is a frame split into connected parts?

bool	NormalizeWire (double precision=METRIC_REGION)
	Perform curves reposition and edges reorientation by creating connected chains with common vertices.

size_t	CreateParts (RPArray< MbWireFrame > &parts)
	Detachment of frame parts. More...

bool	CreateContours (c3d::SpaceCurvesSPtrVector &contours, bool onlySmoothConnected) const
	Create connected contours according to vertex tolerances of the wire frame edges. More...

bool	CreateContours (c3d::WireFramesSPtrVector &contours, bool onlySmoothConnected) const
	Create connected contours according to vertex tolerances of the wire frame edges. More...

bool	CreateContours (const MbSpaceContourCreationParams &params, MbSpaceContourCreationResults< c3d::SpaceCurveSPtr > &results) const
	Create connected contours according to vertex tolerances of the wire frame edges. More...

bool	CreateContours (const MbSpaceContourCreationParams &params, MbSpaceContourCreationResults< c3d::WireFrameSPtr > &results) const
	Create connected contours according to vertex tolerances of the wire frame edges. More...

void	SetOwnChangedThrough (MbeChangedType)
	Set flag of changes for all edges and vertices.

void	GetWeightCentre (MbCartPoint3D &pc) const
	Выдать центр тяжести каркаса. Get the frame's center of mass.

Public Member Functions inherited from MbItem
	MbItem ()
	Constructor.

virtual	~MbItem ()
	Destructor.

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

MbeSpaceType	Family () const override
	Get family of objects.

MbeImplicationType	ImplicationType () const override
	Get attribute container type.

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

virtual void	GetBasisPoints (MbControlData &) const

virtual void	SetBasisPoints (const MbControlData &)

virtual bool	SetPlacement (const MbPlacement3D &)
	Set the coordinate system of an item if it is possible.

virtual bool	AddYourMesh (const MbStepData &stepData, const MbFormNote &note, MbMesh &mesh) const
	Add polygonal object. More...

virtual MbItem *	CutMesh (const MbPlacement3D &cutPlace, double distance, const MbSNameMaker *names=nullptr) const
	Cut the polygonal object by one or two parallel planes. More...

virtual bool	NearestMesh (MbeSpaceType sType, MbeTopologyType tType, MbePlaneType pType, const MbAxis3D &axis, double maxDistance, bool gridPriority, double &t, double &dMin, MbItem &find, SimpleName &findName, MbRefItem &element, SimpleName &elementName, MbPath &path, MbMatrix3D &from) const
	Find the nearest object or name of the nearest object. More...

virtual bool	GetItems (MbeSpaceType type, const MbMatrix3D &from, std::vector< SPtr< MbItem >> &items, std::vector< MbMatrix3D > &matrs)
	Get all objects by the type. More...

virtual bool	GetItems (MbeSpaceType type, const MbMatrix3D &from, RPArray< MbItem > &items, SArray< MbMatrix3D > &matrs)
	Get all objects by type. More...

virtual bool	GetUniqItems (MbeSpaceType type, CSSArray< const MbItem * > &items) const
	Get all unique objects by type. More...

virtual const MbItem *	GetItemByPath (const MbPath &path, size_t ind, MbMatrix3D &from, size_t currInd=0) const
	Get the object by its path. More...

virtual const MbItem *	FindItem (const MbSpaceItem *s, MbPath &path, MbMatrix3D &from) const
	Find object by geometric object. More...

virtual const MbItem *	FindItem (const MbPlaneItem *s, MbPath &path, MbMatrix3D &from) const
	Find object by geometric object. More...

virtual const MbItem *	FindItem (const MbItem *s, MbPath &path, MbMatrix3D &from) const
	Find object by object of geometric model. More...

virtual const MbItem *	GetItemByName (SimpleName n, MbPath &path, MbMatrix3D &from) const
	Find object by name. More...

virtual void	TransformSelected (const MbMatrix3D &matr, MbRegTransform *iReg=nullptr)
	Transform selected object according to the matrix. More...

virtual void	MoveSelected (const MbVector3D &to, MbRegTransform *iReg=nullptr)
	Move selected object along a vector. More...

virtual void	RotateSelected (const MbAxis3D &axis, double angle, MbRegTransform *iReg=nullptr)
	Rotate selected object by a given angle about an axis. More...

virtual bool	GetMatrixFrom (MbMatrix3D &from) const
	Get transform matrix from local coordinate system of object.

virtual bool	GetMatrixInto (MbMatrix3D &into) const
	Get transform matrix into local coordinate system of object.

void	Assign (const MbItem &other)
	Copy creators and attributes.

void	CopyItemName (const MbItem &other)
	Copy the name of an object.

SimpleName	GetItemName () const
	Get name of object.

void	SetItemName (SimpleName n)
	Set name of the object.

bool	IsAttributeEqual (int attribute)
	Whether a sign attribute matches an object?

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

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.

Public Member Functions inherited from MbTransactions
	MbTransactions ()
	Constructor without parameters.

template<class Creators >
	MbTransactions (const Creators &creators)
	Constructor by creators.

virtual	~MbTransactions ()
	Destructor.

void	CreatorsCopy (MbTransactions &other, MbRegDuplicate *iReg=nullptr) const
	Clear the given history tree and copy the creators to it.

void	CreatorsAssign (const MbTransactions &other)
	Clear the history tree and copy the creators from the given history tree to it.

bool	SetCreatorsEqual (const MbTransactions &other)
	Make the creators equal to the creators from the given history tree if the creators are similar.

bool	IsCreatorsSimilar (const MbTransactions &other) const
	Check whether the corresponding creators of the given history tree are similar.

void	CreatorsTransform (const MbMatrix3D &, MbRegTransform *=nullptr)
	Transform the creators according to the matrix.

void	CreatorsMove (const MbVector3D &, MbRegTransform *=nullptr)
	Move creators along the vector.

void	CreatorsRotate (const MbAxis3D &, double angle, MbRegTransform *=nullptr)
	Rotate the creators about the axis by the given angle.

size_t	GetCreatorsCount () const
	Get the creators count.

void	Reserve (size_t count)
	Reserve space for creators.

const MbCreator *	GetCreator (size_t ind) const
	Get constructor by its index.

MbCreator *	SetCreator (size_t ind)
	Get constructor by its index with possibility of editing.

virtual bool	GetCreators (RPArray< MbCreator > &) const
	Add your own creators to the given array.

virtual bool	GetCreators (c3d::CreatorsSPtrVector &) const
	Add your own creators to the given array.

template<class CreatorsVector >
bool	GetCreatorsCopies (CreatorsVector &creators, MbRegDuplicate *iReg) const
	Add copies of your own creators to the given array.

size_t	FindCreator (const MbCreator *creator)
	Find the number of creators in the history tree or return SYS_MAX_T if it is absent.

bool	AddCreator (const MbCreator &, bool addSame=false)
	Add the constructor (addSame = false) or its copy (addSame = true) to the history tree.

bool	AddCreator (const MbCreator *, bool addSame=false)
	Add the constructor (addSame = false) or its copy (addSame = true) to the history tree.

template<class CreatorsVector >
void	AddCreators (const CreatorsVector &creators)
	Add creators to the history tree.

MbCreator *	DetachCreator (size_t ind)
	Remove the constructor with the specified index from the history tree and return it.

bool	DeleteCreator (size_t ind)
	Delete the constructor with the specified index and remove it from the history tree.

void	DeleteCreators ()
	Delete all the creators and clear the history tree.

int	GetCreatorStatus (size_t ind) const
	Get the status of creator with the specified index.

bool	SetCreatorStatus (size_t ind, MbeProcessState)
	Set status to creator with the specified index.

size_t	GetActiveCreatorsCount () const
	Get the active creators count.

bool	SetActiveCreatorsCount (size_t activeCount)
	Set the count of active creators from the beginning to the given index.

void	BreakCreatorsToBasisItem (size_t c, RPArray< MbSpaceItem > &)
	Get the object created by the specified number of creators and the basis items of the other creators.

void	GetCreatorsBasisItems (RPArray< MbSpaceItem > &)
	Get the basis items of the creators.

void	GetCreatorsBasisPoints (MbControlData3D &) const
	Get the basis points of the creators.

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

void	GetProperties (MbProperties &, bool sameCreators=false)
	Get properties of the creators (using original creators or their copies).

void	SetProperties (const MbProperties &)
	Set properties of the creators.

void	CreatorsRead (reader &in)
	Read creators from the stream.

void	CreatorsWrite (writer &out) const
	Write creators to the stream.

Public Member Functions inherited from MbAttributeContainer
	MbAttributeContainer ()
	Constructor without parameters.

	MbAttributeContainer (MbAttribute &)
	Constructor by attribute.

virtual	~MbAttributeContainer ()
	Destructor.

void	AttributesRead (reader &)
	Read attributes from stream.

void	AttributesWrite (writer &) const
	Writing attributes to stream.

void	GetProperties (MbProperties &)
	Get properties of attributes.

void	SetProperties (const MbProperties &)
	Set properties of attributes.

void	SetDensity (double)
	Set density of an object.

double	GetDensity () const
	Get density of an object.

void	SetVisual (float a, float d, float sp, float sh, float t, float e, uint rgb=0)
	Set visual properties of the object.

void	SetVisual (const MbRGBA &ambient, const MbRGBA &diffuse, const MbRGBA &specular, const MbRGBA &emission, uint8 shininess, uint8 opacity, uint8 chrom)
	Set visual properties of the object.

bool	GetVisual (float &a, float &d, float &sp, float &sh, float &t, float &e, uint rgb=0) const
	Get visual properties of the object. More...

bool	IsColored () const

void	SetColor (uint32)
	Change color of the object.

void	SetColor (int R, int G, int B)
	Change color of the object (0-255).

uint32	GetColor () const
	Get color of an object.

void	SetWidth (int)
	Set thickness of lines for object's representation.

int	GetWidth () const
	Get thickness of lines for object's representation.

void	SetStyle (int)
	Set style of lines for object's representation.

int	GetStyle () const
	Get style of lines for object's representation.

void	SetSelected (bool s=true)
	To allocate or not to allocate an object.

bool	IsSelected () const
	Is the object selected.

bool	ReverseSelected ()
	Invert object selection.

void	SetChanged (bool c=true)
	Set: the object is changed or isn't changed.

bool	IsChanged () const
	Is the object changed?

void	SetVisible (bool)
	Set visibility.

bool	IsVisible () const
	Is the object visible?

bool	IsInvisible () const
	Is the object invisible?

void	AttributesAssign (const MbAttributeContainer &)
	Duplicate attributes of a given object, release existing attributes.

size_t	AttributesCount () const
	Get the number of objects.

bool	RemoveAttributes (bool onDeleteOwner=false)
	Delete all attributes from container.

MbAttribute *	AddAttribute (MbAttribute *attr, bool checkSame=true)
	Add attribute in container. More...

MbAttribute *	AddAttribute (const MbAttribute &attr, bool checkSame=true)
	Add attribute in container (adds a copy of the attribute if it can be added). More...

void	GetAttributes (c3d::AttrVector &attrs, MbeAttributeType aFamily, MbeAttributeType subType) const
	Get attributes of a given type or family. More...

void	GetAttributes (c3d::AttrVector &attrs, MbeAttributeType aType) const
	Get attributes of a given type. More...

template<class AttrVector >
void	GetAttributes (AttrVector &attrs) const
	Get attributes. More...

void	GetCommonAttributes (c3d::AttrVector &, const c3d::string_t &samplePrompt, MbeAttributeType subType=at_Undefined, bool firstFound=false) const
	Get attributes using sample of description string.

void	GetStringAttributes (c3d::AttrVector &, const c3d::string_t &sampleContent) const
	Get string attributes using sample of contents of the string.

bool	RemoveAttribute (const MbAttribute *, bool checkAccuracySame=false, double accuracy=LENGTH_EPSILON)
	Get an attribute of a given type, the first one is returned if there are many. More...

bool	RemoveAttributes (MbeAttributeType type, MbeAttributeType subType)
	Delete attributes of a given type.

const MbAttribute *	GetSimpleAttribute (MbeAttributeType) const
	Get a simple attribute of a given subtype.

MbAttribute *	SetSimpleAttribute (MbeAttributeType)
	Get a simple attribute of a given subtype.

MbAttribute *	SetSimpleAttribute (MbAttribute *simpAttr)
	Set a simple attribute of a given subtype.

MbAttribute *	SetSimpleAttribute (const MbAttribute &simpAttr)
	Set a simple attribute of a given subtype (always copies the attribute).

void	RemoveSimpleAttribute (MbeAttributeType)
	Delete simple attributes (one or more) of a given subtype.

MbAttribute *	DetachSimpleAttribute (MbeAttributeType)
	Detach a simple attribute of a given subtype.

void	GetUserAttributes (std::vector< MbUserAttribute * > &attrs, const MbUserAttribType &type) const
	Get a user attribute of a given subtype.

void	RemoveUserAttributes (const MbUserAttribType &type)
	Delete user attributes (one or more) of a given subtype.

void	DetachUserAttributes (std::vector< MbUserAttribute * > &attrs, const MbUserAttribType &type)
	Detach a user attribute of a given subtype.

void	AttributesChange ()
	Perform actions when changing the attributes.

void	AttributesConvert (MbAttributeContainer &other) const
	Perform actions when converting the attributes.

void	AttributesTransform (const MbMatrix3D &, MbRegTransform *=nullptr)
	Perform actions when transforming the attributes.

void	AttributesMove (const MbVector3D &, MbRegTransform *=nullptr)
	Perform actions when moving the attributes.

void	AttributesRotate (const MbAxis3D &, double angle, MbRegTransform *=nullptr)
	Perform actions when rotating the attributes.

void	AttributesCopy (MbAttributeContainer &other, MbRegDuplicate *=nullptr) const
	Perform actions when copying the attributes.

void	AttributesMerge (MbAttributeContainer &other)
	Perform actions when merging the attributes.

void	AttributesReplace (MbAttributeContainer &other)
	Perform actions when replacing the attributes.

void	AttributesSplit (const std::vector< MbAttributeContainer * > &others)
	Perform actions when splitting the attributes.

void	AttributesDelete ()
	Perform actions when deleting the attributes.

Public Member Functions inherited from MbSyncItem
void	Lock () const
	Switch lock on (locking happens only in parallel region).

void	Unlock () const
	Switch lock off if locking has been set.

Protected Member Functions
Functions for working with the wire frame as with a curve.
It is assumed that the frame has a parameter that varies from zero to the sum of the parametric lengths of all edges. The parameter can be used to calculate the radius vector of the edge point of the frame and the derivatives of the radius vector by analogy with the curve. When the parameter is increased, the calculated frame point runs sequentially through all the edges in the order of their sequence. Gaps between the edges of the wire frame are not taken into account.
double	GetTMin () const

double	GetTMax () const

ptrdiff_t	FindSegment (double &t, double &tSeg) const

void	PointOn (double &t, MbCartPoint3D &) const

void	FirstDer (double &t, MbVector3D &) const

void	SecondDer (double &t, MbVector3D &) const

void	ThirdDer (double &t, MbVector3D &) const

void	Normal (double &t, MbVector3D &) const

double	Step (double t, double sag) const

double	DeviationStep (double t, double angle) const

double	MetricStep (double t, double length) const

const MbCurve3D *	GetSegment (size_t ind) const

MbCurve3D *	SetSegment (size_t ind)

bool	IsCurveSameSense (size_t ind)

Protected Member Functions inherited from MbItem
	MbItem (const MbItem &, MbRegDuplicate *)
	Copy-constructor with duplication registrator.

void	LockItem () const
	Catch object if multithreading mode is on.

void	UnlockItem () const
	Release object if multithreading mode is on.

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

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

Protected Member Functions inherited from MbTransactions
	MbTransactions (const MbTransactions &, MbRegDuplicate *iReg)
	Copy-constructor with registrator.

Protected Member Functions inherited from MbAttributeContainer
	MbAttributeContainer (const MbAttributeContainer &, MbRegDuplicate *)
	Copy-constructor with the registrator.

Protected Attributes
c3d::WireEdgesVector	edges
	A set of edges of the frame.

size_t	partsCount
	A number of connected parts of an object.

bool	closed
	Closedness indicates to a possibility to get a set of closed curves.

bool	normal
	Is a frame split into connected parts?

Additional Inherited Members
Static Public Member Functions inherited from MbAttributeContainer
static MbUserAttribute *	ReduceUserAttrib (const MbExternalAttribute &)
	Convert user attribute to "system" one.

static MbExternalAttribute *	AdvanceUserAttrib (const MbUserAttribute &)
	Convert "system" attribute to user one.

Detailed Description

Three-dimensional wire frame.

Three-dimensional wire frame consists of a set of edges of a type MbEdge.
A wire frame may consist of several connected parts. A connected part may have a topology of a star where one vertex is coincident with more than two edges A wire frame may be split into separate connected parts. Each connected part has functions of a composite curve.

Member Function Documentation

◆ Duplicate()

MbSpaceItem& MbWireFrame::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 MbWireFrame::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 MbWireFrame::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 MbWireFrame::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 MbWireFrame::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 MbWireFrame::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 MbWireFrame::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 MbWireFrame::DistanceToPoint ( const MbCartPoint3D & point ) const

overridevirtual

Determine the distance to the point.

Parameters

[in] point - Point.

Returns: Distance to point

Implements MbSpaceItem.

◆ AddYourGabaritTo()

void MbWireFrame::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.

◆ CalculateLocalGabarit()

void MbWireFrame::CalculateLocalGabarit	(	const MbMatrix3D &	into,
		MbCube &	cube
	)		const

overridevirtual

To compute bounding box in a local coordinate system.

To obtain bounding box of object with regar to a local coordinate system, sent box is made to be empty. Then it is computed bounding box of object in a local coordinate system \ and it is stored in box 'cube'

Parameters

[in]	into	- Transformation matrix from object's current coordinate system to a local coordinate system
[in,out]	cube	- Information on bounding box

Implements MbSpaceItem.

◆ CalculateMesh()

void MbWireFrame::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 MbWireFrame::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.

Reimplemented from MbItem.

◆ SetProperties()

void MbWireFrame::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.

Reimplemented from MbItem.

◆ GetPlacement()

bool MbWireFrame::GetPlacement ( MbPlacement3D & p ) const

overridevirtual

Get the coordinate system of an item if it is exist.

Returns: The function returns true, if the object have its own local coordinate system, otherwise it is considered that the object LCS is always "standard" (MbPlacement3D :: global).

Reimplemented from MbItem.

◆ RebuildItem()

bool MbWireFrame::RebuildItem	(	MbeCopyMode	sameShell,
		RPArray< MbSpaceItem > *	items,
		IProgressIndicator *	progInd
	)

overridevirtual

Reconstruct object according to the history tree.

Create object by the history tree.

Parameters

[in]	sameShell	- Whether to perform complete copying of elements while constructing.
[out]	items	- Container for the elements of not performed constructions (can be nullptr).

Returns: Whether an object is constructed.

Reimplemented from MbItem.

◆ CreateMesh()

MbItem* MbWireFrame::CreateMesh	(	const MbStepData &	stepData,
		const MbFormNote &	note,
		MbRegDuplicate *	iReg
	)		const

overridevirtual

Create polygonal object.

Create a polygonal object - a polygonal copy of the given object.

Parameters

[in]	stepData	- Data for step calculation during triangulation.
[in]	note	- Way for polygonal object constructing.

Returns: Created polygonal object.

Implements MbItem.

◆ CuttingEdge()

bool MbWireFrame::CuttingEdge	(	MbEdge *&	targetEdge,
		SArray< double > &	params,
		bool	beginSafe,
		double	eps,
		RPArray< MbEdge > &	edges
	)

Split the edge using the curve parameters into several pieces.

. If beginSafe == true then the edge saves its starting piece, If beginSafe == false then the edge saves its ending piece. According to the parameter 'eps' drop out value in the container 'params', coinciding with each other and with the initial and final parameters of the curve. The container 'edges' contains cut parts. \params[in, out] targetEdge - Edge for cutting. The return value of 'targetEdge' is the shortened edge according to 'beginSafe' flag or nullptr, if the cut param in 'params' lies at the distance less than 'eps' from the corresponding end of the curve,

Parameters

[in]	params	- Parameters of intersection curve of edge to split,
[in]	beginSafe	- The edge will keep a beginning piece (true) or the edge will keep an end piece (false)
[in]	eps	- Precision matching options of parameters to split,
[out]	edges	- The container of cut parts.

Returns: Returns true, if the edge was cut.

◆ MakeCurves()

bool MbWireFrame::MakeCurves ( RPArray< MbCurve3D > & curves ) const

Construct contours of curves copies.

Construct contours of curves copies. New contours are added to the curves array.
\~

Parameters

[out] curves - Array, to which created contours are added.

Returns: Returns true if at least one contour is created.

◆ CreateParts()

size_t MbWireFrame::CreateParts ( RPArray< MbWireFrame > & parts )

Detachment of frame parts.

Detachment of frame parts with saving an initial object. If the initial frame is decomposed, all the parts are put into array 'parts'.

Parameters

[out] parts - Frames obtained from 'frame'.

Returns: Returns a number of frames in 'parts'.

◆ CreateContours() [1/4]

bool MbWireFrame::CreateContours	(	c3d::SpaceCurvesSPtrVector &	contours,
		bool	onlySmoothConnected
	)		const

Create connected contours according to vertex tolerances of the wire frame edges.

Create connected contours according to vertex tolerances of the wire frame edges. The initial object is preserved. If the initial frame is decomposed, all parts will be given as a result. Difference from MakeCurves is that tolerances are different in each edge vertex instead of the global one.

Parameters

[in]	onlySmoothConnected	- Contours segments must be smoothly connected (by G1).
[out]	contours	- Frames obtained from 'frame'.

Returns: Returns true if contours array size is increased.

◆ CreateContours() [2/4]

bool MbWireFrame::CreateContours	(	c3d::WireFramesSPtrVector &	contours,
		bool	onlySmoothConnected
	)		const

Create connected contours according to vertex tolerances of the wire frame edges.

Create connected contours according to vertex tolerances of the wire frame edges. The initial object is preserved. If the initial frame is decomposed, all parts will be given as a result. Difference from MakeCurves is that tolerances are different in each edge vertex instead of the global one.

Parameters

[in]	onlySmoothConnected	- Contours segments must be smoothly connected (by G1).
[out]	contours	- Frames obtained from 'frame'.

Returns: Returns true if contours array size is increased.

◆ CreateContours() [3/4]

bool MbWireFrame::CreateContours	(	const MbSpaceContourCreationParams &	params,
		MbSpaceContourCreationResults< c3d::SpaceCurveSPtr > &	results
	)		const

Create connected contours according to vertex tolerances of the wire frame edges.

Create connected contours according to vertex tolerances of the wire frame edges. The initial object is preserved. If the initial frame is decomposed, all parts will be given as a result. Difference from MakeCurves is that tolerances are different in each edge vertex instead of the global one.

Parameters

[in]	params	- Contour construction operation parameters.
[out]	results	- The result of the contour construction operation.

Returns: Returns true if contours array size is increased.

◆ CreateContours() [4/4]

bool MbWireFrame::CreateContours	(	const MbSpaceContourCreationParams &	params,
		MbSpaceContourCreationResults< c3d::WireFrameSPtr > &	results
	)		const

Create connected contours according to vertex tolerances of the wire frame edges.

Create connected contours according to vertex tolerances of the wire frame edges. The initial object is preserved. If the initial frame is decomposed, all parts will be given as a result. Difference from MakeCurves is that tolerances are different in each edge vertex instead of the global one.

Parameters

[in]	params	- Contour construction operation parameters.
[out]	results	- The result of the contour construction operation.

Returns: Returns true if contours array size is increased.

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

wire_frame.h

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ Duplicate()

◆ Transform()

◆ Move()

◆ Rotate()

◆ IsSame()

◆ IsSimilar()

◆ SetEqual()

◆ DistanceToPoint()

◆ AddYourGabaritTo()

◆ CalculateLocalGabarit()

◆ CalculateMesh()

◆ GetProperties()

◆ SetProperties()

◆ GetPlacement()

◆ RebuildItem()

◆ CreateMesh()

◆ CuttingEdge()

◆ MakeCurves()

◆ CreateParts()

◆ CreateContours() [1/4]

◆ CreateContours() [2/4]

◆ CreateContours() [3/4]

◆ CreateContours() [4/4]