Talos docs

OrbitConfig

Since 0.6
Plain text

Signature

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

MemberSignatureDescription
targettarget: CameraTargetWhat is being orbited.
pivotOffsetpivotOffset: Vec3Offset added to the target point, to frame something other than the origin of the model.
distancedistance: number
minDistanceminDistance: number
maxDistancemaxDistance: number
pitchMinDegpitchMinDeg: numberLowest view pitch, in degrees. Negative looks down, which puts the camera above the subject.
pitchMaxDegpitchMaxDeg: numberHighest view pitch, in degrees. Positive looks up, which puts the camera below the subject.
orbitSpeedDegorbitSpeedDeg: numberDegrees per second at full look deflection.
pitchSpeedDegpitchSpeedDeg: number
zoomSpeedzoomSpeed: numberMetres per second at full zoom deflection.
autoRotateDegautoRotateDeg: numberDegrees per second of idle turntable rotation; 0 disables it.
autoRotateDelayautoRotateDelay: numberSeconds of no input before auto-rotation resumes.
fovfov: number
yawyaw: number
pitchpitch: number