VehicleGraphics3DBearingBox
===========================

.. py:class:: ansys.stk.core.stkobjects.VehicleGraphics3DBearingBox

   Bases: :py:class:`~ansys.stk.core.stkobjects.IVehicleGraphics3DProximityAreaObject`

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

.. py:currentmodule:: VehicleGraphics3DBearingBox

Overview
--------

.. tab-set::

    .. tab-item:: Properties

        .. list-table::
            :header-rows: 0
            :widths: auto

            * - :py:attr:`~ansys.stk.core.stkobjects.VehicleGraphics3DBearingBox.bearing`
              - Get or set the bearing value, relative to North. Uses Angle Dimension.
            * - :py:attr:`~ansys.stk.core.stkobjects.VehicleGraphics3DBearingBox.length`
              - Indicate the length of the box, along the bearing. The value must be greater than 0. Uses Distance Dimension.
            * - :py:attr:`~ansys.stk.core.stkobjects.VehicleGraphics3DBearingBox.width`
              - Indicate the width of the box, across the bearing. The value must be greater than 0. Uses Distance Dimension.
            * - :py:attr:`~ansys.stk.core.stkobjects.VehicleGraphics3DBearingBox.height`
              - Indicate the Height of the box. Uses Distance Dimension.
            * - :py:attr:`~ansys.stk.core.stkobjects.VehicleGraphics3DBearingBox.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.
            * - :py:attr:`~ansys.stk.core.stkobjects.VehicleGraphics3DBearingBox.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.
            * - :py:attr:`~ansys.stk.core.stkobjects.VehicleGraphics3DBearingBox.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.
            * - :py:attr:`~ansys.stk.core.stkobjects.VehicleGraphics3DBearingBox.use_translucency`
              - Specify a translucency of the object.
            * - :py:attr:`~ansys.stk.core.stkobjects.VehicleGraphics3DBearingBox.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
-------------

.. code-block:: python

    from ansys.stk.core.stkobjects import VehicleGraphics3DBearingBox


Property detail
---------------

.. py:property:: bearing
    :canonical: ansys.stk.core.stkobjects.VehicleGraphics3DBearingBox.bearing
    :type: float

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

.. py:property:: length
    :canonical: ansys.stk.core.stkobjects.VehicleGraphics3DBearingBox.length
    :type: float

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

.. py:property:: width
    :canonical: ansys.stk.core.stkobjects.VehicleGraphics3DBearingBox.width
    :type: float

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

.. py:property:: height
    :canonical: ansys.stk.core.stkobjects.VehicleGraphics3DBearingBox.height
    :type: float

    Indicate the Height of the box. Uses Distance Dimension.

.. py:property:: length_offset
    :canonical: ansys.stk.core.stkobjects.VehicleGraphics3DBearingBox.length_offset
    :type: 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.

.. py:property:: width_offset
    :canonical: ansys.stk.core.stkobjects.VehicleGraphics3DBearingBox.width_offset
    :type: 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.

.. py:property:: height_offset
    :canonical: ansys.stk.core.stkobjects.VehicleGraphics3DBearingBox.height_offset
    :type: 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.

.. py:property:: use_translucency
    :canonical: ansys.stk.core.stkobjects.VehicleGraphics3DBearingBox.use_translucency
    :type: bool

    Specify a translucency of the object.

.. py:property:: translucency
    :canonical: ansys.stk.core.stkobjects.VehicleGraphics3DBearingBox.translucency
    :type: float

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