Graphics3DOffsetLabel#

class ansys.stk.core.stkobjects.Graphics3DOffsetLabel#

Class defining the offset of the position of an object label in the 3D Graphics window.

Overview#

enable

Offset the position of an object label in the 3D Graphics window.

x

X value of the offset, where positive and negative values move the label to the right and left, respectively. Dimension depends on context.

y

The Y value of the offset, where positive and negative values move the label up and down, respectively. Dimension depends on context.

z

The Z value of the offset, used only when the offset frame is Cartesian, where positive and negative values move the label out of and into the screen, respectively. Uses SmallDistanceUnit Dimension.

offset_frame

The frame used in computing the offset. A member of the OffsetFrameType enumeration.

Import detail#

from ansys.stk.core.stkobjects import Graphics3DOffsetLabel

Property detail#

property Graphics3DOffsetLabel.enable: bool#

Offset the position of an object label in the 3D Graphics window.

property Graphics3DOffsetLabel.x: float#

X value of the offset, where positive and negative values move the label to the right and left, respectively. Dimension depends on context.

property Graphics3DOffsetLabel.y: float#

The Y value of the offset, where positive and negative values move the label up and down, respectively. Dimension depends on context.

property Graphics3DOffsetLabel.z: float#

The Z value of the offset, used only when the offset frame is Cartesian, where positive and negative values move the label out of and into the screen, respectively. Uses SmallDistanceUnit Dimension.

property Graphics3DOffsetLabel.offset_frame: OffsetFrameType#

The frame used in computing the offset. A member of the OffsetFrameType enumeration.