All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

DraftingInterfaces Interface CATIDftArrow

System.IUnknown
  |
  +---CATIDftArrow
 

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


interface CATIDftArrow

Interface which manages the arrows created in CATDrawing documnent.


Method Index


o AddInterruption(double[2],double[2])
Add a interruption to an arrow.
o AddPoint(int&,double[2])
Add a point to an arrow.
o GetInterruptions(double**,int*)
Get interruptions of arrow path.
o GetNbInterruption(int*)
Get the number of interruptions of arrow path.
o GetNbPoint(int*)
Get the number of points of arrow path.
o GetPoint(int,double[2])
Get arrow point coordinates.
o GetPoints(double**,int*)
Get arrow path.
o GetSymbolType(int*,CATDftArrowExtremity)
Get arrow head or tail symbol.
o GetTarget(IUnknown**,CATDftArrowExtremity)
Get arrow target elements.
o ModifyPoint(int,double[2])
Modify a point of an Arrow.
o RemoveInterruption(int)
Remove a interruption to an arrow.
o RemovePoint(int)
Remove a point from an arrow.
o SetSymbolType(int,CATDftArrowExtremity)
Set arrow head or tail symbol.
o SetTarget(IUnknown*,double[2],CATDftArrowExtremity)
Set Arrow target elements.

Methods


o AddInterruption
public virtual HRESULT AddInterruption( const double[2] iFirstPoint,
const double[2] iSecondPoint) = 0
Add a interruption to an arrow.
Parameters:
iFirstPoint : First point coordinates.
iSecondPoint : Second point coordinates.
Returns:
S_OK
if the operation succeeded.
E_FAIL
if the operation failed.
o AddPoint
public virtual HRESULT AddPoint( const int& iNum,
const double[2] iPoint) = 0
Add a point to an arrow.
Parameters:
iNum : Point number. Point will be inserted at iNum+1 position.
- If iNum equals 0, point is inserted as first point.
- If iNum equals the arrow number of points, point is inserted as last point.
iPoint : Point coordinates to add.
Returns:
S_OK
if the operation succeeded.
E_FAIL
if the operation failed.
o GetInterruptions
public virtual HRESULT GetInterruptions(double** oInterruptions,
int* oNbInterruptions) = 0
Get interruptions of arrow path.
Parameters:
oInterruptions : List of interruptions coordinates (X1,Y1,X2,Y2,.....Xn,Yn).
oNbInterruptions : Number of interruptions.
Returns:
S_OK
if the operation succeeded.
E_FAIL
if the operation failed.
o GetNbInterruption
public virtual HRESULT GetNbInterruption(int* oNbInterruption) = 0
Get the number of interruptions of arrow path.
Parameters:
oNbInterruption : Number of interruptions of arrow path.
Returns:
S_OK
if the operation succeeded.
E_FAIL
if the operation failed.
o GetNbPoint
public virtual HRESULT GetNbPoint(int* oNbPoint) = 0
Get the number of points of arrow path.
Parameters:
oNbPoint : Number of points of arrow path.
Returns:
S_OK
if the operation succeeded.
E_FAIL
if the operation failed.
o GetPoint
public virtual HRESULT GetPoint( const int iNum,
double[2] oPoint) = 0
Get arrow point coordinates.
Parameters:
iNum : Point number.
oPoint : Point coordinates.
Returns:
S_OK
if the operation succeeded.
E_FAIL
if the operation failed.
o GetPoints
public virtual HRESULT GetPoints(double** oPoints,
int* oNbPoints) = 0
Get arrow path.
Parameters:
oPoints : List of points coordinates (X1,Y1,X2,Y2,.....Xn,Yn).
oNbPoints : Number of points.
Returns:
S_OK
if the operation succeeded.
E_FAIL
if the operation failed.
o GetSymbolType
public virtual HRESULT GetSymbolType(int* oSymbolType,
const CATDftArrowExtremity iExtremity= CATDftArrowHead) = 0
Get arrow head or tail symbol.
Parameters:
oSymbolType : Symbol type.
iExtremity : Head (CATDftArrowHead) or Tail (CATDftArrowTail).
Returns:
S_OK
if the operation succeeded.
E_FAIL
if the operation failed.
o GetTarget
public virtual HRESULT GetTarget(IUnknown** oTarget,
const CATDftArrowExtremity iExtremity= CATDftArrowHead) = 0
Get arrow target elements.
Parameters:
oTarget : The target element.
iExtremity : Head (CATDftArrowHead) or Tail (CATDftArrowTail).
Returns:
S_OK
if the operation succeeded.
E_FAIL
if the operation failed.
o ModifyPoint
public virtual HRESULT ModifyPoint( const int iNum,
const double[2] iPoint) = 0
Modify a point of an Arrow.
Parameters:
iNum : Point number to modify.
iPoint : New point coordinates.
Returns:
S_OK
if the operation succeeded.
E_FAIL
if the operation failed.
o RemoveInterruption
public virtual HRESULT RemoveInterruption( const int iNum= 0) = 0
Remove a interruption to an arrow.
Parameters:
iNum : Interruption number to delete.
- If iNum equals to 0, all interruptions will be removed.
Returns:
S_OK
if the operation succeeded.
E_FAIL
if the operation failed.
o RemovePoint
public virtual HRESULT RemovePoint( const int iNum= 0) = 0
Remove a point from an arrow.
Parameters:
iNum : Point number to delete.
- If iNum equals to 0, all points will be removed.
Returns:
S_OK
if the operation succeeded.
E_FAIL
if the operation failed.
o SetSymbolType
public virtual HRESULT SetSymbolType( const int iSymbolType,
const CATDftArrowExtremity iExtremity= CATDftArrowHead) = 0
Set arrow head or tail symbol.
Parameters:
iSymbolType : Symbol type.
iExtremity : Head (CATDftArrowHead) or Tail (CATDftArrowTail).
Returns:
S_OK
if the operation succeeded.
E_FAIL
if the operation failed.
o SetTarget
public virtual HRESULT SetTarget(IUnknown* iTarget,
double[2] iPos,
const CATDftArrowExtremity iExtremity= CATDftArrowHead) = 0
Set Arrow target elements.
Parameters:
iTarget : The target element.
iPos : Position to project on the target element.
iExtremity : Head (CATDftArrowHead) or Tail (CATDftArrowTail).
Returns:
S_OK
if the operation succeeded.
E_FAIL
if the operation failed.

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

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