pycatia.drafting_interfaces.drawing_welding¶
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_welding.DrawingWelding(com_object)¶
Note
CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)
System.IUnknownSystem.IDispatchSystem.CATBaseUnknownSystem.CATBaseDispatchSystem.AnyObjectDrawingWeldingRepresents a drawing welding in a drawing view.- property angle: float¶
Note
- CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)
- o Property Angle() As doubleReturns or sets the angle of the drawing text. The angle is measuredbetween the axis system of the drawing view and the local axis system of thedrawing text. The angle is measured in radians and is countedcounterclockwise.Example:This example sets the angle of the MyText drawing Text to 90 degreesclockwise. You first need to compute the angle in degrees and set the minussign to indicate the rotation is clockwise.Angle90Clockwise = -90MyText.Angle = Angle90Clockwise
- Return type:
float
- get_additional_symbol(i_weld: int) int ¶
Note
- CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))
- o Func GetAdditionalSymbol(CatWelding iWeld) AsCatWeldAdditionalSymbolReturns the additional symbol of the drawing welding.Parameters:iWeldThe xxxExample:This example sets an concave additinal symbol on the MyWeldingdrawing weldingMyWelding.Symbol = DftConcaveSymbol
- Parameters:
i_weld (int) –
- Returns:
enum cat_welding
- Return type:
int
- get_finish_symbol(i_weld: int) int ¶
Note
- CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))
- o Func GetFinishSymbol(CatWelding iWeld) AsCatDftWeldFinishSymbolReturns the finish symbol of the drawing welding.Parameters:iWeldThe field on which finish symbol is applied.Example:This example returns the finish symbol on the first symbol ofthe MyWelding drawing weldingMyWelding.GetFinishSymbol(catWeldingFieldOne,oFinishSymbol)
- Parameters:
i_weld (int) – enum cat_welding
- Returns:
enum cat_dft_weld_finish_symbol
- Return type:
int
- get_symbol(i_weld: int) int ¶
Note
- CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))
- o Func GetSymbol(CatWelding iWeld) As CatWeldingSymbolReturns the symbol of the drawing welding.Parameters:iWeldThe field on which the symbol is appliedoSymbolThe welding symbolExample:This example gets the symbol on the first field of theMyWelding drawing weldingMyWelding.GetSymbol(catWeldingFieldOne,oSymbol)
- Parameters:
i_weld (int) – enum cat_welding
- Returns:
enum cat_welding_symbol
- Return type:
int
- get_text_range(i_field: int) DrawingTextRange ¶
Note
- CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))
- o Func GetTextRange(CatWeldingField iField) AsDrawingTextRangeReturns the field of the drawing welding in a drawing textrange.Parameters:iFieldThe drawing welding fieldReturns:The drawing text range that corresponds to the drawing welding fieldExample:This example retrieves the xxx.Dim textRange As DrawingTextRangeSet textRange = MyWelding.GetTextRange (catWeldingUp)
- Parameters:
i_field (int) – enum cat_welding_field
- Return type:
- property identification_line_side: int¶
Note
- CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)
- o Property IdentificationLineSide() As CatWeldingSideReturns or sets the welding identification line Side of the drawing weldingsymbol.Precondition: This property is only available for ISOstandard.Example:This example sets welding identification line Side to Up.MyWeld.IdentificationLineSide = catWeldingUp
- Returns:
enum cat_welding_side
- Return type:
int
- 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 drawing leader collection of the drawingwelding.Example:This example retrieves in LeaderCollection the collection of leaders ofthe MyWelding drawing welding.Dim LeaderCollection As DrawingLeadersSet LeaderCollection = MyWelding.Leaders
- Return type:
- set_additional_symbol(i_symbol: int, i_weld: int) None ¶
Note
- CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))
- o Sub SetAdditionalSymbol(CatWeldAdditionalSymbol iSymbol,CatWelding iweld)Sets the additional symbol of the drawing welding.Parameters:iSymbolThe welding additional symboliWeldThe xxxExample:This example sets an concave additinal symbol on the MyWeldingdrawing weldingMyWelding.Symbol = DftConcaveSymbol
- Parameters:
i_symbol (int) – enum cat_weld_additional_symbol
i_weld (int) – enum cat_welding
- Return type:
None
- set_finish_symbol(i_finish_symbol: int, i_weld: int) None ¶
Note
- CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))
- o Sub SetFinishSymbol(CatDftWeldFinishSymbol iFinishSymbol,CatWelding iWeld)Sets the finish symbol of the drawing welding.Parameters:iFinishSymbolThe finish welding symboliWeldThe field on which finish symbol will be applied.Example:This example sets the finish symbol on the first symbol of theMyWelding drawing weldingMyWelding.GetFinishSymbol(catWeldingFieldOne,catDftLetterCWelding)
- Parameters:
i_finish_symbol (int) – enum cat_dft_weld_finish_symbol
i_weld (int) – enum cat_welding
- Return type:
None
- set_symbol(i_symbol: int, i_weld: int) None ¶
Note
- CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))
- o Sub SetSymbol(CatWeldingSymbol iSymbol,CatWelding iweld)Sets the symbol of the drawing welding.Parameters:iSymbolThe welding symboliWeldThe field on which the symbol is appliedExample:This example sets a symbol on the first field of the MyWeldingdrawing weldingMyWelding.SetSymbol(catSquareWelding,catWeldingFieldOne)
- Parameters:
i_symbol (int) – enum cat_welding_symbol
i_weld (int) – enum cat_welding
- Return type:
None
- property text_properties: DrawingTextProperties¶
Note
- CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)
- o Property TextProperties() As DrawingTextProperties (ReadOnly)Returns the text properties of the drawing welding.Example:This example retrieves in TextProperties the text properties of theMyWelding drawing welding..Dim TextProperties As DrawingTextPropertiesSet TextProperties = MyWelding.TextProperties
- Return type:
- property welding_side: int¶
Note
- CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)
- o Property WeldingSide() As CatWeldingSideReturns or sets the welding side of the drawing weldingsymbol.Example:This example sets welding side to Up .MyWeld.WeldingSide = catWeldingUp
- Returns:
enum cat_welding_side
- Return type:
int
- property welding_tail: int¶
Note
- CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)
- o Property WeldingTail() As CatDftWeldingTailReturns or sets the welding tail of the drawing weldingsymbol.Example:This example displays the welding symbol tail.MyWeld.WeldingTail = catDftWeldingTailYES
- Returns:
enum cat_dft_welding_tail
- Return type:
int
- property x: float¶
Note
- CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)
- o Property x() As doubleReturns or sets the x coordinate of the drawing welding. It is expressedwith respect to the current view coordinate system. This coordinate, like anylength, is measured in millimeters.Example:This example retrieves in X the x coordinate of the MyWelding drawingwelding.X = MyWelding.x
- Return type:
float
- property y: float¶
Note
- CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)
- o Property y() As doubleReturns or sets the y coordinate of the drawing welding. It is expressedwith respect to the current view coordinate system. This coordinate, like anylength, is measured in millimeters.Example:This example sets the y coordinate of the MyWelding drawing welding to5 inches. You need first to convert the 5 inches intomillmeters.NewYCoordinate = 5*25.4/1000MyWelding.y = NewYCoordinate
- Return type:
float