pycatia.drafting_interfaces.drawing_leader

Module initially auto generated using V5Automation files from CATIA V5 R28 on 2020-06-11 12:40:47.360445

Warning

The notes denoted “CAA V5 Visual Basic Help” are to be used as reference only. They are there as a guide as to how the visual basic / catscript functions work and thus help debugging in pycatia.

class pycatia.drafting_interfaces.drawing_leader.DrawingLeader(com_object)

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

System.IUnknown
System.IDispatch
System.CATBaseUnknown
System.CATBaseDispatch
System.AnyObject
DrawingLeader

Represents a drawing leader in a drawing view.
add_interruption(i_first_point_x: float, i_first_point_y: float, i_second_point_x: float, i_second_point_y: float) → None

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))
o Sub AddInterruption(double iFirstPointX,
double iFirstPointY,
double iSecondPointX,
double iSecondPointY)

Add an interruption to an leader.

Parameters:

iFirstPointX
X coordinates of first point.
iFirstPointY
Y coordinates of first point.
iSecondPointX
X coordinates of second point.
iSecondPointY
Y coordinates of second point.
Example:
This example adds an interruption to MyLeader.

iFirstPointX = 10.
iFirstPointY = 20.
iSecondPointX = 20.
iSecondPointY = 20.
MyLeader.AddInterruption iFirstPointX, iFirstPointY,
iSecondPointX, iSecondPointY
Parameters:

  • i_first_point_x (float) –

  • i_first_point_y (float) –

  • i_second_point_x (float) –

  • i_second_point_y (float) –

Return type:

None

add_point(i_num: int, i_x: float, i_y: float) → None

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))
o Sub AddPoint(long iNum,
double iX,
double iY)

Add a point to an leader.

Parameters:

iNum
Point number. Point will be inserted at iNum+1 position.

iX
X coordinates of point to add.
iY
Y coordinates of point to add.
Example:
This example adds a point to MyLeader.

iNum = 1
iX = 10.
iY = 20.
MyLeader.AddPoint iNum, iX, iY
Parameters:

  • i_num (int) –

  • i_x (float) –

  • i_y (float) –

Return type:

None

property all_around: bool

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)
o Property AllAround() As boolean

Returns or sets the status of all around.

Example:
This example retrieves the status of all around on MyLeader drawing
leader.

oSymbol = MyLeader.AllAround
Return type:

bool

property anchor_point: int

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)
o Property AnchorPoint() As long

Returns or sets anchor point.

Example:
This example retrieves the anchor point on MyLeader drawing
leader.

oAnchorPoint = MyLeader.AnchorPoint
Return type:

int

get_interruptions(o_interruptions: tuple) → int

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))
o Func GetInterruptions(CATSafeArrayVariant oInterruptions) As
long

Get leader path.

Parameters:

oInterruptions
List of interruptions coordinates (X1,Y1,X2,Y2,…..Xn,Yn).


Returns:
oNbInterruptions Number of interruptions.
Example:
This example gets interruptions of MyLeader path.

oNbInterruptions = MyLeader.GetInterruptions(oInterruptions)
Parameters:

o_interruptions (tuple) –

Return type:

int

get_point(i_num: int, o_x: float, o_y: float) → None

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))
o Sub GetPoint(long iNum,
double oX,
double oY)

Get leader point coordinates.

Parameters:

iNum
Point number.
oX
X coordinates of point.
oY
Y coordinates of point.
Example:
This example gets a point to MyLeader.

iNum = 1
MyLeader.GetPoint(iNum, oX, oY)
Parameters:

  • i_num (int) –

  • o_x (float) –

  • o_y (float) –

Return type:

None

get_points(o_points: tuple) → int

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))
o Func GetPoints(CATSafeArrayVariant oPoints) As long

Get leader path.

Parameters:

oPoints
List of points coordinates (X1,Y1,X2,Y2,…..Xn,Yn).


Returns:
oNbPoints Number of points.
Example:
This example gets points of MyLeader path.

oNbPoints = MyLeader.GetPoints(oPoints)
Parameters:

o_points (tuple) –

Return type:

int

property head_symbol: int

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)
o Property HeadSymbol() As CatSymbolType

Returns or sets symbol type of head side.

Example:
This example retrieves the symbol type of head side on MyLeader drawing
leader.

oSymbol = MyLeader.HeadSymbol
Return type:

int

property head_target: AnyObject

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)
o Property HeadTarget() As CATBaseDispatch

Returns or sets target element of head side.

Example:
This example retrieves the target element of head side on MyLeader
drawing leader.

oTarget = MyLeader.HeadTarget
Return type:

AnyObject

property leaders: DrawingLeaders

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)
o Property Leaders() As DrawingLeaders (Read Only)

Returns the secondary drawing leader collection of the drawing
leader.

Example:
This example retrieves in LeaderCollection the collection of leaders of
the Myleader drawing leader.

Dim LeaderCollection As DrawingLeaders
Set LeaderCollection = MyLeader.Leaders
Return type:

DrawingLeaders

modify_point(i_num: int, i_x: float, i_y: float) → None

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))
o Sub ModifyPoint(long iNum,
double iX,
double iY)

Modify a point of an leader.

Parameters:

iNum
Point number to modify.
iX
X coordinates of new point.
iY
Y coordinates of new point.
Example:
This example modifies a point to MyLeader.

iNum = 1
iX = -10.
iY = -20.
MyLeader.ModifyPoint iNum, iX, iY
Parameters:

  • i_num (int) –

  • i_x (float) –

  • i_y (float) –

Return type:

None

property nb_interruption: int

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)
o Property NbInterruption() As long (Read Only)

Returns the number of interruptions of leader path.

Example:
This example retrieves the number of interruptions on MyLeader drawing
leader.

oNbInterruption = MyLeader.NbInterruption
Return type:

int

property nb_point: int

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)
o Property NbPoint() As long (Read Only)

Returns the number of points of leader path.

Example:
This example retrieves the number of points on MyLeader drawing
leader.

oNbPoint = MyLeader.NbPoint
Return type:

int

remove_interruption(i_num: int) → None

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))
o Sub RemoveInterruption(long iNum)

Remove an interruption to an leader.

Parameters:

iNum
Interruption number to delete.
- If iNum equals to 0, all interruptions will be removed.

Example:
This example removes an interruption from
MyLeader.

iNum = 2
MyLeader.RemoveInterruption iNum
Parameters:

i_num (int) –

Return type:

None

remove_point(i_num: int) → None

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))
o Sub RemovePoint(long iNum)

Remove a point from an leader.

Parameters:

iNum
Point number to delete.
Example:
This example removes a point from MyLeader.

iNum = 2
MyLeader.RemovePoint iNum
Parameters:

i_num (int) –

Return type:

None