Class InstancesModule

java.lang.Object

gaiasky.script.v2.impl.APIModule

gaiasky.script.v2.impl.InstancesModule

All Implemented Interfaces:

InstancesAPI

public class InstancesModule
extends APIModule
implements InstancesAPI

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

Field Summary

Fields inherited from class APIModule

api, em, logger, me, name

Modifier and Type	Field	Description
protected final APIv2	api	Reference to API object.
protected final EventManager	em	Reference to event manager.
protected final Logger.Log	logger
protected final APIModule	me	Reference to self.
protected final String	name	Module name.

Constructor Summary

Constructors

Constructor	Description
InstancesModule(EventManager em, APIv2 api, String name)	Create a new module with the given attributes.

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.

Methods inherited from class APIModule

dispose

Modifier and Type	Method	Description
void	dispose()	Method called whenever the module is disposed.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

InstancesModule

public InstancesModule(EventManager em,
 APIv2 api,
 String name)

Create a new module with the given attributes.

Parameters:

api - Reference to the API class.

name - Name of the module.

Method Details

set_projection_yaw

public void set_projection_yaw(float yaw)

Description copied from interface: InstancesAPI

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.

Specified by:

set_projection_yaw in interface InstancesAPI

Parameters:

yaw - The yaw angle in degrees.

set_projection_pitch

public void set_projection_pitch(float pitch)

Description copied from interface: InstancesAPI

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.

Specified by:

set_projection_pitch in interface InstancesAPI

Parameters:

pitch - The pitch angle in degrees.

set_projection_roll

public void set_projection_roll(float roll)

Description copied from interface: InstancesAPI

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.

Specified by:

set_projection_roll in interface InstancesAPI

Parameters:

roll - The roll angle in degrees.

set_projection_fov

public void set_projection_fov(float fov)

Description copied from interface: InstancesAPI

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).

Specified by:

set_projection_fov in interface InstancesAPI

Parameters:

fov - The field of view angle.