OCC Main Page | DataExchange | Toolkits | Packages | Class Hierarchy | Data Structures | File List | Data Fields | Globals

DataExchange
TKIGES
IGESGeom


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

Standard_EXPORT IGESGeom_OffsetCurve ()
Standard_EXPORT 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
- 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
.
Standard_EXPORT Handle_IGESData_IGESEntity BaseCurve () const
 returns the curve to be offset

Standard_EXPORT 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

Standard_EXPORT 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_EXPORT Standard_Boolean HasFunction () const
 returns True if function defining the offset is present.

Standard_EXPORT 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_EXPORT 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_EXPORT Standard_Real FirstOffsetDistance () const
 returns first offset distance (only used if OffsetType() = 1 or 2)

Standard_EXPORT 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_EXPORT Standard_Real SecondOffsetDistance () const
 returns the second offset distance

Standard_EXPORT 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)

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

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

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

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

Standard_EXPORT const Handle (Standard_Type)&DynamicType() const

Private Attributes

Handle_IGESData_IGESEntity theBaseCurve
Standard_Integer theOffsetType
Handle_IGESData_IGESEntity theFunction
Standard_Integer theFunctionCoord
Standard_Integer theTaperedOffsetType
Standard_Real theOffsetDistance1
Standard_Real theArcLength1
Standard_Real theOffsetDistance2
Standard_Real theArcLength2
gp_XYZ theNormalVector
Standard_Real theOffsetParam1
Standard_Real theOffsetParam2

Constructor & Destructor Documentation

Standard_EXPORT IGESGeom_OffsetCurve::IGESGeom_OffsetCurve  ) 
 


Member Function Documentation

Standard_EXPORT Standard_Real IGESGeom_OffsetCurve::ArcLength1  )  const
 

Standard_EXPORT Standard_Real IGESGeom_OffsetCurve::ArcLength2  )  const
 

Standard_EXPORT Handle_IGESData_IGESEntity IGESGeom_OffsetCurve::BaseCurve  )  const
 

Standard_EXPORT Standard_Real IGESGeom_OffsetCurve::EndParameter  )  const
 

Standard_EXPORT Standard_Real IGESGeom_OffsetCurve::FirstOffsetDistance  )  const
 

Standard_EXPORT Handle_IGESData_IGESEntity IGESGeom_OffsetCurve::Function  )  const
 

Standard_EXPORT Standard_Integer IGESGeom_OffsetCurve::FunctionParameter  )  const
 

Standard_EXPORT const IGESGeom_OffsetCurve::Handle Standard_Type   )  const
 

Reimplemented from IGESData_IGESEntity.

Standard_EXPORT Standard_Boolean IGESGeom_OffsetCurve::HasFunction  )  const
 

Standard_EXPORT 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
 

Standard_EXPORT gp_Vec IGESGeom_OffsetCurve::NormalVector  )  const
 

Standard_EXPORT Standard_Integer IGESGeom_OffsetCurve::OffsetType  )  const
 

Standard_EXPORT void IGESGeom_OffsetCurve::Parameters Standard_Real &  StartParam,
Standard_Real &  EndParam
const
 

Standard_EXPORT Standard_Real IGESGeom_OffsetCurve::SecondOffsetDistance  )  const
 

Standard_EXPORT Standard_Real IGESGeom_OffsetCurve::StartParameter  )  const
 

Standard_EXPORT Standard_Integer IGESGeom_OffsetCurve::TaperedOffsetType  )  const
 

Standard_EXPORT gp_Vec IGESGeom_OffsetCurve::TransformedNormalVector  )  const
 


Field Documentation

Standard_Real IGESGeom_OffsetCurve::theArcLength1 [private]
 

Standard_Real IGESGeom_OffsetCurve::theArcLength2 [private]
 

Handle_IGESData_IGESEntity IGESGeom_OffsetCurve::theBaseCurve [private]
 

Handle_IGESData_IGESEntity IGESGeom_OffsetCurve::theFunction [private]
 

Standard_Integer IGESGeom_OffsetCurve::theFunctionCoord [private]
 

gp_XYZ IGESGeom_OffsetCurve::theNormalVector [private]
 

Standard_Real IGESGeom_OffsetCurve::theOffsetDistance1 [private]
 

Standard_Real IGESGeom_OffsetCurve::theOffsetDistance2 [private]
 

Standard_Real IGESGeom_OffsetCurve::theOffsetParam1 [private]
 

Standard_Real IGESGeom_OffsetCurve::theOffsetParam2 [private]
 

Standard_Integer IGESGeom_OffsetCurve::theOffsetType [private]
 

Standard_Integer IGESGeom_OffsetCurve::theTaperedOffsetType [private]
 


The documentation for this class was generated from the following file:
Generated on Mon Aug 25 14:40:51 2008 for OpenCASCADE by  doxygen 1.4.1