Documentation
    Preparing search index...

    Interface OrbitRigOptions

    Options for OrbitRig (§44 orbit).

    interface OrbitRigOptions {
        distance?: number;
        maxDistance?: number;
        maxPitch?: number;
        minDistance?: number;
        minPitch?: number;
        pitch?: number;
        target?: RigTarget;
        yaw?: number;
    }
    Index
    distance? maxDistance? maxPitch? minDistance? minPitch? pitch? target? yaw?
    distance?: number

    Initial OrbitRig.distance, in metres; clamped. Default 1.

    maxDistance?: number

    Furthest retreat. Infinity (the default) means unbounded.

    maxPitch?: number

    Upper pitch bound. Default DEFAULT_ORBIT_PITCH_LIMIT.

    minDistance?: number

    Closest approach to the target. Finite and > 0. Default 1e-3.

    minPitch?: number

    Lower pitch bound. Default −DEFAULT_ORBIT_PITCH_LIMIT.

    pitch?: number

    Initial OrbitRig.pitch, in radians; clamped. Default 0.

    target?: RigTarget

    What the rig orbits. Defaults to nothing, which makes the rig idle.

    yaw?: number

    Initial OrbitRig.yaw, in radians. Default 0.

    Settings
    Member Visibility

    On This Page
    Properties