VRUT Namespace Reference

<Conflicts with glut.h when included after it More...


Classes

class  BaseApp
 Base application class. More...
class  CameraManipulator
 Module processing input events and applying them to camera. More...
class  FHSParser
 Class for parsing FHS files. More...
class  FHSWriter
 Class for writing FHS files. More...
class  IOFhsModule
 FHS import/export module class. More...
class  IOImageModule
 IMAGE import/export module class. More...
class  IOObjModule
 STL import/export module class. More...
class  OBJParser
 Class for parsing OBJ files. More...
class  OBJWriter
 Class for writing OBJ files. More...
class  IORdfModule
 RDF import/export module class. More...
class  RDFParser
 Class for parsing RDF files. More...
class  RDFWriter
 Class for writing RDF files. More...
class  IOStlModule
 STL import/export module class. More...
class  STLParser
 Class for parsing STL files. More...
class  STLWriter
 Class for writing STL files. More...
class  Optimize
 Module for scene optimization. More...
class  RenderGl
 FHS import/export module class. More...
class  BVH
 Bounding volume hierarchy. More...
class  BVHNode
 Data container for BVH node. More...
class  AABB
 AABB class. More...
class  BCone
 Bounding cone class. More...
class  BSphere
 Bounding sphere class. More...
class  Camera
 Camera scene graph node. More...
class  CameraModule
 Module processing input events and applying them to camera - abstract. More...
class  Console
 Console control window. More...
class  DropTarget
 Drag & drop handler. More...
class  Environment
 Environment for registered parameters management class. More...
class  EventHandler
 Central event handler for processing and distributing all events. More...
class  Event
 Event class encapsulating event IDs and helper methods. More...
class  FlexiLog
 Logging class with file and window output. More...
class  FrameRate
 Frame rate counting class. More...
class  GeneralManager
 Server managing any module that was created as general. More...
struct  RayIntersectionInfo
 Structure with pick data. More...
class  Geometry
 Base class for geometry representation - abstract. More...
class  GeometryNode
 SceneNode with geometry More...
class  GeometryTriangles
 Container for triangulated geometry. More...
class  GLWindow
 GL window class. More...
class  GUIEnvironment
 GUI managment for environment parameters. More...
class  Image
 Baseclass for image container - abstract. More...
class  ImageCommon
 Image container with support for many formats readable by wxImage. More...
class  ImageDDS
 Image container with support for many formats readable by wxImage. More...
class  Interpreter
 Command interpreter. More...
class  IOManager
 Server managing import/export modules. More...
class  IOModule
 Import/export type module - abstract. More...
class  Kernel
 Application kernel - singleton. More...
class  KernelModule
 Module with access to kernel. More...
struct  Light
 Light definition. More...
class  LightNode
 SceneNode with light definition More...
class  MainWindow
 Main window class. More...
class  ManipulatorManager
 Server managing all kinds of manipulator modules. More...
class  ManipulatorModule
 Module processing mouse and key input and manipulating object - abstract. More...
struct  Material
 Material definition. More...
class  MODULE_ID
 Unique module ID consisting of server type, module handle id and its instance id. More...
class  ModuleIdHash
 Hashing function for MODULE_ID. More...
class  ModuleIdEqual
 Comparison operator for MODULE_ID. More...
class  Module
 General type module - abstract. More...
class  ModuleThread
 Module thread. More...
class  ModuleHandle
 Data container and management of dynamic library with module instances. More...
class  Parameter
 Parameter data. More...
class  RenderGlModule
 Basic renderglmodule module class. More...
class  RenderManager
 Server managing rendering modules. More...
class  RenderModule
 Render type module - abstract. More...
class  ReadWriteMutex
 Multiple clients may read simultaneously but write access is exclusive. Recursive locking is possible with limitations. More...
class  ReadLocker
 Acquire lock for reading and release lock implicitly in scope. More...
class  WriteLocker
 Acquire lock for writing and release lock implicitly in scope. More...
class  Scene
 Scene data. More...
class  SceneManager
 Class for access and modifications of scene graphs. More...
class  SceneModule
 Module with access to scene manager. More...
class  SceneNode
 Scene node for scene graph. More...
class  ServerBase
 Server base class - abstract, template. More...
struct  ShaderParam
 Shader parameter. More...
struct  ShaderProgram
 Shader program data. More...
class  TextParser
 Class for support of parsing text files. More...
