Graphics3DMarker#

class ansys.stk.core.stkobjects.Graphics3DMarker#

Class defining the 3D marker to represent an object at a specified threshold.

Overview#

set_marker_image_filename

Set the marker image file.

pixel_size

The pixel size of the marker. Dimensionless.

visible

Display a marker in the 3D Graphics window at the object position for the object once a specified detail threshold has been crossed.

marker_type

Specify a 3D marker type to represent the object at the specified threshold. Setting the type with the enum eImageFile is invalid, use SetMarkerImageFile instead.

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.

orientation_mode

Control the rotation of the marker.

Import detail#

from ansys.stk.core.stkobjects import Graphics3DMarker

Property detail#

property Graphics3DMarker.pixel_size: int#

The pixel size of the marker. Dimensionless.

property Graphics3DMarker.visible: bool#

Display a marker in the 3D Graphics window at the object position for the object once a specified detail threshold has been crossed.

property Graphics3DMarker.marker_type: MarkerType#

Specify a 3D marker type to represent the object at the specified threshold. Setting the type with the enum eImageFile is invalid, use SetMarkerImageFile instead.

property Graphics3DMarker.angle: Any#

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

property Graphics3DMarker.x_origin: Graphics3DMarkerOriginType#

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

property Graphics3DMarker.y_origin: Graphics3DMarkerOriginType#

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

property Graphics3DMarker.marker_data: IGraphics3DMarkerData#

The MarkerData property.

property Graphics3DMarker.orientation_mode: Graphics3DMarkerOrientation#

Control the rotation of the marker.

Method detail#

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

Set the marker image file.

Parameters:

image_file : str

Returns:

None