C3D Toolkit  Kernel - 117982, Vision - 2.9.2.2

A plane. More...

#include <surf_plane.h>

+ Inheritance diagram for MbPlane:
+ Collaboration diagram for MbPlane:

Public Member Functions

 MbPlane (const MbPlacement3D &initPlane)
 Constructor by a local coordinate system.
 
 MbPlane (const MbCartPoint3D &c0, const MbCartPoint3D &c1, const MbCartPoint3D &c2)
 Constructor by three points.
 
 MbPlane (const MbCartPoint3D &c0, const MbCartPoint3D &ax, const MbVector3D &aZ)
 Constructor by center and axes X and Z.
 
 MbPlane (const MbCartPoint3D &c0, const MbVector3D &ax, const MbVector3D &ay)
 Constructor by center and axes X and Y.

 
 MbPlane (const MbPlacement3D &, double distance)
 Constructor of shifted plane.
 
Initialization functions
void Init (const MbPlane &)
 Initialization by plane.
 
void Init (const MbPlacement3D &init, double distance)
 Initialization by coordinate system and distance. More...
 
void Init (const MbCartPoint3D &p, const MbPlacement3D &init)
 Initialization by point and coordinate system. More...
 
void Init (const MbCartPoint3D &p)
 Initialize by point. More...
 
bool Init (const MbPlacement3D &init, double ang, MbCurve3D &curve, double t=0)
 Initialization by coordinate system, angle, curve and parameter. More...
 
bool Init (const MbCartPoint3D &p, MbCurve3D &curve, double t=0)
 Initialization by point, curve and parameter. More...
 
bool Init (const MbCurve3D &curve, const MbCartPoint3D &p, bool checkPlanar)
 Initialization by point, perpendicularly to curve. More...
 
void Init (const MbPlacement3D &)
 Initialization by local coordinate system.
 
bool Init (const MbLine3D &, const MbCartPoint3D &)
 Initialization by line and point.
 
bool Init (const MbLine3D &, const MbVector3D &)
 Initialization by line and vector.
 
bool Init (const MbLine3D &line1, const MbLine3D &line2)
 Initialization by two lines. More...
 
bool Init (const MbCartPoint3D &c0, const MbCartPoint3D &c1, const MbCartPoint3D &c2)
 Initialization of plane by three points.
 
void Update (const MbPlacement3D &, VERSION version)
 Initialization by placement and version. More...
 
Common functions of a geometric object
MbeSpaceType IsA () const override
 Get the type of the object.
 
