.. _api-doc:

API
************************

API Documentation is here. Help and documentation on-the-fly are available through the "doc" and "help" commands, as usual.

Tires

.. inheritance-diagram:: Tire TireLinear TirePacejka TirePolynomial
    :parts: 1

Articulated vehicles

.. inheritance-diagram:: VehicleArticulated VehicleArticulatedLinear VehicleArticulatedNonlinear
    :parts: 1

Simple vehicles

.. inheritance-diagram:: VehicleSimple VehicleSimpleLinear VehicleSimpleNonlinear
    :parts: 1

.. automodule:: Tire

.. autoclass:: Tire
    :members:
    :inherited-members:


.. automodule:: TireLinear

.. autoclass:: TireLinear
    :members:
    :show-inheritance:

.. automodule:: TirePacejka

.. autoclass:: TirePacejka
    :members:
    :show-inheritance:

.. automodule:: TirePolynomial

.. autoclass:: TirePolynomial
    :members:
    :show-inheritance:

.. automodule:: VehicleSimple

.. autoclass:: VehicleSimple
    :members:
    :show-inheritance:

.. automodule:: VehicleSimpleLinear

.. autoclass:: VehicleSimpleLinear
    :members:
    :show-inheritance:

.. automodule:: VehicleSimpleNonlinear

.. autoclass:: VehicleSimpleNonlinear
    :members:
    :show-inheritance:

.. automodule:: VehicleSimpleNonlinear4DOF

.. autoclass:: VehicleSimpleNonlinear4DOF
    :members:
    :show-inheritance:

.. automodule:: VehicleArticulated

.. autoclass:: VehicleArticulated
    :members:
    :show-inheritance:

.. automodule:: VehicleArticulatedLinear

.. autoclass:: VehicleArticulatedLinear
    :members:
    :show-inheritance:

.. automodule:: VehicleArticulatedNonlinear

.. autoclass:: VehicleArticulatedNonlinear
    :members:
    :show-inheritance:


.. automodule:: Graphics

.. autoclass:: Graphics
    :members:
    :inherited-members:

.. automodule:: Simulator

.. autoclass:: Simulator
    :members:
    :inherited-members: