IS3D::IS3DEngine Class Reference

#include <IS3DEngine.H>

List of all members.

Public Types


Static Public Member Functions

static void init (int argc, char **argv)
 Call this from your program to initialize the IS3D system.
static void run (ISApp *app)
static void createLog (std::string filename=std::string("log.txt"))
static void loadConfigsFromArguments (int argc, char **argv, bool exitOnUnrecognizedArgument=true)
static void showHelpAndExit (const std::string &programName)
static void setHeadFrame (CoordinateFrame m)
 User's head position and orientation.
static CoordinateFrame getHeadFrame ()
static Vector3 getHeadPos ()
static CoordinateFrame getLeftEyeFrame ()
static Vector3 getLeftEyePos ()
static CoordinateFrame getRightEyeFrame ()
static Vector3 getRightEyePos ()
static void lockHeadFrame ()
 This disables the setHeadFrame function, thereby disabling headtracking.
static void unlockHeadFrame ()
 This reenables the setHeadFrame function after it has been locked.
static CoordinateFrame getCameraFrame ()
static Vector3 getCameraPos ()
static double getSynchronizedTime ()
static void setSynchronizedTime (double t)
static RenderDevice * getRenderDevice ()
 Access to G3D main stuff.
static Log * getDebugLog ()
static VARAreaRef getVarDynamic ()
static VARAreaRef getVarStatic ()
static GFontRef getFont ()
static DebugDrawRef getDebugDraw ()
static void setIOD (double iod)
 Stereo: Interocular distance.
static double getIOD ()
static void toggleStereo ()
static Vector3 getDisplayTopLeft ()
 Corners of the image plane in world coordinates.
static Vector3 getDisplayTopRight ()
static Vector3 getDisplayBottomLeft ()
static Vector3 getDisplayBottomRight ()
static Vector3 getUpVector ()
static Vector3 getForwardVector ()
static int getDisplayHeightPixels ()
 Size of the image plane in pixels.
static int getDisplayWidthPixels ()
static int getMaxScreenWidth ()
 Returns the maximum possible screen size for the current window system.
static int getMaxScreenHeight ()
static long getFrameCount ()
 Returns the number of frames since the application started.
static std::string getG3DDataDir ()
static std::string getIS3DDataDir ()
static void quit ()
 Shutsdown the application.
static void runloop ()
 The main control loop.
static int argc ()
static char ** argv ()
static void printVARInfo ()
static void resetClippingPlanes (double nclip, double fclip)
static double getFarClip ()
static double getNearClip ()
static bool isLightOn (int i)
static void turnLightOff (int i)
static void turnLightOn (int i)
static void setLightPosition (int i, const Vector3 &pos)
static void setLightColor (int i, const Color3 &c)
static Color3 getLightColor (int i)
static Vector4 getLightVector (int i)
static bool isValidLightIndex (int i)
static GLight getLight (int i)
static bool isRunningOnDesktop ()
static bool isRunningInCluster ()
static bool isFullScreen ()
static int getClusterNodeID ()

Member Enumeration Documentation


Member Function Documentation

static void IS3D::IS3DEngine::init ( int  argc,
char **  argv 
) [static]

Call this from your program to initialize the IS3D system.

static void IS3D::IS3DEngine::run ( ISApp app  )  [static]

Call this from your program after calling init() to start running an ISApp.

static void IS3D::IS3DEngine::createLog ( std::string  filename = std::string("log.txt")  )  [static]

Creates a log and stores a ptr to it, this is called automatically by init().

static void IS3D::IS3DEngine::loadConfigsFromArguments ( int  argc,
char **  argv,
bool  exitOnUnrecognizedArgument = true 
) [static]

This is called automatically by init(). Does command line argument parsing and load Config files and sets command line ConfigVals. You can safely call this yourself from a program that does not use IS3DEngine if you still want to react to command line arguments in the IS3DEngine way. Call IS3DEngine::createLog() first if you want ConfigMap warnings to go to the log.

static void IS3D::IS3DEngine::showHelpAndExit ( const std::string &  programName  )  [static]

static void IS3D::IS3DEngine::setHeadFrame ( CoordinateFrame  m  )  [inline, static]

User's head position and orientation.

static CoordinateFrame IS3D::IS3DEngine::getHeadFrame (  )  [inline, static]

static Vector3 IS3D::IS3DEngine::getHeadPos (  )  [inline, static]

static CoordinateFrame IS3D::IS3DEngine::getLeftEyeFrame (  )  [static]

static Vector3 IS3D::IS3DEngine::getLeftEyePos (  )  [static]

static CoordinateFrame IS3D::IS3DEngine::getRightEyeFrame (  )  [static]

static Vector3 IS3D::IS3DEngine::getRightEyePos (  )  [static]

static void IS3D::IS3DEngine::lockHeadFrame (  )  [inline, static]

This disables the setHeadFrame function, thereby disabling headtracking.

static void IS3D::IS3DEngine::unlockHeadFrame (  )  [inline, static]

This reenables the setHeadFrame function after it has been locked.

