CATAnnotationUseItf Interface CATIDftLeader

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

interface CATIDftLeader

This interface give access to leader points and associativity.

See also:

Method Index


o AddInterruption(double[2],double[2])
Add a interruption to a leader.
o AddPoint(int,double [2])
Adds a point on the leader.
o GetAllAround(CATBoolean*)
o GetAnchorElement(CATIDftElementWithLeader**,int*)
Returns the father element and the anchor point of the leader.
o GetAnchorPoint(int*)
Returns the anchor point of the leader.
o GetAnchorSymbol(AnchorSymbol&)
Read the anchor symbol style.
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(int*)
Returns the number of points on the leader.
o GetPoint(int,double [2])
Returns a point of the leader.
o GetPoints(double**)
Returns the list of points on the leader including the anchor point.
o GetSubSet(wchar_t*,IID,IUnknown**)
Returns an interface to modify a subpart of the leader.
o GetSymbolType(CATSymbolType*)
Returns the ending symbol of the leader.
o GetTarget(IUnknown**,int*)
Returns the element targeted by the leader.
o ModifyPoint(int,double [2])
Modifies a point on the leader.
o RemoveInterruption(int)
Remove a interruption to a leader.
o RemovePoint(int)
Removes a point on the leader.
o RemoveTarget()
Remove the associativity to the element targeted by the leader.
o SetAllAround(CATBoolean)
o SetAnchorPoint(int)
Sets the anchor point of the leader.
o SetAnchorSymbol(AnchorSymbol)
Set the anchor symbol style.
o SetMoveMode(CATBoolean)
Set the status of MoveMode.
o SetSymbolType(CATSymbolType)
Sets the ending symbol of the leader.
o SetTarget(IUnknown*,double[2],int)
Sets the leader target.

Enumerated Type Index


o AnchorSymbol
Anchor symbol style.

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( const iPointBefore,
const iPoint)
Adds a point on the leader.
Parameters:
iPointBefore
The point will be inserted at the iPointBefore+1 position.
Note : the end point of the leader is ranked 0 and the anchor point is equal to GetNbPoint().
iPoint
The point to add.
o GetAllAround
public virtual GetAllAround( oAllAround)
Deprecated:
V6R210 use
o GetAnchorElement
public virtual GetAnchorElement( oElmtWithLeader,
oAnchorPoint)
Returns the father element and the anchor point of the leader.
This number is the rank of the point to use in the list returned by CATIDftElementWithLeader::GetLeaderAnchorPoints().
Parameters:
oElmtWithLeader
oAnchorPoint
See also:
o GetAnchorPoint
public virtual GetAnchorPoint( oAnchorPoint)
Returns the anchor point of the leader.
This number is the rank of the point to use in the list returned by CATIDftElementWithLeader::GetLeaderAnchorPoints().
Parameters:
oAnchorPoint
See also:
o GetAnchorSymbol
public virtual GetAnchorSymbol( oAncSymbol)
Read the anchor symbol style.
Parameters:
oAncSymbol
[out] The style of the anchor symbol. @see #AnchorSymbol
Returns:
S_OK
The anchor symbol style has been successfully read
E_UNEXPECTED
An unexpected error occured
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( oNbPoint)
Returns the number of points on the leader.
Parameters:
oNbPoint
Note : the anchor point is not counted.
o GetPoint
public virtual GetPoint( const iNoPoint,
oPoint)
Returns a point of the leader. Set iNoPoint to 0 to get the anchor point.
Parameters:
iNoPoint
The rank of the point.
oPoint
o GetPoints
public virtual GetPoints( oPoints)
Returns the list of points on the leader including the anchor point.
Parameters:
oPoints
The point list. X1,Y1,X2,Y2,.....Xn,Yn
o GetSubSet
public virtual GetSubSet( const iSubSet,
const iItfName,
oProperties)
Returns an interface to modify a subpart of the leader.
Parameters:
iSubSet
can be "Symbols","Lines"
iItfName
An ID on the interface to find.
oProperties
A pointer to the interface.
o GetSymbolType
public virtual GetSymbolType( oSymbolType)
Returns the ending symbol of the leader.
Parameters:
oSymbolType
o GetTarget
public virtual GetTarget( oTarget,
oInf= 0)
Returns the element targeted by the leader.
Parameters:
oTarget
The targeted element.
oInf
Not used yet
o ModifyPoint
public virtual ModifyPoint( const iNoPoint,
const iNewPoint)
Modifies a point on the leader. The anchor point (iNoPoint = 0) can't be modified
Parameters:
iNoPoint
The point to modify.
iNewPoint
The new 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( const iNoPoint= -1)
Removes a point on the leader.
Parameters:
iNoPoint
The point to delete. If iNoPoint is set to -1, all points will be deleted.
o RemoveTarget
public virtual RemoveTarget()
Remove the associativity to the element targeted by the leader.
o SetAllAround
public virtual SetAllAround( iAllAround= FALSE)
Deprecated:
V6R210 use
o SetAnchorPoint
public virtual SetAnchorPoint( const iAnchorPoint)
Sets the anchor point of the leader.
This number is the rank of the point to use in the list returned by CATIDftElementWithLeader::GetLeaderAnchorPoints().
Parameters:
iAnchorPoint
See also:
o SetAnchorSymbol
public virtual SetAnchorSymbol( iAncSymbol)
Set the anchor symbol style.
Parameters:
iAncSymbol
[in] The style of the anchor symbol. @see #AnchorSymbol
Returns:
S_OK
The anchor symbol style has been successfully set
E_INVALIDARG
This style is not supported
E_UNEXPECTED
An unexpected error occured
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( const iSymbolType)
Sets the ending symbol of the leader.
Parameters:
iSymbolType
o SetTarget
public virtual SetTarget( iTarget,
iPos,
const iInf= 0)
Sets the leader target.
Parameters:
iTarget
The targeted element.
iPos
The indication point.
iInf
Not used yet

Enumerated Types


o AnchorSymbol 
enum AnchorSymbol {
  NoSymb,
  AllAround,
  AllOver,
  AllAboutWithHorLine,
  AllAboutWithVerLine,
  AllAroundPartial,
  AllOverPartial,
  AllAboutWithHorLinePartial,
  AllAboutWithVerLinePartial,
  Flag,
  FlagAndAllAround
}
Anchor symbol style.
Parameters:
NoSymb
No anchor symbol
AllAround
All-Around style (circle)
AllOver
All-Over (2 concentric circles)
AllAboutWithHorLine
All-About (square with an horizontal line)
AllAboutWithVerLine
All-About (square with a vertical line)
AllAroundPartial
All-Around (half circle)
AllOverPartial
All-Over (2 half concentric circles)
AllAboutWithHorLinePartial
All-About (half square with an horizontal line)
AllAboutWithVerLinePartial
All-About (half square with a vertical line)
Flag
All-About (Flag)
FlagAndAllAround
All-About (Flag And AllAround)
This object is included in the file: CATIDftLeader.h
If needed, your Imakefile.mk should include the module: CATAnnotationUseItf

Copyright © 1999-2014, Dassault Systèmes. All rights reserved.