> ## Documentation Index
> Fetch the complete documentation index at: https://docs.generalrobotics.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# Velocity

## Velocity

Inherits from: `object`

A class to represent 3D velocity.

Represents velocity in 3D space with x, y, and z components.
Supports mathematical operations and conversions to/from various formats.

Attributes:
x (float): x-component of velocity (m/s or rad/s)
y (float): y-component of velocity (m/s or rad/s)
z (float): z-component of velocity (m/s or rad/s)

### x\_vel

```python theme={null}
Velocity.x_vel() -> float
```

*No docstring provided.*

<ResponseField name="Returns">
  <ResponseField name="returns" type="float" />
</ResponseField>

### x\_vel

```python theme={null}
Velocity.x_vel(value: float) -> None
```

*No docstring provided.*

<ResponseField name="Arguments">
  <ParamField query="value (float)" type="float" required>
    *No description provided.*
  </ParamField>
</ResponseField>

<ResponseField name="Returns">
  <ResponseField name="returns" type="None" />
</ResponseField>

### y\_vel

```python theme={null}
Velocity.y_vel() -> float
```

*No docstring provided.*

<ResponseField name="Returns">
  <ResponseField name="returns" type="float" />
</ResponseField>

### y\_vel

```python theme={null}
Velocity.y_vel(value: float) -> None
```

*No docstring provided.*

<ResponseField name="Arguments">
  <ParamField query="value (float)" type="float" required>
    *No description provided.*
  </ParamField>
</ResponseField>

<ResponseField name="Returns">
  <ResponseField name="returns" type="None" />
</ResponseField>

### z\_vel

```python theme={null}
Velocity.z_vel() -> float
```

*No docstring provided.*

<ResponseField name="Returns">
  <ResponseField name="returns" type="float" />
</ResponseField>

### z\_vel

```python theme={null}
Velocity.z_vel(value: float) -> None
```

*No docstring provided.*

<ResponseField name="Arguments">
  <ParamField query="value (float)" type="float" required>
    *No description provided.*
  </ParamField>
</ResponseField>

<ResponseField name="Returns">
  <ResponseField name="returns" type="None" />
</ResponseField>

### to\_dict

```python theme={null}
Velocity.to_dict() -> dict
```

Serialize to dictionary for JSON transfer.

<ResponseField name="Returns">
  <ResponseField name="dict" type="dict">
    Dictionary representation of the velocity
  </ResponseField>
</ResponseField>

### from\_dict

```python theme={null}
Velocity.from_dict(data: dict) -> 'Velocity'
```

Deserialize from dictionary.

<ResponseField name="Arguments">
  <ParamField query="data (dict)" type="dict" required>
    Dictionary containing velocity data
  </ParamField>
</ResponseField>

<ResponseField name="Returns">
  <ResponseField name="Velocity" type="'Velocity'">
    Reconstructed velocity object
  </ResponseField>
</ResponseField>