vrj::User Class Reference

Representation for Juggler user in multi-user environments. More...

#include <vrj/Kernel/User.h>

List of all members.

Public Member Functions
	User ()
	Constructs the user.
virtual	~User ()
int	getId ()
	Returns the ID of the user in the system.
std::string	getName ()
	Returns the name of this user object.
virtual bool	config (jccl::ConfigElementPtr element)
	Configures the user object.
gadget::PositionProxy *	getHeadPosProxy ()
vpr::Interval	getHeadUpdateTime ()
	Returns the time stamp of the last head tracker update.
float	getInterocularDistance ()
	Gets the eye separation.

---

Detailed Description

Representation for Juggler user in multi-user environments.

Each user has a system-assigned ID as well as a string name from the 'user' config element that created the user. These IDs can be used to identify a user at set points in the execution of a VR Juggler application object where user information is given.

The system-assigned ID number can also be useful as an index into a program array (or other data structure) that stores user-specific data such as navigation matrices or input devices.

Definition at line 58 of file User.h.

---

Constructor & Destructor Documentation

vrj::User::User

(

)

[inline]

Constructs the user.

Definition at line 62 of file User.h.

      : mUserId(-1)
      , mName("")
      , mInterocularDist(0.0f)
   {;}

virtual vrj::User::~User

(

)

[inline, virtual]

Definition at line 68 of file User.h.

   {;}

---

Member Function Documentation

int vrj::User::getId

(

)

Returns the ID of the user in the system.

Postcondition:

-1 => User has not been configured.

Definition at line 46 of file User.cpp.

{ return mUserId; }

std::string vrj::User::getName

(

)

Returns the name of this user object.

Postcondition:

String name of the head.

Definition at line 49 of file User.cpp.

Referenced by vrj::Viewport::outStream(), and vrj::Kernel::removeUser().

{ return mName; }

bool vrj::User::config

(

jccl::ConfigElementPtr

element

)

[virtual]

Configures the user object.

Postcondition:

User has valid ids (int and string). Positional device for user location has been set.

Definition at line 52 of file User.cpp.

References vrjDBG_KERNEL().

{
   vprASSERT(element.get() != NULL);
   vprASSERT(element->getID() == "user");

   vprDEBUG_BEGIN(vrjDBG_KERNEL, vprDBG_STATE_LVL)
      << "vjUser::config: Creating a new user\n" << vprDEBUG_FLUSH;

   // Assign user id
   mUserId = mNextUserId++;

   // Setup user name
   mName = element->getName();

   // Initialize the head stuff
   std::string head_alias = element->getProperty<std::string>("head_position");
   mHead.init(head_alias);

   // Initialize interocular distance
   mInterocularDist = element->getProperty<float>("interocular_distance");

   if(mInterocularDist == 0.0f)
   {
      vprDEBUG(vrjDBG_KERNEL,vprDBG_CONFIG_LVL) << clrOutNORM(clrRED, "WARNING:") << "User: " << mName << " has interocular distance is set to 0.0f.  This is probably not what you wanted.\n" << vprDEBUG_FLUSH;
   }

   vprDEBUG(vrjDBG_KERNEL,vprDBG_STATE_LVL) << "id: " << mUserId << "   Name:" << mName.c_str()
                           << "   head_positon:" << head_alias.c_str()
                           << "   interocular_distance:" << mInterocularDist
                           << std::endl << vprDEBUG_FLUSH;

   return true;
}

gadget::PositionProxy* vrj::User::getHeadPosProxy

(

)

[inline]

Definition at line 90 of file User.h.

Referenced by vrj::PfBasicSimulator::updateInternalData(), vrj::GlBasicSimulator::updateInternalData(), and vrj::SurfaceViewport::updateProjections().

   {
      return mHead.getProxy();
   }

vpr::Interval vrj::User::getHeadUpdateTime

(

)

[inline]

Returns the time stamp of the last head tracker update.

Definition at line 96 of file User.h.

   {
      return mHead->getTimeStamp();
   }

float vrj::User::getInterocularDistance

(

)

[inline]

Gets the eye separation.

Definition at line 102 of file User.h.

Referenced by vrj::GlDrawEllipsoidHeadFunctor::draw(), vrj::PfBasicSimulator::updateProjectionData(), vrj::GlBasicSimulator::updateProjectionData(), and vrj::SurfaceViewport::updateProjections().

   {
      return mInterocularDist;
   }

---

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

• User.h
• User.cpp

---