class  _general
 Add comment here for your module class. More...
class  _io
 Add comment here for your module class. More...
class  _manip
 Add comment here for your module class. More...
class  _render
 Add comment here for your module class. More...
class  _scene
 Add comment here for your module class. More...
struct  ChcNodeInfo
struct  NodeInfo
struct  QueryInfo
class  ChcRenderer
 Ray Tracer module - implements recursive ray tracing. More...
class  Collision_detection
 Module detecting collisions in scene. More...
class  IOVrmlModule
 FHS import/export module class. More...
class  VRMLParser
 Class for parsing VRML files. More...
class  VRMLWriter
 Class for export scene to VRML file. More...
class  Navigation
 Module processing input events and applying them to camera. More...
class  RayTracer
 Ray Tracer module - implements recursive ray tracing. More...
class  TriangleBvh
class  IOScriptingModule
 IO Scripting class. More...
class  JSEnvironment
 JavaScript Environment class. More...
struct  JSEventArgStruct
struct  JSEventStruct
 The structucture for defining events. More...
class  JSHandler
struct  JSMemoryStruct
struct  PrivateData
 Private data abstract class. More...
struct  SceneData
 Scene data class. More...
struct  NodeData
 Node data class. More...
struct  MatrixData
 Matrix data class. More...
struct  VectorData
 Vector data class. More...
struct  EventData
 Event data class. More...
struct  MemoryData
 Memory data class. More...
struct  ChunkData
 Event data class. More...
class  JSScriptingModule
 Scripting class. More...
class  ScriptException
 The script exception class. More...
class  SceneScriptException
class  NodeScriptException
class  ScriptNode
 The ScriptScene class accesses the Scene class. More...
class  ScriptScene
 The ScriptScene class accesses the Scene class. More...
class  ScriptSceneManager
 The class providing communication with the kernel. More...
class  PacketParser
 PacketParser class extends textParser to be ready for parsing DTrack -ASCII format UDP packet. More...
class  Tracking
 General class - agragation of parser and receiver. More...
class  TrackingManipulator
 Class processing events generated by Tracking module. More...

Typedefs

typedef unsigned short _SHORT_ID
 General ID type short.
typedef unsigned _ID
 General ID type.
typedef _ID NODE_ID
typedef _SHORT_ID RENDER_WINDOW_ID
typedef _SHORT_ID SCENE_ID
typedef _ID MATERIAL_ID
typedef _ID GEOMETRY_ID
typedef _SHORT_ID MODULE_HANDLE_ID
typedef _SHORT_ID MODULE_INSTANCE_ID
typedef void
CREATE_INSTANCE_FUNC_PROTO 
CREATE_INSTANCE_FUNC_ARGS
typedef void
RELEASE_INSTANCE_FUNC_PROTO 
RELEASE_INSTANCE_FUNC_ARGS
typedef std::pair< Module
*, MODULE_INSTANCE_ID
ModulePair
typedef std::vector< ModulePairModuleList
typedef std::queue< Body * > bodyqueue

Enumerations

enum  WX_ID {
  ID_MainWin_Quit = wxID_HIGHEST + 1, ID_MainWin_About, ID_MainWin_LogDisable, ID_MainWin_LogError,
  ID_MainWin_LogWarning, ID_MainWin_LogMessage, ID_MainWin_LogAll, ID_MainWin_View_Status,
  ID_MainWin_View_Console, ID_MainWin_View_Log, ID_MainWin_View_RenderNotebook, ID_MainWin_View_Parameters
}
 Unique widget IDs. More...
enum  SERVER_ID {
  MANIP_MANAGER = 1, IO_MANAGER = 2, RENDER_MANAGER = 3, GENERAL_MANAGER = 4,
  SERVER_ID_NONE = 0xf
}
 Server type enum. More...
enum  MODULE_TYPE {
  MODULE_TYPE_IO = 0x01, MODULE_TYPE_SCENE = 0x02, MODULE_TYPE_RENDER = 0x04, MODULE_TYPE_MANIPULATOR = 0x08,
  MODULE_TYPE_CAMERA = 0x10, MODULE_TYPE_KERNEL = 0x11
}
 Module types - server can manage more than 1 module type. More...
