CAD Exchanger SDK
cadex::ModelData_OffsetSurface Class Reference

Defines an offset surface. More...

Inheritance diagram for cadex::ModelData_OffsetSurface:
cadex::ModelData_Surface

Public Member Functions

 ModelData_OffsetSurface ()
 Constructor. More...
 
 ModelData_OffsetSurface (const ModelData_Surface &theBasisSurface, double theOffset)
 Constructor. More...
 
 ModelData_OffsetSurface (const Handle_C &)
 Constructor.
 
ModelData_Surface BasisSurface () const
 Returns basis surface.
 
double Offset () const
 Returns offset value. More...
 
 operator const Handle_C & () const
 
- Public Member Functions inherited from cadex::ModelData_Surface
 ModelData_Surface ()
 Constructor.
 
 ModelData_Surface (const ModelData_Surface &theOther)
 Constructor.
 
 ModelData_Surface (ModelData_Surface &&theOther)
 Constructor.
 
 ~ModelData_Surface ()
 Destructor.
 
ModelData_Surfaceoperator= (const ModelData_Surface &theOther)
 Assignment operator.
 
ModelData_Surfaceoperator= (ModelData_Surface &&theOther)
 Move assignment operator.
 
 operator const Handle_C & () const
 Cast operator.
 
ModelData_SurfaceType Type () const
 Returns a surface type.
 
bool IsNull () const
 Returns true if the object has not been initialized yet.
 
 operator bool () const
 
bool IsUPeriodic () const
 Returns true if the surface is periodic in U direction. More...
 
bool IsVPeriodic () const
 Returns true if the surface is periodic in V direction. More...
 
double UMin () const
 Returns a minimum parameter of a definition domain in U direction. More...
 
double UMax () const
 Returns a maximum parameter of a definition domain in U direction. More...
 
double VMin () const
 Returns a minimum parameter of a definition domain in V direction. More...
 
double VMax () const
 Returns a maximum parameter of a definition domain in V direction. More...
 
void Domain (double &theUMin, double &theUMax, double &theVMin, double &theVMax) const
 Returns a definition domain. More...
 
ModelData_Point Value (double theParameterU, double theParameterV) const
 Evaluates a point on the surface. More...
 
void Transform (const ModelData_Transformation &theTransformation)
 Applies transformation matrix to this object. More...
 
ModelData_Surface Transformed (const ModelData_Transformation &theTransformation) const
 Returns a copy this object after applying transformation. More...
 
ModelData_Continuity Continuity () const
 Returns a continuity type of the surface.
 
void D0 (double theParameterU, double theParameterV, ModelData_Point &theValue) const
 Returns the point theValue of parameter theU, theV on the surface. More...
 
void D1 (double theParameterU, double theParameterV, ModelData_Point &theValue, ModelData_Vector &theD1U, ModelData_Vector &theD1V) const
 Returns the point theValue and the first derivatives in the directions U theD1U and V theD1V at this point. More...
 
void D2 (double theParameterU, double theParameterV, ModelData_Point &theValue, ModelData_Vector &theD1U, ModelData_Vector &theD1V, ModelData_Vector &theD2U, ModelData_Vector &theD2V, ModelData_Vector &theD2UV) const
 Returns the point theValue, the first and the second derivatives in the directions U and V at this point. More...
 
bool DN (double theParameterU, double theParameterV, size_t theDerivativeOrder, ModelData_Point &theValue, ModelData_Vector theD[]) const
 
void Curvature (double theParameterU, double theParameterV, ModelData_Vector &thePrincipalMaxDirection, ModelData_Vector &thePrincipalMinDirection) const
 Returns the max and min principal curvature directions multiplied by max and min value of curvature respectively.
 
void Curvature (double theParameterU, double theParameterV, ModelData_Direction &thePrincipalMaxDirection, ModelData_Direction &thePrincipalMinDirection, double &theMaxCurvature, double &theMinCurvature) const
 Returns the max and min principal curvature directions and their values.
 
void Normal (double theParameterU, double theParameterV, ModelData_Direction &theNormal) const
 Returns the normal direction theNormal at the current point.
 
void Mirror (const ModelData_Point &thePoint)
 Mirrors the surface relative to the point.
 
void Mirror (const ModelData_Axis1Placement &theAxis)
 Mirrors the surface relative to the axis placement.
 
void Mirror (const ModelData_Axis2Placement &theAxis)
 Mirrors the surface relative to the axis placement.
 
template<typename T >
ModelData_Surface Mirrored (const T &theRef) const
 
void Rotate (const ModelData_Axis1Placement &theAxis, double theAngle)
 Rotates the surface around the axis.
 
ModelData_Surface Rotated (const ModelData_Axis1Placement &theAxis, double theAngle)
 
void Translate (const ModelData_Vector &theVector)
 Translates the surface along the vector.
 
ModelData_Surface Translated (const ModelData_Vector &theVector)
 
void Scale (const ModelData_Point &thePoint, double theScale)
 Scales the surface with respect to the point.
 
ModelData_Surface Scaled (const ModelData_Point &thePoint, double theScale)
 

Additional Inherited Members

- Protected Member Functions inherited from cadex::ModelData_Surface
 ModelData_Surface (const Handle_C &, ModelData_SurfaceType)
 Constructor.
 
internal::ModelData_SurfaceImpl & Impl ()
 Returns internal implementation object.
 

Detailed Description

Defines an offset surface.

An offset surface is defined by a basis surface and an offset value.

The following image depicts an example of an offset surface:

offset_surface.png
Offset surface

A basis surface must be at least G1-continous, otherwise behavior is undefined (most likely an exception will be thrown).

An offset surface is parametrized as follows: S(u,v) = B(u,v) + offset * N(u,v), where

  • B(u,v) is a basis surface;
  • offset is an offset value;
  • N(u,v) is a unit normal computed on basis surface;
  • u and v belong to basis surface domain definition.
Examples:
modeling/brep/faceutil.cxx.

Constructor & Destructor Documentation

◆ ModelData_OffsetSurface() [1/2]

cadex::ModelData_OffsetSurface::ModelData_OffsetSurface ( )
inline

Constructor.

Empty constructor.

◆ ModelData_OffsetSurface() [2/2]

cadex::ModelData_OffsetSurface::ModelData_OffsetSurface ( const ModelData_Surface theBasisSurface,
double  theOffset 
)

Constructor.

If theBasisSurface is an offset surface then its basis surface will be used as a basis surface and offset will be a sum of theOffset and the offset value of the theBasisSurface.

theBasisSurface must be at least G1-continuous, otherwise behavior is undefined.

Member Function Documentation

◆ Offset()

double cadex::ModelData_OffsetSurface::Offset ( ) const

Returns offset value.

Returns the value specified in constructor.