# OrbitConfig

> Talos 0.6 · Since 0.6

## Signature

```ts
export interface OrbitConfig {
  /** What is being orbited. */
  target: CameraTarget
  /** Offset added to the target point, to frame something other than the origin of the model. */
  pivotOffset: Vec3
  distance: number
  minDistance: number
  maxDistance: number
  /** Lowest view pitch, in degrees. Negative looks down, which puts the camera above the subject. */
  pitchMinDeg: number
  /** Highest view pitch, in degrees. Positive looks up, which puts the camera below the subject. */
  pitchMaxDeg: number
  /** Degrees per second at full look deflection. */
  orbitSpeedDeg: number
  pitchSpeedDeg: number
  /** Metres per second at full zoom deflection. */
  zoomSpeed: number
  /** Degrees per second of idle turntable rotation; 0 disables it. */
  autoRotateDeg: number
  /** Seconds of no input before auto-rotation resumes. */
  autoRotateDelay: number
  fov: number
  yaw: number
  pitch: number
}
```

Import: `import type { OrbitConfig } from "@argus/gameplay"`

## Members

| Member | Signature | Description |
|---|---|---|
| `target` | `target: CameraTarget` | What is being orbited. |
| `pivotOffset` | `pivotOffset: Vec3` | Offset added to the target point, to frame something other than the origin of the model. |
| `distance` | `distance: number` |  |
| `minDistance` | `minDistance: number` |  |
| `maxDistance` | `maxDistance: number` |  |
| `pitchMinDeg` | `pitchMinDeg: number` | Lowest view pitch, in degrees. Negative looks down, which puts the camera above the subject. |
| `pitchMaxDeg` | `pitchMaxDeg: number` | Highest view pitch, in degrees. Positive looks up, which puts the camera below the subject. |
| `orbitSpeedDeg` | `orbitSpeedDeg: number` | Degrees per second at full look deflection. |
| `pitchSpeedDeg` | `pitchSpeedDeg: number` |  |
| `zoomSpeed` | `zoomSpeed: number` | Metres per second at full zoom deflection. |
| `autoRotateDeg` | `autoRotateDeg: number` | Degrees per second of idle turntable rotation; 0 disables it. |
| `autoRotateDelay` | `autoRotateDelay: number` | Seconds of no input before auto-rotation resumes. |
| `fov` | `fov: number` |  |
| `yaw` | `yaw: number` |  |
| `pitch` | `pitch: number` |  |
