Show / Hide Table of Contents

Class SteamVR_Behaviour_Pose

This component simplifies the use of Pose actions. Adding it to a gameobject will auto set that transform's position and rotation every update to match the pose. Advanced velocity estimation is handled through a buffer of the last 30 updates.

Inheritance

System.Object

UnityEngine.Object

UnityEngine.Component

UnityEngine.Behaviour

UnityEngine.MonoBehaviour

SteamVR_Behaviour_Pose

Inherited Members

UnityEngine.MonoBehaviour.Invoke(System.String, System.Single)

UnityEngine.MonoBehaviour.InvokeRepeating(System.String, System.Single, System.Single)

UnityEngine.MonoBehaviour.CancelInvoke()

UnityEngine.MonoBehaviour.CancelInvoke(System.String)

UnityEngine.MonoBehaviour.IsInvoking(System.String)

UnityEngine.MonoBehaviour.IsInvoking()

UnityEngine.MonoBehaviour.StartCoroutine(System.Collections.IEnumerator)

UnityEngine.MonoBehaviour.StartCoroutine_Auto(System.Collections.IEnumerator)

UnityEngine.MonoBehaviour.StartCoroutine(System.String, System.Object)

UnityEngine.MonoBehaviour.StartCoroutine(System.String)

UnityEngine.MonoBehaviour.StopCoroutine(System.String)

UnityEngine.MonoBehaviour.StopCoroutine(System.Collections.IEnumerator)

UnityEngine.MonoBehaviour.StopCoroutine(UnityEngine.Coroutine)

UnityEngine.MonoBehaviour.StopAllCoroutines()

UnityEngine.MonoBehaviour.print(System.Object)

UnityEngine.MonoBehaviour.useGUILayout

UnityEngine.Behaviour.enabled

UnityEngine.Behaviour.isActiveAndEnabled

UnityEngine.Component.GetComponent(System.Type)

UnityEngine.Component.GetComponent<T>()

UnityEngine.Component.GetComponent(System.String)

UnityEngine.Component.GetComponentInChildren(System.Type, System.Boolean)

UnityEngine.Component.GetComponentInChildren(System.Type)

UnityEngine.Component.GetComponentInChildren<T>()

UnityEngine.Component.GetComponentInChildren<T>(System.Boolean)

UnityEngine.Component.GetComponentsInChildren(System.Type)

UnityEngine.Component.GetComponentsInChildren(System.Type, System.Boolean)

UnityEngine.Component.GetComponentsInChildren<T>(System.Boolean)

UnityEngine.Component.GetComponentsInChildren<T>(System.Boolean, System.Collections.Generic.List<T>)

UnityEngine.Component.GetComponentsInChildren<T>()

UnityEngine.Component.GetComponentsInChildren<T>(System.Collections.Generic.List<T>)

UnityEngine.Component.GetComponentInParent(System.Type)

UnityEngine.Component.GetComponentInParent<T>()

UnityEngine.Component.GetComponentsInParent(System.Type)

UnityEngine.Component.GetComponentsInParent(System.Type, System.Boolean)

UnityEngine.Component.GetComponentsInParent<T>(System.Boolean)

UnityEngine.Component.GetComponentsInParent<T>(System.Boolean, System.Collections.Generic.List<T>)

UnityEngine.Component.GetComponentsInParent<T>()

UnityEngine.Component.GetComponents(System.Type)

UnityEngine.Component.GetComponents(System.Type, System.Collections.Generic.List<UnityEngine.Component>)

UnityEngine.Component.GetComponents<T>(System.Collections.Generic.List<T>)

UnityEngine.Component.GetComponents<T>()

UnityEngine.Component.CompareTag(System.String)

UnityEngine.Component.SendMessageUpwards(System.String, System.Object, UnityEngine.SendMessageOptions)

UnityEngine.Component.SendMessageUpwards(System.String, System.Object)

UnityEngine.Component.SendMessageUpwards(System.String)

UnityEngine.Component.SendMessageUpwards(System.String, UnityEngine.SendMessageOptions)

UnityEngine.Component.SendMessage(System.String, System.Object, UnityEngine.SendMessageOptions)

UnityEngine.Component.SendMessage(System.String, System.Object)

UnityEngine.Component.SendMessage(System.String)

UnityEngine.Component.SendMessage(System.String, UnityEngine.SendMessageOptions)

UnityEngine.Component.BroadcastMessage(System.String, System.Object, UnityEngine.SendMessageOptions)

UnityEngine.Component.BroadcastMessage(System.String, System.Object)

UnityEngine.Component.BroadcastMessage(System.String)

UnityEngine.Component.BroadcastMessage(System.String, UnityEngine.SendMessageOptions)

UnityEngine.Component.transform

UnityEngine.Component.gameObject

UnityEngine.Component.tag

UnityEngine.Component.rigidbody

UnityEngine.Component.rigidbody2D

UnityEngine.Component.camera

UnityEngine.Component.light

UnityEngine.Component.animation

UnityEngine.Component.constantForce

UnityEngine.Component.renderer