MbSpaceItemDuplicate (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...
 
bool IsSame (const MbSpaceItem &other, double accuracy=LENGTH_EPSILON) const override
 Determine whether an object is equal. More...
 
bool SetEqual (const MbSpaceItem &) override
 Make objects equal if they are similar. More...
 
void GetProperties (MbProperties &properties) override
 Outstanding properties of the object. More...
 
void SetProperties (const MbProperties &properties) override
 Change the properties of an object. More...
 
Functions for surface domain description
double GetUMin () const override
 Get the minimum value of u.
 
double GetVMin () const override
 Get the minimum value of v.
 
double GetUMax () const override
 Get the maximum value of u.
 
double GetVMax () const override
 Get the maximum value of v.
 
bool IsUClosed () const override
 Determine whether a surface is closed in u-parameter direction. More...
 
bool IsVClosed () const override
 Determine whether a surface is closed in v-parameter direction. More...
 
Functions for working at surface domain

In contrast to other surfaces functions PointOn and Derive.. of plane don't correct parameters when getting out of rectangular domain bounds.

void PointOn (double &u, double &v, MbCartPoint3D &) const override
 Calculate a point on the surface. More...
 
void DeriveU (double &u, double &v, MbVector3D &) const override
 Calculate first derivative with respect to u.
 
void DeriveV (double &u, double &v, MbVector3D &) const override
 Calculate first derivative with respect to v.
 
void DeriveUU (double &u, double &v, MbVector3D &) const override
 Calculate second derivative with respect to u.
 
void DeriveVV (double &u, double &v, MbVector3D &) const override
 Calculate second derivative with respect to v.
 
void DeriveUV (double &u, double &v, MbVector3D &) const override
 Calculate second derivative.
 
void DeriveUUU (double &u, double &v, MbVector3D &) const override
 Calculate third derivative.
 
void DeriveUUV (double &u, double &v, MbVector3D &) const override
 Calculate third derivative.
 
void DeriveUVV (double &u, double &v, MbVector3D &) const override
 Calculate third derivative.
 
void DeriveVVV (double &u, double &v, MbVector3D &) const override
 Calculate third derivative.
 
void Normal (double &u, double &v, MbVector3D &) const override
 Calculate normal.
 
void NormalU (double &u, double &v, MbVector3D &) const override
 Calculate derivative of normal with respect to U.
 
void NormalV (double &u, double &v, MbVector3D &) const override
 Calculate derivative of normal with respect to V.
 
Functions for working inside and outside the surface domain.

functions _PointOn, _Derive... of surfaces don't correct parameters when getting out of rectangular domain bounds.

void _PointOn (double u, double v, MbCartPoint3D &) const override
 Calculate a point on the surface. More...
 
void _DeriveU (double u, double v, MbVector3D &) const override
 Calculate first derivative with respect to u on extended surface.
 
void _DeriveV (double u, double v, MbVector3D &) const override
 Calculate first derivative with respect to v on extended surface.
 
void _DeriveUU (double u, double v, MbVector3D &) const override
 Calculate second derivative with respect to u on extended surface.
 
void _DeriveVV (double u, double v, MbVector3D &) const override
 Calculate second derivative with respect to v on extended surface.
 
void _DeriveUV (double u, double v, MbVector3D &) const override
 Calculate second derivative on extended surface.
 
void _DeriveUUU (double u, double v, MbVector3D &) const override
 Calculate third derivative on extended surface.
 
void _DeriveUUV (double u, double v, MbVector3D &) const override
 Calculate third derivative on extended surface.
 
void _DeriveUVV (double u, double v, MbVector3D &) const override
 Calculate third derivative on extended surface.
 
void _DeriveVVV (double u, double v, MbVector3D &) const override
 Calculate third derivative on extended surface.
 
void _Normal (double u, double v, MbVector3D &) const override
 Calculate a normal on extended surface.
 
void _NormalU (double u, double v, MbVector3D &) const override
 Calculate derivative of normal vector on extended surface.
 
void _NormalV (double u, double v, MbVector3D &) const override
 Calculate derivative of normal vector on extended surface.
 
void _NormalUU (double u, double v, MbVector3D &) const override
 Calculate second derivative of normal vector on extended surface.
 
void _NormalUV (double u, double v, MbVector3D &) const override
 Calculate second derivative of normal vector on extended surface.
 
void _NormalVV (double u, double v, MbVector3D &) const override
 Calculate second derivative of normal vector on extended surface.
 
Functions for get of the group of data inside and outside the surface's domain of parameters.
void Explore (double &u, double &v, bool ext, MbCartPoint3D &pnt, MbVector3D &uDer, MbVector3D &vDer, MbVector3D *uuDer, MbVector3D *vvDer, MbVector3D *uvDer, MbVector3D *nor) const override
 Calculate point and derivatives of object for given parameters. More...
 
void _PointNormal (double u, double v, MbCartPoint3D &pnt, MbVector3D &deru, MbVector3D &derv, MbVector3D &norm, MbVector3D &noru, MbVector3D &norv, MbVector3D &deruu, MbVector3D &dervv, MbVector3D &deruv) const override
 Calculate all derivatives at point. More...
 
Function of moving on surface
double StepU (double u, double v, double sag) const override
 Calculate parameter step. More...
 
double StepV (double u, double v, double sag) const override
 Calculate parameter step. More...
 
double DeviationStepU (double u, double v, double angle) const override
 Calculate parameter step. More...
 
double DeviationStepV (double u, double v, double angle) const override
 Calculate parameter step. More...
 
double MetricStepU (double u, double v, double length) const override
 Calculate parameter step. More...
 
double MetricStepV (double u, double v, double length) const override
 Calculate parameter step. More...
 
size_t GetUCount () const override
 The number of splittings by u-parameter for a check of events.
 
size_t GetVCount () const override
 The number of splittings by v-parameter for a check of events.
 
Common functions of surface.
void GetLimitPoint (ptrdiff_t number, MbCartPoint3D &pnt) const override
 Calculate the boundary point. More...
 
void GetLimitPoint (ptrdiff_t number, MbCartPoint &pnt) const override
 Calculate the boundary two-dimensional point. More...
 
double CurvatureU (double u, double v) const override
 Calculate line curvature along the direction of u. More...
 
double CurvatureV (double u, double v) const override
 Calculate line curvature along the direction of v. More...
 
bool IsPlanar (double accuracy=METRIC_EPSILON) const override
 Whether a surface is planar.
 
MbSplineSurfaceNurbsSurface (double u1, double u2, double v1, double v2, bool bmatch=false) const override
 Construct a NURBS copy of trimmed surface. More...
 
MbSurfaceNurbsSurface (const MbNurbsParameters &uParam, const MbNurbsParameters &vParam) const override
 Construct a NURBS copy of a surface. More...
 
MbSurfaceOffset (double d, bool same) const override
 Create an offset surface. More...
 
MbCurve3DCurveU (double v, MbRect1D *pRgn, bool bApprox=true) const override
 Construct spatial copy of the line v = const. More...
 
MbCurve3DCurveV (double u, MbRect1D *pRgn, bool bApprox=true) const override
 Construct spatial copy of the line u = const.
More...
 
MbCurve3DCurveUV (const MbLineSegment &, bool bApprox=true) const override
 Construct spatial copy of line by parametric line. More...
 
MbeItemLocation PointRelative (const MbCartPoint3D &pnt, double eps=ANGLE_REGION) const override
 Get point location relative to the surface. More...
 
double DistanceToPoint (const MbCartPoint3D &) const override
 Determine the distance to the point. More...
 
void DirectPointProjection (const MbCartPoint3D &p, const MbVector3D &v, SArray< MbCartPoint > &uv, bool ext, MbRect2D *uvRange=nullptr) const override
 Find all a point projection onto the surface along a vector in either of two directions. More...
 
virtual bool NearDirectPointProjection (const MbCartPoint3D &p, const MbVector3D &vector, double &u, double &v, bool ext, MbRect2D *uvRange=nullptr, bool onlyPositiveDirection=false) const override
 Find the nearest point projection to the surface in the vector direction. More...
 
virtual MbeNewtonResult CurveIntersectNewton (const MbCurve3D &, double funcEpsilon, size_t limit, double &u, double &v, double &t, bool ext0, bool ext) const override
 Solution of equation system for determination of intersections between a surface and a curve. For internal use only.
 
void CurveIntersection (const MbCurve3D &, SArray< MbCartPoint > &uv, SArray< double > &tt, bool ext0, bool ext, bool touchInclude=false) const override
 Determine points of intersection between a surface and a curve. More...
 
MbeNewtonResult SurfaceIntersectNewton (const MbSurface &surf, MbeParamDir switchPar, double funcEpsilon, size_t limit, double &u0, double &v0, double &u1, double &v1, bool ext0, bool ext1) const override
 Solution of equation system for determination of surfaces intersections. For internal use only.
 
bool IsSimilarToSurface (const MbSurface &surf, VERSION version, double precision=METRIC_PRECISION) const override
 Define whether the surfaces are similar for merge. More...
 
bool GetMatrixToSurface (const MbSurface &surf, MbMatrix &matr, VERSION version, double precision=METRIC_PRECISION) const override
 Get two-dimensional matrix of transformation from its parametric region to the parametric region of 'surf'. More...
 
double GetParamDelta () const override
 Get the maximum increment of parameter.
 
double GetParamPrice () const override
 Get the minimum distinguishable value of parameter.
 
double GetUParamToUnit () const override
 Get increment of u-parameter, corresponding to the unit length in space.
 
double GetVParamToUnit () const override
 Get increment of v-parameter, corresponding to the unit length in space.
 
double GetUParamToUnit (double u, double v) const override
 Get increment of u-parameter, corresponding to the unit length in space.
 
double GetVParamToUnit (double u, double v) const override
 Get increment of v-parameter, corresponding to the unit length in space.
 
void GetParamsToUnit (double u, double v, double &uParam, double &vParam) const override
 Get increment of parameters, corresponding to the unit length in space.
 
void GetTesselation (const MbStepData &stepData, double u1, double u2, double v1, double v2, SArray< double > &uu, SArray< double > &vv) const override
 Determine a splitting of parametric region of a surface by verticals and horizontals. More...
 
void CalculateGabarit (MbCube &gab) const override
 Calculate bounding box of surface. It is recommended to use GetGabarit.
 
void CalculateLocalGabarit (const MbMatrix3D &, MbCube &) const override
 To compute bounding box in a local coordinate system. More...
 
bool SetLimit (double u1, double v1, double u2, double v2) override
 Set surface limits. For internal use only.
 
void SetExtendedParamRegion (double u1, double v1, double u2, double v2) override
 Set extended limits of surface. For internal use only.
 
void IncludePoint (double u, double v) override
 Include a point into domain. For internal use only.
 
size_t GetUMeshCount () const override
 The the number of splittings in u-direction.
 
size_t GetVMeshCount () const override
 The the number of splittings in v-direction.
 
bool IsLineU () const override
 Check that all derivatives of surface with respect to u which have more than first order are equal to null.
 
bool IsLineV () const override
 Check that all derivatives of surface with respect to v which have more than first order are equal to null.
 
bool IsShift (const MbSpaceItem &, MbVector3D &, bool &isSame, double accuracy=LENGTH_EPSILON) const override
 Determine whether the object is a translation. More...
 
Functions of elementary surfaces.
bool GetPointProjection (const MbCartPoint3D &p, bool init, double &u, double &v, bool ext, MbRect2D *uvRange=nullptr) const override
 The nearest point projection onto the surface. More...
 
Functions of plane.
bool CubeIntersection (const MbSurface &) const
 Whether the bounding cube of a surface intersects a plane.
 
bool Intersect (const MbCube &c) const
 Whether a plane intersects a cube.
 
void SetLimit (double d)
 Set surface limits. More...
 
void SetLimit (double u, double v)
 Set surface limits. More...
 
bool IncludeCube (const MbCube &)
 Include a cube projection. More...
 
bool AssignCube (const MbCube &)
 Set cube projection. More...
 
double GetNormalAngle (const MbLine3D &line) const
 A sine of an angle between the line and the plane.
 
void Symmetry (MbMatrix3D &m) const
 The matrix of symmetry transformation relative to the plane.
 
void Invert (MbMatrix *=nullptr, MbRegTransform *ireg=nullptr)
 Invert the normal of plane.
 
void SetRightPlacement ()
 Make the coordinate system right.
 
void AdaptToPlace (const MbPlacement3D &p)
 Match with the placement. More...
 
void SetPlacement (const MbPlacement3D &p)
 Set the coordinate system.
 
void PlaneCurveIntersection (const MbPlacement3D &curvePlace, MbCurve &curve, SArray< MbCartPoint > &uv, SArray< double > &tt, bool ext0, bool ext, bool touchInclude=false) const
 Intersection points of a plane and a planar curve. More...
 
bool IsSimilarPlanes (const MbPlane &plane, const MbRect &rect0, const MbRect &rect1) const
 Whether planes are similar to merge. More...
 
bool IsAreaDegenerate () const
 Whether the bounding box of a plane is degenerate.
 
- Public Member Functions inherited from MbElementarySurface
MbeSpaceType Type () const override
 Get the group object type.
 
void Move (const MbVector3D &to, MbRegTransform *=nullptr) override
 Move an object along a vector. More...
 
void Rotate (const MbAxis3D &axis, double angle, MbRegTransform *=nullptr) override
 Rotate an object around an axis at a given angle. More...
 
void GetBasisItems (RPArray< MbSpaceItem > &s) override
 Get the base objects.
 
void GetBasisPoints (MbControlData3D &) const override
 Get control points of object.
 
void SetBasisPoints (const MbControlData3D &) override
 Change the object by control points.
 
MbeNewtonResult PointProjectionNewton (const MbCartPoint3D &p, size_t iterLimit, double &u, double &v, bool ext) const override
 Finding of point projection on surface. For internal use only.
 
bool NearPointProjection (const MbCartPoint3D &p, double &u, double &v, bool ext, MbRect2D *uvRange=nullptr) const override
 Find the projection of a point onto the surface. More...
 
bool IsRectangular () const override
 Determine whether derivatives with respect to u and v are orthogonal.
 
void AddTesselation (double step, size_t maxCount, double w1, double w2, SArray< double > &ww) const
 Add parameters to the array with given step. More...
 
const MbPlacement3DGetPlacement () const
 A local coordinate system.
 
MbPlacement3DSetPlacement ()
 
void InitPlacement (const MbPlacement3D &p)
 Set the local coordinate system.
 
bool IsPositionNormal () const
 Whether the coordinate system is orthonormalized.
 
bool IsPositionIsotropic () const
 Whether the coordinate system is orthogonal and isotropic by the axes.
 
bool IsPositionCircular () const
 Whether the coordinate system is orthogonal with X and Y axes equal by length.
 
- Public Member Functions inherited from MbSurface
virtual ~MbSurface ()
 Destructor.
 
virtual void Accept (Visitor &visitor)
 Implementation of a function initializing a visit of an object.
 
MbeSpaceType Type () const override
 Get the group object type.
 
MbeSpaceType Family () const override
 Get family of objects.
 
double DistanceToPoint (const MbCartPoint3D &) const override
 Determine the distance to the point. More...
 
void AddYourGabaritTo (MbCube &c) const override
 Expand sent bounding box (a.k.a. gabarit), so that it included the object. More...
 
void Refresh () override
 Translate all the time (mutable) data objects in an inconsistent (initial) state.
 
virtual void PrepareIntegralData (const bool forced) const
 Calculate temporary (mutable) data of an object. More...
 
void CalculateMesh (const MbStepData &stepData, const MbFormNote &note, MbMesh &mesh) const override
 Build polygonal copy mesh. More...
 
MbPropertyCreateProperty (MbePrompt name) const override
 Create your own property with the name.
 
void GetBasisPoints (MbControlData3D &) const override
 Get control points of object.
 
void SetBasisPoints (const MbControlData3D &) override
 Change the object by control points.
 
size_t size () const
 Number of objects if object is interpreted as vector of objects.
 
const MbSurfaceoperator[] (size_t) const
 An access operator.
 
virtual bool IsUTouch () const
 Determine whether a surface is closed in u-parameter direction regardless of the smoothness of the closure. More...
 
virtual bool IsVTouch () const
 Determine whether a surface is closed in v-parameter direction regardless of the smoothness of the closure. More...
 
virtual bool IsUPeriodic () const
 Determine whether a surface is closed in u-parameter direction. More...
 
virtual bool IsVPeriodic () const
 Determine whether a surface is closed in v-parameter direction. More...
 
virtual double GetUPeriod () const
 Return period for smoothly closed surface or 0.
 
virtual double GetVPeriod () const
 Return period for smoothly closed surface or 0.
 
virtual double GetPeriod (ptrdiff_t i) const
 Return period. More...
 
virtual size_t Periodicity () const
 Determine periodicity. More...
 
virtual bool GetPoleUMin () const
 Whether a pole exists on parametric region boundary.
 
virtual bool GetPoleUMax () const
 Whether a pole exists on parametric region boundary.
 
virtual bool GetPoleVMin () const
 Whether a pole exists on parametric region boundary.
 
virtual bool GetPoleVMax () const
 Whether a pole exists on parametric region boundary.
 
virtual bool IsPole (double u, double v, double paramPrecision=PARAM_PRECISION) const
 Whether the point is a pole.
 
bool IsPole (const MbCartPoint &uv, double paramPrecision=PARAM_PRECISION) const
 Whether the point is a pole.
 
virtual void TangentU (double &u, double &v, MbVector3D &) const
 Calculate tangent vector in u.
 
virtual void TangentV (double &u, double &v, MbVector3D &) const
 Calculate tangent vector in v.
 
virtual void Explore (double &u, double &v, MbCartPoint3D &pnt, MbVector3D &uDer, MbVector3D &vDer) const
 Calculate point and first derivatives with respect to u and with respect to v. More...
 
virtual void _TangentU (double u, double v, MbVector3D &) const
 Calculate tangent vector in u direction on extended surface.
 
virtual void _TangentV (double u, double v, MbVector3D &) const
 Calculate tangent vector in v direction on extended surface.
 
virtual void _NormalD (double u, double v, double du, double dv, MbVector3D &der) const
 Calculate derivative of normal vector at the point with the given parameters u and v along the line with the given direction (du,dv).
 
virtual void _NormalDD (double u, double v, double du, double dv, MbVector3D &der) const
 Calculate second derivative of normal vector at the point with the given parameters u and v along the line with the given direction (du,dv).
 
double SurfaceStep (const double &u, const double &v, bool alongU, const MbStepData &stepData) const
 Calculate parameter step. More...
 
virtual const MbSurfaceGetSurface () const
 Get itself (it is overloaded only in CurveBoundedSurface).
 
virtual const MbSurfaceGetBasisSurface () const
 Get the base surface if exists or itself.
 
virtual MbSurfaceSetSurface ()
 Get itself (it is overloaded only in CurveBoundedSurface).
 
virtual MbSurfaceSetBasisSurface ()
 Get the base surface if exists or itself.
 
MbCartPoint3D GetLimitPoint (ptrdiff_t number) const
 Calculate the boundary point. More...
 
double NormalCurvatureU (double u, double v) const
 Calculate a normal curvature of line along the direction of u. More...
 
double NormalCurvatureV (double u, double v) const
 Calculate a normal curvature of line along the direction of v. More...
 
double NormalCurvature (double u, double v, double du, double dv) const
 Calculate a normal curvature of surface. More...
 
bool MeanGaussCurvature (double u, double v, double &mean, double &gauss) const
 Calculate the mean and the Gaussian curvature.
More...
 
bool MainCurvatures (double u, double v, double &c1, double &c2, double &du, double &dv) const
 Calculate the mean and the Gaussian curvature.
More...
 
virtual bool IsSameBase (const MbSurface &) const
 Whether a base surface is a copy of the base surface of the given object.
 
virtual double GetRadius () const
 Get the physical radius of the object or null if it impossible.
More...
 
virtual double GetFilletRadius (const MbCartPoint3D &p, double accuracy=METRIC_REGION) const
 Get fillet radius if the surface is a fillet surface with the set accuracy. More...
 
virtual MbeParamDir GetFilletDirection (double accuracy=METRIC_REGION) const
 Direction of fillet surface with accuracy. More...
 
virtual bool GetCylinderAxis (MbAxis3D &) const
 Get rotation axis of a surface.
 
virtual bool GetCentre (MbCartPoint3D &c) const
 Give the center of sphere surface.
 
virtual bool GetCenterLines (std::vector< MbCurve3D * > &clCurves) const
 Get center lines of a surface.
 
virtual void ChangeCarrier (const MbSpaceItem &item, MbSpaceItem &init)
 Changing of carrier. More...
 
virtual bool ChangeCarrierBorne (const MbSurface &item, MbSurface &init, const MbMatrix &matr)
 Changing of carrier elements. More...
 
virtual bool IsSpinePeriodic () const
 Periodicity of the guide. More...
 
MbSplineSurfaceNurbsSurface (bool bmatch=false) const
 Construct a NURBS copy of a surface. More...
 
bool NurbsParam (const MbNurbsParameters &tParam, bool uParam, double op1, double op2, bool &isClosedNurbs, double &epsilon, SArray< double > &params) const
 Prepare parameters for the transformation to NURBS surface. More...
 
void CheckApproxPointParamsOpen (bool isU, double par, size_t degree, size_t pCount, SArray< double > &tList, SArray< double > &aKnots) const
 Chose points for approximation along the parameter. More...
 
void CheckApproxPointParamsClosed (bool isU, double par, size_t degree, size_t pCount, SArray< double > &tList, SArray< double > &aKnots) const
 Chose points for approximation along the parameter. More...
 
virtual MbeItemLocation PointClassification (const MbCartPoint &pnt, bool ignoreClosed=false) const
 A point is located inside the region on a surface. More...
 
virtual double DistanceToBorder (const MbCartPoint &point, double &epsilon) const
 Calculate the parametric distance to the nearest boundary. More...
 
virtual size_t CurveClassification (const MbCurve &curve, SArray< double > &tcurv, SArray< MbVector > &dir) const
 Determine points of intersections between the curve and the surface contours. More...
 
size_t SurfaceBorderIntersection (const MbCurve &curve, SArray< double > &tcurv, SArray< MbVector > &dir) const
 Determine points of intersections between the curve and the surface contours. More...
 
virtual MbeNewtonResult DirectPointProjectionNewton (const MbCartPoint3D &p, const MbVector3D &vect, size_t iterLimit, double &u, double &v, double &w, bool ext) const
 Finding of point projections to the surface in direction of the vector. For internal use only.
 
virtual MbeNewtonResult CurveTangentNewton (const MbCurve3D &curv1, double funcEpsilon, size_t iterLimit, double &u0, double &v0, double &t1, bool ext0, bool ext1) const
 Solution of equation system for determination of tangency between a surface and a curve. For internal use only.
 
virtual MbeNewtonResult SurfaceTangentNewton (const MbSurface &surf1, MbeParamDir switchPar, double funcEpsilon, size_t iterLimit, double &u0, double &v0, double &u1, double &v1, bool ext0, bool ext1) const
 Solution of equation system for determination of surfaces tangency. For internal use only.
 
virtual MbeNewtonResult SilhouetteNewton (const MbVector3D &eye, bool perspective, const MbAxis3D *axis, MbeParamDir switchPar, double funcEpsilon, size_t iterLimit, double &u, double &v, bool ext) const
 Solution of equation system for determination of surface silhouette points. For internal use only.

 
virtual bool IsSpecialSimilarToSurface (const MbSurface &surf, VERSION version, double precision=METRIC_PRECISION) const
 Whether the surfaces are similar to merge. Special case. For internal use only.
 
virtual bool ProjectCurveOnSimilarSurface (const MbCurve3D &spaceCurve, const MbCurve &curve, const MbSurface &surfNew, MbCurve *&curveNew) const
 Construction of projection of a surface curve on coincident surface. More...
 
bool ProjectCurveOnSimilarSurface (const MbCurve3D &spaceCurve, const MbCurve &curve, const MbSurface &surfNew, SPtr< MbCurve > &curveNew) const
 Construction of projection of a surface curve on coincident surface. More...
 
virtual ThreeStates Salient () const
 Determine whether the surface is convex. More...
 
virtual double DistanceToCurve (const MbCurve3D &curve, double &u, double &v, double &t, bool tCalc=false) const
 Calculate the nearest distance to a curve. More...
 
virtual double DistanceToSurface (const MbSurface &surf1, double &u0, double &v0, double &u1, double &v1) const
 Calculate the nearest distance to a surface. More...
 
virtual bool CreateNormalPlacements (const MbVector3D &axisZ, double angle, SArray< MbPlacement3D > &places, VERSION version=Math::DefaultMathVersion()) const
 Construct normal placements of constructive planes.

 
virtual bool CreateTangentPlacements (const MbVector3D &axisZ, SArray< MbPlacement3D > &places) const
 Construct tangent placements of constructive planes.
 
MbeNewtonResult PlacementNewton (const MbVector3D &vec, double angle, MbeParamDir switchPar, size_t iterLimit, double &u, double &v) const
 Construct tangent placements of constructive planes. For internal use only.
 
bool CreateVconstPlacements (const MbVector3D &axisZ, double angle, bool normalPlace, SArray< MbPlacement3D > &places) const
 Construct the normal or tangent placements on v-lines.
 
bool CreateUconstPlacements (const MbVector3D &axisZ, double angle, bool normalPlace, SArray< MbPlacement3D > &places) const
 Construct the normal or tangent placements on u-lines.
 
virtual double ParamArea () const
 Calculate the area of parameters domain.
 
virtual size_t GetUPairs (double v, SArray< double > &u) const
 Calculate U-pairs by V. More...
 
virtual size_t GetVPairs (double u, SArray< double > &v) const
 Calculate V-pairs by U. More...
 
MbeNewtonResult IsoclinalNewton (const MbVector3D &dir, size_t iterLimit, double &u, double &v) const
 Determination of parameters of a surface isocline point. For internal use only.
 
virtual void GetIsoclinal (const MbVector3D &nor, SArray< MbCartPoint > &uv) const
 Find all isoclines of a surface. More...
 
void CalculateLocalGabarit (const MbMatrix3D &into, MbCube &cube) const override
 Calculate bounding box in the local coordinate system.
 
const MbCubeGetGabarit () const
 Calculate bounding box of surface.
 
const MbCubeCube () const
 Return saved bounding box. It should be empty. It is recommended to use GetGabarit.
 
void SetDirtyGabarit () const
 Make the bounding box empty. For internal use only.
 
void CopyGabarit (const MbSurface &s, const MbVector3D *to=nullptr)
 Copy the bounding box from the copy. More...
 
double GetGabDiagonal () const
 Calculate the diagonal of the bounding box.
 
void CalculateRect (const MbPlacement3D &place, MbRect &rect) const
 Calculate the rectangular bounding box of a surface in the given plane. More...
 
virtual MbContourMakeContour (bool sense) const
 Return the bounding two-dimensional contour. More...
 
virtual MbCurveMakeSegment (size_t i, bool sense) const
 Return a segment of the bounding two-dimensional contour. More...
 
MbCurveMakeCurve (size_t number1, size_t number2) const
 Return a segment of the bounding two-dimensional contour. More...
 
bool SetLimit (const MbRect &)
 Set surface limits. For internal use only.
 
double GetMaxParamDeltaU () const
 Get the maximum increment of U-parameter.
 
double GetMaxParamDeltaV () const
 Get the maximum increment of V-parameter.
 
double GetUParamToUnit (const MbCartPoint &uv) const
 Get increment of u-parameter, corresponding to the unit length in space.
 
double GetVParamToUnit (const MbCartPoint &uv) const
 Get increment of v-parameter, corresponding to the unit length in space.
 
double GetUEpsilon () const
 Get the minimum distinguishable value of u-parameter. It corresponds to the length Math::metricEpsilon in space.
 
double GetVEpsilon () const
 Get the minimum distinguishable value of v-parameter. It corresponds to the length Math::metricEpsilon in space.
 
double GetUEpsilon (double u, double v) const
 Get the minimum distinguishable value of u-parameter. It corresponds to the length Math::metricEpsilon in space.
 
double GetVEpsilon (double u, double v) const
 Get the minimum distinguishable value of v-parameter. It corresponds to the length Math::metricEpsilon in space.
 
double GetURegion () const
 Get the minimum distinguishable value of u-parameter. It corresponds to the length Math::metricRegion in space.
 
double GetVRegion () const
 Get the minimum distinguishable value of v-parameter. It corresponds to the length Math::metricRegion in space.
 
double GetURegion (double u, double v) const
 Get the minimum distinguishable value of u-parameter. It corresponds to the length Math::metricRegion in space.
 
double GetVRegion (double u, double v) const
 Get the minimum distinguishable value of v-parameter. It corresponds to the length Math::metricRegion in space.
 
void CalculatePolygon (double minPar, double maxPar, double constPar, MbeParamDir dir, const MbStepData &stepData, MbPolygon3D &polygon) const
 Calculate polygon by u or v. More...
 
virtual void CalculateSurfaceWire (const MbStepData &stepData, size_t beg, MbMesh &mesh, size_t uMeshCount=c3d::WIRE_MAX, size_t vMeshCount=c3d::WIRE_MAX) const
 Calculate mesh. More...
 
void AddTesselation (const MbStepData &stepData, MbeParamDir dir, double u1, double u2, double v1, double v2, SArray< double > &uu, SArray< double > &vv) const
 Determine splitting of the surface parametric region according to direction. More...
 
virtual void CalculateSurfaceGrid (const MbStepData &stepData, bool sense, MbGrid &grid) const
 Approximate a surface by triangular plates. More...
 
virtual void CheckSurfParams (double &u, double &v) const
 Check parameters. Analogue of the global function _CheckParams, optimized for caches usage. More...
 
bool GetPlacement (MbPlacement3D *place, bool exact=false) const
 Get a local coordinate system of planar surface (or only a possibility of getting it).
 
bool GetPlanePlacement (MbPlacement3D &place) const
 Get a local coordinate system if a surface is a plane.
 
bool GetControlPlacement (MbPlacement3D &place, bool sameSense=true) const
 Construct a local coordinate system of a surface with origin at the middle point of base surface parametric limits. More...
 
bool OrientPlacement (MbPlacement3D &place, bool normalSense=true) const
 Orient an axis X of a placement along the line of its intersection with surface.
 
bool IsPointOn (const MbCartPoint3D &, double eps=METRIC_PRECISION) const
 Determine whether a point is located on a surface or not.
 
void PointOn (MbCartPoint &uv, MbCartPoint3D &p) const
 Calculate the point on a surface inside the domain of surface.
 
void _PointOn (const MbCartPoint &uv, MbCartPoint3D &p) const
 Calculate a point on a surface extension.
 
void Normal (MbCartPoint &uv, MbVector3D &v) const
 Calculate the normal vector to a surface inside the domain of surface.
 
bool GetMatrix (double xMin, double xMax, double yMin, double yMax, MbMatrix &matr) const
 Find a matrix of transformation for the curves on a surface when the parameterization is changed. More...
 
double GetUMid () const
 The middle value of u.
 
double GetVMid () const
 The middle value of v.
 
double GetURange () const
 Parametric length by u.
 
double GetVRange () const
 Parametric length by v.
 
void GetRect (MbRect &r) const
 Get parametric bounding box.
 
void GetRect (MbRect2D &r) const
 Get parametric bounding box.
 
- 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 bool IsSimilar (const MbSpaceItem &item) const
 Determine whether an object is similar. More...
 
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 MbNestSyncItem
void Lock () const
 Switch lock on (locking happens only in parallel region).
 
void Unlock () const
 Switch lock off if locking has been set.
 
CommonRecursiveMutexGetLock () const
 Get a pointer to the mutex object. Return nullptr if no parallelism. For use in ScopedLock.
 

Additional Inherited Members

- Protected Member Functions inherited from MbSurface
 MbSurface ()
 Constructor.
 
 MbSurface (const MbSurface &)
 Copy-constructor.
 
void MoveGabarit (const MbVector3D &v)
 Move bounding box.
 
void NormalCalculation (const MbVector3D &uDer, const MbVector3D &vDer, double u, double v, bool ext, MbVector3D &nor) const
 Normal calculation by derivatives uDer and vDer on point with parameters u, v.
 
double StepAlong (double u, double v, double sag, bool alongU, double stepMinCoeff, const MbVector3D &der, const MbVector3D &sec) const
 Step calculation by sag.
 
double DeviationStepAlong (double u, double v, double angle, bool alongU, const MbVector3D &der, const MbVector3D &sec) const
 Step calculation by normal deviation.
 
- Protected Member Functions inherited from MbSpaceItem
 MbSpaceItem ()
 Default constructor.
 
- Protected Member Functions inherited from MbRefItem
 MbRefItem ()
 Constructor without parameters.
 
- Protected Attributes inherited from MbElementarySurface
MbPlacement3D position
 Local coordinate system.
 
double umin
 Minimal value of first parameter.
 
double vmin
 Minimal value of second parameter.
 
double umax
 Maximal value of first parameter.
 
double vmax
 Maximal value of second parameter.
 
- Protected Attributes inherited from MbSurface
MbCube cube
 Bounding box of surface. More...
 

Detailed Description

A plane.

A plane is located on the XY coordinate plane of the local coordinate system 'position'.
Parameters of plane are calculated from the coordinates origin 'position.origin'. The first parameter of plane is calculated on the axis 'position.axisX', the second parameter of plane is calculated on the axis 'position.axisY'.
A plane behaves like an infinite surface, although it has boundary parameter values umin, umax and vmin, vmax.
In contrast to other surfaces functions PointOn and Derive.. of plane don't correct parameters when getting out of rectangular domain bounds.

Radius-vector of the surface is described by the vector function
r(u,v) = position.origin + (u position.axisX) + (v position.axisY).

Member Function Documentation

◆ Init() [1/7]

void MbPlane::Init ( const MbPlacement3D init,
double  distance 
)

Initialization by coordinate system and distance.

Initialization by coordinate system and translation by the distance 'distance' in direction of the normal vector (Z axis).

Parameters
[in]init- Coordinate system
[in]distance- Distance

◆ Init() [2/7]

void MbPlane::Init ( const MbCartPoint3D p,
const MbPlacement3D init 
)

Initialization by point and coordinate system.

Initialization by point and coordinate system.
The result is a plane with right coordinate system.

Parameters
[in]p- A point, it defines location of the plane origin.
[in]init- A coordinate system, it defines direction of Z and X axes.

◆ Init() [3/7]

void MbPlane::Init ( const MbCartPoint3D p)

Initialize by point.

Initialization by point.
The result is a plane with right coordinate system.
Directions of Z and X axes remain.

Parameters
[in]p- A point, it defines location of the plane origin.

◆ Init() [4/7]

bool MbPlane::Init ( const MbPlacement3D init,
double  ang,
MbCurve3D curve,
double  t = 0 
)

Initialization by coordinate system, angle, curve and parameter.

Initialization by coordinate system, angle, curve and parameter.

In case of success we get a plane:
with right coordinate system,
center of coordinate system is defined by a point on a curve 'curve' with parameter t;
direction of the axis X is defined by the derivative vector of a curve 'curve' in the point with parameter t;
direction of Z axis is defined by Z axis of the coordinate system 'init' rotated around the axis with the direction of
X axis by the angle 'angle'.

Parameters
[in]init- Coordinate system
[in]ang- Angle
[in]curve- Curve
[in]t- Parameter on curve
Returns
Returns true in case of success.

◆ Init() [5/7]

bool MbPlane::Init ( const MbCartPoint3D p,
MbCurve3D curve,
double  t = 0 
)

Initialization by point, curve and parameter.

Initialization by point, curve and parameter.
In case of success we get a plane:
with origin at the point of the curve with parameter t;
direction of the axis X is defined by the derivative vector of a curve in the point with parameter t;
direction of Y axis is defined by the vector from the point on the curve to point p.

Parameters
[in]p- Point
[in]curve- Curve
[in]t- Parameter on curve
Returns
Returns true in case of success.

◆ Init() [6/7]

bool MbPlane::Init ( const MbCurve3D curve,
const MbCartPoint3D p,
bool  checkPlanar 
)

Initialization by point, perpendicularly to curve.

Initialization by point, perpendicularly to curve.

Parameters
[in]p- Point
[in]curve- Curve
[in]checkPlanar- Use curve information, if it's planar.

◆ Init() [7/7]

bool MbPlane::Init ( const MbLine3D line1,
const MbLine3D line2 
)

Initialization by two lines.

Initialization by two lines.
In case of success it initializes a plane by the first line and direction of the second line.

Parameters
[in]line1- First line.
[in]line2- Second line

◆ Update()

void MbPlane::Update ( const MbPlacement3D ,
VERSION  version 
)

Initialization by placement and version.

Initialization by placement and version.

Warning
This can be used only in KOMPAS-3D.

◆ Duplicate()

MbSpaceItem& MbPlane::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 MbPlane::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.

Reimplemented from MbElementarySurface.

◆ IsSame()

bool MbPlane::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.

◆ SetEqual()

bool MbPlane::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.

◆ GetProperties()

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

◆ IsUClosed()

bool MbPlane::IsUClosed ( ) const
overridevirtual

Determine whether a surface is closed in u-parameter direction.

Determine whether a surface is closed smoothly in u-parameter direction without regard to the boundary contour. It is always false for MbCurveBoundSurface. It is recommended to use IsUPeriodic.

Implements MbSurface.

◆ IsVClosed()

bool MbPlane::IsVClosed ( ) const
overridevirtual

Determine whether a surface is closed in v-parameter direction.

Determine whether a surface is closed smoothly in v-parameter direction without regard to the boundary contour. It is always false for MbCurveBoundSurface. It is recommended to use IsVPeriodic.

Implements MbSurface.

◆ PointOn()

void MbPlane::PointOn ( double &  u,
double &  v,
MbCartPoint3D p 
) const
overridevirtual

Calculate a point on the surface.

Correct parameters when getting out of rectangular domain bounds and Calculate a point on the surface.

Parameters
[in]u- First surface parameter.
[in]v- Second surface parameter.
[out]p- A point on the surface.

Implements MbSurface.

◆ _PointOn()

void MbPlane::_PointOn ( double  u,
double  v,
MbCartPoint3D p 
) const
overridevirtual

Calculate a point on the surface.

Calculate a point on the surface including the outside area determination parameters.

Parameters
[in]u- First surface parameter.
[in]v- Second surface parameter.
[out]p- A point on the surface or on extended surface.

Reimplemented from MbSurface.

◆ Explore()

void MbPlane::Explore ( double &  u,
double &  v,
bool  ext,
MbCartPoint3D pnt,
MbVector3D uDer,
MbVector3D vDer,
MbVector3D uuDer,
MbVector3D vvDer,
MbVector3D uvDer,
MbVector3D nor 
) const
overridevirtual

Calculate point and derivatives of object for given parameters.

Values of point and derivatives are calculated on parameters area and on extended surface.

Parameters
[in]u- Parameter.
[in]v- Parameter.
[in]ext- On parameters area (false), on extended surface (true).
[out]pnt- Point.
[out]uDer- Derivative with respect to u.
[out]vDer- Derivative with respect to v.
[out]uuDer- Second derivative with respect to u, if not nullptr.
[out]vvDer- Second derivative with respect to v, if not nullptr.
[out]uvDer- Second derivative with respect to u and v, if not nullptr.

Reimplemented from MbSurface.

◆ _PointNormal()

void MbPlane::_PointNormal ( double  u,
double  v,
MbCartPoint3D pnt,
MbVector3D deru,
MbVector3D derv,
MbVector3D norm,
MbVector3D noru,
MbVector3D norv,
MbVector3D deruu,
MbVector3D dervv,
MbVector3D deruv 
) const
overridevirtual

Calculate all derivatives at point.

Values of point and derivatives are calculated an extended surface.

Parameters
[in]u- Parameter.
[in]v- Parameter.
[out]pnt- Point.
[out]deru- Derivative with respect to u.
[out]derv- Derivative with respect to v.
[out]norm- Normal.
[out]noru- Derivative of normal vector with respect to u.
[out]norv- Derivative of normal vector with respect to v.
[out]deruu- Second derivative with respect to u.
[out]dervv- Second derivative with respect to v.
[out]deruv- Second derivative with respect to u and v.

Reimplemented from MbSurface.

◆ StepU()

double MbPlane::StepU ( double  u,
double  v,
double  sag 
) const
overridevirtual

Calculate parameter step.

Calculate parameter step for the surface approximation by its sag value along a line with a constant value of v. Calculation of the step is performed with consideration of curvature radius. A step of surface approximation along a curve is chosen in such way, that the deviation from its polygon does not exceed the given value of sag.

Parameters
[in]u- A parameter defining a point on the surface.
[in]v- A parameter defining a point on the surface.
[in]sag- Maximum feasible sag value.
Returns
A sag value by parameter at given point.

Reimplemented from MbSurface.

◆ StepV()

double MbPlane::StepV ( double  u,
double  v,
double  sag 
) const
overridevirtual

Calculate parameter step.

Calculate parameter step for the surface approximation by its sag value along a line with a constant value of u. Calculation of the step is performed with consideration of curvature radius. A step of surface approximation along a curve is chosen in such way, that the deviation from its polygon does not exceed the given value of sag.

Parameters
[in]u- A parameter defining a point on the surface.
[in]v- A parameter defining a point on the surface.
[in]sag- Maximum feasible sag value.
Returns
A sag value by parameter at given point.

Reimplemented from MbSurface.

◆ DeviationStepU()

double MbPlane::DeviationStepU ( double  u,
double  v,
double  angle 
) const
overridevirtual

Calculate parameter step.

Calculate parameter step for the surface approximation by the deviation angle of the tangent vector along a line with a constant value of u. A step of surface approximation along a curve is chosen in such way, that angular deviation of the tangent to the curve at the next point does not exceed the given value ang.

Parameters
[in]u- A parameter defining a point on the surface.
[in]v- A parameter defining a point on the surface.
[in]ang- The maximum feasible deviation angle of tangent.
Returns
A sag value by parameter at given point.

Reimplemented from MbSurface.

◆ DeviationStepV()

double MbPlane::DeviationStepV ( double  u,
double  v,
double  angle 
) const
overridevirtual

Calculate parameter step.

Calculate parameter step for the surface approximation by the deviation angle of the tangent vector along a line with a constant value of v. A step of surface approximation along a curve is chosen in such way, that angular deviation of the tangent to the curve at the next point does not exceed the given value ang.

Parameters
[in]u- A parameter defining a point on the surface.
[in]v- A parameter defining a point on the surface.
[in]ang- The maximum feasible deviation angle of tangent.
Returns
A sag value by parameter at given point.

Reimplemented from MbSurface.

◆ MetricStepU()

double MbPlane::MetricStepU ( double  u,
double  v,
double  length 
) const
overridevirtual

Calculate parameter step.

Calculate the parameter step for approximation of a surface by the given metric length of a step along a line with a constant value of u.

Parameters
[in]u- A parameter defining a point on the surface.
[in]v- A parameter defining a point on the surface.
[in]len- The given metric length.
Returns
A sag value by parameter at given point.

Reimplemented from MbSurface.

◆ MetricStepV()

double MbPlane::MetricStepV ( double  u,
double  v,
double  length 
) const
overridevirtual

Calculate parameter step.

Calculate the parameter step for approximation of a surface by the given metric length of a step along a line with a constant value of v.

Parameters
[in]u- A parameter defining a point on the surface.
[in]v- A parameter defining a point on the surface.
[in]len- The given metric length.
Returns
A sag value by parameter at given point.

Reimplemented from MbSurface.

◆ GetLimitPoint() [1/2]

void MbPlane::GetLimitPoint ( ptrdiff_t  number,
MbCartPoint3D pnt 
) const
overridevirtual

Calculate the boundary point.

Calculate one of the points where parameters take the maximum or the minimum values.

Parameters
[in]number- A number of a boundary point.
1 corresponds to the point (umin, vmin)
2 corresponds to the point (umax, vmin)
3 corresponds to the point (umax, vmax)
4 corresponds to the point (umin, vmax)
[in,out]pnt- A calculated point.

Reimplemented from MbSurface.

◆ GetLimitPoint() [2/2]

void MbPlane::GetLimitPoint ( ptrdiff_t  number,
MbCartPoint pnt 
) const
overridevirtual

Calculate the boundary two-dimensional point.

Calculate one of the points where parameters take the maximum or the minimum values.

Parameters
[in]number- A number of a boundary point.
1 corresponds to the point (umin, vmin)
2 corresponds to the point (umax, vmin)
3 corresponds to the point (umax, vmax)
4 corresponds to the point (umin, vmax)
[in,out]pnt- A calculated point.

Reimplemented from MbSurface.

◆ CurvatureU()

double MbPlane::CurvatureU ( double  u,
double  v 
) const
overridevirtual

Calculate line curvature along the direction of u.

There is calculated a line curvature along the direction of u when v = const.

Parameters
[in]u- Parameter.
[in]v- Parameter.
Returns
Curvature.

Reimplemented from MbSurface.

◆ CurvatureV()

double MbPlane::CurvatureV ( double  u,
double  v 
) const
overridevirtual

Calculate line curvature along the direction of v.

There is calculated a line curvature along the direction of v when u = const.

Parameters
[in]u- Parameter.
[in]v- Parameter.
Returns
Curvature.

Reimplemented from MbSurface.

◆ NurbsSurface() [1/2]

MbSplineSurface* MbPlane::NurbsSurface ( double  u1,
double  u2,
double  v1,
double  v2,
bool  bmatch = false 
) const
overridevirtual

Construct a NURBS copy of trimmed surface.

An obtained surface is always unclosed in u and in v. The exception is the NURBS surface itself. If the surface does not require recalculation, then a copy of it is returned. Parameters u1, u2, v1 and v2 are the bounds of surface trimming.

Parameters
[in]u1- Minimum parameter in U.
[in]u2- Maximum parameter in U.
[in]v1- Minimum parameter in V.
[in]v2- Maximum parameter in V.
[in]bmatch- true, if it is required to keep one-to-one correspondence of parametric regions in mapping.

Reimplemented from MbSurface.

◆ NurbsSurface() [2/2]

MbSurface* MbPlane::NurbsSurface ( const MbNurbsParameters uParam,
const MbNurbsParameters vParam 
) const
overridevirtual

Construct a NURBS copy of a surface.

Constructs a NURBS surface which approximates a given surface with the given parameters in each direction. In parameters the degree and the number of knots of a spline and the range of curve's parameters changing may be set. If the flag of accurate approximation is not set in parameters then NURBS without multiple knots is constructed.

Parameters
[in]uParam- Parameters of construction in u direction.
[in]vParam- Parameters of construction in v direction.
Returns
The constructed NURBS surface or nullptr in a case of failure.

Reimplemented from MbSurface.

◆ Offset()

MbSurface* MbPlane::Offset ( double  d,
bool  same 
) const
overridevirtual

Create an offset surface.

Parameters
[in]d- Distance by the normal vector from the base surface to the offset surface.
[in]same- A flag showing whether to use the current surface or its copy in offset surface.

Reimplemented from MbSurface.

◆ CurveU()

MbCurve3D* MbPlane::CurveU ( double  v,
MbRect1D pRgn,
bool  bApprox = true 
) const
overridevirtual

Construct spatial copy of the line v = const.

Parameters
[in]v- Parameter in V direction.
[in]pRgn- A range of u-parameters.
[in]bApprox- If false, then it returns null only in a case when the exact curve has been successfully created.
If true, then it returns null in a case when the curve is not degenerate.
Returns
Constructed curve.

Reimplemented from MbSurface.

◆ CurveV()

MbCurve3D* MbPlane::CurveV ( double  u,
MbRect1D pRgn,
bool  bApprox = true 
) const
overridevirtual

Construct spatial copy of the line u = const.

Parameters
[in]u- Parameter in U direction.
[in]pRgn- A range of v-parameters.
[in]bApprox- If false, then it returns null only in a case when the exact curve has been successfully created.
If true, then it returns null in a case when the curve is not degenerate.
Returns
Constructed curve.

Reimplemented from MbSurface.

◆ CurveUV()

MbCurve3D* MbPlane::CurveUV ( const MbLineSegment segm,
bool  bApprox = true 
) const
overridevirtual

Construct spatial copy of line by parametric line.

Parameters
[in]segm- A segment in parametric plane of surface, a spatial copy of which is required to construct.
[in]bApprox- If false, then it returns null only in a case when the exact curve has been successfully created.
If true, then it returns null in a case when the curve is not degenerate.

Reimplemented from MbSurface.

◆ PointRelative()

MbeItemLocation MbPlane::PointRelative ( const MbCartPoint3D pnt,
double  eps = ANGLE_REGION 
) const
overridevirtual

Get point location relative to the surface.

Parameters
[in]pnt- The investigated point.
[in]eps- Tolerance of getting a point onto a surface.
Returns
Iloc_InItem = 1 - point is located over the surface (from the side of normal vector)
iloc_OnItem = 0 - point is located on the surface,
iloc_OutOfItem = -1 - point is located under the surface.

Reimplemented from MbSurface.

◆ DistanceToPoint()

double MbPlane::DistanceToPoint ( const MbCartPoint3D point) const
overridevirtual

Determine the distance to the point.

Determine the distance to the point.

Parameters
[in]point- Point.
Returns
Distance to point

Reimplemented from MbElementarySurface.

◆ DirectPointProjection()

void MbPlane::DirectPointProjection ( const MbCartPoint3D pnt,
const MbVector3D vect,
SArray< MbCartPoint > &  uv,
bool  ext,
MbRect2D uvRange = nullptr 
) const
overridevirtual

Find all a point projection onto the surface along a vector in either of two directions.

Calculate all points of intersection with the ray outgoing from the given point 'p' by the direction 'vect'. If the range of parameters changing 'uvRange' is set, then it is required to find a projection in the given range. A range of parameters may not belong to the domain of a surface.

Parameters
[in]pnt- A given point.
[in]vect- A direction vector.
[out]uv- A set of projection points in the area of surface definition.
[in]ext- A flag defining whether to seek projection on the extension of the surface.
[in]uvRange- A range of surface parameters changing in which the solution should be found.

Reimplemented from MbSurface.

◆ NearDirectPointProjection()

virtual bool MbPlane::NearDirectPointProjection ( const MbCartPoint3D pnt,
const MbVector3D vect,
double &  u,
double &  v,
bool  ext,
MbRect2D uvRange = nullptr,
bool  onlyPositiveDirection = false 
) const
overridevirtual

Find the nearest point projection to the surface in the vector direction.

Calculate the nearest point of intersection with the ray outgoing from the given point 'p' by the direction 'vect'. If the range of parameters changing 'uvRange' is set, then it is required to find a projection in the given range. A range of parameters may not belong to the domain of a surface.

Parameters
[in]pnt- A given point.
[in]vect- A direction vector.
[in,out]u- Input - initial approximation, output - parameter of a surface, corresponding to the nearest projection.
[in,out]v- Input - initial approximation, output - parameter of a surface, corresponding to the nearest projection.
[in]ext- A flag defining whether to seek projection on the extension of the curve.
[in]uvRange- A range of parameters changing in which the solution should be found.
Returns
True - if there is found a projection which satisfies to all input conditions.

Reimplemented from MbSurface.

◆ CurveIntersection()

void MbPlane::CurveIntersection ( const MbCurve3D curv,
SArray< MbCartPoint > &  uv,
SArray< double > &  tt,
bool  ext0,
bool  ext,
bool  touchInclude = false 
) const
overridevirtual

Determine points of intersection between a surface and a curve.

Determine points of intersection between a surface and a curve.

Parameters
[in]curv- A given curve.
[in,out]uv- A set of intersection points on the surface.
[in,out]tt- A set of intersection points on the curve.
[in]ext0- A flag defining whether to seek intersections on extended surface (if it is true, then seek).
[in]ext- A flag defining whether to seek intersections on extended curve (if it is true, then seek).
[in]touchInclude- Whether to consider tangency as intersection. If true, then consider.

Reimplemented from MbSurface.

◆ IsSimilarToSurface()

bool MbPlane::IsSimilarToSurface ( const MbSurface surf,
VERSION  version,
double  precision = METRIC_PRECISION 
) const
overridevirtual

Define whether the surfaces are similar for merge.

Surfaces are similar for merge if they coincide geometrically or one surface transits to another.

Parameters
[in]surf- A given surface.
[in]version- Version of operation.
[in]precision- Precision of calculation.
Returns
True - if surfaces are similar.

Reimplemented from MbSurface.

◆ GetMatrixToSurface()

bool MbPlane::GetMatrixToSurface ( const MbSurface surf,
MbMatrix matr,
VERSION  version,
double  precision = METRIC_PRECISION 
) const
overridevirtual

Get two-dimensional matrix of transformation from its parametric region to the parametric region of 'surf'.

Calculation of matrix of transformation from one parametric region to another. it is performed for the surfaces which are similar for merge.

Parameters
[in]surf- A given surface.
[out]matr- A transformation matrix.
[in]version- Version of operation.
[in]precision- Precision of calculation.
Returns
True - matrix is calculated.

Reimplemented from MbSurface.

◆ GetTesselation()

void MbPlane::GetTesselation ( const MbStepData stepData,
double  u1,
double  u2,
double  v1,
double  v2,
SArray< double > &  uu,
SArray< double > &  vv 
) const
overridevirtual

Determine a splitting of parametric region of a surface by verticals and horizontals.

Determine a splitting of parametric region of a surface by verticals and horizontals during triangulation.

Parameters
[in]stepData- Data for step calculation during triangulation.
[in]u1- Minimal value of u-parameter in the region of surface splitting.
[in]u2- Maximal value of u-parameter in the region of surface splitting.
[in]v1- Minimal value of v-parameter in the region of surface splitting.
[in]v2- Maximal value of v-parameter in the region of surface splitting.
[out]uu- A set of parameters of splitting by u.
[out]vv- A set of parameters of splitting by v.

Reimplemented from MbSurface.

◆ CalculateLocalGabarit()

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

◆ IsShift()

bool MbPlane::IsShift ( const MbSpaceItem obj,
MbVector3D dir,
bool &  isSame,
double  accuracy = LENGTH_EPSILON 
) const
overridevirtual

Determine whether the object is a translation.

Determine whether the object is a translation of a given object.

Parameters
[in]obj- A pattern object.
[out]dir- A translation vector if the object is translation.
[out]isSame- True at the output if the current surface and the pattern object are identical.
Returns
True - if a surface is translation

Reimplemented from MbSurface.

◆ GetPointProjection()

bool MbPlane::GetPointProjection ( const MbCartPoint3D p,
bool  init,
double &  u,
double &  v,
bool  ext,
MbRect2D uvRange = nullptr 
) const
overridevirtual

The nearest point projection onto the surface.

The nearest point projection onto the surface.

Parameters
[in]p- Projecting point
[in]init- If true, then input parameters u and v are considered to be initial approximations
[in,out]u- Parameter of projection onto the surface
[in,out]v- Parameter of projection onto the surface
[in]ext- Attribute of search at the extension of a surface
[in]uvRange- Region of search the projection
Returns
True if the operation succeeded

Implements MbElementarySurface.

◆ SetLimit() [1/2]

void MbPlane::SetLimit ( double  d)
inline

Set surface limits.

Set surface limits by the square with a center in origin
and a side equal to 2 * d.

◆ SetLimit() [2/2]

void MbPlane::SetLimit ( double  u,
double  v 
)
inline

Set surface limits.

Set surface limits by the rectangle with a center in origin, width equal to 2 * u and height equal to 2 * v.

◆ IncludeCube()

bool MbPlane::IncludeCube ( const MbCube )

Include a cube projection.

Extend the plane limits by adding of the cube projection.

◆ AssignCube()

bool MbPlane::AssignCube ( const MbCube )

Set cube projection.

Change the limits of plane to the cube projection on plane.

◆ AdaptToPlace()

void MbPlane::AdaptToPlace ( const MbPlacement3D p)
inline

Match with the placement.

Match with the placement by rotation till the parallelism and translation along placement normal. The projection of the coordinate system p origin becomes the center of a plane.
The axis Z of a plane remains.
The projection X axis of the coordinate system p becomes the axis X of the plane.

Warning
This can be used only in KOMPAS-3D.

◆ PlaneCurveIntersection()

void MbPlane::PlaneCurveIntersection ( const MbPlacement3D curvePlace,
MbCurve curve,
SArray< MbCartPoint > &  uv,
SArray< double > &  tt,
bool  ext0,
bool  ext,
bool  touchInclude = false 
) const

Intersection points of a plane and a planar curve.

Intersection points of a plane and a planar curve.

Parameters
[in]curvePlace- Curve placement
[in]curve- Curve
[out]uv- Intersection points on plane
[out]tt- Parameters of intersection points on curve
[in]ext0- An attribute of search of intersection points on the plane extension
[in]ext- An attribute of search of intersection points on the curve extension
[in]touchInclude- True if tangency points are required

◆ IsSimilarPlanes()

bool MbPlane::IsSimilarPlanes ( const MbPlane plane,
const MbRect rect0,
const MbRect rect1 
) const

Whether planes are similar to merge.

Whether planes are similar to merge.

Parameters
[in]plane- Second plane
[in]rect0- Parameter region on the first plane
[in]rect1- Parameter region on the second plane

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