enum  JSEVT_PARAM_TYPE {
  JSEVT_NULL, JSEVT_BOOL, JSEVT_INT, JSEVT_MODULE_ID,
  JSEVT_RENDER_WINDOW_ID, JSEVT_SCENE_ID, JSEVT_NODE_ID, JSEVT_STRING,
  JSEVT_MEMORY
}
 The types of parameters for JS Events. More...
enum  JSMEM_TYPE { JSMEM_INT = 1, JSMEM_FLOAT, JSMEM_MATRIX, JSMEM_NULL }
 The memory types. More...

Functions

void runToolkitTest ()

Variables

const int MODULE_VERSION = 1
 Module version number.
const wxString SERVER_CLASS_NAMES []
 Class names of different servers.
const wxString MODULE_PATHS []
 Paths to modules from different servers - server has all its module in 1 place (excluding GeneralManager).
const int MODULES_VER_SUPP = 1
 Only modules with same version are supported.
const NODE_ID NODE_ID_NONE = (NODE_ID)~(NODE_ID(0))
 Invalid scene node.
const RENDER_WINDOW_ID RENDER_WINDOW_ID_NONE = (RENDER_WINDOW_ID)~(RENDER_WINDOW_ID(0))
 Invalid render window ID.
const SCENE_ID SCENE_ID_NONE = (SCENE_ID)~(SCENE_ID(0))
 Invalid scene ID.
const MATERIAL_ID MATERIAL_ID_NONE = (MATERIAL_ID)~(MATERIAL_ID(0))
 Invalid material ID.
const GEOMETRY_ID GEOMETRY_ID_NONE = (GEOMETRY_ID)~(GEOMETRY_ID(0))
 Invalid geometry ID.
const MODULE_HANDLE_ID MODULE_HANDLE_ID_NONE = (MODULE_HANDLE_ID)~(MODULE_HANDLE_ID(0))
 Invalid module handle ID.
const MODULE_INSTANCE_ID MODULE_INSTANCE_ID_NONE = (MODULE_INSTANCE_ID)~(MODULE_INSTANCE_ID(0))
 Invalid module instance ID.
const MODULE_ID MODULE_ID_NONE (SERVER_ID_NONE, MODULE_HANDLE_ID_NONE, MODULE_INSTANCE_ID_NONE)
 Invalid module ID.


Detailed Description

<Conflicts with glut.h when included after it

Replace all instances of 'optimize' with your new project name

Replace all instances of '_general' with your new project name

Replace all instances of '_io' with your new project name

Replace all instances of '_manip' with your new project name

Replace all instances of '_render' with your new project name

Replace all instances of '_scene' with your new project name

Description : Reads and writes VRML files Author : Hana Truskova truskh1@fel.cvut.cz

Purpose : IParser for VRML files.


Typedef Documentation

typedef unsigned VRUT::_ID

General ID type.

Definition at line 70 of file moddefs.h.

typedef unsigned short VRUT::_SHORT_ID

General ID type short.

Definition at line 68 of file moddefs.h.

typedef std::queue< Body * > VRUT::bodyqueue

Definition at line 13 of file pparser.h.

typedef void CREATE_INSTANCE_FUNC_PROTO VRUT::CREATE_INSTANCE_FUNC_ARGS

Definition at line 321 of file module.h.

Definition at line 92 of file moddefs.h.

Definition at line 88 of file moddefs.h.

Definition at line 96 of file moddefs.h.

Definition at line 100 of file moddefs.h.

typedef std::vector<ModulePair> VRUT::ModuleList

Definition at line 35 of file modulehandle.h.

Definition at line 32 of file modulehandle.h.

typedef _ID VRUT::NODE_ID

Definition at line 76 of file moddefs.h.

typedef void RELEASE_INSTANCE_FUNC_PROTO VRUT::RELEASE_INSTANCE_FUNC_ARGS

Definition at line 322 of file module.h.

Definition at line 80 of file moddefs.h.

Definition at line 84 of file moddefs.h.


Enumeration Type Documentation

The types of parameters for JS Events.

Enumerator:
JSEVT_NULL 
JSEVT_BOOL 
JSEVT_INT 
JSEVT_MODULE_ID 
JSEVT_RENDER_WINDOW_ID 
JSEVT_SCENE_ID 
JSEVT_NODE_ID 
JSEVT_STRING 
JSEVT_MEMORY 

Definition at line 15 of file jsevents.h.

