All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

GSMInterfaces Interface CATIGSMConic

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

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


interface CATIGSMConic

Conic Curve.
Role: Allows to access data of the Conic feature created by using five feature that can be points, tangents or one parameter. There is always two extremity points and a planar support.

See also:
CATIGSMFactory.CreateConic


Method Index


o CheckConicParameterValue(CATISpecObject_var,CATMathVector&,CATMathVector&,CATISpecObject_var,CATISpecObject_var,double&,double&,int&)
Check conic parametrer value.
o CheckPoint(CATISpecObject_var,CATISpecObject_var,int&,CATISpecObject_var,CATISpecObject_var)
Checks the validity of a Conic Passing point.
o CheckStartAndEndTangentDirections(CATISpecObject_var,CATMathVector&,CATMathVector&,CATISpecObject_var,CATISpecObject_var,CATICkeParm_var,CATISpecObject_var,int&)
Checks the validity and provides a status of the tangent directions at the start and end points.
o GetConicParm(CATICkeParm_var&)
Gets the Conic Parameter ( As a literal ).
o GetConicParm(double&)
Gets the Conic Parameter value ( As a Double ).
o GetConicUserTol(CATICkeParm_var&)
Gets the Conic User Tolerance.
o GetDirectionVector(CATIGSMDirection_var&,int,CATMathVector&)
Gets the Direction vector that corresponds to the Direction specifications.
o GetEndCst(CATIGSMCurveCst_var&)
Gets the End Constraint Point of the Conic Curve.
o GetGSMConicType(CATGSMConicType&)
Gets the Type of the Conic Curve.
o GetIntermediateCst(CATIGSMCurveCst_var&,int)
Gets the Intermediate CSt at Position Pos (1<= Pos <=3 ).
o GetPassingPoint(int,CATISpecObject_var&)
Gets a Conic Passing Point.
o GetStartCst(CATIGSMCurveCst_var&)
Gets the Starting Constraint Point of the Conic Curve.
o GetSupport(CATISpecObject_var&)
Gets the Support Plane of the Conic Curve.
o GetTangentDirectionAtPassingPoint(int,CATIGSMDirection_var&,int&)
Gets the Tangent direction specifactions at a conic passing Point.
o GetTgtIntPoint(CATISpecObject_var&)
Gets the Tangent Intersection Point.
o GetUniquePointIndexWhereTangentIsSet(CATGSMConicType,int&)
Gets the Unique Point index where a tangent constraint is set.
o SetConicParm(CATICkeParm_var)
Sets the Conic Parameter.
o SetConicParm(double)
Sets the Conic Parameter.
o SetConicUserTol(CATICkeParm_var)
Sets the Conic User Tolerance.
o SetEndCst(CATIGSMCurveCst_var)
Sets the End Constraint Point of the Conic Curve.
o SetIntermediateCst(CATIGSMCurveCst_var,int)
Sets the Intermediate Conic CSt at Position Pos (1<= Pos <=3 ).
o SetStartCst(CATIGSMCurveCst_var)
Sets the Starting Constraint Point of the Conic Curve.
o SetSupport(CATISpecObject_var)
Sets the Support Plane of the Conic Curve.
o SetTgtIntPoint(CATISpecObject_var)
Sets the Tangent Intersection Point.

Methods


