pycatia.navigator_interfaces.marker_3D

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_3D.Marker3D(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
Marker3D

Represents a marker 3D.
add_object(i_object: AnyObject) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Sub AddObject(AnyObject iObject)

Adds a link to an object.

Parameters:

iObject
The object to be linked.

Example:

This example links ThisProduct to the NewMarker3D marker
3D.


NewMarker3D.AddObject(ThisProduct)
Parameters:

i_object (AnyObject) –

Return type:

None

count_object() → int

Note

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

Returns the number of objects which are linked to the marker
3D.

Example:

This example reads the number of objects in the marker3D
NewMarker3D.


Dim number As Integer
number = NewMarker3D.CountObject
Return type:

int

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 marker 3D’s filling status (1 the figure is filled, 0
the figure is not filled).

Example:

This example retrieves the filling status of NewMarker3D marker
3D.


Dim status As Integer
status = NewMarker3D.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 marker 3D’s framing status (1 the figure is framed, 0
the figure is not framed).

Example:

This example retrieves the framing status of NewMarker3D marker
3D.


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

int

get_object_positions(i_index: cat_variant, o_coordinates: tuple) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Sub GetObjectPositions(CATVariant iIndex,
CATSafeArrayVariant oCoordinates)

Retrieves the coordinates of the anchor point of the marker on the
object.

Parameters:

iIndex
The index of the object in the marker 3D. The index of the first
object is 1, and the index of the last object is CountObject.

oCoordinates
The coordinates of the anchor point

oCoordinates(0) is the X coordinate of the anchor
point
oCoordinates(1) is the Y coordinate of the anchor
point
oCoordinates(2) is the Z coordinate of the anchor point


Example:

This example retrieves the coordinates of the anchor in the
NewMarker3D marker 3D.


Dim Coordinates (3)
NewMarker3D.GetObjectPositions Coordinates
Parameters:

  • i_index (cat_variant) –

  • o_coordinates (tuple) –

Return type:

None

get_text_positions(o_coordinates: tuple) → None

Note

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

Retrieves the coordinates of the positions of a text marker 3D. The
bottom-left corner of the text is anchored to a given
point.

Returns:
The coordinates of the text anchor point

oCoordinates(0) is the X coordinate of the text anchor
point
oCoordinates(1) is the Y coordinate of the text anchor
point
oCoordinates(2) is the Z coordinate of the text anchor point


Example:

This example retrieves the coordinates of the text in the
NewMarker3D marker 3D.


Dim Coordinates (2)
NewMarker3D.GetTextPositions Coordinates
Parameters:

o_coordinates (tuple) –

Return type:

None

item_object(i_index: cat_variant) → AnyObject

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Func ItemObject(CATVariant iIndex) As CATBaseDispatch

Returns an object which is linked to the marker 3D using its
index.

Parameters:

iIndex
The index of the object in the marker 3D. The index of the first
object is 1, and the index of the last object is CountObject.


Returns:
The retrieved object
Example:

This example retrieves in ThisObject the ninth
object
from the NewMarker3D marker 3D.


Dim ThisObject As Marker3D
Set ThisObject = NewMarker3D.ItemObject(9)
Parameters:

i_index (cat_variant) –

Return type:

AnyObject

remove_object(i_index: cat_variant) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Sub RemoveObject(CATVariant iIndex)

Removes an object which is linked to the marker 3D using its
index.

Parameters:

iIndex
The index of the object in the marker 3D. The index of the first
object is 1, and the index of the last object is CountObject.


Example:

This example removes the ninth object
from the NewMarker3D marker 3D.


NewMarker3D.RemoveObject(9)
Parameters:

i_index (cat_variant) –

Return type:

None

set_object_positions(i_index: cat_variant, i_coordinates: tuple) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Sub SetObjectPositions(CATVariant iIndex,
CATSafeArrayVariant iCoordinates)

Sets the coordinates of the anchor point of the marker on the
object.

Parameters:

iIndex
The index of the object in the marker 3D. The index of the first
object is 1, and the index of the last object is CountObject.

iCoordinates
The coordinates of the anchor point

oCoordinates(0) is the X coordinate of the anchor
point
oCoordinates(1) is the Y coordinate of the anchor
point
oCoordinates(2) is the Z coordinate of the anchor point


Example:

This example sets the coordinates of the anchor in the NewMarker3D
marker 3D.


Dim Coordinates (3)
NewMarker3D.SetObjectPositions Coordinates
Parameters:

  • i_index (cat_variant) –

  • i_coordinates (tuple) –

Return type:

None

set_text_positions(i_coordinates: tuple) → None

Note

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

Sets the coordinates of the positions of a text marker 3D.

Parameters:

iCoordinates
The coordinates of the text anchor point

oCoordinates(0) is the X coordinate of the text anchor
point
oCoordinates(1) is the Y coordinate of the text anchor
point
oCoordinates(2) is the Z coordinate of the text anchor point


Example:

This example sets the coordinates of the text in the NewMarker3D
marker 3D.


Dim Coordinates (2)
NewMarker3D.SetTextPositions 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 marker 3D.

Example:

This example reads the text of NewMarker3D marker
3D.


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

str

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 marker 3D.

Example:

This example retrieves the text’s font of NewMarker3D marker
3D.


Dim font As String
font = NewMarker3D.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

Returns or sets the orientation of text.

Example:

This example retrieves the orientation of NewMarker3D marker
3D.


Dim orientation As CatMarkerTextOrientation
orientation = NewMarker3D.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 marker 3D.

Example:

This example retrieves the text’s size of NewMarker3D marker
3D.


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

float

property type: int

Note

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

Returns the type of the marker 3D.

Example:

This example reads the type of NewMarker3D marker
3D.

Dim type As CatMarker3DType
type = NewMarker3D.Type
Returns:

eum cat_marker_3d_type

Return type:

int

update() → None

Note

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

Updates the the marker 3D: that is to take into account all modifications
which occur since last update.

Example:

This example updates the NewMarker3D marker 3D.


NewMarker3D.Update
Return type:

None