00015                              {
00016               JSEVT_NULL,
00017               JSEVT_BOOL,
00018               JSEVT_INT,
00019               JSEVT_MODULE_ID,
00020               JSEVT_RENDER_WINDOW_ID,
00021               JSEVT_SCENE_ID,
00022               JSEVT_NODE_ID,
00023               JSEVT_STRING,
00024               JSEVT_MEMORY
00025        };

The memory types.

Enumerator:
JSMEM_INT 
JSMEM_FLOAT 
JSMEM_MATRIX 
JSMEM_NULL 

Definition at line 15 of file jsmemory.h.

00015                        {
00016               JSMEM_INT = 1,
00017               JSMEM_FLOAT,
00018               JSMEM_MATRIX,
00019               JSMEM_NULL
00020        };

Module types - server can manage more than 1 module type.

Enumerator:
MODULE_TYPE_IO  Scene import/export module.
MODULE_TYPE_SCENE  Scene access module.
MODULE_TYPE_RENDER  Render module.
MODULE_TYPE_MANIPULATOR  Manipulator module.
MODULE_TYPE_CAMERA  Camera manipulator module.
MODULE_TYPE_KERNEL  Kernel access module.

Definition at line 54 of file moddefs.h.

00055        {
00056               MODULE_TYPE_IO           = 0x01,  
00057               MODULE_TYPE_SCENE        = 0x02,  
00058               MODULE_TYPE_RENDER       = 0x04,  
00059               MODULE_TYPE_MANIPULATOR  = 0x08,  
00060               MODULE_TYPE_CAMERA       = 0x10,  
00061               MODULE_TYPE_KERNEL       = 0x11   
00062        };

Server type enum.

Enumerator:
MANIP_MANAGER  Manipulator manager.
IO_MANAGER  IO manager.
RENDER_MANAGER  Render manager.
GENERAL_MANAGER  General manager.
SERVER_ID_NONE  No server.

Definition at line 24 of file moddefs.h.

00025        {
00026               MANIP_MANAGER   = 1,  
00027               IO_MANAGER      = 2,  
00028               RENDER_MANAGER  = 3,  
00029               GENERAL_MANAGER = 4,  
00030               SERVER_ID_NONE  = 0xf 
00031        };

Unique widget IDs.

Enumerator:
ID_MainWin_Quit 
ID_MainWin_About 
ID_MainWin_LogDisable 
ID_MainWin_LogError 
ID_MainWin_LogWarning 
ID_MainWin_LogMessage 
ID_MainWin_LogAll 
ID_MainWin_View_Status 
ID_MainWin_View_Console 
ID_MainWin_View_Log 
ID_MainWin_View_RenderNotebook 
ID_MainWin_View_Parameters 

Definition at line 20 of file basedefs.h.


Function Documentation

void VRUT::runToolkitTest (  ) 


Variable Documentation

Invalid geometry ID.

Definition at line 94 of file moddefs.h.

Invalid material ID.

Definition at line 90 of file moddefs.h.

Invalid module handle ID.

Definition at line 98 of file moddefs.h.

Invalid module ID.

Invalid module instance ID.

Definition at line 102 of file moddefs.h.

const wxString VRUT::MODULE_PATHS[]

Initial value:

       {
              wxEmptyString,
              wxT("modules/manip"),
              wxT("modules/io"),
              wxT("modules/render"),
              wxT("modules")
       }
Paths to modules from different servers - server has all its module in 1 place (excluding GeneralManager).

Definition at line 44 of file moddefs.h.

const int VRUT::MODULE_VERSION = 1

Module version number.

Module version number - must be the same as main app version.

Definition at line 21 of file cameramanipulator.h.

const int VRUT::MODULES_VER_SUPP = 1

Only modules with same version are supported.

Definition at line 65 of file moddefs.h.

Invalid scene node.

Definition at line 78 of file moddefs.h.

Invalid render window ID.

Definition at line 82 of file moddefs.h.

Invalid scene ID.

Definition at line 86 of file moddefs.h.

const wxString VRUT::SERVER_CLASS_NAMES[]

Initial value:

       {
              wxEmptyString,
              wxT("<EventManager>"),
              wxT("<IOManager>"),
              wxT("<RenderManager>"),
              wxT("<GeneralManager>")
       }
Class names of different servers.

Definition at line 34 of file moddefs.h.


Generated on Tue Mar 10 14:41:40 2009 for VRUT by  doxygen 1.5.5