UnityEngine.Component.audio

UnityEngine.Component.guiText

UnityEngine.Component.networkView

UnityEngine.Component.guiElement

UnityEngine.Component.guiTexture

UnityEngine.Component.collider

UnityEngine.Component.collider2D

UnityEngine.Component.hingeJoint

UnityEngine.Component.particleEmitter

UnityEngine.Component.particleSystem

UnityEngine.Object.Destroy(UnityEngine.Object, System.Single)

UnityEngine.Object.Destroy(UnityEngine.Object)

UnityEngine.Object.DestroyImmediate(UnityEngine.Object, System.Boolean)

UnityEngine.Object.DestroyImmediate(UnityEngine.Object)

UnityEngine.Object.FindObjectsOfType(System.Type)

UnityEngine.Object.DontDestroyOnLoad(UnityEngine.Object)

UnityEngine.Object.DestroyObject(UnityEngine.Object, System.Single)

UnityEngine.Object.DestroyObject(UnityEngine.Object)

UnityEngine.Object.FindSceneObjectsOfType(System.Type)

UnityEngine.Object.FindObjectsOfTypeIncludingAssets(System.Type)

UnityEngine.Object.FindObjectsOfTypeAll(System.Type)

UnityEngine.Object.ToString()

UnityEngine.Object.GetInstanceID()

UnityEngine.Object.GetHashCode()

UnityEngine.Object.Equals(System.Object)

UnityEngine.Object.Instantiate(UnityEngine.Object, UnityEngine.Vector3, UnityEngine.Quaternion)

UnityEngine.Object.Instantiate(UnityEngine.Object, UnityEngine.Vector3, UnityEngine.Quaternion, UnityEngine.Transform)

UnityEngine.Object.Instantiate(UnityEngine.Object)

UnityEngine.Object.Instantiate(UnityEngine.Object, UnityEngine.Transform)

UnityEngine.Object.Instantiate(UnityEngine.Object, UnityEngine.Transform, System.Boolean)

UnityEngine.Object.Instantiate<T>(T)

UnityEngine.Object.FindObjectsOfType<T>()

UnityEngine.Object.FindObjectOfType(System.Type)

UnityEngine.Object.FindObjectOfType<T>()

UnityEngine.Object.name

UnityEngine.Object.hideFlags

System.Object.Equals(System.Object, System.Object)

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

Namespace: Valve.VR

Assembly: Assembly-CSharp.dll

Syntax

public class SteamVR_Behaviour_Pose : MonoBehaviour

Fields

broadcastDeviceChanges

Declaration

[Tooltip("Can be disabled to stop broadcasting bound device status changes")]
public bool broadcastDeviceChanges

Field Value

Type	Description
System.Boolean

deviceIndex

Declaration

protected int deviceIndex

Field Value

Type	Description
System.Int32

historyBuffer

Declaration

protected SteamVR_HistoryBuffer historyBuffer

Field Value

Type	Description
SteamVR_HistoryBuffer

inputSource

Declaration

[Tooltip("The device this action should apply to. Any if the action is not device specific.")]
public SteamVR_Input_Sources inputSource

Field Value

Type	Description
SteamVR_Input_Sources

lastFrameUpdated

Declaration

protected int lastFrameUpdated

Field Value

Type	Description
System.Int32

onConnectedChanged

This Unity event will fire whenever the device is connected or disconnected

Declaration

public SteamVR_Behaviour_Pose_ConnectedChangedEvent onConnectedChanged

Field Value

Type	Description
SteamVR_Behaviour_Pose_ConnectedChangedEvent

onConnectedChangedEvent

This C# event will fire whenever the device is connected or disconnected

Declaration

public SteamVR_Behaviour_Pose.DeviceConnectedChangeHandler onConnectedChangedEvent

Field Value

Type	Description
SteamVR_Behaviour_Pose.DeviceConnectedChangeHandler

onDeviceIndexChanged

This Unity event will fire whenever the device's deviceIndex changes

Declaration

public SteamVR_Behaviour_Pose_DeviceIndexChangedEvent onDeviceIndexChanged

Field Value

Type	Description
SteamVR_Behaviour_Pose_DeviceIndexChangedEvent

onDeviceIndexChangedEvent

This C# event will fire whenever the device's deviceIndex changes

Declaration

public SteamVR_Behaviour_Pose.DeviceIndexChangedHandler onDeviceIndexChangedEvent

Field Value

Type	Description
SteamVR_Behaviour_Pose.DeviceIndexChangedHandler

onTrackingChanged

This Unity event will fire whenever the device's tracking state changes

Declaration

public SteamVR_Behaviour_Pose_TrackingChangedEvent onTrackingChanged

Field Value

Type	Description
SteamVR_Behaviour_Pose_TrackingChangedEvent

onTrackingChangedEvent

This C# event will fire whenever the device's tracking state changes

Declaration

public SteamVR_Behaviour_Pose.TrackingChangeHandler onTrackingChangedEvent

Field Value

Type	Description
SteamVR_Behaviour_Pose.TrackingChangeHandler

