Open CASCADE Technology 6.6.0
Public Member Functions
IGESGeom_OffsetCurve Class Reference

defines IGESOffsetCurve, Type <130> Form <0>
in package IGESGeom
An OffsetCurve entity contains the data necessary to
determine the offset of a given curve C. This entity
points to the base curve to be offset and contains
offset distance and other pertinent information.

#include <IGESGeom_OffsetCurve.hxx>

Inheritance diagram for IGESGeom_OffsetCurve:
Inheritance graph
[legend]

Public Member Functions

 IGESGeom_OffsetCurve ()
void Init (const Handle< IGESData_IGESEntity > &aBaseCurve, const Standard_Integer anOffsetType, const Handle< IGESData_IGESEntity > &aFunction, const Standard_Integer aFunctionCoord, const Standard_Integer aTaperedOffsetType, const Standard_Real offDistance1, const Standard_Real arcLength1, const Standard_Real offDistance2, const Standard_Real arcLength2, const gp_XYZ &aNormalVec, const Standard_Real anOffsetParam, const Standard_Real anotherOffsetParam)
 This method is used to set the fields of the class
OffsetCurve

Handle_IGESData_IGESEntity BaseCurve () const
 returns the curve to be offset

Standard_Integer OffsetType () const
 returns the offset distance flag
1 = Single value offset (uniform distance)
2 = Offset distance varying linearly
3 = Offset distance specified as a function

Handle_IGESData_IGESEntity Function () const
 returns the function defining the offset if at all the offset
is described as a function or Null Handle.

Standard_Boolean HasFunction () const
 returns True if function defining the offset is present.

Standard_Integer FunctionParameter () const
 returns particular coordinate of the curve which describes offset
as a function of its parameters. (only used if OffsetType() = 3)

Standard_Integer TaperedOffsetType () const
 returns tapered offset type flag (only used if OffsetType() = 2 or 3)
1 = Function of arc length
2 = Function of parameter

Standard_Real FirstOffsetDistance () const
 returns first offset distance (only used if OffsetType() = 1 or 2)

Standard_Real ArcLength1 () const
 returns arc length or parameter value (depending on value of
offset distance flag) of first offset distance
(only used if OffsetType() = 2)

Standard_Real SecondOffsetDistance () const
 returns the second offset distance

Standard_Real ArcLength2 () const
 returns arc length or parameter value (depending on value of
offset distance flag) of second offset distance
(only used if OffsetType() = 2)

gp_Vec NormalVector () const
 returns unit vector normal to plane containing curve to be offset

gp_Vec TransformedNormalVector () const
 returns unit vector normal to plane containing curve to be offset
after applying Transf. Matrix

void Parameters (Standard_Real &StartParam, Standard_Real &EndParam) const
Standard_Real StartParameter () const
 returns Start Parameter value of the offset curve

Standard_Real EndParameter () const
 returns End Parameter value of the offset curve


Constructor & Destructor Documentation

IGESGeom_OffsetCurve::IGESGeom_OffsetCurve ( )

Member Function Documentation

Standard_Real IGESGeom_OffsetCurve::ArcLength1 ( ) const
Standard_Real IGESGeom_OffsetCurve::ArcLength2 ( ) const
Handle_IGESData_IGESEntity IGESGeom_OffsetCurve::BaseCurve ( ) const
Standard_Real IGESGeom_OffsetCurve::EndParameter ( ) const
Standard_Real IGESGeom_OffsetCurve::FirstOffsetDistance ( ) const
Handle_IGESData_IGESEntity IGESGeom_OffsetCurve::Function ( ) const
Standard_Integer IGESGeom_OffsetCurve::FunctionParameter ( ) const
Standard_Boolean IGESGeom_OffsetCurve::HasFunction ( ) const
void IGESGeom_OffsetCurve::Init ( const Handle< IGESData_IGESEntity > &  aBaseCurve,
const Standard_Integer  anOffsetType,
const Handle< IGESData_IGESEntity > &  aFunction,
const Standard_Integer  aFunctionCoord,
const Standard_Integer  aTaperedOffsetType,
const Standard_Real  offDistance1,
const Standard_Real  arcLength1,
const Standard_Real  offDistance2,
const Standard_Real  arcLength2,
const gp_XYZ aNormalVec,
const Standard_Real  anOffsetParam,
const Standard_Real  anotherOffsetParam 
)
  • aBaseCurve : The curve entity to be offset
  • anOffsetType : Offset distance flag
    1 = Single value, uniform distance
    2 = Varying linearly
    3 = As a specified function
  • aFunction : Curve entity, one coordinate of which
    describes offset as a function of its
    parameter (0 unless OffsetType = 3)
  • aFunctionCoord : Particular coordinate of curve
    describing offset as function of its
    parameters. (used if OffsetType = 3)
  • aTaperedOffsetType : Tapered offset type flag
    1 = Function of arc length
    2 = Function of parameter
    (Only used if OffsetType = 2 or 3)
  • offDistance1 : First offset distance
    (Only used if OffsetType = 1 or 2)
  • arcLength1 : Arc length or parameter value of
    first offset distance
    (Only used if OffsetType = 2)
  • offDistance2 : Second offset distance
  • arcLength2 : Arc length or parameter value of
    second offset distance
    (Only used if OffsetType = 2)
  • aNormalVec : Unit vector normal to plane containing
    curve to be offset
  • anOffsetParam : Start parameter value of offset curve
  • anotherOffsetParam : End parameter value of offset curve
gp_Vec IGESGeom_OffsetCurve::NormalVector ( ) const
Standard_Integer IGESGeom_OffsetCurve::OffsetType ( ) const
void IGESGeom_OffsetCurve::Parameters ( Standard_Real StartParam,
Standard_Real EndParam 
) const
Standard_Real IGESGeom_OffsetCurve::SecondOffsetDistance ( ) const
Standard_Real IGESGeom_OffsetCurve::StartParameter ( ) const
Standard_Integer IGESGeom_OffsetCurve::TaperedOffsetType ( ) const
gp_Vec IGESGeom_OffsetCurve::TransformedNormalVector ( ) const

The documentation for this class was generated from the following file:
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines