VehicleGraphics3DBearingBox#

class ansys.stk.core.stkobjects.VehicleGraphics3DBearingBox#

Bases: IVehicleGraphics3DProximityAreaObject

Define a volume, relative to a bearing from the North, around an object.

Overview#

bearing

Get or set the bearing value, relative to North. Uses Angle Dimension.

length

Indicate the length of the box, along the bearing. The value must be greater than 0. Uses Distance Dimension.

width

Indicate the width of the box, across the bearing. The value must be greater than 0. Uses Distance Dimension.

height

Indicate the Height of the box. Uses Distance Dimension.

length_offset

Get or set the distance to offset the box (forward or backward) along the bearing. A positive LengthOffset value moves the box forward. Uses Distance Dimension.

width_offset

Get or set the distance to offset the box (left or right) along the bearing. A positive value moves the box to the right. Uses Distance Dimension.

height_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.

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.

Import detail#

from ansys.stk.core.stkobjects import VehicleGraphics3DBearingBox

Property detail#

property VehicleGraphics3DBearingBox.bearing: float#

Get or set the bearing value, relative to North. Uses Angle Dimension.

property VehicleGraphics3DBearingBox.length: float#

Indicate the length of the box, along the bearing. The value must be greater than 0. Uses Distance Dimension.

property VehicleGraphics3DBearingBox.width: float#

Indicate the width of the box, across the bearing. The value must be greater than 0. Uses Distance Dimension.

property VehicleGraphics3DBearingBox.height: float#

Indicate the Height of the box. Uses Distance Dimension.

property VehicleGraphics3DBearingBox.length_offset: float#

Get or set the distance to offset the box (forward or backward) along the bearing. A positive LengthOffset value moves the box forward. Uses Distance Dimension.

property VehicleGraphics3DBearingBox.width_offset: float#

Get or set the distance to offset the box (left or right) along the bearing. A positive value moves the box to the right. Uses Distance Dimension.

property VehicleGraphics3DBearingBox.height_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.

property VehicleGraphics3DBearingBox.use_translucency: bool#

Specify a translucency of the object.

property VehicleGraphics3DBearingBox.translucency: float#

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