All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

GSMInterfaces Interface CATIGSMCurvePar

System.IUnknown
  |
  +---System.IDispatch
    |
    +---System.CATBaseUnknown
      |
      +---CATIGSMCurvePar
 

Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.


interface CATIGSMCurvePar

Parallel Curve.
Role: Allows to access data of the Parallel Curve feature created by using a curve, a support, an orientation and an offset value Gets, sets the Curve Offset definition elements

See also:
CATIGSMFactory.CreateCurvePar


Method Index


o Get3DSmoothing(CATBoolean&)
Queries whether '3D Smoothing' for smoothing operation is activated or not.
o GetBothSidesMode(CATBoolean&)
Queries whether both sides are computed or not.
o GetCkeCurveParValue(CATICkeParm_var&)
Gets the offset value.
o GetCkeCurveParValue1(CATICkeParm_var&)
Gets the offset value.
o GetCkeCurveParValue2(CATICkeParm_var&)
Gets the offset value.
o GetCurveParLaw(CATICkeLaw_var&)
Gets the offset law.
o GetCurveParType(enum CATGSMCurveParCornerType&)
Gets the Corner type .
o GetCurveParValue(double&)
Gets the offset value.
o GetCurveParValue1(double&)
Gets the offset value.
o GetCurveParValue2(double&)
Gets the offset value.
o GetDeviationValue(CATICkeParm_var&)
Gets the maximum deviation allowed for smoothing operation.
o GetDeviationValue(double&)
Gets the maximum deviation allowed for smoothing operation.
o GetGeodesic(CATBoolean&)
Gets the Geodesic mode.
o GetInvertDirection(CATBoolean&)
Gets the orientation.
o GetInvertMappingLaw(CATBoolean&)
Gets the mapping orientation of the law (if offset is specified by a law).
o GetOtherSide(CATISpecObject_var&)
Gets the other side.
o GetPassingPoint(CATISpecObject_var&)
Gets the passing point.
o GetPitchLawType(enum CATGSMBasicLawType&)
Gets pitch law type.
o GetPlaneNormal(CATMathVector&)
Get the Normal of the plane created when the Support of the curve is not specified.
o GetProfil(CATISpecObject_var&)
Gets the reference curve.
o GetSmoothingType(CATGSMTolerantModelingSmoothingType&)
Gets Smoothing Type.
o GetSupport(CATISpecObject_var&)
Gets the support of the curve.
o IsOffsetSpecifiedByALaw(CATBoolean&)
Queries wether the offset of curve parallel is specified by a law or a constant value.
o Set3DSmoothing(CATBoolean)
Sets or unsets the '3D Smoothing' activation for smoothing operation.
o SetBothSidesMode(CATBoolean)
Sets or unsets the computation of both sides.
o SetCurveParLaw(CATICkeLaw_var)
Sets the offset law.
o SetCurveParType(enum CATGSMCurveParCornerType)
Sets the Corner type .
o SetCurveParValue(CATICkeParm_var)
Sets the offset value.
o SetCurveParValue(double)
Sets the offset value.
o SetCurveParValue1(CATICkeParm_var)
Sets the offset value.
o SetCurveParValue1(double)
Sets the offset value.
o SetCurveParValue2(CATICkeParm_var)
Sets the offset value.
o SetCurveParValue2(double)
Sets the offset value.
o SetDeviationValue(CATICkeParm_var&)
Sets the maximum deviation allowed for smoothing operation.
o SetDeviationValue(double)
Sets the maximum deviation allowed for smoothing operation.
o SetGeodesic(CATBoolean)
Sets the Geodesic mode.
o SetInvertDirection(CATBoolean)
Sets the orientation.
o SetInvertMappingLaw(CATBoolean)
Sets the mapping orientation of the law (if offset is specified by a law).
o SetPassingPoint(CATISpecObject_var)
Sets the passing point.
o SetPitchLawType(enum CATGSMBasicLawType)
Sets pitch law type.
o SetPlaneNormal(CATMathVector&)
Set the Normal of the plane created when the Support of the curve is not specified.
o SetProfil(CATISpecObject_var)
Sets the reference curve.
o SetSmoothingType(CATGSMTolerantModelingSmoothingType)
Sets Smoothing Type.
o SetSupport(CATISpecObject_var)
Sets the reference support.

