CATAnnotationUseItf Interface 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 AddInterruption( | const | iFirstPoint, |
| const | iSecondPoint) |
-
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 AddPoint( | const | iNum, |
| const | iPoint) |
-
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 GetInterruptions( | | oInterruptions, |
| | oNbInterruptions) |
-
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 GetNbInterruption( | | oNbInterruption) |
-
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 GetNbPoint( | | oNbPoint) |
-
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 GetPoint( | const | iNum, |
| | oPoint) |
-
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 GetPoints( | | oPoints, |
| | oNbPoints) |
-
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 GetSymbolType( | | oSymbolType, |
| const | iExtremity | = CATDftArrowHead) |
-
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 GetTarget( | | oTarget, |
| const | iExtremity | = CATDftArrowHead) |
-
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 ModifyPoint( | const | iNum, |
| const | iPoint) |
-
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 RemoveInterruption( | const | iNum | = 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 RemovePoint( | const | iNum | = 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 SetSymbolType( | const | iSymbolType, |
| const | iExtremity | = CATDftArrowHead) |
-
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 SetTarget( | | iTarget, |
| | iPos, |
| const | iExtremity | = CATDftArrowHead) |
-
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: CATAnnotationUseItf
Copyright © 1999-2014, Dassault Systèmes. All rights reserved.