Interface InstancesAPI

All Known Implementing Classes:
InstancesModule
public interface InstancesAPI
API definition for the instances module, InstancesModule.

The instances module contains methods and calls to access, modify, and query the connected instances subsystem (primary-replica).

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    set_projection_fov(float fov)
    Same as CameraModule.set_fov(float), but this method bypasses the restriction of an active projection in the replica (replicas that have an active projection do not accept fov modification events).
    void
    set_projection_pitch(float pitch)
    Sets the projection pitch angle (if this is a replica instance), in degrees.
    void
    set_projection_roll(float roll)
    Sets the projection roll angle (if this is a replica instance), in degrees.
    void
    set_projection_yaw(float yaw)
    Sets the projection yaw angle (if this is a replica instance), in degrees.

  • Method Details

    • set_projection_yaw

      void set_projection_yaw(float yaw)
      Sets the projection yaw angle (if this is a replica instance), in degrees. The yaw angle turns the camera to the right. This function is intended for multi-projector setups, to configure replicas without restarting Gaia Sky.
      Parameters:
      yaw - The yaw angle in degrees.

    • set_projection_pitch

      void set_projection_pitch(float pitch)
      Sets the projection pitch angle (if this is a replica instance), in degrees. The pitch angle turns the camera up. This function is intended for multi-projector setups, to configure replicas without restarting Gaia Sky.
      Parameters:
      pitch - The pitch angle in degrees.

    • set_projection_roll

      void set_projection_roll(float roll)
      Sets the projection roll angle (if this is a replica instance), in degrees. The roll angle rolls the camera clockwise. This function is intended for multi-projector setups, to configure replicas without restarting Gaia Sky.
      Parameters:
      roll - The roll angle in degrees.

    • set_projection_fov

      void set_projection_fov(float fov)
      Same as CameraModule.set_fov(float), but this method bypasses the restriction of an active projection in the replica (replicas that have an active projection do not accept fov modification events).
      Parameters:
      fov - The field of view angle.