Class MotionTrackedDeviceFunctionLibrary

Motion Tracked Device Function Library

Inheritance

System.Object

UObject

BlueprintFunctionLibrary

MotionTrackedDeviceFunctionLibrary

Inherited Members

UObject.TransientPackage

UObject.CastTo<T>(UObject)

UObject.CastTo(UObject, Type)

UObject.RemoveObject(UObject)

UObject.MakeObjectArrayField<T>(NativeArray*)

UObject.NotImplemented<T>()

UObject.Construct()

UObject.GetHashCode()

UObject.GetName()

UObject.ToString()

UObject.Name

UObject._None

UObject.None

UObject.ObjPointer

UObject.LoadObjectFromClass(Class, UObject, String, String, LoadFlags, PackageMap, Boolean)

UObject.LoadClass(Class, UObject, String, String, LoadFlags, PackageMap)

UObject.GetPropertyFor<T>(Name)

UObject.ExecuteUbergraph

System.Object.Equals(System.Object)

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

System.Object.GetType()

System.Object.MemberwiseClone()

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

Namespace: UE4.HeadMountedDisplay

Assembly: UE4DotNet.dll

Syntax

public class MotionTrackedDeviceFunctionLibrary : BlueprintFunctionLibrary

Properties

DefaultObject

Get UE4 Default Object for this Class

Declaration

public static MotionTrackedDeviceFunctionLibrary DefaultObject { get; }

Property Value

Type	Description
MotionTrackedDeviceFunctionLibrary

StaticClass

Get UE4 Class

Declaration

public static Class StaticClass { get; }

Property Value

Type	Description
Class

Methods

DisableMotionTrackingForComponent(MotionControllerComponent)

Disable tracking of the specified controller, by player index and tracked device type.

Declaration

public static void DisableMotionTrackingForComponent(MotionControllerComponent MotionControllerComponent)

Parameters

Type	Name	Description
MotionControllerComponent	MotionControllerComponent

Remarks

@param MotionControllerComponent (in) The motion controller component who's associated device is targeted.

DisableMotionTrackingOfAllControllers()

Disable tracking for all controllers.

Declaration

public static void DisableMotionTrackingOfAllControllers()

DisableMotionTrackingOfControllersForPlayer(Int32)

Disable tracking for all controllers associated with the specified player.

Declaration

public static void DisableMotionTrackingOfControllersForPlayer(int PlayerIndex)

Parameters

Type	Name	Description
System.Int32	PlayerIndex

Remarks

@param PlayerIndex (in) The index of the player.

DisableMotionTrackingOfDevice(Int32, EControllerHand)

Disable tracking of the specified controller, by player index and tracked device type.

Declaration

public static void DisableMotionTrackingOfDevice(int PlayerIndex, EControllerHand Hand)

Parameters

Type	Name	Description
System.Int32	PlayerIndex
EControllerHand	Hand

Remarks

@param PlayerIndex (in) The index of the player. @param Hand (in) The tracked device type.

DisableMotionTrackingOfSource(Int32, Name)

Disable tracking of the specified controller, by player index and tracked device type.

Declaration

public static void DisableMotionTrackingOfSource(int PlayerIndex, Name SourceName)

Parameters

Type	Name	Description
System.Int32	PlayerIndex
Name	SourceName

Remarks

@param PlayerIndex (in) The index of the player. @param SourceName (in) The tracked device id.

EnableMotionTrackingForComponent(MotionControllerComponent)

Enable tracking of the specified controller, by player index and tracked device type.

Declaration

public static bool EnableMotionTrackingForComponent(MotionControllerComponent MotionControllerComponent)

Parameters

Type	Name	Description
MotionControllerComponent	MotionControllerComponent

Returns

Type	Description
System.Boolean

Remarks

@param MotionControllerComponent (in) The motion controller component who's associated device is targeted.

@return (Boolean) true if the specified device is now set to be tracked. This could fail due to tracking limits, or on invalid input.

EnableMotionTrackingOfDevice(Int32, EControllerHand)

Enable tracking of the specified controller, by player index and tracked device type.

Declaration

public static bool EnableMotionTrackingOfDevice(int PlayerIndex, EControllerHand Hand)

Parameters

Type	Name	Description
System.Int32	PlayerIndex
EControllerHand	Hand

Returns

Type	Description
System.Boolean

Remarks

@param PlayerIndex (in) The index of the player. @param Hand (in) The device type.

@return (Boolean) true if the specified device is now set to be tracked. This could fail due to tracking limits, or on invalid input.

EnableMotionTrackingOfSource(Int32, Name)

Enable tracking of the specified controller, by player index and tracked device type.

Declaration

public static bool EnableMotionTrackingOfSource(int PlayerIndex, Name SourceName)

Parameters

Type	Name	Description
System.Int32	PlayerIndex
Name	SourceName

Returns

Type	Description
System.Boolean

Remarks

@param PlayerIndex (in) The index of the player. @param SourceName (in) The device id.

