Show / Hide Table of Contents

    Class SteamVR_Action_In_Source

    In actions are all input type actions. Boolean, Single, Vector2, Vector3, Skeleton, and Pose. This class fires onChange and onUpdate events.

    Inheritance
    System.Object
    SteamVR_Action_Source
    SteamVR_Action_In_Source
    SteamVR_Action_Boolean_Source
    SteamVR_Action_Pose_Source
    SteamVR_Action_Single_Source
    SteamVR_Action_Vector2_Source
    SteamVR_Action_Vector3_Source
    Implements
    ISteamVR_Action_In_Source
    ISteamVR_Action_Source
    Inherited Members
    SteamVR_Action_Source.fullPath
    SteamVR_Action_Source.handle
    SteamVR_Action_Source.actionSet
    SteamVR_Action_Source.direction
    SteamVR_Action_Source.inputSource
    SteamVR_Action_Source.setActive
    SteamVR_Action_Source.active
    SteamVR_Action_Source.activeBinding
    SteamVR_Action_Source.lastActive
    SteamVR_Action_Source.lastActiveBinding
    SteamVR_Action_Source.inputSourceHandle
    SteamVR_Action_Source.action
    SteamVR_Action_Source.Preinitialize(SteamVR_Action, SteamVR_Input_Sources)
    System.Object.Equals(System.Object)
    System.Object.Equals(System.Object, System.Object)
    System.Object.GetHashCode()
    System.Object.GetType()
    System.Object.MemberwiseClone()
    System.Object.ToString()
    System.Object.ReferenceEquals(System.Object, System.Object)
    Namespace: Valve.VR
    Assembly: Assembly-CSharp.dll
    Syntax
    public abstract class SteamVR_Action_In_Source : SteamVR_Action_Source, ISteamVR_Action_In_Source, ISteamVR_Action_Source

    Fields

    inputOriginInfo

    Declaration
    protected InputOriginInfo_t inputOriginInfo
    Field Value
    Type Description
    InputOriginInfo_t

    inputOriginInfo_size

    Declaration
    protected static uint inputOriginInfo_size
    Field Value
    Type Description
    System.UInt32

    lastInputOriginInfo

    Declaration
    protected InputOriginInfo_t lastInputOriginInfo
    Field Value
    Type Description
    InputOriginInfo_t

    Properties

    activeDevice

    The input source that triggered the action to be updated

    Declaration
    public SteamVR_Input_Sources activeDevice { get; }
    Property Value
    Type Description
    SteamVR_Input_Sources

    activeOrigin

    The handle to the component that triggered the action to be changed

    Declaration
    public abstract ulong activeOrigin { get; }
    Property Value
    Type Description
    System.UInt64

    changed

    Returns true if the action has been changed since the previous update

    Declaration
    public abstract bool changed { get; protected set; }
    Property Value
    Type Description
    System.Boolean

    changedTime

    The Time.realtimeSinceStartup that this action was last changed.

    Declaration
    public float changedTime { get; protected set; }
    Property Value
    Type Description
    System.Single

    isUpdating

    [Should not be called by user code] Forces the system to start updating the data for this action and the specified input source. Should only be used if you've set SteamVR_Action.startUpdatingSourceOnAccess to false.

    Declaration
    public bool isUpdating { get; set; }
    Property Value
    Type Description
    System.Boolean

    lastActiveOrigin

    The handle to the component that triggered the action to be changed in the previous update

    Declaration
    public abstract ulong lastActiveOrigin { get; }
    Property Value
    Type Description
    System.UInt64

    lastChanged

    Returns true if the action was changed for the previous update cycle

    Declaration
    public abstract bool lastChanged { get; protected set; }
    Property Value
    Type Description
    System.Boolean

    lastOriginGetFrame

    Declaration
    protected int lastOriginGetFrame { get; set; }
    Property Value
    Type Description
    System.Int32

    localizedOriginName

    Gets the localized full name of the device that the action was updated by. ex: "Left Hand Vive Controller Trackpad"

    Declaration
    public string localizedOriginName { get; }
    Property Value
    Type Description
    System.String

    renderModelComponentName

    The name of the component on the render model that caused the action to be updated (not localized)

    Declaration
    public string renderModelComponentName { get; }
    Property Value
    Type Description
    System.String

    trackedDeviceIndex

    The device index (used by Render Models) used by the device that triggered the action to be updated

    Declaration
    public uint trackedDeviceIndex { get; }
    Property Value
    Type Description
    System.UInt32

    updateTime

    The time the action was updated (Time.realtimeSinceStartup)

    Declaration
    public float updateTime { get; protected set; }
    Property Value
    Type Description
    System.Single

    Methods

    GetLocalizedOrigin()

    Gets the localized full name of the device that the action was updated by. ex: "Left Hand Vive Controller Trackpad"

    Declaration
    public string GetLocalizedOrigin()
    Returns
    Type Description
    System.String

    GetLocalizedOriginPart(EVRInputStringBits[])

    Gets the localized name of the device that the action corresponds to. Include as many EVRInputStringBits as you want to add to the localized string

    Declaration
    public string GetLocalizedOriginPart(params EVRInputStringBits[] localizedParts)
    Parameters
    Type Name Description
    EVRInputStringBits[] localizedParts
    • VRInputString_Hand - Which hand the origin is in. ex: "Left Hand".
    • VRInputString_ControllerType - What kind of controller the user has in that hand. ex: "Vive Controller".
    • VRInputString_InputSource - What part of that controller is the origin. ex: "Trackpad".
    • VRInputString_All - All of the above. ex: "Left Hand Vive Controller Trackpad".
    Returns
    Type Description
    System.String

    Initialize()

    [Should not be called by user code] Initializes the handle for the action, the size of the InputOriginInfo struct, and any other related SteamVR data.

    Declaration
    public override void Initialize()
    Overrides
    SteamVR_Action_Source.Initialize()

    UpdateOriginTrackedDeviceInfo()

    Declaration
    protected void UpdateOriginTrackedDeviceInfo()

    UpdateValue()

    [Should not be called by user code] Updates the data for this action and this input source

    Declaration
    public abstract void UpdateValue()

    Implements

    ISteamVR_Action_In_Source
    ISteamVR_Action_Source
    In This Article
    • Fields
      • inputOriginInfo
      • inputOriginInfo_size
      • lastInputOriginInfo
    • Properties
      • activeDevice
      • activeOrigin
      • changed
      • changedTime
      • isUpdating
      • lastActiveOrigin
      • lastChanged
      • lastOriginGetFrame
      • localizedOriginName
      • renderModelComponentName
      • trackedDeviceIndex
      • updateTime
    • Methods
      • GetLocalizedOrigin()
      • GetLocalizedOriginPart(EVRInputStringBits[])
      • Initialize()
      • UpdateOriginTrackedDeviceInfo()
      • UpdateValue()
    • Implements
    Back to top Copyright (c) Valve Corporation, All rights reserved.