o CheckConicParameterValue
public virtual HRESULT CheckConicParameterValue( const CATISpecObject_var iPtTgtInt,
const CATMathVector& iStartMDir,
const CATMathVector& iEndMDir,
const CATISpecObject_var iStartPoint,
const CATISpecObject_var iStartEnd,
double& iConicParmValue,
double& oConicParmResol,
int& ostatus)= 0
Check conic parametrer value.
Parameters:
iPtTgtInt
Tangent Intersection Point ( Note : Can be NULL if iStartMDir and EndMDir are specified)
iStartMDir
Explicit specification of the Tangent Direction at the Start Point
iEndMDir
Explicit specification of the Tangent Direction at the End Point
iStartPoint
Conic curve Start Point
iEndPoint
Conic curve End Point
iConicParmValue
Conic Parameter specification
iConicParmResol
Conic Resolution
iPassingPoint
Any Intermediate Pasing point of the conic curve (must differs from the start point or the end point)
ostatus
Output status about conic parameter value ostatus = ... Implements a function from an interface.
See also:
CATIGSMConic.CheckConicParameterValue
o CheckPoint
public virtual HRESULT CheckPoint( const CATISpecObject_var iPoint,
const CATISpecObject_var iSupportPlane,
int& oStatus,
const CATISpecObject_var iStartPoint= NULL_var,
const CATISpecObject_var iEndPoint= NULL_var )= 0
Checks the validity of a Conic Passing point.
Parameters:
iPoint
Passing Point to check
iSupportPlane
Support Plane of the Conic curve
iStartPoint
if specified, StartPoint of the conic curve
iEndPoint
if specified, End Point of the conic curve
oStatus
= -1 if the method failed to analyse = 0 Point is OK = 1 Point to check is not set in the support Plane = 2 Point to check is aligned with the Start and End Points (makes sense if iStartPoint and iEndPoint were set)
See also:
CATIGSMConic.CheckPoint
o CheckStartAndEndTangentDirections
public virtual HRESULT CheckStartAndEndTangentDirections( const CATISpecObject_var iPtTgtInt,
const CATMathVector& iStartMDir,
const CATMathVector& iEndMDir,
const CATISpecObject_var iStartPoint,
const CATISpecObject_var iEndPoint,
const CATICkeParm_var iConicParm,
const CATISpecObject_var iPassingPoint,
int& ostatus)= 0
Checks the validity and provides a status of the tangent directions at the start and end points.
Parameters:
iPtTgtInt
Tangent Intersection Point ( Note : Can be NULL if iStartMDir and EndMDir are specified) It specifies the tangents directions as the intersections of the line (iStartPoint, iPtTgtInt) with the line (iEndPoint,iPtTgtInt)
iStartMDir
Explicit specification of the Tangent Direction at the Start Point
iEndMDir
Explicit specification of the Tangent Direction at the End Point
iStartPoint
Conic curve Start Point
iEndPoint
Conic curve End Point
iConicParm
Conic Parameter specification
iPassingPoint
Any Intermediate Pasing point of the conic curve (must differs from the start point or the end point)
ostatus
Output status about the start and end tangent orientations ostatus = 0: The start and end tangent directions intersect themselves and are correctly oriented according to the conic curve orientation from StartPoint to EndPoint ostatus = 1: the 2 tangents intersect themselves : only starting tangent has to be inverted ostatus = 2: the 2 tangents intersect themselves : only ending tangent has to be inverted ostatus = 3: the 2 tTangents intersect themselves : both tangentes has to be inverted ostatus = 10: the 2 tangents are parallel and correctly oriented ostatus = 11: the 2 tangents are parallel : only starting tangent has to be inverted ostatus = 12: the 2 tangents are parallel : only ending tangent has to be inverted ostatus = 13: the 2 tangents are parallel : both tangentes has to be inverted ostatus = -10: the 2 tangents are parallel and are detected not valid ostatus = -1 : Input specifications are incomplete in order to perform tangent direction checks
o GetConicParm
public virtual HRESULT GetConicParm(CATICkeParm_var& oConicParm) = 0
Gets the Conic Parameter ( As a literal ).
Parameters:
oConicParm
See also:
CATICkeParm
o GetConicParm
public virtual HRESULT GetConicParm(double& oConicParm) = 0
Gets the Conic Parameter value ( As a Double ).
Parameters:
oConicParm
o GetConicUserTol
public virtual HRESULT GetConicUserTol(CATICkeParm_var& oConicUserTol) = 0
Gets the Conic User Tolerance.
Parameters:
oConicUserTol
See also:
CATICkeParm
o GetDirectionVector
public virtual HRESULT GetDirectionVector( const CATIGSMDirection_var& iTgtDir,
const int iInvertDirFlag,
CATMathVector& oMDir)= 0
Gets the Direction vector that corresponds to the Direction specifications.
Parameters:
iTgtDir
CATIGSM Direction specification
iInvertDirFlag
Flag value must be set to -1 to reverse the CATIGSM Direction specification.
oMDir
CATMathVector Direction
o GetEndCst
public virtual HRESULT GetEndCst(CATIGSMCurveCst_var& oEndCst) = 0
Gets the End Constraint Point of the Conic Curve.
Parameters:
oEndCst
See also:
CATIGSMCurveCst
o GetGSMConicType
public virtual HRESULT GetGSMConicType(CATGSMConicType& oType) = 0
Gets the Type of the Conic Curve.
Parameters:
oType
oPointIndexWhereTangentIsSet
= 1 if Tangent is set at the Conic Start point location = 2 if Tangent is set at the second Conic point location = 3 if Tangent is set at the third Conic point location = 4 if Tangent is set at the Conic end point location (makes sense only for the Conic curve type "TwoIntermediatePassingPointsPlusOneTangent")
o GetIntermediateCst
public virtual HRESULT GetIntermediateCst(CATIGSMCurveCst_var& oInterCst,
int Pos) = 0
Gets the Intermediate CSt at Position Pos (1<= Pos <=3 ).
Parameters:
oInterCst
See also:
CATIGSMCurveCst
o GetPassingPoint
public virtual HRESULT GetPassingPoint(int iPointNumber,
CATISpecObject_var& oSpecPt) = 0
Gets a Conic Passing Point.
Parameters:
iPointNumber
Order Number ( From 1 to 5 ) of the Point to get iPointNumber = 1 must be set to retrieve the Start Point iPointNumber = 5 must be set to retrieve the End Point iPointNumber = 2, 3, or 4 must be set to retrieve respectively the first,second, third intermediate passing point
oSpecPt
Retrieved Passing Point
o GetStartCst
public virtual HRESULT GetStartCst(CATIGSMCurveCst_var& oStartCst) = 0
Gets the Starting Constraint Point of the Conic Curve.
Parameters:
oStartCst
See also:
CATIGSMCurveCst
o GetSupport
public virtual HRESULT GetSupport(CATISpecObject_var& oSupport) = 0
Gets the Support Plane of the Conic Curve.
Parameters:
oSupport
See also:
CATISpecObject
o GetTangentDirectionAtPassingPoint
public virtual HRESULT GetTangentDirectionAtPassingPoint(int iPointNumber,
CATIGSMDirection_var& oTgtDir,
int& oInvertDirFlag)= 0
Gets the Tangent direction specifactions at a conic passing Point.
Parameters:
iPointNumber
Order Number ( From 1 to 5 ) of the Point to get: iPointNumber = 1 must be set to retrieve the Start Point iPointNumber = 5 must be set to retrieve the End Point iPointNumber = 2, 3, or 4 must be set to retrieve respectively the first,second, third intermediate passing point
oTgtDir
Retrieved CATIGSM Direction specification
oInvertDirFlag
Flag value must be set to -1 to reverse the CATIGSM Direction specification
o GetTgtIntPoint
public virtual HRESULT GetTgtIntPoint(CATISpecObject_var& oTgtIntPt) = 0
Gets the Tangent Intersection Point.
Parameters:
oTgtIntPt
See also:
CATISpecObject
o GetUniquePointIndexWhereTangentIsSet
public virtual HRESULT GetUniquePointIndexWhereTangentIsSet(CATGSMConicType iType,
int& oPointIndexWhereTangentIsSet) = 0
Gets the Unique Point index where a tangent constraint is set.
Parameters:
iType
oPointIndexWhereTangentIsSet
= 1 if Tangent is set at the Conic Start point location = 2 if Tangent is set at the second Conic point location = 3 if Tangent is set at the third Conic point location = 4 if Tangent is set at the Conic end point location (makes sense only for the Conic curve type "TwoIntermediatePassingPointsPlusOneTangent")
o SetConicParm
public virtual HRESULT SetConicParm( const CATICkeParm_var iConicParm) = 0
Sets the Conic Parameter.
Parameters:
iConicParm
See also:
CATICkeParm
o SetConicParm
public virtual HRESULT SetConicParm( const double iConicParm) = 0
Sets the Conic Parameter.
Parameters:
iConicParm
( As a Double )
o SetConicUserTol
public virtual HRESULT SetConicUserTol( const CATICkeParm_var iConicTol) = 0
Sets the Conic User Tolerance.
Parameters:
iConicTol
See also:
CATICkeParm
o SetEndCst
public virtual HRESULT SetEndCst( const CATIGSMCurveCst_var iEndCst) = 0
Sets the End Constraint Point of the Conic Curve.
Parameters:
iStartCst
See also:
CATIGSMCurveCst
o SetIntermediateCst
public virtual HRESULT SetIntermediateCst( const CATIGSMCurveCst_var iInterCst,
int iPos) = 0
Sets the Intermediate Conic CSt at Position Pos (1<= Pos <=3 ).
Parameters:
iInterCst
iPos
See also:
CATIGSMCurveCst
o SetStartCst
public virtual HRESULT SetStartCst( const CATIGSMCurveCst_var iStartCst) = 0
Sets the Starting Constraint Point of the Conic Curve.
Parameters:
iStartCst
See also:
CATIGSMCurveCst
o SetSupport
public virtual HRESULT SetSupport( const CATISpecObject_var iSupport) = 0
Sets the Support Plane of the Conic Curve.
Parameters:
iSupport
See also:
CATISpecObject
o SetTgtIntPoint
public virtual HRESULT SetTgtIntPoint( const CATISpecObject_var iTgtIntPt) = 0
Sets the Tangent Intersection Point.
Parameters:
iTgtIntPt
See also:
CATISpecObject

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

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