@return (Boolean) true if the specified device is now set to be tracked. This could fail due to tracking limits, or on invalid input.

EnumerateMotionSources()

Returns a list of all available motion sources (FNames associated with discrete tracking data that can be used to drive MotionControllerComponents).

Declaration

public static IReadOnlyCollection<Name> EnumerateMotionSources()

Returns

Type	Description
System.Collections.Generic.IReadOnlyCollection<Name>

GetActiveTrackingSystemName()

Returns the system name used to distinguish the current tracking system.

Declaration

public static Name GetActiveTrackingSystemName()

Returns

Type	Description
Name

Remarks

If no XR tracking system is active, then the name 'None' is returned.

GetMaximumMotionTrackedControllerCount()

Get the maximum number of controllers that can be tracked.

Declaration

public static int GetMaximumMotionTrackedControllerCount()

Returns

Type	Description
System.Int32

Remarks

@return (int) number of controllers that can be tracked, or -1 if there is no limit (IsMotionTrackedDeviceCountManagementNecessary() should return false).

GetMotionTrackingEnabledControllerCount()

Get the number of controllers for which tracking is enabled.

Declaration

public static int GetMotionTrackingEnabledControllerCount()

Returns

Type	Description
System.Int32

Remarks

@return (int) number of controllers tracked now, or -1 if this query is unsupported (IsMotionTrackedDeviceCountManagementNecessary() should return false).

IsMotionSourceTracking(Int32, Name)

Queries the specified source's tracking status and returns true if it has tracking.

Declaration

public static bool IsMotionSourceTracking(int PlayerIndex, Name SourceName)

Parameters

Type	Name	Description
System.Int32	PlayerIndex
Name	SourceName

Returns

Type	Description
System.Boolean

Remarks

@return Tracking status of the specified controller.

IsMotionTrackedDeviceCountManagementNecessary()

Returns true if it is necessary for the game to manage how many motion tracked devices it is asking to be tracked simultaneously.

Declaration

public static bool IsMotionTrackedDeviceCountManagementNecessary()

Returns

Type	Description
System.Boolean

Remarks

On some platforms this is unnecessary because all supported devices can be tracked simultaneously.

@return (Boolean) true if the game might need to manage which motion tracked devices are actively tracked.

IsMotionTrackingEnabledForComponent(MotionControllerComponent)

Returns true if tracking is enabled for the specified device.

Declaration

public static bool IsMotionTrackingEnabledForComponent(MotionControllerComponent MotionControllerComponent)

Parameters

Type	Name	Description
MotionControllerComponent	MotionControllerComponent

Returns

Type	Description
System.Boolean

Remarks

@param MotionControllerComponent (in) The motion controller component who's associated device is targeted.

@return (Boolean) true if the specified device is set to be tracked.

IsMotionTrackingEnabledForDevice(Int32, EControllerHand)

Returns true if tracking is enabled for the specified device.

Declaration

public static bool IsMotionTrackingEnabledForDevice(int PlayerIndex, EControllerHand Hand)

Parameters

Type	Name	Description
System.Int32	PlayerIndex
EControllerHand	Hand

Returns

Type	Description
System.Boolean

Remarks

@param PlayerIndex (in) The index of the player. @param Hand (in) The tracked device type.

@return (Boolean) true if the specified device is set to be tracked.

IsMotionTrackingEnabledForSource(Int32, Name)

Returns true if tracking is enabled for the specified device.

Declaration

public static bool IsMotionTrackingEnabledForSource(int PlayerIndex, Name SourceName)

Parameters

Type	Name	Description
System.Int32	PlayerIndex
Name	SourceName

Returns

Type	Description
System.Boolean

Remarks

@param PlayerIndex (in) The index of the player. @param SourceName (in) The tracked device id.

@return (Boolean) true if the specified device is set to be tracked.

New(UObject, Name)

Spawn an object of this class

Declaration

public static MotionTrackedDeviceFunctionLibrary New(UObject obj = null, Name name = default(Name))

Parameters

Type	Name	Description
UObject	obj
Name	name

Returns

Type	Description
MotionTrackedDeviceFunctionLibrary

SetIsControllerMotionTrackingEnabledByDefault(Boolean)

Set whether motion tracked controllers activate on creation by default, or do not and must be explicitly activated.

Declaration

public static void SetIsControllerMotionTrackingEnabledByDefault(bool Enable)

Parameters

Type	Name	Description
System.Boolean	Enable

Remarks

@param Require (in) True means controllers are enabled by default. Enables beyond the controller count limit will fail.

Operators

Implicit(IntPtr to MotionTrackedDeviceFunctionLibrary)

Convert from IntPtr to UObject

Declaration

public static implicit operator MotionTrackedDeviceFunctionLibrary(IntPtr p)

Parameters

Type	Name	Description
System.IntPtr	p

Returns

Type	Description
MotionTrackedDeviceFunctionLibrary