MTOGraphics3DMarker#

class ansys.stk.core.stkobjects.MTOGraphics3DMarker#

MTO 3D graphics marker options.

Overview#

set_marker_image_filename

Set the marker image file.

pixel_size

The pixel size of the marker (markers do not resize as the window size is changed). Dimensionless.

marker_type

Specify a 3D marker type to represent the object at the specified threshold. A member of the MarkerType enumeration.

angle

The angle representing the amount of rotation of the marker. Uses Angle Dimension.

x_origin

The horizontal point of origin for the marker (left, center or right).

y_origin

The vertical point of origin for the marker (top, center or bottom).

marker_data

The MarkerData property.

rotate_from_north

Opt whether to set the rotation angle relative to north. (By default, the rotation angle is relative to the screen.).

orientation_mode

Control the rotation of the marker.

Import detail#

from ansys.stk.core.stkobjects import MTOGraphics3DMarker

Property detail#

property MTOGraphics3DMarker.pixel_size: int#

The pixel size of the marker (markers do not resize as the window size is changed). Dimensionless.

property MTOGraphics3DMarker.marker_type: MarkerType#

Specify a 3D marker type to represent the object at the specified threshold. A member of the MarkerType enumeration.

property MTOGraphics3DMarker.angle: Any#

The angle representing the amount of rotation of the marker. Uses Angle Dimension.

property MTOGraphics3DMarker.x_origin: Graphics3DMarkerOriginType#

The horizontal point of origin for the marker (left, center or right).

property MTOGraphics3DMarker.y_origin: Graphics3DMarkerOriginType#

The vertical point of origin for the marker (top, center or bottom).

property MTOGraphics3DMarker.marker_data: IGraphics3DMarkerData#

The MarkerData property.

property MTOGraphics3DMarker.rotate_from_north: bool#

Opt whether to set the rotation angle relative to north. (By default, the rotation angle is relative to the screen.).

property MTOGraphics3DMarker.orientation_mode: Graphics3DMarkerOrientation#

Control the rotation of the marker.

Method detail#

MTOGraphics3DMarker.set_marker_image_filename(self, image_file: str) None#

Set the marker image file.

Parameters:

image_file : str

Returns:

None