pycatia.drafting_interfaces.drawing_arrow¶
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_arrow.DrawingArrow(com_object)¶
Note
CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)
System.IUnknownSystem.IDispatchSystem.CATBaseUnknownSystem.CATBaseDispatchSystem.AnyObjectDrawingArrowRepresents a drawing arrow 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 arrow.Parameters:iFirstPointXX coordinates of first point.iFirstPointYY coordinates of first point.iSecondPointXX coordinates of second point.iSecondPointYY coordinates of second point.Example:This example adds an interruption to MyArrow.iFirstPointX = 10.iFirstPointY = 20.iSecondPointX = 20.iSecondPointY = 20.MyArrow.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 arrow.Parameters:iNumPoint number. Point will be inserted at iNum+1 position.iXX coordinates of point to add.iYY coordinates of point to add.Example:This example adds a point to MyArrow.iNum = 1iX = 10.iY = 20.MyArrow.AddPoint iNum, iX, iY
- Parameters:
i_num (int) –
i_x (float) –
i_y (float) –
- Return type:
None
- get_interruptions(o_interruptions: tuple) int ¶
Note
- CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))
- o Func GetInterruptions(CATSafeArrayVariant oInterruptions) AslongGet arrow path.Parameters:oInterruptionsList of interruptions coordinates (X1,Y1,X2,Y2,…..Xn,Yn).Returns:oNbInterruptions Number of interruptions.Example:This example gets interruptions of MyArrow path.oNbInterruptions = MyArrow.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 arrow point coordinates.Parameters:iNumPoint number.oXX coordinates of point.oYY coordinates of point.Example:This example gets a point to MyArrow.iNum = 1MyArrow.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 longGet arrow path.Parameters:oPointsList of points coordinates (X1,Y1,X2,Y2,…..Xn,Yn).Returns:oNbPoints Number of points.Example:This example gets points of MyArrow path.oNbPoints = MyArrow.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 CatSymbolTypeReturns or sets symbol type of head side.Example:This example retrieves the symbol type of head side on MyArrow drawingarrow.oSymbol = MyArrow.HeadSymbol
- Returns:
enum cat_symbol_type
- Return type:
int
- property head_target: AnyObject¶
Note
- CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)
- o Property HeadTarget() As CATBaseDispatchReturns or sets target element of head side.Example:This example retrieves the target element of head side on MyArrowdrawing arrow.oTarget = MyArrow.HeadTarget
- Return type:
- 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 Arrow.Parameters:iNumPoint number to modify.iXX coordinates of new point.iYY coordinates of new point.Example:This example modifies a point to MyArrow.iNum = 1iX = -10.iY = -20.MyArrow.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 arrow path.Example:This example retrieves the number of interruptions on MyArrow drawingarrow.oNbInterruption = MyArrow.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 arrow path.Example:This example retrieves the number of points on MyArrow drawingarrow.oNbPoint = MyArrow.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 arrow.Parameters:iNumInterruption number to delete.- If iNum equals to 0, all interruptions will be removed.Example:This example removes an interruption from MyArrow.iNum = 2MyArrow.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 arrow.Parameters:iNumPoint number to delete.Example:This example removes a point from MyArrow.iNum = 2MyArrow.RemovePoint iNum
- Parameters:
i_num (int) –
- Return type:
None
- property tail_symbol: int¶
Note
- CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)
- o Property TailSymbol() As CatSymbolTypeReturns or sets symbol type of tail side.Example:This example retrieves the symbol type of tail side on MyArrow drawingarrow.oSymbol = MyArrow.TailSymbol
- Return type:
int
- property tail_target: AnyObject¶
Note
- CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)
- o Property TailTarget() As CATBaseDispatchReturns or sets target element of tail side.Example:This example retrieves the target element of tail side on MyArrowdrawing arrow.oTarget = MyArrow.TailTarget
- Return type: