Package org.lwjgl.openvr

Class TrackedDevicePose

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<TrackedDevicePose>

org.lwjgl.openvr.TrackedDevicePose

All Implemented Interfaces:

AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer

public class TrackedDevicePose
extends org.lwjgl.system.Struct<TrackedDevicePose>
implements org.lwjgl.system.NativeResource

Describes a single pose for a tracked object.

Layout

 struct TrackedDevicePose_t {
     HmdMatrix34_t mDeviceToAbsoluteTracking;
     HmdVector3_t vVelocity();
     HmdVector3_t vAngularVelocity();
     ETrackingResult eTrackingResult();
     bool bPoseIsValid;
     bool bDeviceIsConnected();
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	TrackedDevicePose.Buffer	An array of TrackedDevicePose structs.

Nested classes/interfaces inherited from class org.lwjgl.system.Struct

org.lwjgl.system.Struct.StructValidation

Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer

org.lwjgl.system.Pointer.Default

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ALIGNOF	The struct alignment in bytes.
static final int	BDEVICEISCONNECTED	The struct member offsets.
static final int	BPOSEISVALID	The struct member offsets.
static final int	ETRACKINGRESULT	The struct member offsets.
static final int	MDEVICETOABSOLUTETRACKING	The struct member offsets.
static final int	SIZEOF	The struct size in bytes.
static final int	VANGULARVELOCITY	The struct member offsets.
static final int	VVELOCITY	The struct member offsets.

Fields inherited from interface org.lwjgl.system.Pointer

BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors

Constructor	Description
TrackedDevicePose(ByteBuffer container)	Creates a TrackedDevicePose instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
boolean	bDeviceIsConnected()	This indicates that there is a device connected for this spot in the pose array.
TrackedDevicePose	bDeviceIsConnected(boolean value)	Sets the specified value to the bDeviceIsConnected() field.
boolean	bPoseIsValid()
TrackedDevicePose	bPoseIsValid(boolean value)	Sets the specified value to the bPoseIsValid field.
static TrackedDevicePose	calloc()	Returns a new TrackedDevicePose instance allocated with memCalloc.
static TrackedDevicePose.Buffer	calloc(int capacity)	Returns a new TrackedDevicePose.Buffer instance allocated with memCalloc.
static TrackedDevicePose.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new TrackedDevicePose.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static TrackedDevicePose	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new TrackedDevicePose instance allocated on the specified MemoryStack and initializes all its bits to zero.
static TrackedDevicePose	callocStack()	Deprecated.
static TrackedDevicePose.Buffer	callocStack(int capacity)	Deprecated.
static TrackedDevicePose.Buffer	callocStack(int capacity, org.lwjgl.system.MemoryStack stack)	Deprecated.
static TrackedDevicePose	callocStack(org.lwjgl.system.MemoryStack stack)	Deprecated.
static TrackedDevicePose	create()	Returns a new TrackedDevicePose instance allocated with BufferUtils.
static TrackedDevicePose.Buffer	create(int capacity)	Returns a new TrackedDevicePose.Buffer instance allocated with BufferUtils.
static TrackedDevicePose	create(long address)	Returns a new TrackedDevicePose instance for the specified memory address.
static TrackedDevicePose.Buffer	create(long address, int capacity)	Create a TrackedDevicePose.Buffer instance at the specified memory.
static @Nullable TrackedDevicePose	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable TrackedDevicePose.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
int	eTrackingResult()	one of: VR.ETrackingResult_TrackingResult_UninitializedVR.ETrackingResult_TrackingResult_Calibrating_InProgressVR.ETrackingResult_TrackingResult_Calibrating_OutOfRangeVR.ETrackingResult_TrackingResult_Running_OKVR.ETrackingResult_TrackingResult_Running_OutOfRangeVR.ETrackingResult_TrackingResult_Fallback_RotationOnly
TrackedDevicePose	eTrackingResult(int value)	Sets the specified value to the eTrackingResult() field.
static TrackedDevicePose	malloc()	Returns a new TrackedDevicePose instance allocated with memAlloc.
static TrackedDevicePose.Buffer	malloc(int capacity)	Returns a new TrackedDevicePose.Buffer instance allocated with memAlloc.
static TrackedDevicePose.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new TrackedDevicePose.Buffer instance allocated on the specified MemoryStack.
static TrackedDevicePose	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new TrackedDevicePose instance allocated on the specified MemoryStack.
static TrackedDevicePose	mallocStack()	Deprecated.
static TrackedDevicePose.Buffer	mallocStack(int capacity)	Deprecated.
static TrackedDevicePose.Buffer	mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)	Deprecated.
static TrackedDevicePose	mallocStack(org.lwjgl.system.MemoryStack stack)	Deprecated.
HmdMatrix34	mDeviceToAbsoluteTracking()
TrackedDevicePose	mDeviceToAbsoluteTracking(Consumer<HmdMatrix34> consumer)	Passes the mDeviceToAbsoluteTracking field to the specified Consumer.
TrackedDevicePose	mDeviceToAbsoluteTracking(HmdMatrix34 value)	Copies the specified HmdMatrix34 to the mDeviceToAbsoluteTracking field.
static boolean	nbDeviceIsConnected(long struct)	Unsafe version of bDeviceIsConnected().
static void	nbDeviceIsConnected(long struct, boolean value)	Unsafe version of bDeviceIsConnected.
static boolean	nbPoseIsValid(long struct)	Unsafe version of bPoseIsValid().
static void	nbPoseIsValid(long struct, boolean value)	Unsafe version of bPoseIsValid.
static int	neTrackingResult(long struct)	Unsafe version of eTrackingResult().
static void	neTrackingResult(long struct, int value)	Unsafe version of eTrackingResult.
static HmdMatrix34	nmDeviceToAbsoluteTracking(long struct)	Unsafe version of mDeviceToAbsoluteTracking().
static void	nmDeviceToAbsoluteTracking(long struct, HmdMatrix34 value)	Unsafe version of mDeviceToAbsoluteTracking.
static HmdVector3	nvAngularVelocity(long struct)	Unsafe version of vAngularVelocity().
static void	nvAngularVelocity(long struct, HmdVector3 value)	Unsafe version of vAngularVelocity.
static HmdVector3	nvVelocity(long struct)	Unsafe version of vVelocity().
static void	nvVelocity(long struct, HmdVector3 value)	Unsafe version of vVelocity.
TrackedDevicePose	set(HmdMatrix34 mDeviceToAbsoluteTracking, HmdVector3 vVelocity, HmdVector3 vAngularVelocity, int eTrackingResult, boolean bPoseIsValid, boolean bDeviceIsConnected)	Initializes this struct with the specified values.
TrackedDevicePose	set(TrackedDevicePose src)	Copies the specified struct data to this struct.
int	sizeof()
HmdVector3	vAngularVelocity()	angular velocity in radians/s
TrackedDevicePose	vAngularVelocity(Consumer<HmdVector3> consumer)	Passes the vAngularVelocity() field to the specified Consumer.
TrackedDevicePose	vAngularVelocity(HmdVector3 value)	Copies the specified HmdVector3 to the vAngularVelocity() field.
HmdVector3	vVelocity()	velocity in tracker space in m/s
TrackedDevicePose	vVelocity(Consumer<HmdVector3> consumer)	Passes the vVelocity() field to the specified Consumer.
TrackedDevicePose	vVelocity(HmdVector3 value)	Copies the specified HmdVector3 to the vVelocity() field.

