All Frameworks Class Hierarchy This Framework Previous Next Indexes
DraftingInterfaces Interface CATIDftElementWithLeader
System.IUnknown
|
+---CATIDftElementWithLeader
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATIDftElementWithLeader
Interface on Leader list management.
- See also:
- CATIDftLeader
Method Index
- o
AddLeader(int,double[2],CATIDftLeader**,SymbolType)
- Add a leader to the element.
- o
GetAnchorDelta(int,double*)
- Get the leader anchor delta without view scale.
- o
GetAnchorPoint(int,double [2])
- Returns the position of a particular anchor point for leader.
- o
GetAnchorPoints(int*,double**,int**,double**)
- Returns all possible anchor points for leaders on the element.
- o
GetLeader(int,CATIDftLeader**)
- Returns a particular leader.
- o
GetLeadersVisualization(int*)
- Returns the visualization mode.
- o
GetNbLeader(int*)
- Returns the number of leader on the element.
- o
GetStandardBehavior(boolean*)
- Returns the standard obligation.
- o
RemoveLeader(int)
- Removes a leader.
- o
SetAnchorDelta(int,double)
- Set the leader anchor delta without view scale.
- o
SetLeadersVisualization(int)
- Set the visualization mode for leaders.
- o
SetStandardBehavior(boolean)
- Set the standard obligation.
- o
SlideAlongLeader(double,double)
- Slide the text along its leaders.
Methods
o AddLeader
public virtual HRESULT AddLeader( | int | iAnchorOnElement, |
| const double[2] | iEndPoint, |
| CATIDftLeader** | oLeader, |
| SymbolType | iSymbolType | = NOTUSED) = 0 |
-
Add a leader to the element.
- Parameters:
-
- iAnchorOnElement
- The rank of the point in the list returned by GetAnchorPoints
- iEndPoint
- The point of the arrow
- oLeader
- A pointer on the leader added.
- iSymbolType
- The type of the symbol (can be automaticly overriden by some annotations)
o GetAnchorDelta
public virtual HRESULT GetAnchorDelta( | const int | iNoLeader, |
| double* | oDelta) = 0 |
-
Get the leader anchor delta without view scale.
- Parameters:
-
- oDelta
o GetAnchorPoint
public virtual HRESULT GetAnchorPoint( | int | iNoPoint, |
| double [2] | oPoint) = 0 |
-
Returns the position of a particular anchor point for leader.
- Parameters:
-
- iNoPoints
- Rank of the point in the possible list of anchor point. The list start to 1 to number
of points returned by GetAnchorPoints method.
- oPoint
- The point.
o GetAnchorPoints
public virtual HRESULT GetAnchorPoints( | int* | oNbPoints, |
| double** | oPointListe, |
| int** | oPointIsValid, |
| double** | oDeltaListe) = 0 |
-
Returns all possible anchor points for leaders on the element.
- Parameters:
-
- oNbPoints
- Number of possible points to anchor leader.
- oPointListe
- Liste of points, X1,Y1,X2,Y2,...
- oPointIsValid
- Liste of usable points rank in the previous list.
- oDeltaListe
- Liste of delta for anchor point
o GetLeader
-
Returns a particular leader.
- Parameters:
-
- iNoLeader
- The rank of the leader. Start to 1 to number of leader returned by GetNbLeader method.
- oLeader
- A pointer on the leader.
o GetLeadersVisualization
public virtual HRESULT GetLeadersVisualization( | int* | oShowMode) = 0 |
-
Returns the visualization mode.
- Parameters:
-
- ShowMode
- if ShowMode = 0, leaders aren't visible.
o GetNbLeader
public virtual HRESULT GetNbLeader( | int* | oNbLeader) = 0 |
-
Returns the number of leader on the element.
- Parameters:
-
- oNbLeader
- The number of leader on the element.
o GetStandardBehavior
public virtual HRESULT GetStandardBehavior( | boolean* | oStd) = 0 |
-
Returns the standard obligation.
- Parameters:
-
- oStd
- if oStd = TRUE -> the leader anchor point will respect the current standard
(either ISO/JIS/ANSI)
if oStd = FALSE -> the leader anchor point doeas not respect any standard
o RemoveLeader
public virtual HRESULT RemoveLeader( | int | iNoLeader) = 0 |
-
Removes a leader.
- Parameters:
-
- iNoLeader
- Rank of leader to delete. If iNoLeader is equal to -1, all leaders will
be deleted.
o SetAnchorDelta
public virtual HRESULT SetAnchorDelta( | const int | iNoLeader, |
| const double | iDelta) = 0 |
-
Set the leader anchor delta without view scale.
- Parameters:
-
- iDelta
o SetLeadersVisualization
public virtual HRESULT SetLeadersVisualization( | int | iShowMode) = 0 |
-
Set the visualization mode for leaders.
- Parameters:
-
- ShowMode
- if ShowMode = 0, leaders won't be visible.
o SetStandardBehavior
public virtual HRESULT SetStandardBehavior( | const boolean | iStd) = 0 |
-
Set the standard obligation.
- Parameters:
-
- iStd
- if iStd = TRUE -> the leader anchor point will respect the current standard
(either ISO/JIS/ANSI)
if iStd = FALSE -> the leader anchor point doeas not respect any standard
o SlideAlongLeader
public virtual HRESULT SlideAlongLeader( | const double | iDeltaX, |
| const double | iDeltaY) = 0 |
-
Slide the text along its leaders.
- Parameters:
-
- iDeltaX
-
- iDeltaY
This object is included in the file: CATIDftElementWithLeader.h
If needed, your Imakefile.mk should include the module: CATDraftingInterfaces