Legacy Documentation: Version 5.3
LanguageEnglish
  • C#
  • JS

Script language

Select your preferred scripting language. All code snippets will be displayed in this language.

ClusterInput

class in UnityEngine

Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Sumbission failed

For some reason your suggested change could not be submitted. Please try again in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

Description

Interface for reading and writing inputs in a Unity Cluster.

ClusterInput provides access to VRPN devices by connecting to a VRPN server. It also provides access to writeable inputs. All inputs managed by ClusterInput will be replicated to the rest of the connected slaves in the cluster. Using ClusterInput is much like using the traditional Input system in Unity.

#pragma strict
function Update() {
	// Buttons and Axis provide a single value.
	var buttonValue: boolean = ClusterInput.GetButton("button1");
	var axisValue: float = ClusterInput.GetAxis("axis1");
	// A tracker provides 2 values, rotation and position.
	var position: Vector3 = ClusterInput.GetTrackerPosition("tracker1");
	var rotation: Quaternion = ClusterInput.GetTrackerRotation("tracker1");
	if (ClusterNetwork.isMasterOfCluster) {
		var axisValueCustom: float = MyCustomDevicePlugin.GetValue("myaxis");
		ClusterInput.SetAxis("customAxis", axisValueCustom);
	}
}
using UnityEngine;
using System.Collections;

public class ExampleClass : MonoBehaviour { void Update () { // Buttons and Axis provide a single value. bool buttonValue = ClusterInput.GetButton ("button1"); float axisValue = ClusterInput.GetAxis ("axis1");

// A tracker provides 2 values, rotation and position. Vector3 position = ClusterInput.GetTrackerPosition ("tracker1"); Quaternion rotation = ClusterInput.GetTrackerRotation ("tracker1");

if (ClusterNetwork.isMasterOfCluster ){ float axisValueCustom = MyCustomDevicePlugin.GetValue ("myaxis"); ClusterInput.SetAxis ("customAxis", axisValueCustom); } } }

Static Functions

AddInputAdd a new VRPN input entry.
CheckConnectionToServerCheck the connection status of the device to the VRPN server it connected to.
EditInputEdit an input entry which added via ClusterInput.AddInput.
GetAxisReturns the axis value as a continous float.
GetButtonReturns the binary value of a button.
GetTrackerPositionReturn the position of a tracker as a Vector3.
GetTrackerRotationReturns the rotation of a tracker as a Quaternion.
SetAxisSets the axis value for this input. Only works for input typed Custom.
SetButtonSets the button value for this input. Only works for input typed Custom.
SetTrackerPositionSets the tracker position for this input. Only works for input typed Custom.
SetTrackerRotationSets the tracker rotation for this input. Only works for input typed Custom.