VehicleGraphics3DControlBox#

class ansys.stk.core.stkobjects.VehicleGraphics3DControlBox#

Define a volume around the object that moves with the object.

Overview#

Properties

`use_translucency`	Specify a translucency of the object.
`translucency`	Get or set the translucency of the object. Valid values are 0 - 100, where 0 is opaque and 100 is transparent. Dimensionless.
`reference_frame`	Get or set the reference axes that is used to align the ellipsoid.
`x_axis_length`	Indicate how far along the velocity vector the box extends. Uses Distance Dimension.
`y_axis_length`	Indicate how far along the orbit normal the box extends. Uses Distance Dimension.
`z_axis_length`	Indicate how far along the orbit plane the box extends. Uses Distance Dimension.
`x_offset`	Get or set the distance to offset the box (forward or backward) along the velocity vector. A positive value moves the box forward along the velocity vector. Uses Distance Dimension.
`y_offset`	Get or set the distance to offset the box (left or right) along the velocity vector. A positive value moves the box right along the vector 90 degrees clockwise from the velocity vector. Uses Distance Dimension.
`z_offset`	Get or set the distance to offset the box (up or down). A positive value moves the box down, towards the ground. Uses Distance Dimension.

from ansys.stk.core.stkobjects import VehicleGraphics3DControlBox

property VehicleGraphics3DControlBox.use_translucency: bool#: Specify a translucency of the object.

property VehicleGraphics3DControlBox.translucency: float#: Get or set the translucency of the object. Valid values are 0 - 100, where 0 is opaque and 100 is transparent. Dimensionless.

property VehicleGraphics3DControlBox.reference_frame: IVectorGeometryToolAxes#: Get or set the reference axes that is used to align the ellipsoid.

property VehicleGraphics3DControlBox.x_axis_length: float#: Indicate how far along the velocity vector the box extends. Uses Distance Dimension.

property VehicleGraphics3DControlBox.y_axis_length: float#: Indicate how far along the orbit normal the box extends. Uses Distance Dimension.

property VehicleGraphics3DControlBox.z_axis_length: float#: Indicate how far along the orbit plane the box extends. Uses Distance Dimension.

property VehicleGraphics3DControlBox.x_offset: float#: Get or set the distance to offset the box (forward or backward) along the velocity vector. A positive value moves the box forward along the velocity vector. Uses Distance Dimension.

property VehicleGraphics3DControlBox.y_offset: float#: Get or set the distance to offset the box (left or right) along the velocity vector. A positive value moves the box right along the vector 90 degrees clockwise from the velocity vector. Uses Distance Dimension.

property VehicleGraphics3DControlBox.z_offset: float#: Get or set the distance to offset the box (up or down). A positive value moves the box down, towards the ground. Uses Distance Dimension.