Support Forum       G3D Web Page     
Classes | Public Member Functions | Static Public Member Functions | Protected Member Functions | Static Protected Member Functions | Protected Attributes | List of all members
G3D::XR::Hand Class Reference

Tracked human hand. More...

Inherits G3D::XR::Object.

Classes

class  BoneIndex
 For each finger, 0 is the bone nearest the wrist. More...
 

Public Member Functions

const Array< CFrame > & boneFrameArray () const
 Coordinate frame for each bone (joint). More...
 
const CFrame & frame () const
 Where the AR/VR system estimates the object will be at the time of the next HMD::submit() call, in the room coordinate frame. More...
 
const int index () const
 Zero-based index in the XR::objectArray. More...
 
virtual bool isController () const
 
virtual bool isHMD () const
 
const String & name () const
 Unique identifier. More...
 
int nativeAPIIndex () const
 Index of this object in the underlying OS API (e.g., OVR, OpenVR, SteamVR) More...
 
const CFrame & previousFrame () const
 Frame that was predicted at the previous HMD::submit() time. More...
 

Static Public Member Functions

static shared_ptr< Hand > create (int index, int nativeAPIIndex, const String &name)
 

Protected Member Functions

 Hand (int index, int nativeAPIIndex, const String &name)
 

Static Protected Member Functions

template<class T , class ... ArgTypes>
static shared_ptr< T > createShared (ArgTypes &&... args)
 Like std::make_shared, but works for protected constructors. More...
 

Protected Attributes

Array< CFrame > m_boneArray
 
CFrame m_frame
 
int m_index
 
String m_name
 
int m_nativeAPIIndex
 
CFrame m_previousFrame
 

Detailed Description

Tracked human hand.

xr-hand-bones.png

Constructor & Destructor Documentation

◆ Hand()

G3D::XR::Hand::Hand ( int  index,
int  nativeAPIIndex,
const String &  name 
)
inlineprotected

Member Function Documentation

◆ boneFrameArray()

const Array<CFrame>& G3D::XR::Hand::boneFrameArray ( ) const
inline

Coordinate frame for each bone (joint).

These are relative to the root bone, not the tracking space, the parent bone, or world space.

See also
BoneIndex

◆ create()

static shared_ptr<Hand> G3D::XR::Hand::create ( int  index,
int  nativeAPIIndex,
const String &  name 
)
inlinestatic

◆ createShared()

template<class T , class ... ArgTypes>
static shared_ptr<T> G3D::ReferenceCountedObject::createShared ( ArgTypes &&...  args)
inlinestaticprotectedinherited

Like std::make_shared, but works for protected constructors.

Call as createShared<myclass>.

◆ frame()

const CFrame& G3D::XR::Object::frame ( ) const
inlineinherited

Where the AR/VR system estimates the object will be at the time of the next HMD::submit() call, in the room coordinate frame.

◆ index()

const int G3D::XR::Object::index ( ) const
inlineinherited

◆ isController()

virtual bool G3D::XR::Object::isController ( ) const
inlinevirtualinherited

Reimplemented in G3D::XR::Controller.

◆ isHMD()

virtual bool G3D::XR::Object::isHMD ( ) const
inlinevirtualinherited

Reimplemented in G3D::XR::HMD.

◆ name()

const String& G3D::XR::Object::name ( ) const
inlineinherited

◆ nativeAPIIndex()

int G3D::XR::Object::nativeAPIIndex ( ) const
inlineinherited

Index of this object in the underlying OS API (e.g., OVR, OpenVR, SteamVR)

Referenced by G3D::XR::Object::create(), G3D::EmulatedXR::EmulatedHMD::create(), and create().

◆ previousFrame()

const CFrame& G3D::XR::Object::previousFrame ( ) const
inlineinherited

Frame that was predicted at the previous HMD::submit() time.

Member Data Documentation

◆ m_boneArray

Array<CFrame> G3D::XR::Hand::m_boneArray
protected

Referenced by boneFrameArray().

◆ m_frame

CFrame G3D::XR::Object::m_frame
protectedinherited

Referenced by G3D::XR::Object::frame().

◆ m_index

int G3D::XR::Object::m_index
protectedinherited

Referenced by G3D::XR::Object::index().

◆ m_name

String G3D::XR::Object::m_name
protectedinherited

Referenced by G3D::XR::Object::name().

◆ m_nativeAPIIndex

int G3D::XR::Object::m_nativeAPIIndex
protectedinherited

◆ m_previousFrame

CFrame G3D::XR::Object::m_previousFrame
protectedinherited

documentation generated on Wed Nov 24 2021 08:02:02 using doxygen 1.8.15