All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

SketcherInterfaces Interface CATISketch

System.IUnknown
  |
  +---System.IDispatch
    |
    +---System.CATBaseUnknown
      |
      +---SketcherInterfaces.CATISketchEditor
        |
        +---CATISketch
 

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


interface CATISketch

The methods of this interface provide the client with the functionality for handling a sketch.
Role:


Method Index


o AttachToPlane(CATBaseUnknown_var&,int,int)
Defines the planar support of the sketch (the sketch becomes Sliding).
o GetAbsolute2DAxis(CATI2DAxis_var&)
Returns the absolute axis of the sketch.
o GetAxisData(double*,double*,double*)
Returns the position of the sketch in space.
o GetComponents(CATIdent,CATListValCATI2DWFGeometry_var&)
Retrieves all geometries.
o GetCurrentCenterLine()
Returns the (unique) center line of the sketch.
o GetPlanarSupport(CATISpecObject_var&)
Returns the planar support of the sketch.
o IsEmpty()
Tells if the sketch is empty.
o Isolate()
Isolates the projected and intersected Geometries.
o SetAxisData(double*,double*,double*)
Defines the position of the sketch in space.
o SetCurrentCenterLine(CATI2DLine_var&)
Defines the (unique) center line of the sketch.

Methods


o AttachToPlane
public virtual HRESULT AttachToPlane( const CATBaseUnknown_var& iPlane,
const int iKeepRelativOrientation=0,
const int iSlidingMode=-1) = 0
Defines the planar support of the sketch (the sketch becomes Sliding).
o GetAbsolute2DAxis
public virtual HRESULT GetAbsolute2DAxis(CATI2DAxis_var& oAxis) = 0
Returns the absolute axis of the sketch.
o GetAxisData
public virtual HRESULT GetAxisData(double* oRootPoint,
double* oHAxis,
double* oVAxis) = 0
Returns the position of the sketch in space.
o GetComponents
public virtual HRESULT GetComponents( const CATIdent iIntfName,
CATListValCATI2DWFGeometry_var& ioGeomLst) = 0
Retrieves all geometries.
Parameters:
const
CATIdent iIntfName [in] To get only geometries answering to iIntfName interface.
CATListValCATI2DWFGeometry_var&
ioGeomLst [inout] The list of geometries.
o GetCurrentCenterLine
public virtual CATISpecObject_var GetCurrentCenterLine()= 0
Returns the (unique) center line of the sketch.
o GetPlanarSupport
public virtual HRESULT GetPlanarSupport(CATISpecObject_var& oPlane) = 0
Returns the planar support of the sketch.
o IsEmpty
public virtual int IsEmpty()= 0
Tells if the sketch is empty.
Returns:
int
1
The shetch is empty.
0
The sketch is not empty.
o Isolate
public virtual HRESULT Isolate()= 0
Isolates the projected and intersected Geometries.
o SetAxisData
public virtual HRESULT SetAxisData( const double* iRootPoint,
const double* iHAxis,
const double* iVAxis) = 0
Defines the position of the sketch in space.
o SetCurrentCenterLine
public virtual HRESULT SetCurrentCenterLine( const CATI2DLine_var& iLine) = 0
Defines the (unique) center line of the sketch.

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

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