All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

SketcherInterfaces Interface CATI2DSplineCurve

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

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


interface CATI2DSplineCurve



Method Index


o AddLastPoint(CATI2DPoint*,int)
Inserts control point in the spline at the last position.
o Compute(int)
Computes the spline, according to the recorded control points.
o GetClosure(int*)
Gets whether the curve is closed.
o GetCstPoints(CATListValCATI2DCstPoint_var&)
Gives the list of the control points of the spline.
o GetDegree(int*)
Gives the degree of the curve (3 or 5)
o InsertControlPointAfter(CATI2DPoint*,unsigned long,int)
Inserts control point in the spline.
o RemovePoint(CATI2DPoint*,int)
Removes control point in the spline.
o SetClosure(int)
Sets whether the curve is closed.

Methods


o AddLastPoint
public virtual HRESULT AddLastPoint(CATI2DPoint* iPoint,
const int iEvaluationType) = 0
Inserts control point in the spline at the last position.
If a 2D point is given (and not a control point), a new control point is created and aggregated in the spline.
If a 2D control point is given, it will be aggregated in the spline.
If the 2D control point is previously aggregated in a spline, the return code will be E_FAIL.
Parameters:
iPoint
The new point to be inserted. (@see CATI2DPoint and CATI2DCstPoint for more information).
iEvaluationType
Unused.
o Compute
public virtual HRESULT Compute( const int iEvaluationType) = 0
Computes the spline, according to the recorded control points.
Parameters:
iEvaluationType
Unused.
o GetClosure
public virtual HRESULT GetClosure(int* oClosed) = 0
Gets whether the curve is closed.
Parameters:
oClosed
Closing flag
1
for a closed curve
0
for an open curve
o GetCstPoints
public virtual HRESULT GetCstPoints(CATListValCATI2DCstPoint_var& oCstPointsList) = 0
Gives the list of the control points of the spline.
Parameters:
oCstPointsList
The list of the control points. (@see CATI2DPoint and CATI2DCstPoint for more information).
o GetDegree
public virtual HRESULT GetDegree(int* oDegree) = 0
Gives the degree of the curve (3 or 5)
Parameters:
oDegree
The degree of the spline curve
o InsertControlPointAfter
public virtual HRESULT InsertControlPointAfter(CATI2DPoint* iPoint,
const unsigned long iPosition,
const int iEvaluationType) = 0
Inserts control point in the spline.
If a 2D point is given (and not a control point), a new control point is created and aggregated in the spline.
If a 2D control point is given, it will be aggregated in the spline.
If the 2D control point is previously aggregated in a spline, the return code will be E_FAIL.
Parameters:
iPoint
The new point to be inserted. (@see CATI2DPoint and CATI2DCstPoint for more information).
iPosition
The position at which to insert the point. To insert a new control point as the first element, set iPosition to 0.
iEvaluationType
Unused.
o RemovePoint
public virtual HRESULT RemovePoint(CATI2DPoint* iPoint,
const int iEvaluationType) = 0
Removes control point in the spline.
Parameters:
iPoint
The point to be removed. (@see CATI2DPoint and CATI2DCstPoint for more information).
iEvaluationType
Unused.
o SetClosure
public virtual HRESULT SetClosure( const int iClosed) = 0
Sets whether the curve is closed.
Parameters:
iClosed
Closing flag
1
for a closed curve
0
for an open curve

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

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