SbTrackerInfo Class Reference
[Basics]

VSG extension Class for representing 3D tracker information. More...

#include <Inventor/events/SbTrackerInfo.h>

List of all members.

Public Member Functions

 SbTrackerInfo ()
 ~SbTrackerInfo ()
void setPosition3 (const SbVec3f &p)
const SbVec3fgetPosition3 () const
const SbRotationgetOrientation () const
void getOrientation (SbVec3f &axis, float &angle) const
void setOrientation (float q0, float q1, float q2, float q3)
void setOrientation (const float q[4])
void setOrientation (const SbVec3f &axis, float angle)
void setOrientation (SbRotation orientation)
void setOrientation (float xangle, float yangle, float zangle)
const SbLine getRay () const
void setData (void *appData)
const void * getData () const

Detailed Description

VSG extension Class for representing 3D tracker information.

An object that stores information about the state of a 3D tracker device, specifically position and orientation.

A "tracker" is any device whose position and orientation are dynamically tracked in 3D, typically for immersive VR applications. For example: a head tracker. A "controller" is an input device which typically has buttons and/or valuators (e.g. a joystick). Many controllers have an associated tracker. For example, the commonly used "wand" input device has three buttons, a two-axis joystick (two valuators), and an associated tracker.

The virtual method SoEvent::getTrackerInfo() can be used to determine if an event object has associated tracker information. Traditional 2D events like SoMouseButtonEvent and SoLocation2Event return NULL. 3D events like SoTrackerEvent and SoControllerButtonEvent return a pointer to their associated tracker information (SbTrackerInfo).

In addition to the usual methods for setting an orientation, this class provides a method that takes three Euler angles specified in radians. This allows orientation information returned by the widely used trackd API to be stored directly into an Open Inventor event object.

Tracker info is most often used by Open Inventor classes to specify a direction for picking or intersection with a dragger. This class provides the getRay() method to conveniently get an SbLine defining the direction the tracker is pointing.

This class also provides a void * data member that could be used, for example, to distinguish different tracker devices or communicate any other information between an application and custom nodes in the scene graph. Open Inventor does not set or use this variable.

SEE ALSO

SoControllerButtonEvent, SoEvent, SoTrackerEvent


Constructor & Destructor Documentation

SbTrackerInfo::SbTrackerInfo (  ) 

Constructor.

SbTrackerInfo::~SbTrackerInfo (  ) 

Destructor.


Member Function Documentation

const void* SbTrackerInfo::getData (  )  const [inline]

Get application data.

void SbTrackerInfo::getOrientation ( SbVec3f axis,
float &  angle 
) const [inline]

Get orientation of tracker.

Return value as axis and angle.

const SbRotation& SbTrackerInfo::getOrientation (  )  const [inline]

Get orientation of tracker as a standard Open Inventor rotation (quaternion).

const SbVec3f& SbTrackerInfo::getPosition3 (  )  const [inline]

Get position of tracker in world coordinates.

const SbLine SbTrackerInfo::getRay (  )  const

Convenience function to get ray for picking/intersecting.

void SbTrackerInfo::setData ( void *  appData  )  [inline]

Set application data.

void SbTrackerInfo::setOrientation ( float  xangle,
float  yangle,
float  zangle 
)

Set orientation value from Euler angles in radians (using the trackd convention Z*X*Y).

void SbTrackerInfo::setOrientation ( SbRotation  orientation  )  [inline]

Set orientation value from an SbRotation.

void SbTrackerInfo::setOrientation ( const SbVec3f axis,
float  angle 
) [inline]

Set orientation value from axis and angle in radians.

void SbTrackerInfo::setOrientation ( const float  q[4]  )  [inline]

Set orientation value from array of 4 floats defining the rotation quaternion.

void SbTrackerInfo::setOrientation ( float  q0,
float  q1,
float  q2,
float  q3 
) [inline]

Set orientation value from 4 floats defining the rotation quaternion.

void SbTrackerInfo::setPosition3 ( const SbVec3f p  )  [inline]

Set position of tracker in world coordinates.


The documentation for this class was generated from the following file:

Open Inventor Toolkit reference manual, generated on 8 Apr 2021
Copyright © Thermo Fisher Scientific All rights reserved.
http://www.openinventor.com/