C3D Toolkit  Kernel - 118057, Vision - 2.14.7.1821
MbOffsetWireFrameParams Class Reference

Parameters of an offset wire frame. More...

#include <op_wireframe_parameter.h>

+ Inheritance diagram for MbOffsetWireFrameParams:
+ Collaboration diagram for MbOffsetWireFrameParams:

Public Types

enum class  OffsetMethod : uint8 { chordal = 0x01 }
 Enumeration of ways to offset the wire frame. More...
 

Public Member Functions

 MbOffsetWireFrameParams (const MbVector3D &offsetVect, bool useFillet, bool keepRadius, bool bluntAngle, bool fromBeg, const MbSNameMaker &nameMaker, bool useSurfaceNormal, c3d::ConstSurfaceSPtr surface=nullptr)
 Constructor by parameters. More...
 
 MbOffsetWireFrameParams (const MbVector3D &offsetVect, const MbSNameMaker &nameMaker)
 Constructor by parameters. More...
 
DEPRECATE_DECLARE MbOffsetWireFrameParams (c3d::ConstFaceSPtr &face, const MbAxis3D &axis, double dist, const MbSNameMaker &nameMaker)
 Constructor by parameters. More...
 
 MbOffsetWireFrameParams (c3d::ConstSolidSPtr solid, const c3d::IndicesVector &facesIndices, const MbAxis3D &axis, double dist, OffsetMethod method, bool extendWire, bool extendShell, const MbSNameMaker &nameMaker)
 Constructor by parameters. More...
 
virtual ~MbOffsetWireFrameParams ()
 Destructor.
 
c3d::ConstSolidSPtr GetSolid () const
 Get solid.
 
const c3d::IndicesVectorGetIndices () const
 Get indices.
 
const MbSNameMakerGetNameMaker () const
 Get names maker.
 
const MbOffsetWireFrameInfo * GetOffsetInfo () const
 Get parameters. For internal use.
 
- Public Member Functions inherited from MbPrecision
 MbPrecision ()
 Default constructor.
 
 MbPrecision (double _precision, double _deviation)
 Constructor by the specified precision.
 
 MbPrecision (const MbPrecision &other)
 Copy-constructor.
 
 ~MbPrecision ()
 Destructor.
 
void Init (const MbPrecision &other)
 Initialization function.
 
void Init (double _precision)
 Initialization function.
 
MbPrecisionoperator= (const MbPrecision &other)
 Assignment operator.
 
bool IsSame (const MbPrecision &other, double accuracy) const
 Determine whether an object is equal?
 
double GetPrecision () const
 Get precision.
 
void SetPrecision (double a)
 Set precision.
 

Additional Inherited Members

- Static Public Member Functions inherited from MbPrecision
static double GetMaxMetricTolerance ()
 Get the maximum metric tolerance. More...
 
static double GetMaxAngleTolerance ()
 Get the maximum angular tolerance. More...
 
- Static Public Attributes inherited from MbPrecision
static const MbPrecision defaultPrecision
 Default precision (METRIC_PRECISION, ANGLE_REGION);.
 
- Protected Attributes inherited from MbPrecision
double precision
 The metric precision of the construction of objects.
 
double deviation
 The angular precision of the construction of objects.
 

Detailed Description

Parameters of an offset wire frame.

Parameters of an offset wire frame.

Warning
Under development.

Member Enumeration Documentation

◆ OffsetMethod

Enumeration of ways to offset the wire frame.

Enumerator
chordal 

Chordal offset method of a wire frame.

Constructor & Destructor Documentation

◆ MbOffsetWireFrameParams() [1/4]

MbOffsetWireFrameParams::MbOffsetWireFrameParams ( const MbVector3D offsetVect,
bool  useFillet,
bool  keepRadius,
bool  bluntAngle,
bool  fromBeg,
const MbSNameMaker nameMaker,
bool  useSurfaceNormal,
c3d::ConstSurfaceSPtr  surface = nullptr 
)
explicit

Constructor by parameters.

Constructor for offsetting a wire frame.

Parameters
[in]offsetVect- The displacement vector at a point of the wire frame.
[in]useFillet- If 'true', the gaps are to be filled with fillet, otherwise with the extended curves.
[in]keepRadius- If 'true', the existent fillet radii are to be kept.
[in]bluntAngle- If 'true', sharp corners are to be blunt.
[in]fromBeg- The translation vector is associated with the beginning (if true).
[in]nameMaker- An object defining the frame edge names.
[in]useSurfaceNormal- Offset point is moved according to surface normal.
[in]surface- Frame's surface or similar to such surface.

◆ MbOffsetWireFrameParams() [2/4]

MbOffsetWireFrameParams::MbOffsetWireFrameParams ( const MbVector3D offsetVect,
const MbSNameMaker nameMaker 
)
explicit

Constructor by parameters.

Constructor for offsetting a wire frame.

Parameters
[in]offsetVect- The displacement vector at a point of the wire frame.
[in]nameMaker- An object defining the frame edge names.

◆ MbOffsetWireFrameParams() [3/4]

DEPRECATE_DECLARE MbOffsetWireFrameParams::MbOffsetWireFrameParams ( c3d::ConstFaceSPtr face,
const MbAxis3D axis,
double  dist,
const MbSNameMaker nameMaker 
)
explicit

Constructor by parameters.

Deprecated:
The constructor is deprecated and will be removed in version 2026.

Constructor for offsetting a wire frame along a surface.

Parameters
[in]face- The face on which to build the offset wire frame.
[in]axis- The offset direction with a reference point.
[in]dist- The offset distance.
[in]nameMaker- An object defining the frame edge names.

◆ MbOffsetWireFrameParams() [4/4]

MbOffsetWireFrameParams::MbOffsetWireFrameParams ( c3d::ConstSolidSPtr  solid,
const c3d::IndicesVector facesIndices,
const MbAxis3D axis,
double  dist,
OffsetMethod  method,
bool  extendWire,
bool  extendShell,
const MbSNameMaker nameMaker 
)

Constructor by parameters.

Constructor for offsetting a wire frame along a set of faces of the solid.

Parameters
[in]solid- The solid on which to build the offset wire frame.
[in]facesIndices- Indices of the solid faces on which to build the offset wire frame.
[in]axis- The offset direction with a reference point.
[in]dist- The offset distance.
[in]method- The offset method.
[in]extendWire- A flag that determines whether to extend the equidistant line to the edges of the faces.
[in]extendShell- A flag that determines whether to construct an equidistant line on the continuation of the faces (true) or truncate it by the boundaries of the faces (false)
[in]nameMaker- An object defining the frame edge names.

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