Package org.vivecraft.api.data

Enum Class FBTMode

java.lang.Object

java.lang.Enum<FBTMode>

org.vivecraft.api.data.FBTMode

All Implemented Interfaces:

Serializable, Comparable<FBTMode>, Constable

public enum FBTMode
extends Enum<FBTMode>

The mode used for full-body tracking, denoting which body parts are being tracked.

Since:

1.3.0

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ARMS_LEGS	Head, hands, waist, and feet trackers are available.
ARMS_ONLY	Only head and hands are available.
WITH_JOINTS	Head, hands, waist, feet, elbow, and knee trackers are available.

Method Summary

Modifier and Type	Method	Description
boolean	bodyPartAvailable(VRBodyPart bodyPart)	Whether the provided body part is available in this full-body tracking mode.
static FBTMode	valueOf(String name)	Returns the enum constant of this class with the specified name.
static FBTMode[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

ARMS_ONLY

public static final FBTMode ARMS_ONLY

Only head and hands are available.

Since:

1.3.0

ARMS_LEGS

public static final FBTMode ARMS_LEGS

Head, hands, waist, and feet trackers are available.

Since:

1.3.0

WITH_JOINTS

public static final FBTMode WITH_JOINTS

Head, hands, waist, feet, elbow, and knee trackers are available.

Since:

1.3.0

Method Details

values

public static FBTMode[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static FBTMode valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

bodyPartAvailable

public boolean bodyPartAvailable(VRBodyPart bodyPart)

Whether the provided body part is available in this full-body tracking mode.

Parameters:

bodyPart - The body part to see if data is available for in this mode.

Returns:

Whether the provided body part is available in this mode.

Since:

1.3.0