static CoordinateFrame IS3D::IS3DEngine::getCameraFrame (  )  [inline, static]

For desktop situations it makes more sense to think of a camera, rather than a head, but they are really at the same location.

static Vector3 IS3D::IS3DEngine::getCameraPos (  )  [inline, static]

static double IS3D::IS3DEngine::getSynchronizedTime (  )  [static]

When not in the Cave, this is the same as System::getLocalTime(), but when WallClock messages are received from the cluster synchronization code in the Cave, this returns the system time based on them. in seconds.

static void IS3D::IS3DEngine::setSynchronizedTime ( double  t  )  [inline, static]

static RenderDevice* IS3D::IS3DEngine::getRenderDevice (  )  [inline, static]

Access to G3D main stuff.

static Log* IS3D::IS3DEngine::getDebugLog (  )  [inline, static]

static VARAreaRef IS3D::IS3DEngine::getVarDynamic (  )  [inline, static]

static VARAreaRef IS3D::IS3DEngine::getVarStatic (  )  [inline, static]

static GFontRef IS3D::IS3DEngine::getFont (  )  [static]

static DebugDrawRef IS3D::IS3DEngine::getDebugDraw (  )  [static]

static void IS3D::IS3DEngine::setIOD ( double  iod  )  [inline, static]

Stereo: Interocular distance.

static double IS3D::IS3DEngine::getIOD (  )  [inline, static]

static void IS3D::IS3DEngine::toggleStereo (  )  [inline, static]

static Vector3 IS3D::IS3DEngine::getDisplayTopLeft (  )  [inline, static]

Corners of the image plane in world coordinates.

static Vector3 IS3D::IS3DEngine::getDisplayTopRight (  )  [inline, static]

static Vector3 IS3D::IS3DEngine::getDisplayBottomLeft (  )  [inline, static]

static Vector3 IS3D::IS3DEngine::getDisplayBottomRight (  )  [inline, static]

static Vector3 IS3D::IS3DEngine::getUpVector (  )  [inline, static]

static Vector3 IS3D::IS3DEngine::getForwardVector (  )  [inline, static]

static int IS3D::IS3DEngine::getDisplayHeightPixels (  )  [inline, static]

Size of the image plane in pixels.

static int IS3D::IS3DEngine::getDisplayWidthPixels (  )  [inline, static]

static int IS3D::IS3DEngine::getMaxScreenWidth (  )  [static]

Returns the maximum possible screen size for the current window system.

static int IS3D::IS3DEngine::getMaxScreenHeight (  )  [static]

static long IS3D::IS3DEngine::getFrameCount (  )  [inline, static]

Returns the number of frames since the application started.

static std::string IS3D::IS3DEngine::getG3DDataDir (  )  [static]

Returns path to the G3D data directory, this can be set from the ConfigVal G3DDataDir It defaults to $G/lib/G3D

static std::string IS3D::IS3DEngine::getIS3DDataDir (  )  [static]

Returns path to the IS3D data directory, this can be set from the ConfigVal IS3DDataDir It defaults to ../../data, which works for all the demos. If that doesn't exist, then it defaults to $G/lib/IS3D

static void IS3D::IS3DEngine::quit (  )  [static]

Shutsdown the application.

static void IS3D::IS3DEngine::runloop (  )  [static]

The main control loop.

static int IS3D::IS3DEngine::argc (  )  [inline, static]

static char** IS3D::IS3DEngine::argv (  )  [inline, static]

static void IS3D::IS3DEngine::printVARInfo (  )  [static]

static void IS3D::IS3DEngine::resetClippingPlanes ( double  nclip,
double  fclip 
) [static]

static double IS3D::IS3DEngine::getFarClip (  )  [inline, static]

static double IS3D::IS3DEngine::getNearClip (  )  [inline, static]

static bool IS3D::IS3DEngine::isLightOn ( int  i  )  [static]

static void IS3D::IS3DEngine::turnLightOff ( int  i  )  [static]

static void IS3D::IS3DEngine::turnLightOn ( int  i  )  [static]

static void IS3D::IS3DEngine::setLightPosition ( int  i,
const Vector3 &  pos 
) [static]

static void IS3D::IS3DEngine::setLightColor ( int  i,
const Color3 &  c 
) [static]

static Color3 IS3D::IS3DEngine::getLightColor ( int  i  )  [static]

static Vector4 IS3D::IS3DEngine::getLightVector ( int  i  )  [static]

static bool IS3D::IS3DEngine::isValidLightIndex ( int  i  )  [static]

static GLight IS3D::IS3DEngine::getLight ( int  i  )  [static]

static bool IS3D::IS3DEngine::isRunningOnDesktop (  )  [static]

static bool IS3D::IS3DEngine::isRunningInCluster (  )  [static]

static bool IS3D::IS3DEngine::isFullScreen (  )  [static]

static int IS3D::IS3DEngine::getClusterNodeID (  )  [static]

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

Generated on Wed Jan 26 06:31:20 2011 for IS3D by  doxygen 1.5.6