Methods inherited from class org.lwjgl.system.Struct

clear, free, isNull, validate, validate

Methods inherited from class org.lwjgl.system.Pointer.Default

address, equals, hashCode, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.lwjgl.system.NativeResource

close, free

Field Details

SIZEOF

public static final int SIZEOF

The struct size in bytes.

ALIGNOF

public static final int ALIGNOF

The struct alignment in bytes.

MDEVICETOABSOLUTETRACKING

public static final int MDEVICETOABSOLUTETRACKING

The struct member offsets.

VVELOCITY

public static final int VVELOCITY

The struct member offsets.

VANGULARVELOCITY

public static final int VANGULARVELOCITY

The struct member offsets.

ETRACKINGRESULT

public static final int ETRACKINGRESULT

The struct member offsets.

BPOSEISVALID

public static final int BPOSEISVALID

The struct member offsets.

BDEVICEISCONNECTED

public static final int BDEVICEISCONNECTED

The struct member offsets.

Constructor Details

TrackedDevicePose

public TrackedDevicePose(ByteBuffer container)

Creates a TrackedDevicePose instance at the current position of the specified ByteBuffer container. Changes to the buffer's content will be visible to the struct instance and vice versa.

The created instance holds a strong reference to the container object.

Method Details

sizeof

public int sizeof()

