All Frameworks Class Hierarchy This Framework Indexes
DraftingInterfaces Interface CATIDrwLeader
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATIDrwLeader
Interface of leader objects.
- See also:
- CATIDrwEltWithLeader
Method Index
- o
AddInterruption(double[2],double[2])
- Add a interruption to a leader.
- o
AddPoint(int&,double&,double&)
- Add a point to a leader.
- o
GetAllAround(CATBoolean*)
- Get the status of AllAround.
- o
GetAnchorPoint()
- Get the anchor point of the leader on the annotation.
- o
GetAnchorPoint(int&,int&)
- Get the anchor point of the leader on the annotation.
- o
GetInterruptions(double**,int*)
- Get interruptions of leader path.
- o
GetMoveMode(CATBoolean*)
- Get the status of MoveMode.
- o
GetNbInterruption(int*)
- Get the number of interruptions of leader path.
- o
GetNbPoint()
- Returns the number of points of a leader.
- o
GetPoint(int)
- Returns a particular point of a leader.
- o
GetPoints()
- Returns points of a leader.
- o
GetSymbolType()
- Gets the ending symbol.
- o
ModifyPoint(int,double,double)
- Modifies a particular point of a leader.
- o
RemoveInterruption(int)
- Remove a interruption to a leader.
- o
RemovePoint(int)
- Erase a particular point of a leader.
- o
SetAllAround(CATBoolean)
- Set the status of AllAround.
- o
SetAnchorPoint(int&)
- Set the anchor point of the leader on the annotation.
- o
SetAssociativeOrientation(CATBaseUnknown*,CATAssProjectingMode)
- Puts orientation link between the leader extremity and a reference.
- o
SetAssociativePosition(CATBaseUnknown*,CATAssPositioningBehavior,CATAssProjectingMode)
- Puts a positional link between the leader extremity and a reference.
- o
SetMoveMode(CATBoolean)
- Set the status of MoveMode.
- o
SetSymbolType(int&)
- Sets the ending symbol.
Methods
o AddInterruption
| public virtual AddInterruption( | const | iFirstPoint, |
| const | iSecondPoint) |
-
Add a interruption to a leader.
- 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( | | iPointBefore, |
| | iXpos, |
| | iYpos) |
-
Add a point to a leader.
- Parameters:
-
- iPointBefore
- The rank of the preceding point : 0 to GetNbPoint().
0 means anchor point.
GetNbPoint() means append at the end of leader
o GetAllAround
| public virtual GetAllAround( | | oAllAround) |
-
Get the status of AllAround.
- Parameters:
-
-
-
- oAllAround : TRUE mean to display AllAround.
- Returns:
-
- S_OK
- if the operation succeeded.
- E_FAIL
- if the operation failed.
o GetAnchorPoint
| public virtual GetAnchorPoint( | ) |
-
Get the anchor point of the leader on the annotation.
- See also:
- CATIDrwEltWithLeader.GetLeaderAnchorPoints
o GetAnchorPoint
| public virtual GetAnchorPoint( | | oNum, |
| | oFixed) |
-
Get the anchor point of the leader on the annotation.
- See also:
- CATIDrwEltWithLeader.GetLeaderAnchorPoints
o GetInterruptions
| public virtual GetInterruptions( | | oInterruptions, |
| | oNbInterruptions) |
-
Get interruptions of leader 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 GetMoveMode
| public virtual GetMoveMode( | | oMoveMode) |
-
Get the status of MoveMode.
- Parameters:
-
-
-
- oMoveMode : TRUE mean to move with annotation.
- 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 leader path.
- Parameters:
-
-
-
- oNbInterruption : Number of interruptions of leader path.
- Returns:
-
- S_OK
- if the operation succeeded.
- E_FAIL
- if the operation failed.
o GetNbPoint
| public virtual GetNbPoint( | ) |
-
Returns the number of points of a leader.
The anchor point is not taken into account.
- Returns:
- The number of points.
o GetPoint
| public virtual GetPoint( | | iNoPoint) |
-
Returns a particular point of a leader.
To get the anchor point set NoPoint to 0.
- Parameters:
-
- iNoPoint
- Tha anchor point index.
- Returns:
- The anchor point at index iNoPoint.
o GetPoints
| public virtual GetPoints( | ) |
-
Returns points of a leader.
The anchor point is not in the list.
- Returns:
- The mathematical anchor point list.
o GetSymbolType
| public virtual GetSymbolType( | ) |
-
Gets the ending symbol.
- Returns:
- The symbol type.
o ModifyPoint
| public virtual ModifyPoint( | | iNoPoint, |
| | iNewX, |
| | iNewY) |
-
Modifies a particular point of a leader.
NoPoint is from 1 to GetNbPoint().
- Parameters:
-
- iNoPoint
- The leader point to be modified
- iNewX
- The new X coordinate of this point
- iNewY
- The new Y coordinate of this point
o RemoveInterruption
| public virtual RemoveInterruption( | const | iNum | = 0) |
-
Remove a interruption to a leader.
- 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( | | iNoPoint) |
-
Erase a particular point of a leader.
- Parameters:
-
- iNoPoint
-
NoPoint is from 1 to GetNbPoint().
-1 means erase all points.
o SetAllAround
| public virtual SetAllAround( | | iAllAround | = FALSE) |
-
Set the status of AllAround.
- Parameters:
-
-
-
- iAllAround : TRUE mean to display AllAround.
- Returns:
-
- S_OK
- if the operation succeeded.
- E_FAIL
- if the operation failed.
o SetAnchorPoint
| public virtual SetAnchorPoint( | | iAnchorPoint) |
-
Set the anchor point of the leader on the annotation.
- See also:
- CATIDrwEltWithLeader.GetLeaderAnchorPoints
o SetAssociativeOrientation
| public virtual SetAssociativeOrientation( | | ipRef, |
| | iProjMode | =Ass_Contour) |
-
Puts orientation link between the leader extremity and a reference.
- Parameters:
-
- iRef
- The reference. All elements which implements the CATIDrwMarkupable interface can
be used (annotations, geometry, ...).
- iProjMode
- The projection mode (On curve, follow hot points, Extensionlines of dimensions...).
Default : projected on the curve.
- Returns:
- HRESULT
- S_OK
- Orientation link has been created
- E_FAIL
- No orientation link created
o SetAssociativePosition
| public virtual SetAssociativePosition( | | ipRef, |
| | iPosBehavior | =Ass_Relative, |
| | iProjMode | =Ass_Contour) |
-
Puts a positional link between the leader extremity and a reference.
- Parameters:
-
- iRef
- The reference. All elements which implements the CATIDrwMarkupable interface can
be used (annotations, geometry, ...).
- iPosBehavior
- Relative or absolute.
- iProjMode
- The projection mode (On curve, follow hot points, Extensionlines of dimensions...).
Default : projected on the curve.
- Returns:
- HRESULT
- S_OK
- Positional link has been created
- E_FAIL
- No positional link created
o SetMoveMode
| public virtual SetMoveMode( | | iMoveMode | = FALSE) |
-
Set the status of MoveMode.
- Parameters:
-
-
-
- iMoveMode : TRUE mean to move with annotation.
- Returns:
-
- S_OK
- if the operation succeeded.
- E_FAIL
- if the operation failed.
o SetSymbolType
| public virtual SetSymbolType( | | SymbolType) |
-
Sets the ending symbol.
- Parameters:
-
- iSymbolType
- The symbol type.
This object is included in the file: CATIDrwLeader.h
If needed, your Imakefile.mk should include the module: CATDraftingInterfaces