All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

SketcherInterfaces Interface CATI2DCurve

System.IUnknown
  |
  +---System.IDispatch
    |
    +---System.CATBaseUnknown
      |
      +---SketcherInterfaces.IDMCurve2D
        |
        +---CATI2DCurve
 

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


interface CATI2DCurve

2D Curve Definition.
Role: This interface provides the client with the information related to 2D curves.


Method Index


o GetDiscretisation(double,double,double,int*,double**,double**)
Returns a discretisation of the curve satisfying a given sag.
o GetEndPoint()
Returns (or create) the end point of the 2D curve.
o GetGeneratingElement()
o GetStartPoint()
Returns (or create) the start point of the 2D curve.
o IsATrimmedCurve()
Tells if curve is trimmed.
o IsClosed()
Tells if curve is closed.
o IsParamReversed(int*)
Tells if the edge chooses a specific direction of parameterization as its inerent one.
o ReadEndPoint()
Returns the end point of the 2D curve.
o ReadStartPoint()
Returns the start point of the 2D curve.
o ReverseParam()
Reverses the direction of the parametrization.
o SetEndPoint(CATI2DPoint_var&,int*)
Defines the end point of the 2D curve.
o SetEndPoint(double*)
Defines the end point coordinates of the 2D curve.
o SetStartPoint(CATI2DPoint_var&,int*)
Defines the start point of the 2D curve.
o SetStartPoint(double*)
Defines the start point coordinates of the 2D curve.

Methods


o GetDiscretisation
public virtual HRESULT GetDiscretisation(double iStartParam,
double iEndParam,
double iSag,
int* oSize,
double** oParams,
double** oPoints) = 0
Returns a discretisation of the curve satisfying a given sag.
Parameters:
double
iStartParam [in] The parameter of the start point.
double
iEndParam [in] The parameter of the end point.
double
iSag [in] The sag (must be strictly greater than 0).
int
*oSize [out] The number of points computed.
double
**oParams [out] If not NULL, *oParams contains the computed parameters. Must be freeded by caller (delete [] *oParams).
double
**oPoints [out] If not NULL, *oPoints contains the computed points. Must be freeded by caller (delete [] *oPoints).
Returns:
HRESULT
o GetEndPoint
public virtual CATI2DPoint_var GetEndPoint()= 0
Returns (or create) the end point of the 2D curve.
Returns:
CATI2DPoint_var A handler on the end point.
o GetGeneratingElement
public virtual CATISpecObject_var GetGeneratingElement()= 0
o GetStartPoint
public virtual CATI2DPoint_var GetStartPoint()= 0
Returns (or create) the start point of the 2D curve.
Returns:
CATI2DPoint_var A handler on the start point.
o IsATrimmedCurve
public virtual int IsATrimmedCurve()= 0
Tells if curve is trimmed.
Returns:
int
1
The curve is timmed.
0
The curve is not trimmed.
o IsClosed
public virtual int IsClosed()= 0
Tells if curve is closed.
Returns:
int
1
The curve is closed.
0
The curve is not closed.
o IsParamReversed
public virtual HRESULT IsParamReversed(int* oReversed) = 0
Tells if the edge chooses a specific direction of parameterization as its inerent one.
Parameters:
int
*oReversed [out] The edge's direction compared with the flow dictated by the parameterization of the underlying curve geometry.
1
The edge's direction is opposed to underlying curve geometry.
0
The edge's direction is the same as underlying curve geometry.
Returns:
HRESULT
o ReadEndPoint
public virtual CATI2DPoint_var ReadEndPoint()= 0
Returns the end point of the 2D curve.
Returns:
CATI2DPoint_var A handler on the end point or NULL_var if not defined.
o ReadStartPoint
public virtual CATI2DPoint_var ReadStartPoint()= 0
Returns the start point of the 2D curve.
Returns:
CATI2DPoint_var A handler on the start point or NULL_var if not defined.
o ReverseParam
public virtual HRESULT ReverseParam()= 0
Reverses the direction of the parametrization.
Returns:
HRESULT
o SetEndPoint
public virtual int SetEndPoint( const CATI2DPoint_var& iPoint,
int* ioKeepPreviousLimitPoint=NULL) = 0
Defines the end point of the 2D curve.
Parameters:
const
CATI2DPoint_var &iPoint [in] The handler on the 2D point.
int
*ioKeepPreviousLimitPoint [in/out] This argument can be used to erase or keep the previous end point. [in] 1/ If the argument is omitted, or if its value is 0 (zero), the behavior is identical: The preceding end point will be erased, if it existed and if it is not used any more (no constraint references it, it is not limit point of another element). 2/ If the argument value is not zero, the preceding end point will not be erased. [out] 1/ If the input value of this argument was 0, or if it was omitted, the value of output is not significant. 2/ If the input value of this argument was 1, the output value indicates if the point could have been erased or not: Value 2 of output indicates that the previous end point is now isolated, and that it can be erased without consequence. Value 3 of output indicates that the previous end point is not isolated, and that its erasure is not without consequence.
Returns:
int EXIT_SUCCESS EXIT_FAILURE
o SetEndPoint
public virtual CATI2DPoint_var SetEndPoint( const double* iPoint) = 0
Defines the end point coordinates of the 2D curve.
Parameters:
const
double *iPoint [in] The 2D point coordinates.
Returns:
CATI2DPoint_var A handler on the end point.
o SetStartPoint
public virtual int SetStartPoint( const CATI2DPoint_var& iPoint,
int* ioKeepPreviousLimitPoint=NULL) = 0
Defines the start point of the 2D curve.
Parameters:
const
CATI2DPoint_var &iPoint [in] The handler on the 2D point.
int
*ioKeepPreviousLimitPoint [in/out] This argument can be used to erase or keep the previous start point. [in] 1/ If the argument is omitted, or if its value is 0 (zero), the behavior is identical: The preceding start point will be erased, if it existed and if it is not used any more (no constraint references it, it is not limit point of another element). 2/ If the argument value is not zero, the preceding start point will not be erased. [out] 1/ If the input value of this argument was 0, or if it was omitted, the value of output is not significant. 2/ If the input value of this argument was 1, the output value indicates if the point could have been erased or not: Value 2 of output indicates that the previous start point is now isolated, and that it can be erased without consequence. Value 3 of output indicates that the previous start point is not isolated, and that its erasure is not without consequence.
Returns:
int EXIT_SUCCESS EXIT_FAILURE
o SetStartPoint
public virtual CATI2DPoint_var SetStartPoint( const double* iPoint) = 0
Defines the start point coordinates of the 2D curve.
Parameters:
const
double *iPoint [in] The 2D point coordinates.
Returns:
CATI2DPoint_var A handler on the start point.

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

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