pycatia.navigator_interfaces.marker_2D

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.navigator_interfaces.marker_2D.Marker2D(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
Marker2D

Represents a marker 2D in a specified annotated view.
property fill: int

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)
o Property Fill() As long

Returns or sets the Marker2D’s filling status (1 the figure is filled, 0
the figure is not filled).

Example:

This example retrieves the filling status of the NewMarker2D
Marker2D.


Dim status As Integer
status = NewMarker2D.Fill
Return type:

int

property frame: int

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)
o Property Frame() As long

Returns or sets the Marker2D’s framing status (1 the figure is framed, 0
the figure is not framed).

Example:

This example retrieves the framing status of the NewMarker2D
Marker2D.


Dim status As Integer
status = NewMarker2D.Frame
Return type:

int

get_positions(o_coordinates: tuple) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Sub GetPositions(CATSafeArrayVariant oCoordinates)

Retrieves the coordinates of the positions of the
Marker2D.

These positions depend on the type of the Marker2D :

Line: 2 positions.
Arrow: 2 positions, the first being the head and the second being the
tail.
Rectangle: 2 positions, the first being the bottom-left corner and the
second being the top-right corner.
Circle: 2 positions, the first being the center and the second being a
point on the circle.
FreeHand: as many positions as points.
Text: 1 position, the bottom-left corner.
Picture: 2 positions, the first being the bottom-left corner and the
second being the top-right corner.

Parameters:

oCoordinates
The coordinates of the positions expressed as an array of variants
are:

oCoordinates(0) is the X coordinate of the first
point
oCoordinates(1) is the Y coordinate of the first
point
oCoordinates(2) is the X coordinate of the second
point
oCoordinates(3) is the Y coordinate of the second
point
oCoordinates(n*2-2) is the X coordinate of the n-th
point
oCoordinates(n*2-1) is the Y coordinate of the n-th point


Example:

This example retrieves the coordinates of the positions of the
NewMarker2D Marker2D.


Dim Coordinates (3)
NewMarker2D.GetPositions Coordinates
Parameters:

o_coordinates (tuple) –

Return type:

None

property picture: str

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)
o Property Picture() As CATBSTR

Returns or sets the path to a picture file for a picture
Marker2D.

Example:

This example retrieves the path to a picture file of the
NewMarker2D Marker2D.


Dim path As String
path = NewMarker2D.Picture
Return type:

str

set_positions(i_coordinates: tuple) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Sub SetPositions(CATSafeArrayVariant iCoordinates)

Sets the coordinates of the positions of the Marker2D.

These positions depend on the type of the Marker2D :

Line: 2 positions.
Arrow: 2 positions, the first being the head and the second being the
tail.
Rectangle: 2 positions, the first being the bottom-left corner and the
second being the top-right corner.
Circle: 2 positions, the first being the center and the second being a
point on the circle.
FreeHand: as many positions as points.
Text: 1 position, the bottom-left corner.
Picture: 2 positions, the first being the bottom-left corner and the
second being the top-right corner.

Parameters:

iCoordinates
The coordinates of the positions expressed as an array of variants
are:

iCoordinates(0) is the X coordinate of the first
point
iCoordinates(1) is the Y coordinate of the first
point
iCoordinates(2) is the X coordinate of the second
point
iCoordinates(3) is the Y coordinate of the second
point
oCoordinates(n*2-2) is the X coordinate of the n-th
point
oCoordinates(n*2-1) is the Y coordinate of the n-th point


Example:

This example sets the coordinates of the positions of the
NewMarker2D Marker2D.


Dim Coordinates (3) ‘To be valuated
NewMarker2D.SetPositions Coordinates
Parameters:

i_coordinates (tuple) –

Return type:

None

property text: str

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)
o Property Text() As CATBSTR

Returns or sets the text for a text Marker2D.

Example:

This example retrieves the text of the NewMarker2D
Marker2D.


Dim text As String
text = NewMarker2D.Text
Return type:

str

property text_angle: float

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)
o Property TextAngle() As double

Returns or sets the text’s angle for a text Marker2D.

Example:

This example retrieves the text’s angle of the NewMarker2D
Marker2D.


Dim angle As Double
size = NewMarker2D.TextAngle
Return type:

float

property text_font: str

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)
o Property TextFont() As CATBSTR

Returns or sets the text’s font for a text Marker2D.

Example:

This example retrieves the text’s font of the NewMarker2D
Marker2D.


Dim font As String
font = NewMarker2D.TextFont
Return type:

str

property text_orientation: int

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)
o Property TextOrientation() As CatMarkerTextOrientation

Return or set the orientation of text.

Example:

This example retrieves the orientation of the NewMarker2D
Marker2D.


Dim orientation As CatMarkerTextOrientation
orientation = NewMarker2D.TextOrientation
Returns:

enum cat_marker_text_orientation

Return type:

int

property text_size: float

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)
o Property TextSize() As double

Returns or sets the text’s size for a text Marker2D.

Example:

This example retrieves the text’s size of the NewMarker2D
Marker2D.


Dim size As Double
size = NewMarker2D.TextSize
Return type:

float

property type: int

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)
o Property Type() As CatMarker2DType (Read Only)

Returns the type of the marker 2D.

Example:

This example retrieves the type of the NewMarker2D
Marker2D.


Dim type As CatMarker2DType
type = NewMarker2D.Type
Returns:

enum cat_marker_2d_type

Return type:

int