Specified by:

sizeof in class org.lwjgl.system.Struct<TrackedDevicePose>

mDeviceToAbsoluteTracking

public HmdMatrix34 mDeviceToAbsoluteTracking()

Returns:

a HmdMatrix34 view of the mDeviceToAbsoluteTracking field.

vVelocity

public HmdVector3 vVelocity()

velocity in tracker space in m/s

vAngularVelocity

public HmdVector3 vAngularVelocity()

angular velocity in radians/s

eTrackingResult

public int eTrackingResult()

one of:

VR.ETrackingResult_TrackingResult_Uninitialized

VR.ETrackingResult_TrackingResult_Calibrating_InProgress

VR.ETrackingResult_TrackingResult_Calibrating_OutOfRange

VR.ETrackingResult_TrackingResult_Running_OK

VR.ETrackingResult_TrackingResult_Running_OutOfRange

VR.ETrackingResult_TrackingResult_Fallback_RotationOnly

bPoseIsValid

public boolean bPoseIsValid()

Returns:

the value of the bPoseIsValid field.

bDeviceIsConnected

public boolean bDeviceIsConnected()

This indicates that there is a device connected for this spot in the pose array. It could go from true to false if the user unplugs the device.

mDeviceToAbsoluteTracking

public TrackedDevicePose mDeviceToAbsoluteTracking(HmdMatrix34 value)

Copies the specified HmdMatrix34 to the mDeviceToAbsoluteTracking field.

mDeviceToAbsoluteTracking

public TrackedDevicePose mDeviceToAbsoluteTracking(Consumer<HmdMatrix34> consumer)

Passes the mDeviceToAbsoluteTracking field to the specified Consumer.

vVelocity

public TrackedDevicePose vVelocity(HmdVector3 value)

Copies the specified HmdVector3 to the vVelocity() field.

vVelocity

public TrackedDevicePose vVelocity(Consumer<HmdVector3> consumer)

Passes the vVelocity() field to the specified Consumer.

vAngularVelocity

public TrackedDevicePose vAngularVelocity(HmdVector3 value)

Copies the specified HmdVector3 to the vAngularVelocity() field.

vAngularVelocity

public TrackedDevicePose vAngularVelocity(Consumer<HmdVector3> consumer)

Passes the vAngularVelocity() field to the specified Consumer.

eTrackingResult

public TrackedDevicePose eTrackingResult(int value)

Sets the specified value to the eTrackingResult() field.

bPoseIsValid

public TrackedDevicePose bPoseIsValid(boolean value)

Sets the specified value to the bPoseIsValid field.

bDeviceIsConnected

public TrackedDevicePose bDeviceIsConnected(boolean value)

Sets the specified value to the bDeviceIsConnected() field.

set

public TrackedDevicePose set(HmdMatrix34 mDeviceToAbsoluteTracking,
 HmdVector3 vVelocity,
 HmdVector3 vAngularVelocity,
 int eTrackingResult,
 boolean bPoseIsValid,
 boolean bDeviceIsConnected)

Initializes this struct with the specified values.

set

