pycatia.drafting_interfaces.drawing_dim_line

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_dim_line.DrawingDimLine(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
DrawingDimLine

Manages dimension line of a dimension in drawing view.

This interface is obtained from DrawingDimension.GetDimLine
method.
property color: int

Note

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

Returns or sets color of dimension line.

Example:
This example retrieves color of dimension line MyDimLine drawing
dimension.

oColorDimLine = MyDimLine.Color
Return type:

int

property dim_line_graph_rep: int

Note

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

Returns or graphic representation of dimension line.

Example:
This example retrieves graphic representation of dimension line
MyDimLine drawing dimension.

odimLineGraphRep = MyDimLine.DimLineGraphRep
Returns:

enum cat_dim_line_graph_rep

Return type:

int

property dim_line_orientation: int

Note

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

Returns or orientation of dimension line.

Example:
This example retrieves orientation of dimension line MyDimLine drawing
dimension.

odimLineOrient = MyDimLine.DimLineOrientation
Returns:

enum cat_dim_orientation

Return type:

int

property dim_line_reference

Note

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

Returns or reference of dimension line.

Example:
This example retrieves reference of dimension line MyDimLine drawing
dimension.

odimLineRef = MyDimLine.DimLineReference
Returns:

enum cat_dim_reference

Return type:

int

property dim_line_rep: int

Note

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

Returns or representation of dimension line.

Example:
This example retrieves representation of dimension line MyDimLine
drawing dimension.

odimLineRep = MyDimLine.DimLineRep
Returns:

enum cat_dim_line_rep

Return type:

int

property dim_line_type: int

Note

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

Returns type of dimension line.

Example:
This example retrieves type of dimension line MyDimLine drawing
dimension.

odimLineType = MyDimLine.DimLineType
Return type:

int

get_dim_line_dir(o_dir_x: float, o_dir_y: float) → None

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))
o Sub GetDimLineDir(double oDirX,
double oDirY)

Returns direction of a dimension line in case of a catDimUserDefined
representation mode. To retrieve the representation mode:
DrawingDimLine.get_DimLineRep.

Parameters:

oDirX,oDirY
The components of the direction vector
Example:
This example retrieves the direction vector of a dimension line
MyDimLine drawing dimension.

MyDimLine.GetDimLineDir oDirX, oDirY
Parameters:

  • o_dir_x (float) –

  • o_dir_y (float) –

Return type:

None

get_geom_info(o_geom_infos: tuple) → None

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))
o Sub GetGeomInfo(CATSafeArrayVariant oGeomInfos)

Get geometrical information of dimension line.

Parameters:

oGeomInfos
geometrical information.
Example:
This example gets geometrical information of MyDimLine
path.

MyDimLine.GetGeomInfo(oGeomInfos)
Parameters:

o_geom_infos (tuple) –

Return type:

None

get_symb_color(index: int) → int

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))
o Func GetSymbColor(long Index) As long

Get symbol color of dimension line.

Parameters:

Index
1:first symbol 2:second symbol 3:leader symbol
oColorSymb
symbol color.
Example:
This example gets symbol color of MyDimLine path.

ColorSymb = MyDimLine.GetSymbColor(Index)
Parameters:

index (int) –

Return type:

int

get_symb_thickness(index: int) → float

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))
o Func GetSymbThickness(long Index) As double

Get symbol thickness of dimension line.

Parameters:

Index
1:first symbol 2:second symbol 3:leader symbol
oThickSymb
symbol thickness.
Example:
This example gets symbol thickness of MyDimLine
path.

ThickSymb = MyDimLine.GetSymbThickness(Index)
Parameters:

index (int) –

Return type:

float

get_symb_type(index: int) → int

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))
o Func GetSymbType(long Index) As CatDimSymbols

Get symbol type of dimension line.

Parameters:

Index
1:first symbol 2:second symbol 3:leader symbol
oTypeSymb
symbol type.
Example:
This example gets symbol type of MyDimLine path.

typeSymb = MyDimLine.GetSymbType(Index)
Parameters:

index (int) –

Returns:

enum cat_dim_symbols

Return type:

int

set_symb_color(index: int, i_color_symb: int) → None

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))
o Sub SetSymbColor(long Index,
long iColorSymb)

Set symbol color of dimension line.

Parameters:

Index
1:first symbol 2:second symbol 3:leader symbol
oColorSymb
symbol color.
Example:
This example sets symbol color of MyDimLine path.

MyDimLine.SetSymbColor(Index, iColorSymb)
Parameters:

  • index (int) –

  • i_color_symb (int) –

Return type:

None

set_symb_thickness(index: int, i_thick_symb: float) → None

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))
o Sub SetSymbThickness(long Index,
double iThickSymb)

Set symbol thickness of dimension line.

Parameters:

Index
1:first symbol 2:second symbol 3:leader symbol
oThickSymb
symbol thickness.
Example:
This example sets symbol thickness of MyDimLine
path.

MyDimLine.GetSymbThickness(Index, iThickSymb)
Parameters:

  • index (int) –

  • i_thick_symb (float) –

Return type:

None

set_symb_type(index: int, i_symb_type: int) → None

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))
o Sub SetSymbType(long Index,
CatDimSymbols iSymbType)

Set symbol type of dimension line.

Parameters:

Index
1:first symbol 2:second symbol 3:leader symbol
iSymbType
symbol type.
Example:
This example sets symbol type of MyDimLine path.

MyDimLine.SetSymbType(Index, iSymbType)
Parameters:

  • index (int) –

  • i_symb_type (int) – enum cat_dim_symbols

Return type:

None

property thickness: float

Note

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

Returns or sets thickness of dimension line.

Example:
This example retrieves thickness of dimension line MyDimLine drawing
dimension.

oThickDimLine = MyDimLine.Thickness
Return type:

float