.. PelvisOperator:

**************
PelvisOperator
**************

The pelvis operator moves your agent in space and positions it on the given height field.

.. _inputs:

Inputs
=============

.. list-table:: Inputs
   :widths: auto
   :header-rows: 1

   * - Name
     - Type
     - Default
     - Description
   * - active
     - BooleanPort
     - True
     - Enables this operator
   * - direction
     - VectorPort
     - V3d(1, 0, 0)
     - The direction vector
   * - useDirectionMetadata
     - BooleanPort
     - True
     - If true, the operator uses the direction metadata instead of the direction port value
   * - usePositionOnly
     - BooleanPort
     - False
     - If true, the operator will only use the agent position
   * - inPose
     - PosePort
     - 
     - The input pose
   * - heightField
     - StringPort
     - 
     - The name of the height field
   * - gravityField
     - StringPort
     - 
     - The name of the gravity field
   * - heightFieldOffset
     - DoublePort
     - 0.0
     - An extra offset applied to your agent heights from the ground
   * - compensateStretchLeg
     - BooleanPort
     - False
     - Compensate the leg stretching

.. _outputs:
        
Outputs
=============

.. list-table:: Outputs
   :widths: auto
   :header-rows: 1

   * - Name
     - Type
     - Default
     - Description
   * - outPose
     - PosePort
     - 
     - The output pose