Methods


o Get3DSmoothing
public virtual HRESULT Get3DSmoothing(CATBoolean& o3DSmoothing) = 0
Queries whether '3D Smoothing' for smoothing operation is activated or not. Available only for tangent or curvature smoothing type
Parameters:
o3DSmoothing
TRUE : Smoothing performed without specifying support FALSE : Smoothing performed with specific support (retrieved by GetSupport)
o GetBothSidesMode
public virtual HRESULT GetBothSidesMode(CATBoolean& oMode) = 0
Queries whether both sides are computed or not.
Parameters:
oMode
Computation option on (TRUE) or off (FALSE)
o GetCkeCurveParValue
public virtual HRESULT GetCkeCurveParValue(CATICkeParm_var& oOffValue) = 0
Gets the offset value.
Parameters:
oOffValue
Offset value
o GetCkeCurveParValue1
public virtual HRESULT GetCkeCurveParValue1(CATICkeParm_var& oOffValue) = 0
Gets the offset value.
Parameters:
oOffValue
Offset value
o GetCkeCurveParValue2
public virtual HRESULT GetCkeCurveParValue2(CATICkeParm_var& oOffValue) = 0
Gets the offset value.
Parameters:
oOffValue
Offset value
o GetCurveParLaw
public virtual HRESULT GetCurveParLaw(CATICkeLaw_var& oOffLaw) = 0
Gets the offset law.
Parameters:
oOffLaw
Offset law
o GetCurveParType
public virtual HRESULT GetCurveParType(enum CATGSMCurveParCornerType& oCornerType) = 0
Gets the Corner type .
Parameters:
oCornerType
CATGSMCurvePar_Sharp = 0 : Sharp corner CATGSMCurvePar_Round = 1 : Round corner
o GetCurveParValue
public virtual HRESULT GetCurveParValue(double& oOffValue) = 0
Gets the offset value.
Parameters:
oOffValue
Offset value
o GetCurveParValue1
public virtual HRESULT GetCurveParValue1(double& oOffValue) = 0
Gets the offset value.
Parameters:
oOffValue
Offset value
o GetCurveParValue2
public virtual HRESULT GetCurveParValue2(double& oOffValue) = 0
Gets the offset value.
Parameters:
oOffValue
Offset value
o GetDeviationValue
public virtual HRESULT GetDeviationValue(CATICkeParm_var& oDeviation) = 0
Gets the maximum deviation allowed for smoothing operation.
Gets in distance unit, it corresponds to the radius of a pipe around the input curve in which the result is allowed to be.
Parameters:
Elem
Maximum deviation literal feature
o GetDeviationValue
public virtual HRESULT GetDeviationValue(double& oDeviation) = 0
Gets the maximum deviation allowed for smoothing operation.
Gets in distance unit, it corresponds to the radius of a pipe around the input curve in which the result is allowed to be.
Parameters:
val
Maximum deviation value
o GetGeodesic
public virtual HRESULT GetGeodesic(CATBoolean& oGeodesic) = 0
Gets the Geodesic mode.
Parameters:
oGeodesic
False : Euclidian mode True : Geodesic mode
o GetInvertDirection
public virtual HRESULT GetInvertDirection(CATBoolean& oInvert) = 0
Gets the orientation.
Parameters:
oInvert
: False means that there is no invertion of the curve orientation (orientation is the vector product of the tangent of the curve by the normal on the support) : True to invert this orientation
o GetInvertMappingLaw
public virtual HRESULT GetInvertMappingLaw(CATBoolean& oInvert) = 0
Gets the mapping orientation of the law (if offset is specified by a law).
Parameters:
oInvert
False : Law is applied from the beginning to the end of the curve (mapping is not inverted). True : Law is applied from the end to the beginning of the curve (mapping is inverted).
o GetOtherSide
public virtual HRESULT GetOtherSide(CATISpecObject_var& oElem) = 0
Gets the other side.
Parameters:
oElem
Other side
o GetPassingPoint
public virtual HRESULT GetPassingPoint(CATISpecObject_var& oPassingPoint) = 0
Gets the passing point.
Parameters:
oPassingPoint
new passing point
o GetPitchLawType
public virtual HRESULT GetPitchLawType(enum CATGSMBasicLawType& oType) = 0
Gets pitch law type.
Parameters:
oType
Type of law (from CATGSMBasicLawType enumeration).
See also:
CATGSMBasicLawType
o GetPlaneNormal
public virtual HRESULT GetPlaneNormal(CATMathVector& oNormal) = 0
Get the Normal of the plane created when the Support of the curve is not specified.
Parameters:
oNormal
CATMathVector
o GetProfil
public virtual HRESULT GetProfil(CATISpecObject_var& oElem) = 0
Gets the reference curve.
Parameters:
oElem
new reference curve
o GetSmoothingType
public virtual HRESULT GetSmoothingType(CATGSMTolerantModelingSmoothingType& oType) = 0
Gets Smoothing Type.
Parameters:
oType
Smoothing type : TM_None -> No Smoothing : TM_G1 -> G1 Smoothing : Enhance current continuity to tangent continuity : TM_G2 -> G2 Smoothing : Enhance current continuity to curvature continuity
See also:
CATGSMTolerantModelingSmoothingType
o GetSupport
public virtual HRESULT GetSupport(CATISpecObject_var& oSupport) = 0
Gets the support of the curve.
Parameters:
oSupport
new curve support
o IsOffsetSpecifiedByALaw
public virtual HRESULT IsOffsetSpecifiedByALaw(CATBoolean& oIsLaw) = 0
Queries wether the offset of curve parallel is specified by a law or a constant value.
Parameters:
oLaw
: False means that the offset of curve parallel is specified by a law. : True means that the offset of curve parallel is specified by a constant value.
o Set3DSmoothing
public virtual HRESULT Set3DSmoothing(CATBoolean i3DSmoothing) = 0
Sets or unsets the '3D Smoothing' activation for smoothing operation. Available only for tangent or curvature smoothing type
Parameters:
i3DSmoothing
TRUE : Smoothing performed without specifying support FALSE : Smoothing performed with specific support (retrieved by GetSupport)
o SetBothSidesMode
public virtual HRESULT SetBothSidesMode(CATBoolean iMode) = 0
Sets or unsets the computation of both sides.
Parameters:
iMode
Computation option on (TRUE) or off (FALSE)
o SetCurveParLaw
public virtual HRESULT SetCurveParLaw( const CATICkeLaw_var iOffLaw) = 0
Sets the offset law.
Parameters:
iOffLaw
Offset law
o SetCurveParType
public virtual HRESULT SetCurveParType(enum CATGSMCurveParCornerType iCornerType) = 0
Sets the Corner type .
Parameters:
ioCornerType
CATGSMCurvePar_Sharp = 0 : Sharp corner CATGSMCurvePar_Round = 1 : Round corner
o SetCurveParValue
public virtual HRESULT SetCurveParValue( const CATICkeParm_var iOffValue) = 0
Sets the offset value.
Parameters:
iOffValue
Offset value
o SetCurveParValue
public virtual HRESULT SetCurveParValue(double iOffValue) = 0
Sets the offset value.
Parameters:
iOffValue
Offset value
o SetCurveParValue1
public virtual HRESULT SetCurveParValue1( const CATICkeParm_var iOffValue) = 0
Sets the offset value.
Parameters:
iOffValue
Offset value
o SetCurveParValue1
public virtual HRESULT SetCurveParValue1(double iOffValue) = 0
Sets the offset value.
Parameters:
iOffValue
Offset value
o SetCurveParValue2
public virtual HRESULT SetCurveParValue2( const CATICkeParm_var iOffValue) = 0
Sets the offset value.
Parameters:
iOffValue
Offset value
o SetCurveParValue2
public virtual HRESULT SetCurveParValue2(double iOffValue) = 0
Sets the offset value.
Parameters:
iOffValue
Offset value
o SetDeviationValue
public virtual HRESULT SetDeviationValue( const CATICkeParm_var& iDeviation) = 0
Sets the maximum deviation allowed for smoothing operation.
Sets in distance unit, it corresponds to the radius of a pipe around the input curve in which the result is allowed to be.
Parameters:
Elem
Maximum deviation literal feature
o SetDeviationValue
public virtual HRESULT SetDeviationValue( const double iDeviation) = 0
Sets the maximum deviation allowed for smoothing operation.
Sets in distance unit, it corresponds to the radius of a pipe around the input curve in which the result is allowed to be.
Parameters:
val
Maximum deviation value
o SetGeodesic
public virtual HRESULT SetGeodesic(CATBoolean iGeodesic) = 0
Sets the Geodesic mode.
Parameters:
iGeodesic
False : Euclidian mode True : Geodesic mode
o SetInvertDirection
public virtual HRESULT SetInvertDirection(CATBoolean Invert) = 0
Sets the orientation.
Parameters:
Invert
False means that there is no invertion of the curve orientation (orientation is the vector product of the tangent of the curve by the normal on the support) True to invert this orientation
o SetInvertMappingLaw
public virtual HRESULT SetInvertMappingLaw(CATBoolean iInvert) = 0
Sets the mapping orientation of the law (if offset is specified by a law).
Parameters:
iInvert
False : Law is applied from the beginning to the end of the curve (mapping is not inverted). True : Law is applied from the end to the beginning of the curve (mapping is inverted).
o SetPassingPoint
public virtual HRESULT SetPassingPoint( const CATISpecObject_var iPassingPoint) = 0
Sets the passing point.
Parameters:
iPassingPoint
new passing point
o SetPitchLawType
public virtual HRESULT SetPitchLawType( const enum CATGSMBasicLawType iType) = 0
Sets pitch law type.
Parameters:
iType
Type of law (from CATGSMBasicLawType enumeration):
- CATGSMBasicLawType_Constant,
- CATGSMBasicLawType_SType.
See also:
CATGSMBasicLawType
o SetPlaneNormal
public virtual HRESULT SetPlaneNormal(CATMathVector& iNormal) = 0
Set the Normal of the plane created when the Support of the curve is not specified.
Parameters:
iNormal
CATMathVector
o SetProfil
public virtual HRESULT SetProfil( const CATISpecObject_var iElem) = 0
Sets the reference curve.
Parameters:
iElem
new reference curve
o SetSmoothingType
public virtual HRESULT SetSmoothingType(CATGSMTolerantModelingSmoothingType iType) = 0
Sets Smoothing Type.
Parameters:
iType
Smoothing type : TM_None -> No Smoothing : TM_G1 -> G1 Smoothing : Enhance current continuity to tangent continuity : TM_G2 -> G2 Smoothing : Enhance current continuity to curvature continuity
See also:
CATGSMTolerantModelingSmoothingType
o SetSupport
public virtual HRESULT SetSupport( const CATISpecObject_var iSupport) = 0
Sets the reference support.
Parameters:
iSupport
new curve support

This object is included in the file: CATIGSMCurvePar.h
If needed, your Imakefile.mk should include the module: CATGitInterfaces

Copyright © 2003, Dassault Systèmes. All rights reserved.