public TrackedDevicePose set(TrackedDevicePose src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static TrackedDevicePose malloc()

Returns a new TrackedDevicePose instance allocated with memAlloc. The instance must be explicitly freed.

calloc

public static TrackedDevicePose calloc()

Returns a new TrackedDevicePose instance allocated with memCalloc. The instance must be explicitly freed.

create

public static TrackedDevicePose create()

Returns a new TrackedDevicePose instance allocated with BufferUtils.

create

public static TrackedDevicePose create(long address)

Returns a new TrackedDevicePose instance for the specified memory address.

createSafe

public static @Nullable TrackedDevicePose createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static TrackedDevicePose.Buffer malloc(int capacity)

Returns a new TrackedDevicePose.Buffer instance allocated with memAlloc. The instance must be explicitly freed.

Parameters:

capacity - the buffer capacity

calloc

public static TrackedDevicePose.Buffer calloc(int capacity)

Returns a new TrackedDevicePose.Buffer instance allocated with memCalloc. The instance must be explicitly freed.

Parameters:

capacity - the buffer capacity

create

public static TrackedDevicePose.Buffer create(int capacity)

Returns a new TrackedDevicePose.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

public static TrackedDevicePose.Buffer create(long address,
 int capacity)

Create a TrackedDevicePose.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

public static @Nullable TrackedDevicePose.Buffer createSafe(long address,
 int capacity)

Like create, but returns null if address is NULL.

mallocStack

@Deprecated
public static TrackedDevicePose mallocStack()

Deprecated.

Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

callocStack

@Deprecated
public static TrackedDevicePose callocStack()

Deprecated.

Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

mallocStack

@Deprecated
public static TrackedDevicePose mallocStack(org.lwjgl.system.MemoryStack stack)

Deprecated.

Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

callocStack

@Deprecated
public static TrackedDevicePose callocStack(org.lwjgl.system.MemoryStack stack)

Deprecated.

Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

mallocStack

@Deprecated
public static TrackedDevicePose.Buffer mallocStack(int capacity)

Deprecated.

Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.

callocStack

@Deprecated
public static TrackedDevicePose.Buffer callocStack(int capacity)

Deprecated.

Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.

mallocStack

@Deprecated
public static TrackedDevicePose.Buffer mallocStack(int capacity,
 org.lwjgl.system.MemoryStack stack)

Deprecated.

Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.

callocStack

@Deprecated
public static TrackedDevicePose.Buffer callocStack(int capacity,
 org.lwjgl.system.MemoryStack stack)

Deprecated.

Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.

malloc

public static TrackedDevicePose malloc(org.lwjgl.system.MemoryStack stack)

Returns a new TrackedDevicePose instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static TrackedDevicePose calloc(org.lwjgl.system.MemoryStack stack)

Returns a new TrackedDevicePose instance allocated on the specified MemoryStack and initializes all its bits to zero.

Parameters:

stack - the stack from which to allocate

malloc

public static TrackedDevicePose.Buffer malloc(int capacity,
 org.lwjgl.system.MemoryStack stack)

Returns a new TrackedDevicePose.Buffer instance allocated on the specified MemoryStack.

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

public static TrackedDevicePose.Buffer calloc(int capacity,
 org.lwjgl.system.MemoryStack stack)

Returns a new TrackedDevicePose.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

nmDeviceToAbsoluteTracking

public static HmdMatrix34 nmDeviceToAbsoluteTracking(long struct)

Unsafe version of mDeviceToAbsoluteTracking().

nvVelocity

public static HmdVector3 nvVelocity(long struct)

Unsafe version of vVelocity().

nvAngularVelocity

public static HmdVector3 nvAngularVelocity(long struct)

Unsafe version of vAngularVelocity().

neTrackingResult

public static int neTrackingResult(long struct)

Unsafe version of eTrackingResult().

nbPoseIsValid

public static boolean nbPoseIsValid(long struct)

Unsafe version of bPoseIsValid().

nbDeviceIsConnected

public static boolean nbDeviceIsConnected(long struct)

Unsafe version of bDeviceIsConnected().

nmDeviceToAbsoluteTracking

public static void nmDeviceToAbsoluteTracking(long struct,
 HmdMatrix34 value)

Unsafe version of mDeviceToAbsoluteTracking.

nvVelocity

public static void nvVelocity(long struct,
 HmdVector3 value)

Unsafe version of vVelocity.

nvAngularVelocity

public static void nvAngularVelocity(long struct,
 HmdVector3 value)

Unsafe version of vAngularVelocity.

neTrackingResult

public static void neTrackingResult(long struct,
 int value)

Unsafe version of eTrackingResult.

nbPoseIsValid

public static void nbPoseIsValid(long struct,
 boolean value)

Unsafe version of bPoseIsValid.

nbDeviceIsConnected

public static void nbDeviceIsConnected(long struct,
 boolean value)

Unsafe version of bDeviceIsConnected.