onTransformChanged

This Unity event will fire whenever the position or rotation of this transform is changed.

Declaration

public SteamVR_Behaviour_PoseEvent onTransformChanged

Field Value

Type	Description
SteamVR_Behaviour_PoseEvent

onTransformChangedEvent

This C# event will fire whenever the position or rotation of this transform is changed.

Declaration

public SteamVR_Behaviour_Pose.ChangeHandler onTransformChangedEvent

Field Value

Type	Description
SteamVR_Behaviour_Pose.ChangeHandler

onTransformUpdated

This Unity event will fire whenever the position or rotation of this transform is updated.

Declaration

public SteamVR_Behaviour_PoseEvent onTransformUpdated

Field Value

Type	Description
SteamVR_Behaviour_PoseEvent

onTransformUpdatedEvent

This C# event will fire whenever the position or rotation of this transform is updated.

Declaration

public SteamVR_Behaviour_Pose.UpdateHandler onTransformUpdatedEvent

Field Value

Type	Description
SteamVR_Behaviour_Pose.UpdateHandler

origin

Declaration

[Tooltip("If not set, relative to parent")]
public Transform origin

Field Value

Type	Description
UnityEngine.Transform

poseAction

Declaration

public SteamVR_Action_Pose poseAction

Field Value

Type	Description
SteamVR_Action_Pose

Properties

isActive

Returns whether or not the pose action is bound and able to be updated

Declaration

public bool isActive { get; }

Property Value

Type	Description
System.Boolean

isValid

Returns whether or not the current pose is in a valid state

Declaration

public bool isValid { get; }

Property Value

Type	Description
System.Boolean

Methods

CheckDeviceIndex()

Declaration

protected virtual void CheckDeviceIndex()

GetAngularVelocity()

Returns the current angular velocity of the pose (as of the last update)

Declaration

public Vector3 GetAngularVelocity()

Returns

Type	Description
UnityEngine.Vector3

GetDeviceIndex()

Returns the device index for the device bound to the pose.

Declaration

public int GetDeviceIndex()

Returns

Type	Description
System.Int32

GetEstimatedPeakVelocities(out Vector3, out Vector3)

Uses previously recorded values to find the peak speed of the pose and returns the corresponding velocity and angular velocity

Declaration

public void GetEstimatedPeakVelocities(out Vector3 velocity, out Vector3 angularVelocity)

Parameters

Type	Name	Description
UnityEngine.Vector3	velocity
UnityEngine.Vector3	angularVelocity

GetLocalizedName(EVRInputStringBits[])

Gets the localized name of the device that the action corresponds to.

Declaration

public string GetLocalizedName(params EVRInputStringBits[] localizedParts)

Parameters

Type	Name	Description
EVRInputStringBits[]	localizedParts	VRInputString_Hand - Which hand the origin is in. E.g. "Left Hand" VRInputString_ControllerType - What kind of controller the user has in that hand.E.g. "Vive Controller" VRInputString_InputSource - What part of that controller is the origin. E.g. "Trackpad" VRInputString_All - All of the above. E.g. "Left Hand Vive Controller Trackpad"

Returns

Type	Description
System.String

GetVelocitiesAtTimeOffset(Single, out Vector3, out Vector3)

Returns the velocities of the pose at the time specified. Can predict in the future or return past values.

Declaration

public bool GetVelocitiesAtTimeOffset(float secondsFromNow, out Vector3 velocity, out Vector3 angularVelocity)

Parameters

Type	Name	Description
System.Single	secondsFromNow
UnityEngine.Vector3	velocity
UnityEngine.Vector3	angularVelocity

Returns

Type	Description
System.Boolean

GetVelocity()

Returns the current velocity of the pose (as of the last update)

Declaration

public Vector3 GetVelocity()

Returns

Type	Description
UnityEngine.Vector3

OnDeviceConnectedChanged(SteamVR_Action_Pose, SteamVR_Input_Sources, Boolean)

Declaration

protected virtual void OnDeviceConnectedChanged(SteamVR_Action_Pose changedAction, SteamVR_Input_Sources changedSource, bool connected)

Parameters

Type	Name	Description
SteamVR_Action_Pose	changedAction
SteamVR_Input_Sources	changedSource
System.Boolean	connected

OnDisable()

Declaration

protected virtual void OnDisable()

OnEnable()

Declaration

protected virtual void OnEnable()

OnTrackingChanged(SteamVR_Action_Pose, SteamVR_Input_Sources, ETrackingResult)

Declaration

protected virtual void OnTrackingChanged(SteamVR_Action_Pose changedAction, SteamVR_Input_Sources changedSource, ETrackingResult trackingChanged)

Parameters

Type	Name	Description
SteamVR_Action_Pose	changedAction
SteamVR_Input_Sources	changedSource
ETrackingResult	trackingChanged

Start()

Declaration

protected virtual void Start()

UpdateHistoryBuffer()

Declaration

protected void UpdateHistoryBuffer()

UpdateTransform()

Declaration

protected virtual void UpdateTransform()