TITLE

AUTHOR
Version 0.1.2 2006-07-10
CREATEDATE

Table of Contents

Table of contents

OpenArena Namespace Index
OpenArena Namespace List
Here is a list of all namespaces with brief descriptions:OpenArena  	pagenum
std  	pagenum

OpenArena Hierarchical Index
OpenArena Class Hierarchy
This inheritance list is sorted roughly, but not completely, alphabetically:OpenArena::BITMAP_HEADER	pagenum
OpenArena::BITMAP_INFO	pagenum
OpenArena::BITMAP_QUAD	pagenum
OpenArena::Camera	pagenum
OpenArena::ControlScheme	pagenum
OpenArena::Font	pagenum
OpenArena::Image	pagenum
OpenArena::Level	pagenum
OpenArena::list< ItemType >	pagenum
OpenArena::listNode< ItemType >	pagenum
OpenArena::Logger	pagenum
OpenArena::WindowsLogger	pagenum
OpenArena::Player	pagenum
OpenArena::Plugin	pagenum
OpenArena::VideoPlugin	pagenum
OpenArena::NullVideoPlugin	pagenum
OpenArena::PluginManager	pagenum
OpenArena::Screen	pagenum
OpenArena::Window	pagenum
OpenArena::Texture	pagenum
OpenArena::TextureImage	pagenum
OpenArena::TGA	pagenum
OpenArena::TGAHeader	pagenum
OpenArena::Triangle	pagenum
OpenArena::Vec2f	pagenum
OpenArena::Vec2i	pagenum
OpenArena::Vec3d	pagenum
OpenArena::Window::Initializer	pagenum
OpenArena::Window::Resizer	pagenum

OpenArena Class Index
OpenArena Class List
Here are the classes, structs, unions and interfaces with brief descriptions:
OpenArena::BITMAP_HEADER  	pagenum
OpenArena::BITMAP_INFO  	pagenum
OpenArena::BITMAP_QUAD  	pagenum
OpenArena::Camera (The Camera class represents a camera or view in 3-dimensional space ) 	pagenum
OpenArena::ControlScheme (This class represents a user's control scheme ) 	pagenum
OpenArena::Font (Write brief comment for Font here ) 	pagenum
OpenArena::Image (Write brief comment for Image here ) 	pagenum
OpenArena::Level  	pagenum
OpenArena::list< ItemType > (Write brief comment for list here ) 	pagenum
OpenArena::listNode< ItemType > (Write brief comment for listNode here ) 	pagenum
OpenArena::Logger (Write brief comment for Logger here ) 	pagenum
OpenArena::NullVideoPlugin (Write brief comment for NullVideoPlugin here ) 	pagenum
OpenArena::Player (Write brief comment for Player here ) 	pagenum
OpenArena::Plugin (Write brief comment for Plugin here ) 	pagenum
OpenArena::PluginManager (Write brief comment for PluginManager here ) 	pagenum
OpenArena::Screen (Write brief comment for Screen here ) 	pagenum
OpenArena::Texture (Write brief comment for Texture here ) 	pagenum
OpenArena::TextureImage (Write brief comment for TextureImage here ) 	pagenum
OpenArena::TGA (Write brief comment for TGA here ) 	pagenum
OpenArena::TGAHeader (Write brief comment for TGAHeader here ) 	pagenum
OpenArena::Triangle (Write brief comment for Triangle here ) 	pagenum
OpenArena::Vec2f (Write brief comment for Vec2f here ) 	pagenum
OpenArena::Vec2i (Write brief comment for Vec2i here ) 	pagenum
OpenArena::Vec3d (Write brief comment for Vec3d here ) 	pagenum
OpenArena::VideoPlugin (Write brief comment for VideoPlugin here ) 	pagenum
OpenArena::Window (Write brief comment for Window here ) 	pagenum
OpenArena::Window::Initializer (Write brief comment for Initializer here ) 	pagenum
OpenArena::Window::Resizer (Write brief comment for Resizer here ) 	pagenum
OpenArena::WindowsLogger (Write brief comment for WindowsLogger here ) 	pagenum

OpenArena File Index
OpenArena File List
Here is a list of all files with brief descriptions:
src/bmp.cpp  	pagenum
src/bmp.h  	pagenum
src/camera.cpp  	pagenum
src/camera.h  	pagenum
src/ctrls.cpp  	pagenum
src/ctrls.h  	pagenum
src/datatypes.h  	pagenum
src/geometry.h  	pagenum
src/image.h  	pagenum
src/keys.cpp  	pagenum
src/keys.h  	pagenum
src/level.cpp  	pagenum
src/level.h  	pagenum
src/linux.cpp  	pagenum
src/list.h  	pagenum
src/Logger.h  	pagenum
src/macosx.cpp  	pagenum
src/main.h  	pagenum
src/mydefs.h  	pagenum
src/mygl.cpp  	pagenum
src/mygl.h  	pagenum
src/myglFont.cpp  	pagenum
src/myglFont.h  	pagenum
src/myglTexture.cpp  	pagenum
src/myglTexture.h  	pagenum
src/NullVideoPlugin.cpp  	pagenum
src/NullVideoPlugin.h  	pagenum
src/player.cpp  	pagenum
src/player.h  	pagenum
src/Plugin.h  	pagenum
src/PluginManager.cpp  	pagenum
src/PluginManager.h  	pagenum
src/screen.cpp  	pagenum
src/screen.h  	pagenum
src/strmanip.cpp  	pagenum
src/strmanip.h  	pagenum
src/texture.h  	pagenum
src/tga.cpp  	pagenum
src/tga.h  	pagenum
src/vector.cpp  	pagenum
src/vector.h  	pagenum
src/version.h  	pagenum
src/VideoPlugin.h  	pagenum
src/window.cpp  	pagenum
src/window.h  	pagenum
src/windows.cpp  	pagenum
src/WindowsLogger.cpp  	pagenum
src/WindowsLogger.h  	pagenum
src/worlddefs.h  	pagenum

OpenArena Namespace Documentation
OpenArena Namespace Reference

Classes
struct BITMAP_HEADER
struct BITMAP_INFO
struct BITMAP_QUAD
class Camera
The Camera class represents a camera or view in 3-dimensional space. 

class ControlScheme
This class represents a user's control scheme. 

class Triangle
Write brief comment for Triangle here. 

class Image
Write brief comment for Image here. 

class Level
class listNode
Write brief comment for listNode here. 

class list
Write brief comment for list here. 

class Logger
Write brief comment for Logger here. 

class Font
Write brief comment for Font here. 

class Texture
Write brief comment for Texture here. 

class NullVideoPlugin
Write brief comment for NullVideoPlugin here. 

class Player
Write brief comment for Player here. 

class Plugin
Write brief comment for Plugin here. 

class PluginManager
Write brief comment for PluginManager here. 

class Screen
Write brief comment for Screen here. 

class TextureImage
Write brief comment for TextureImage here. 

struct TGAHeader
Write brief comment for TGAHeader here. 

struct TGA
Write brief comment for TGA here. 

class Vec3d
Write brief comment for Vec3d here. 

class Vec2f
Write brief comment for Vec2f here. 

class Vec2i
Write brief comment for Vec2i here. 

class VideoPlugin
Write brief comment for VideoPlugin here. 

class Window
Write brief comment for Window here. 

class WindowsLogger
Write brief comment for WindowsLogger here. 

Typedefs
typedef unsigned int LIST_ARRAY_INDEX_TYPE
typedef Vec3d Vec3f
Enumerations
enum Keys { KEY_UNKNOWN =  0, KEY_BUTTON0, KEY_BUTTON1, KEY_BUTTON2, KEY_BUTTON3, KEY_BUTTON4, KEY_LEFT, KEY_RIGHT, KEY_UP, KEY_DOWN, KEY_SPACE, KEY_RETURN, KEY_SHIFT, KEY_PAUSE, KEY_CONTROL, KEY_CAPITAL, KEY_ESCAPE, KEY_PRIOR, KEY_NEXT, KEY_END, KEY_HOME, KEY_INSERT, KEY_DELETE, KEY_LWIN, KEY_RWIN, KEY_APPS, KEY_NUMPAD0, KEY_NUMPAD1, KEY_NUMPAD2, KEY_NUMPAD3, KEY_NUMPAD4, KEY_NUMPAD5, KEY_NUMPAD6, KEY_NUMPAD7, KEY_NUMPAD8, KEY_NUMPAD9, KEY_MULTIPLY, KEY_ADD, KEY_SUBTRACT, KEY_DIVIDE, KEY_F1, KEY_F2, KEY_F3, KEY_F4, KEY_F5, KEY_F6, KEY_F7, KEY_F8, KEY_F9, KEY_F10, KEY_F11, KEY_F12, KEY_NUMLOCK, KEY_SCROLL, KEY_SEPARATOR, KEY_OEM_1, KEY_OEM_2, KEY_OEM_3, KEY_OEM_4, KEY_OEM_5, KEY_OEM_6, KEY_OEM_7, KEY_OEM_PERIOD, KEY_OEM_PLUS, KEY_OEM_MINUS, KEY_OEM_COMMA, KEY_BACK, KEY_TAB, KEY_0, KEY_1, KEY_2, KEY_3, KEY_4, KEY_5, KEY_6, KEY_7, KEY_8, KEY_9, KEY_A, KEY_B, KEY_C, KEY_D, KEY_E, KEY_F, KEY_G, KEY_H, KEY_I, KEY_J, KEY_K, KEY_L, KEY_M, KEY_N, KEY_O, KEY_P, KEY_Q, KEY_R, KEY_S, KEY_T, KEY_U, KEY_V, KEY_W, KEY_X, KEY_Y, KEY_Z }
Write brief comment for Keys here. 

enum { GL_MY_TEXTURE_CONSOLEBACKGROUND = 0, NUM_MENU_TEXTURES }
Write brief comment for GL_MY_TEXTURE_CONSOLEBACKGROUND here. 

Functions
void PrintBMPHeader (BITMAP_HEADER header)
void PrintBMPInfo (BITMAP_INFO info)
TextureImage * LoadBMP (const char *Filename)
Loads a bitmap (*.bmp) file and returns a pointer to a TextureImage object. 

char KeyToASCII (Keys key, bool shift)
Write brief comment for KeyToASCII here. 

void FreeGLTexture (GLuint &)
Write brief comment for FreeGLTexture here. 

bool LoadGLTexture (string, GLuint &, GLuint=GL_LINEAR, GLuint=GL_LINEAR)
Write brief comment for LoadGLTexture here. 

TextureImage * LoadTGA (const char *filename)
Write brief comment for LoadTGA here. 

TextureImage * LoadUncompressedTGA (FILE *fTGA)
TextureImage * LoadCompressedTGA (FILE *fTGA)
Vec3d Vector (double, double)
Write brief comment for Vector here. 

Variables
const Keys KEY_LBUTTON = KEY_BUTTON0
Write brief comment for KEY_LBUTTON here. 

const Keys KEY_RBUTTON = KEY_BUTTON1
Write brief comment for KEY_RBUTTON here. 

const Keys KEY_MBUTTON = KEY_BUTTON2
Write brief comment for KEY_MBUTTON here. 

const float piover180 = 0.0174532925f
Write brief comment for piover180 here. 

const string DEFAULT_TEXTURE_NAME = "oa/textures/default.bmp"
Write brief comment for DEFAULT_TEXTURE_NAME here. 

const unsigned int MAX_CONSOLE_LINES = 30
Write brief comment for MAX_CONSOLE_LINES here. 

const unsigned int MAX_CONSOLE_HISTORY_LINES = MAX_CONSOLE_LINES + 20
Write brief comment for MAX_CONSOLE_HISTORY_LINES here. 

const unsigned int MAX_CONSOLE_OUTPUT_LINES = MAX_CONSOLE_LINES
Write brief comment for MAX_CONSOLE_OUTPUT_LINES here. 

const unsigned int MAX_OUTPUT_TEXT_LINES = 4
Write brief comment for MAX_OUTPUT_TEXT_LINES here. 

const GLubyte uTGAcompare [12] = {0,0,2, 0,0,0,0,0,0,0,0,0}
const GLubyte cTGAcompare [12] = {0,0,10,0,0,0,0,0,0,0,0,0}

Detailed Description
<File comment goes here!!>
Copyright (c) 2005 by Tom Hicks tomhicks@olympusonline.net 

Typedef Documentation
typedef unsigned int OpenArena::LIST_ARRAY_INDEX_TYPE
typedef Vec3d OpenArena::Vec3f

Enumeration Type Documentation
enum OpenArena::Keys
Write brief comment for Keys here. 

Write detailed description for Keys here.
Remarks:
Write remarks for Keys here.
See also:
Separate items with the '|' character. 

Enumerator: 
KEY_UNKNOWN  
KEY_BUTTON0  
KEY_BUTTON1  
KEY_BUTTON2  
KEY_BUTTON3  
KEY_BUTTON4  
KEY_LEFT  
KEY_RIGHT  
KEY_UP  
KEY_DOWN  
KEY_SPACE  
KEY_RETURN  
KEY_SHIFT  
KEY_PAUSE  
KEY_CONTROL  
KEY_CAPITAL  
KEY_ESCAPE  
KEY_PRIOR  
KEY_NEXT  
KEY_END  
KEY_HOME  
KEY_INSERT  
KEY_DELETE  
KEY_LWIN  
KEY_RWIN  
KEY_APPS  
KEY_NUMPAD0  
KEY_NUMPAD1  
KEY_NUMPAD2  
KEY_NUMPAD3  
KEY_NUMPAD4  
KEY_NUMPAD5  
KEY_NUMPAD6  
KEY_NUMPAD7  
KEY_NUMPAD8  
KEY_NUMPAD9  
KEY_MULTIPLY  
KEY_ADD  
KEY_SUBTRACT  
KEY_DIVIDE  
KEY_F1  
KEY_F2  
KEY_F3  
KEY_F4  
KEY_F5  
KEY_F6  
KEY_F7  
KEY_F8  
KEY_F9  
KEY_F10  
KEY_F11  
KEY_F12  
KEY_NUMLOCK  
KEY_SCROLL  
KEY_SEPARATOR  
KEY_OEM_1  
KEY_OEM_2  
KEY_OEM_3  
KEY_OEM_4  
KEY_OEM_5  
KEY_OEM_6  
KEY_OEM_7  
KEY_OEM_PERIOD  
KEY_OEM_PLUS  
KEY_OEM_MINUS  
KEY_OEM_COMMA  
KEY_BACK  
KEY_TAB  
KEY_0  
KEY_1  
KEY_2  
KEY_3  
KEY_4  
KEY_5  
KEY_6  
KEY_7  
KEY_8  
KEY_9  
KEY_A  
KEY_B  
KEY_C  
KEY_D  
KEY_E  
KEY_F  
KEY_G  
KEY_H  
KEY_I  
KEY_J  
KEY_K  
KEY_L  
KEY_M  
KEY_N  
KEY_O  
KEY_P  
KEY_Q  
KEY_R  
KEY_S  
KEY_T  
KEY_U  
KEY_V  
KEY_W  
KEY_X  
KEY_Y  
KEY_Z  
anonymous enum
Write brief comment for GL_MY_TEXTURE_CONSOLEBACKGROUND here. 

Enumerator: 
GL_MY_TEXTURE_CONSOLEBACKGROUND  
NUM_MENU_TEXTURES  

Function Documentation
void OpenArena::PrintBMPHeader (BITMAP_HEADER header)
void OpenArena::PrintBMPInfo (BITMAP_INFO info)
TextureImage * OpenArena::LoadBMP (const char * Filename)
Loads a bitmap (*.bmp) file and returns a pointer to a TextureImage object. 

Parameters:
filename The path to the file to open.
Returns:
A pointer to the created TextureImage object.
Remarks:
Will be replaced with an actual class soon
See also:

char OpenArena::KeyToASCII (Keys key, bool shift)
Write brief comment for KeyToASCII here. 

Parameters:
key Description of parameter key.
shift Description of parameter shift.
Returns:
Write description of return value here.
Exceptions:
<exception class> Description of criteria for throwing this exception.
Write detailed description for KeyToASCII here.
Remarks:
Write remarks for KeyToASCII here.
See also:
Separate items with the '|' character. 
void OpenArena::FreeGLTexture (GLuint &)
Write brief comment for FreeGLTexture here. 

Parameters:
Description of parameter .
Exceptions:
<exception class> Description of criteria for throwing this exception.
Write detailed description for FreeGLTexture here.
Remarks:
Write remarks for FreeGLTexture here.
See also:
Separate items with the '|' character. 
bool OpenArena::LoadGLTexture (string, GLuint &, GLuint = GL_LINEAR, GLuint = GL_LINEAR)
Write brief comment for LoadGLTexture here. 

Parameters:
Description of parameter .
Description of parameter .
Description of parameter .
Description of parameter .
Returns:
Write description of return value here.
Exceptions:
<exception class> Description of criteria for throwing this exception.
Write detailed description for LoadGLTexture here.
Remarks:
Write remarks for LoadGLTexture here.
See also:
Separate items with the '|' character. 
TextureImage * OpenArena::LoadTGA (const char * filename)
Write brief comment for LoadTGA here. 

Parameters:
filename Description of parameter filename.
Returns:
Write description of return value here.
Exceptions:
<exception class> Description of criteria for throwing this exception.
Write detailed description for LoadTGA here.
Remarks:
Write remarks for LoadTGA here.
See also:
Separate items with the '|' character. 
TextureImage * OpenArena::LoadUncompressedTGA (FILE * fTGA)
TextureImage * OpenArena::LoadCompressedTGA (FILE * fTGA)
Vec3d OpenArena::Vector (double, double)
Write brief comment for Vector here. 

Parameters:
Description of parameter .
Description of parameter .
Returns:
Write description of return value here.
Exceptions:
<exception class> Description of criteria for throwing this exception.
Write detailed description for Vector here.
Remarks:
Write remarks for Vector here.
See also:
Separate items with the '|' character. 

Variable Documentation
const Keys OpenArena::KEY_LBUTTON = KEY_BUTTON0
Write brief comment for KEY_LBUTTON here. 

Write detailed description for KEY_LBUTTON here.
Remarks:
Write remarks for KEY_LBUTTON here.
See also:
Separate items with the '|' character. 
const Keys OpenArena::KEY_RBUTTON = KEY_BUTTON1
Write brief comment for KEY_RBUTTON here. 

Write detailed description for KEY_RBUTTON here.
Remarks:
Write remarks for KEY_RBUTTON here.
See also:
Separate items with the '|' character. 
const Keys OpenArena::KEY_MBUTTON = KEY_BUTTON2
Write brief comment for KEY_MBUTTON here. 

Write detailed description for KEY_MBUTTON here.
Remarks:
Write remarks for KEY_MBUTTON here.
See also:
Separate items with the '|' character. 
const float OpenArena::piover180 = 0.0174532925f
Write brief comment for piover180 here. 

Write detailed description for piover180 here.
Remarks:
Write remarks for piover180 here.
See also:
Separate items with the '|' character. 
const string OpenArena::DEFAULT_TEXTURE_NAME = "oa/textures/default.bmp"
Write brief comment for DEFAULT_TEXTURE_NAME here. 

Write detailed description for DEFAULT_TEXTURE_NAME here.
Remarks:
Write remarks for DEFAULT_TEXTURE_NAME here.
See also:
Separate items with the '|' character. 
const unsigned int OpenArena::MAX_CONSOLE_LINES = 30
Write brief comment for MAX_CONSOLE_LINES here. 

Write detailed description for MAX_CONSOLE_LINES here.
Remarks:
Write remarks for MAX_CONSOLE_LINES here.
See also:
Separate items with the '|' character. 
const unsigned int OpenArena::MAX_CONSOLE_HISTORY_LINES = MAX_CONSOLE_LINES + 20
Write brief comment for MAX_CONSOLE_HISTORY_LINES here. 

Write detailed description for MAX_CONSOLE_HISTORY_LINES here.
Remarks:
Write remarks for MAX_CONSOLE_HISTORY_LINES here.
See also:
Separate items with the '|' character. 
const unsigned int OpenArena::MAX_CONSOLE_OUTPUT_LINES = MAX_CONSOLE_LINES
Write brief comment for MAX_CONSOLE_OUTPUT_LINES here. 

Write detailed description for MAX_CONSOLE_OUTPUT_LINES here.
Remarks:
Write remarks for MAX_CONSOLE_OUTPUT_LINES here.
See also:
Separate items with the '|' character. 
const unsigned int OpenArena::MAX_OUTPUT_TEXT_LINES = 4
Write brief comment for MAX_OUTPUT_TEXT_LINES here. 

Write detailed description for MAX_OUTPUT_TEXT_LINES here.
Remarks:
Write remarks for MAX_OUTPUT_TEXT_LINES here.
See also:
Separate items with the '|' character. 
const GLubyte OpenArena::uTGAcompare[12] = {0,0,2, 0,0,0,0,0,0,0,0,0}
const GLubyte OpenArena::cTGAcompare[12] = {0,0,10,0,0,0,0,0,0,0,0,0}

std Namespace Reference

OpenArena Class Documentation
OpenArena::BITMAP_HEADER Struct Reference
Public Attributes
uint16 type
uint32 size
uint16 reserved1
uint16 reserved2
uint32 offset

Member Data Documentation
uint32 OpenArena::BITMAP_HEADER::offset
uint16 OpenArena::BITMAP_HEADER::reserved1
uint16 OpenArena::BITMAP_HEADER::reserved2
uint32 OpenArena::BITMAP_HEADER::size
uint16 OpenArena::BITMAP_HEADER::type

The documentation for this struct was generated from the following file:
src/bmp.cpp

OpenArena::BITMAP_INFO Struct Reference
Public Attributes
uint32 size
uint32 width
uint32 height
uint16 planes
uint16 bitCount
uint32 compression
uint32 sizeImage
uint32 xPelsPerMeter
uint32 yPelsPerMeter
uint32 clrUsed
uint32 clrImportant

Member Data Documentation
uint16 OpenArena::BITMAP_INFO::bitCount
uint32 OpenArena::BITMAP_INFO::clrImportant
uint32 OpenArena::BITMAP_INFO::clrUsed
uint32 OpenArena::BITMAP_INFO::compression
uint32 OpenArena::BITMAP_INFO::height
uint16 OpenArena::BITMAP_INFO::planes
uint32 OpenArena::BITMAP_INFO::size
uint32 OpenArena::BITMAP_INFO::sizeImage
uint32 OpenArena::BITMAP_INFO::width
uint32 OpenArena::BITMAP_INFO::xPelsPerMeter
uint32 OpenArena::BITMAP_INFO::yPelsPerMeter

The documentation for this struct was generated from the following file:
src/bmp.cpp

OpenArena::BITMAP_QUAD Struct Reference
Public Attributes
uint8 blue
uint8 green
uint8 red
uint8 reserved

Member Data Documentation
uint8 OpenArena::BITMAP_QUAD::blue
uint8 OpenArena::BITMAP_QUAD::green
uint8 OpenArena::BITMAP_QUAD::red
uint8 OpenArena::BITMAP_QUAD::reserved

The documentation for this struct was generated from the following file:
src/bmp.cpp

OpenArena::Camera Class Reference
The Camera class represents a camera or view in 3-dimensional space. 
 #include <camera.h>
Public Member Functions
Camera ()
Creates a new Camera object. 

Vec3f Position ()
Returns this Camera's position. 

Vec3d View ()
Returns the view vector of this camera. 

Vec3d UpVector ()
Returns a vector pointing up with respect to the view. 

Vec3d Strafe ()
Returns this Camera's strafe vector. 

void PositionCamera (double xpos, double ypos, double zpos, double xview, double yview, double zview, double xup, double yup, double zup)
Relocates and reorients this Camera. 

void PositionCamera (Vec3d pos, Vec3d view, Vec3d up)
Relocates and reorients this Camera. 

void RotateView (double angle, Vec3d axis)
Rotates the camera a given ammount around a given axis. 

void RotateView (double angle, double X, double Y, double Z)
Rotates the camera a given ammount around a given axis. 

void SetViewByMouse (Window window)
Updates the view and up vectors based on mouse movement. 

void StrafeCamera (double speed)
Moves the camera along its strafe axis a given distance. 

void MoveCamera (double speed)
Moves the camera along its view vector a given number of units. 

void Update ()
Recalculates the strafe vector. 

void Look ()
Calls gluLookAt to tell OpenGL where to render from. 

void RotateHorizontal (float angle)
Write brief comment for RotateHorizontal here. 

void RotateVertical (float angle)
Write brief comment for RotateVertical here. 

Private Member Functions
Vec3f GetUpVector ()
Write brief comment for GetUpVector here. 

Vec3f GetRightVector ()
Write brief comment for GetRightVector here. 

Vec3f GetForwardVector ()
Write brief comment for GetForwardVector here. 

void UpdateVectors ()
Private Attributes
Vec3f m_vPosition
Vec3f m_vView
Vec3f m_vUpVector
Vec3f m_vStrafe

Detailed Description
The Camera class represents a camera or view in 3-dimensional space. 

The Camera class maintains location, view, and orientation (up view) vectors. The Camera can be moved and rotated in any direction. It includes a wrapper, Look(), for gluLookAt.
Remarks:

See also:

Constructor & Destructor Documentation
OpenArena::Camera::Camera ()
Creates a new Camera object. 

Creates a new Camera object located at the origin, pointing at the negative z-axis with up being the positive y-axis. 

Member Function Documentation
Vec3f OpenArena::Camera::GetForwardVector () [private]
Write brief comment for GetForwardVector here. 

Returns:
Write description of return value here.
Exceptions:
<exception class> Description of criteria for throwing this exception.
Write detailed description for GetForwardVector here.
Remarks:
Write remarks for GetForwardVector here.
See also:
Separate items with the '|' character. 
Vec3f OpenArena::Camera::GetRightVector () [private]
Write brief comment for GetRightVector here. 

Returns:
Write description of return value here.
Exceptions:
<exception class> Description of criteria for throwing this exception.
Write detailed description for GetRightVector here.
Remarks:
Write remarks for GetRightVector here.
See also:
Separate items with the '|' character. 
Vec3f OpenArena::Camera::GetUpVector () [private]
Write brief comment for GetUpVector here. 

Returns:
Write description of return value here.
Exceptions:
<exception class> Description of criteria for throwing this exception.
Write detailed description for GetUpVector here.
Remarks:
Write remarks for GetUpVector here.
See also:
Separate items with the '|' character. 
void OpenArena::Camera::Look ()
Calls gluLookAt to tell OpenGL where to render from. 

Remarks:
Uses the position, view, and up vectors.
See also:

void OpenArena::Camera::MoveCamera (double speed)
Moves the camera along its view vector a given number of units. 

Parameters:
speed The distance to move the camera.
Remarks:

See also:

Vec3f OpenArena::Camera::Position ()
Returns this Camera's position. 

Returns:
This Camera's position as a Vec3d vector.
Returns this Camera's position. 
void OpenArena::Camera::PositionCamera (Vec3d pos, Vec3d view, Vec3d up)
Relocates and reorients this Camera. 

Parameters:
pos The new position vector.
view The new view vector.
up The new up vector.
Remarks:

See also:

void OpenArena::Camera::PositionCamera (double xpos, double ypos, double zpos, double xview, double yview, double zview, double xup, double yup, double zup)
Relocates and reorients this Camera. 

Parameters:
xpos The x-coordinate of the new position vector.
ypos The y-coordinate of the new position vector.
zpos The z-coordinate of the new position vector.
xview The x-coordinate of the new view vector.
yview The y-coordinate of the new view vector.
zview The z-coordinate of the new view vector.
xup The x-coordinate of the new up vector.
yup The y-coordinate of the new up vector.
zup The z-coordinate of the new up vector.
Remarks:

See also:

void OpenArena::Camera::RotateHorizontal (float angle)
Write brief comment for RotateHorizontal here. 

Parameters:
angle Description of parameter angle.
Exceptions:
<exception class> Description of criteria for throwing this exception.
Write detailed description for RotateHorizontal here.
Remarks:
Write remarks for RotateHorizontal here.
See also:
Separate items with the '|' character. 
void OpenArena::Camera::RotateVertical (float angle)
Write brief comment for RotateVertical here. 

Parameters:
angle Description of parameter angle.
Exceptions:
<exception class> Description of criteria for throwing this exception.
Write detailed description for RotateVertical here.
Remarks:
Write remarks for RotateVertical here.
See also:
Separate items with the '|' character. 
void OpenArena::Camera::RotateView (double angle, double X, double Y, double Z)
Rotates the camera a given ammount around a given axis. 

Parameters:
angle The number of degrees to rotate.
X The x component of the vector representing the axis to rotate around
Y The y component of the vector representing the axis to rotate around
Z The z component of the vector representing the axis to rotate around
Remarks:
The vector should be normalized as the values get passed directly to glRotatef().
See also:

void OpenArena::Camera::RotateView (double angle, Vec3d axis)
Rotates the camera a given ammount around a given axis. 

Parameters:
angle The number of degrees to rotate.
axis A vector representing the axis to rotate around.
This method passes the arguments to glRotatef()
Remarks:

See also:

void OpenArena::Camera::SetViewByMouse (Window window)
Updates the view and up vectors based on mouse movement. 

Parameters:
window The Window used to get the mouse coordinates.
Remarks:
This will be removed in favor of some sort of event trigger.
See also:

Vec3f OpenArena::Camera::Strafe ()
Returns this Camera's strafe vector. 

The strafe axis is an axis perpendicular to both the up vector and the view vector.
Returns:
This Camera's strafe vector.
Remarks:

See also:

void OpenArena::Camera::StrafeCamera (double speed)
Moves the camera along its strafe axis a given distance. 

Parameters:
speed The distance to move.
Remarks:

See also:

void OpenArena::Camera::Update ()
Recalculates the strafe vector. 

Remarks:

See also:

void OpenArena::Camera::UpdateVectors () [private]
Vec3f OpenArena::Camera::UpVector ()
Returns a vector pointing up with respect to the view. 

Returns:
A vector pointing up with respect to the view.
Remarks:

See also:

Vec3f OpenArena::Camera::View ()
Returns the view vector of this camera. 

Returns:
The view vector of this camera.
Remarks:

See also:

Member Data Documentation
Vec3f OpenArena::Camera::m_vPosition [private]
Vec3f OpenArena::Camera::m_vStrafe [private]
Vec3f OpenArena::Camera::m_vUpVector [private]
Vec3f OpenArena::Camera::m_vView [private]

The documentation for this class was generated from the following files:
src/camera.h
src/camera.cpp

OpenArena::ControlScheme Class Reference
This class represents a user's control scheme. 
 #include <ctrls.h>
Public Types
ACTION_FORWARD
ACTION_BACKWARD
ACTION_LOOKLEFT
ACTION_LOOKRIGHT
ACTION_LOOKUP
ACTION_LOOKDOWN
ACTION_MOVELEFT
ACTION_MOVERIGHT
ACTION_MOVEUP
ACTION_MOVEDOWN
ACTION_ROLLLEFT
ACTION_ROLLRIGHT
ACTION_FIREPRIMARY
ACTION_FIRESECONDARY
ACTION_WEAPONNEXT
ACTION_WEAPONPREV
ACTION_TOGGLE_LIGHTS
ACTION_TOGGLE_FPS
ACTION_TOGGLE_CONSOLE
ACTION_TOGGLE_MOUSELOOK
ACTION_QUICKMOUSELOOK
enum Action { ACTION_FORWARD, ACTION_BACKWARD, ACTION_LOOKLEFT, ACTION_LOOKRIGHT, ACTION_LOOKUP, ACTION_LOOKDOWN, ACTION_MOVELEFT, ACTION_MOVERIGHT, ACTION_MOVEUP, ACTION_MOVEDOWN, ACTION_ROLLLEFT, ACTION_ROLLRIGHT, ACTION_FIREPRIMARY, ACTION_FIRESECONDARY, ACTION_WEAPONNEXT, ACTION_WEAPONPREV, ACTION_TOGGLE_LIGHTS, ACTION_TOGGLE_FPS, ACTION_TOGGLE_CONSOLE, ACTION_TOGGLE_MOUSELOOK, ACTION_QUICKMOUSELOOK }
Public Member Functions
void LoadDefaultControlScheme ()
This method loads a hard coded default control scheme. 

void ClearControlScheme ()
This method clears this control scheme so that no keys are bound to any actions. 

void Unbind (uint8)
This method removes a key from all actions. 

bool Bind (uint32, uint8)
This method binds a key to an action. 

Public Attributes
list< uint8 > forward
list< uint8 > backward
list< uint8 > lookLeft
list< uint8 > lookRight
list< uint8 > lookUp
list< uint8 > lookDown
list< uint8 > moveLeft
list< uint8 > moveRight
list< uint8 > moveUp
list< uint8 > moveDown
list< uint8 > firePrimary
list< uint8 > fireSecondary
list< uint8 > weaponNext
list< uint8 > weaponPrev
list< uint8 > toggleLights
list< uint8 > toggleFPS
list< uint8 > toggleConsole
list< uint8 > toggleMouseLook
list< uint8 > quickMouseLook
list< uint8 > rollLeft
list< uint8 > rollRight

Detailed Description
This class represents a user's control scheme. 

This class manages a set of actions and their associated keys.
Remarks:
This could become a set of keys with associated actions.
See also:

Member Enumeration Documentation
enum OpenArena::ControlScheme::Action

Enumerator: 
ACTION_FORWARD  
ACTION_BACKWARD  
ACTION_LOOKLEFT  
ACTION_LOOKRIGHT  
ACTION_LOOKUP  
ACTION_LOOKDOWN  
ACTION_MOVELEFT  
ACTION_MOVERIGHT  
ACTION_MOVEUP  
ACTION_MOVEDOWN  
ACTION_ROLLLEFT  
ACTION_ROLLRIGHT  
ACTION_FIREPRIMARY  
ACTION_FIRESECONDARY  
ACTION_WEAPONNEXT  
ACTION_WEAPONPREV  
ACTION_TOGGLE_LIGHTS  
ACTION_TOGGLE_FPS  
ACTION_TOGGLE_CONSOLE  
ACTION_TOGGLE_MOUSELOOK  
ACTION_QUICKMOUSELOOK  

Member Function Documentation
bool OpenArena::ControlScheme::Bind (uint32, uint8)
This method binds a key to an action. 

Parameters:
The ACTION_* constant for the action to bind to.
The KEY_* constant for the key to bind.
Returns:
Returns false if an invalid action is specified and true otherwise.
Remarks:
This unbinds the key before binding it to the new action.
See also:

void OpenArena::ControlScheme::ClearControlScheme ()
This method clears this control scheme so that no keys are bound to any actions. 

Remarks:

See also:

void OpenArena::ControlScheme::LoadDefaultControlScheme ()
This method loads a hard coded default control scheme. 

Remarks:

See also:

void OpenArena::ControlScheme::Unbind (uint8)
This method removes a key from all actions. 

Parameters:
The KEY_* constant for the key to unbind.
Remarks:

See also:

Member Data Documentation
list<uint8> OpenArena::ControlScheme::backward
list<uint8> OpenArena::ControlScheme::firePrimary
list<uint8> OpenArena::ControlScheme::fireSecondary
list<uint8> OpenArena::ControlScheme::forward
list<uint8> OpenArena::ControlScheme::lookDown
list<uint8> OpenArena::ControlScheme::lookLeft
list<uint8> OpenArena::ControlScheme::lookRight
list<uint8> OpenArena::ControlScheme::lookUp
list<uint8> OpenArena::ControlScheme::moveDown
list<uint8> OpenArena::ControlScheme::moveLeft
list<uint8> OpenArena::ControlScheme::moveRight
list<uint8> OpenArena::ControlScheme::moveUp
list<uint8> OpenArena::ControlScheme::quickMouseLook
list<uint8> OpenArena::ControlScheme::rollLeft
list<uint8> OpenArena::ControlScheme::rollRight
list<uint8> OpenArena::ControlScheme::toggleConsole
list<uint8> OpenArena::ControlScheme::toggleFPS
list<uint8> OpenArena::ControlScheme::toggleLights
list<uint8> OpenArena::ControlScheme::toggleMouseLook
list<uint8> OpenArena::ControlScheme::weaponNext
list<uint8> OpenArena::ControlScheme::weaponPrev

The documentation for this class was generated from the following files:
src/ctrls.h
src/ctrls.cpp

OpenArena::Font Class Reference
Write brief comment for Font here. 
 #include <myglFont.h>
Public Member Functions
Font ()
Write brief comment for Font here. 

~Font ()
Write brief comment for ~Font here. 

bool BuildFont (const char *)
Write brief comment for BuildFont here. 

bool FreeFont ()
Write brief comment for FreeFont here. 

void Print (int, int, const char *, unsigned int=0)
Write brief comment for Print here. 

bool Loaded ()
Write brief comment for Loaded here. 

void SetScreenDimensions (short, short)
Write brief comment for SetScreenDimensions here. 

void SetScreenWidth (short)
Write brief comment for SetScreenWidth here. 

void SetScreenHeight (short)
Write brief comment for SetScreenHeight here. 

short ScreenWidth ()
Write brief comment for ScreenWidth here. 

short ScreenHeight ()
Write brief comment for ScreenHeight here. 

Private Attributes
short screenWidth
short screenHeight
unsigned int base
GLuint texture
bool status

Detailed Description
Write brief comment for Font here. 

Write detailed description for Font here.
Remarks:
Write remarks for Font here.
See also:
Separate items with the '|' character. 

Constructor & Destructor Documentation
OpenArena::Font::Font ()
Write brief comment for Font here. 

Exceptions:
<exception class> Description of criteria for throwing this exception.
Write detailed description for Font here.
Remarks:
Write remarks for Font here.
See also:
Separate items with the '|' character. 
OpenArena::Font::~Font ()
Write brief comment for ~Font here. 

Exceptions:
<exception class> Description of criteria for throwing this exception.
Write detailed description for ~Font here.
Remarks:
Write remarks for ~Font here.
See also:
Separate items with the '|' character. 

Member Function Documentation
bool OpenArena::Font::BuildFont (const char *)
Write brief comment for BuildFont here. 

Parameters:
Description of parameter .
Returns:
Write description of return value here.
Exceptions:
<exception class> Description of criteria for throwing this exception.
Write detailed description for BuildFont here.
Remarks:
Write remarks for BuildFont here.
See also:
Separate items with the '|' character. 
bool OpenArena::Font::FreeFont ()
Write brief comment for FreeFont here. 

Returns:
Write description of return value here.
Exceptions:
<exception class> Description of criteria for throwing this exception.
Write detailed description for FreeFont here.
Remarks:
Write remarks for FreeFont here.
See also:
Separate items with the '|' character. 
bool OpenArena::Font::Loaded ()
Write brief comment for Loaded here. 

Returns:
Write description of return value here.
Exceptions:
<exception class> Description of criteria for throwing this exception.
Write detailed description for Loaded here.
Remarks:
Write remarks for Loaded here.
See also:
Separate items with the '|' character. 
void OpenArena::Font::Print (int, int, const char *, unsigned int = 0)
Write brief comment for Print here. 

Parameters:
Description of parameter .
Description of parameter .
Description of parameter .
Description of parameter .
Exceptions:
<exception class> Description of criteria for throwing this exception.
Write detailed description for Print here.
Remarks:
Write remarks for Print here.
See also:
Separate items with the '|' character. 
short OpenArena::Font::ScreenHeight ()
Write brief comment for ScreenHeight here. 

Returns:
Write description of return value here.
Exceptions:
<exception class> Description of criteria for throwing this exception.
Write detailed description for ScreenHeight here.
Remarks:
Write remarks for ScreenHeight here.
See also:
Separate items with the '|' character. 
short OpenArena::Font::ScreenWidth ()
Write brief comment for ScreenWidth here. 

Returns:
Write description of return value here.
Exceptions:
<exception class> Description of criteria for throwing this exception.
Write detailed description for ScreenWidth here.
Remarks:
Write remarks for ScreenWidth here.
See also:
Separate items with the '|' character. 
void OpenArena::Font::SetScreenDimensions (short, short)
Write brief comment for SetScreenDimensions here. 

Parameters:
Description of parameter .
Description of parameter .
Exceptions:
<exception class> Description of criteria for throwing this exception.
Write detailed description for SetScreenDimensions here.
Remarks:
Write remarks for SetScreenDimensions here.
See also:
Separate items with the '|' character. 
void OpenArena::Font::SetScreenHeight (short)
Write brief comment for SetScreenHeight here. 

Parameters:
Description of parameter .
Exceptions:
<exception class> Description of criteria for throwing this exception.
Write detailed description for SetScreenHeight here.
Remarks:
Write remarks for SetScreenHeight here.
See also:
Separate items with the '|' character. 
void OpenArena::Font::SetScreenWidth (short)
Write brief comment for SetScreenWidth here. 

Parameters:
Description of parameter .
Exceptions:
<exception class> Description of criteria for throwing this exception.
Write detailed description for SetScreenWidth here.
Remarks:
Write remarks for SetScreenWidth here.
See also:
Separate items with the '|' character. 

Member Data Documentation
unsigned int OpenArena::Font::base [private]
short OpenArena::Font::screenHeight [private]
short OpenArena::Font::screenWidth [private]
bool OpenArena::Font::status [private]
GLuint OpenArena::Font::texture [private]

The documentation for this class was generated from the following files:
src/myglFont.h
src/myglFont.cpp

OpenArena::Image Class Reference
Write brief comment for Image here. 
 #include <image.h>
Public Types
Type_RGB
enum Type { Type_RGB }
Public Member Functions
virtual uint8 * GetImageData () const =0
Write brief comment for GetImageData here. 

virtual uint32 GetBitsPerPixel () const =0
Write brief comment for GetBitsPerPixel here. 

virtual uint32 GetBytesPerPixel () const =0
Write brief comment for GetBytesPerPixel here. 

virtual uint32 GetWidth () const =0
Write brief comment for GetWidth here. 

virtual uint32 GetHeight () const =0
Write brief comment for GetHeight here. 

virtual Image::Type GetType () const =0
Write brief comment for GetType here. 

virtual ~Image (void)
Write brief comment for ~Image here. 

Detailed Description
Write brief comment for Image here. 

Write detailed description for Image here.
Remarks:
Write remarks for Image here.
See also:
Separate items with the '|' character. 

Member Enumeration Documentation
enum OpenArena::Image::Type

Enumerator: 
Type_RGB  

Constructor & Destructor Documentation
virtual OpenArena::Image::~Image (void) [inline, virtual]
Write brief comment for ~Image here. 

Exceptions:
<exception class> Description of criteria for throwing this exception.
Write detailed description for ~Image here.
Remarks:
Write remarks for ~Image here.
See also:
Separate items with the '|' character. 

Member Function Documentation
virtual uint32 OpenArena::Image::GetBitsPerPixel () const [pure virtual]
Write brief comment for GetBitsPerPixel here. 

Returns:
Write description of return value here.
Exceptions:
<exception class> Description of criteria for throwing this exception.
Write detailed description for GetBitsPerPixel here.
Remarks:
Write remarks for GetBitsPerPixel here.
See also:
Separate items with the '|' character. 
virtual uint32 OpenArena::Image::GetBytesPerPixel () const [pure virtual]
Write brief comment for GetBytesPerPixel here. 

Returns:
Write description of return value here.
Exceptions:
<exception class> Description of criteria for throwing this exception.
Write detailed description for GetBytesPerPixel here.
Remarks:
Write remarks for GetBytesPerPixel here.
See also:
Separate items with the '|' character. 
virtual uint32 OpenArena::Image::GetHeight () const [pure virtual]
Write brief comment for GetHeight here. 

Returns:
Write description of return value here.
Exceptions:
<exception class> Description of criteria for throwing this exception.
Write detailed description for GetHeight here.
Remarks:
Write remarks for GetHeight here.
See also:
Separate items with the '|' character. 
virtual uint8* OpenArena::Image::GetImageData () const [pure virtual]
Write brief comment for GetImageData here. 

Returns:
Write description of return value here.
Exceptions:
<exception class> Description of criteria for throwing this exception.
Write detailed description for GetImageData here.
Remarks:
Write remarks for GetImageData here.
See also:
Separate items with the '|' character. 
virtual Image::Type OpenArena::Image::GetType () const [pure virtual]
Write brief comment for GetType here. 

Returns:
Write description of return value here.
Exceptions:
<exception class> Description of criteria for throwing this exception.
Write detailed description for GetType here.
Remarks:
Write remarks for GetType here.
See also:
Separate items with the '|' character. 
virtual uint32 OpenArena::Image::GetWidth () const [pure virtual]
Write brief comment for GetWidth here. 

Returns:
Write description of return value here.
Exceptions:
<exception class> Description of criteria for throwing this exception.
Write detailed description for GetWidth here.
Remarks:
Write remarks for GetWidth here.
See also:
Separate items with the '|' character. 

The documentation for this class was generated from the following file:
src/image.h

OpenArena::Level Class Reference
#include <level.h>
Public Member Functions
Level ()
Write brief comment for Level here. 

~Level ()
Write brief comment for ~Level here. 

bool LoadMap (string mapname)
Write brief comment for LoadMap here. 

bool LoadMap ()
Write brief comment for LoadMap here. 

void SaveMap (string mapname)
Write brief comment for SaveMap here. 

bool LoadConfig (string cfgname)
Write brief comment for LoadConfig here. 

void LoadConfig ()
Write brief comment for LoadConfig here. 

void SaveConfig (string cfgname)
void Execute (string cmd)
Write brief comment for Execute here. 

void LoadGLTextures ()
Write brief comment for LoadGLTextures here. 

void Render ()
Write brief comment for Render here. 

void UnloadMap ()
Write brief comment for UnloadMap here. 

void UpdateConsole (char)
Write brief comment for UpdateConsole here. 

uint32 FPS ()
Write brief comment for FPS here. 

void ParseCmds (const char *)
Write brief comment for ParseCmds here. 

void Print (int x, int y, const char *string, unsigned int set)
void SetWindow (Window *)
Write brief comment for SetWindow here. 

Window * GetWindow ()
Write brief comment for GetWindow here. 

void ConsolePrint (string)
Write brief comment for ConsolePrint here. 

Public Attributes
Screen screen
Font glFont
string nextLevel
Player * defaultPlayer
uint32 numTextures
string * textureNames
string bgm
unsigned char bgmCDA
string gamedir
float gravity
bool mlook
bool showFPS
bool showConsole
bool sound
float turnSpeed
float moveSpeed
float mouseSpeed
unsigned char maxFPS
Triangle * triangles
uint32 numTriangles
list< Player > players
list< Texture * > textures
Texture menuTextures [NUM_MENU_TEXTURES]
Window * _window
Private Attributes
string consoleHistory [MAX_CONSOLE_HISTORY_LINES]
string consoleOutput [MAX_CONSOLE_OUTPUT_LINES]
string outputText [MAX_OUTPUT_TEXT_LINES]

Constructor & Destructor Documentation
OpenArena::Level::Level ()
Write brief comment for Level here. 

Exceptions:
<exception class> Description of criteria for throwing this exception.
Write detailed description for Level here.
Remarks:
Write remarks for Level here.
See also:
Separate items with the '|' character. 
OpenArena::Level::~Level ()
Write brief comment for ~Level here. 

Exceptions:
<exception class> Description of criteria for throwing this exception.
Write detailed description for ~Level here.
Remarks:
Write remarks for ~Level here.
See also:
Separate items with the '|' character. 

Member Function Documentation
void OpenArena::Level::ConsolePrint (string)
Write brief comment for ConsolePrint here. 

Parameters:
Description of parameter .
Exceptions:
<exception class> Description of criteria for throwing this exception.
Write detailed description for ConsolePrint here.
Remarks:
Write remarks for ConsolePrint here.
See also:
Separate items with the '|' character. 
void OpenArena::Level::Execute (string cmd)
Write brief comment for Execute here. 

Parameters:
cmd Description of parameter cmd.
Exceptions:
<exception class> Description of criteria for throwing this exception.
Write detailed description for Execute here.
Remarks:
Write remarks for Execute here.
See also:
Separate items with the '|' character. 
uint32 OpenArena::Level::FPS ()
Write brief comment for FPS here. 

Returns:
Write description of return value here.
Exceptions:
<exception class> Description of criteria for throwing this exception.
Write detailed description for FPS here.
Remarks:
Write remarks for FPS here.
See also:
Separate items with the '|' character. 
Window * OpenArena::Level::GetWindow ()
Write brief comment for GetWindow here. 

Returns:
Write description of return value here.
Exceptions:
<exception class> Description of criteria for throwing this exception.
Write detailed description for GetWindow here.
Remarks:
Write remarks for GetWindow here.
See also:
Separate items with the '|' character. 
void OpenArena::Level::LoadConfig ()
Write brief comment for LoadConfig here. 

Exceptions:
<exception class> Description of criteria for throwing this exception.
Write detailed description for LoadConfig here.
Remarks:
Write remarks for LoadConfig here.
See also:
Separate items with the '|' character. 
bool OpenArena::Level::LoadConfig (string cfgname)
Write brief comment for LoadConfig here. 

Parameters:
cfgname Description of parameter cfgname.
Returns:
Write description of return value here.
Exceptions:
<exception class> Description of criteria for throwing this exception.
Write detailed description for LoadConfig here.
Remarks:
Write remarks for LoadConfig here.
See also:
Separate items with the '|' character. 
void OpenArena::Level::LoadGLTextures ()
Write brief comment for LoadGLTextures here. 

Exceptions:
<exception class> Description of criteria for throwing this exception.
Write detailed description for LoadGLTextures here.
Remarks:
Write remarks for LoadGLTextures here.
See also:
Separate items with the '|' character. 
bool OpenArena::Level::LoadMap ()
Write brief comment for LoadMap here. 

Returns:
Write description of return value here.
Exceptions:
<exception class> Description of criteria for throwing this exception.
Write detailed description for LoadMap here.
Remarks:
Write remarks for LoadMap here.
See also:
Separate items with the '|' character. 
bool OpenArena::Level::LoadMap (string mapname)
Write brief comment for LoadMap here. 

Parameters:
mapname Description of parameter mapname.
Returns:
Write description of return value here.
Exceptions:
<exception class> Description of criteria for throwing this exception.
Write detailed description for LoadMap here.
Remarks:
Write remarks for LoadMap here.
See also:
Separate items with the '|' character. 
void OpenArena::Level::ParseCmds (const char *)
Write brief comment for ParseCmds here. 

Parameters:
Description of parameter .
Exceptions:
<exception class> Description of criteria for throwing this exception.
Write detailed description for ParseCmds here.
Remarks:
Write remarks for ParseCmds here.
See also:
Separate items with the '|' character. 
void OpenArena::Level::Print (int x, int y, const char * string, unsigned int set)
void OpenArena::Level::Render ()
Write brief comment for Render here. 

Exceptions:
<exception class> Description of criteria for throwing this exception.
Write detailed description for Render here.
Remarks:
Write remarks for Render here.
See also:
Separate items with the '|' character. 
void OpenArena::Level::SaveConfig (string cfgname)
void OpenArena::Level::SaveMap (string mapname)
Write brief comment for SaveMap here. 

Parameters:
mapname Description of parameter mapname.
Exceptions:
<exception class> Description of criteria for throwing this exception.
Write detailed description for SaveMap here.
Remarks:
Write remarks for SaveMap here.
See also:
Separate items with the '|' character. 
void OpenArena::Level::SetWindow (Window *)
Write brief comment for SetWindow here. 

Parameters:
Description of parameter .
Exceptions:
<exception class> Description of criteria for throwing this exception.
Write detailed description for SetWindow here.
Remarks:
Write remarks for SetWindow here.
See also:
Separate items with the '|' character. 
void OpenArena::Level::UnloadMap ()
Write brief comment for UnloadMap here. 

Exceptions:
<exception class> Description of criteria for throwing this exception.
Write detailed description for UnloadMap here.
Remarks:
Write remarks for UnloadMap here.
See also:
Separate items with the '|' character. 
void OpenArena::Level::UpdateConsole (char)
Write brief comment for UpdateConsole here. 

Parameters:
Description of parameter .
Exceptions:
<exception class> Description of criteria for throwing this exception.
Write detailed description for UpdateConsole here.
Remarks:
Write remarks for UpdateConsole here.
See also:
Separate items with the '|' character. 

Member Data Documentation
Window* OpenArena::Level::_window
string OpenArena::Level::bgm
unsigned char OpenArena::Level::bgmCDA
string OpenArena::Level::consoleHistory[MAX_CONSOLE_HISTORY_LINES] [private]
string OpenArena::Level::consoleOutput[MAX_CONSOLE_OUTPUT_LINES] [private]
Player* OpenArena::Level::defaultPlayer
string OpenArena::Level::gamedir
Font OpenArena::Level::glFont
float OpenArena::Level::gravity
unsigned char OpenArena::Level::maxFPS
Texture OpenArena::Level::menuTextures[NUM_MENU_TEXTURES]
bool OpenArena::Level::mlook
float OpenArena::Level::mouseSpeed
float OpenArena::Level::moveSpeed
string OpenArena::Level::nextLevel
uint32 OpenArena::Level::numTextures
uint32 OpenArena::Level::numTriangles
string OpenArena::Level::outputText[MAX_OUTPUT_TEXT_LINES] [private]
list<Player> OpenArena::Level::players
Screen OpenArena::Level::screen
bool OpenArena::Level::showConsole
bool OpenArena::Level::showFPS
bool OpenArena::Level::sound
string* OpenArena::Level::textureNames
list<Texture*> OpenArena::Level::textures
Triangle* OpenArena::Level::triangles
float OpenArena::Level::turnSpeed

The documentation for this class was generated from the following files:
src/level.h
src/level.cpp

OpenArena::list< ItemType > Class Template Reference
Write brief comment for list here. 
 #include <list.h>
Public Member Functions
list ()
Write brief comment for list here. 

~list ()
Write brief comment for ~list here. 

list (const list &)
Write brief comment for list here. 

bool IsEmpty () const 
Write brief comment for IsEmpty here. 

bool IsFull () const 
Write brief comment for IsFull here. 

void Insert (ItemType newItem)
Write brief comment for Insert here. 

void Remove (ItemType target)
Write brief comment for Remove here. 

void Remove ()
Write brief comment for Remove here. 

ItemType Retrieve () const 
Write brief comment for Retrieve here. 

bool PrevPosition ()
Write brief comment for PrevPosition here. 

bool NextPosition ()
Write brief comment for NextPosition here. 

bool IsFirstPosition () const 
Write brief comment for IsFirstPosition here. 

bool IsLastPosition () const 
Write brief comment for IsLastPosition here. 

void FirstPosition ()
Write brief comment for FirstPosition here. 

void LastPosition ()
Write brief comment for LastPosition here. 

void Clear ()
Write brief comment for Clear here. 

bool Contains (ItemType) const 
Write brief comment for Contains here. 

unsigned int Length ()
Write brief comment for Length here. 

void operator= (const list< ItemType > &)
Write brief comment for operator = here. 

ItemType operator[] (LIST_ARRAY_INDEX_TYPE) const 
Write brief comment for operator [] here. 

ItemType & operator[] (LIST_ARRAY_INDEX_TYPE)
Write brief comment for operator [] here. 

Private Attributes
listNode< ItemType > * head
listNode< ItemType > * tail
listNode< ItemType > * currPos

Detailed Description
template<class ItemType> class OpenArena::list< ItemType >
Write brief comment for list here. 

Parameters:
ItemType Description of parameter ItemType.
Write detailed description for list here.
Remarks:
Write remarks for list here.
See also:
Separate items with the '|' character. 

Constructor & Destructor Documentation
template<class ItemType> OpenArena::list< ItemType >::list ()
Write brief comment for list here. 

Exceptions:
<exception class> Description of criteria for throwing this exception.
Write detailed description for list here.
Remarks:
Write remarks for list here.
See also:
Separate items with the '|' character. 
template<class ItemType> OpenArena::list< ItemType >::~list ()
Write brief comment for ~list here. 

Exceptions:
<exception class> Description of criteria for throwing this exception.
Write detailed description for ~list here.
Remarks:
Write remarks for ~list here.
See also:
Separate items with the '|' character. 
template<class ItemType> OpenArena::list< ItemType >::list (const list< ItemType > &)
Write brief comment for list here. 

Parameters:
Description of parameter .
Exceptions:
<exception class> Description of criteria for throwing this exception.
Write detailed description for list here.
Remarks:
Write remarks for list here.
See also:
Separate items with the '|' character. 

Member Function Documentation
template<class ItemType> void OpenArena::list< ItemType >::Clear ()
Write brief comment for Clear here. 

Exceptions:
<exception class> Description of criteria for throwing this exception.
Write detailed description for Clear here.
Remarks:
Write remarks for Clear here.
See also:
Separate items with the '|' character. 
template<class ItemType> bool OpenArena::list< ItemType >::Contains (ItemType) const
Write brief comment for Contains here. 

Parameters:
Description of parameter .
Returns:
Write description of return value here.
Exceptions:
<exception class> Description of criteria for throwing this exception.
Write detailed description for Contains here.
Remarks:
Write remarks for Contains here.
See also:
Separate items with the '|' character. 
template<class ItemType> void OpenArena::list< ItemType >::FirstPosition ()
Write brief comment for FirstPosition here. 

Exceptions:
<exception class> Description of criteria for throwing this exception.
Write detailed description for FirstPosition here.
Remarks:
Write remarks for FirstPosition here.
See also:
Separate items with the '|' character. 
template<class ItemType> void OpenArena::list< ItemType >::Insert (ItemType newItem)
Write brief comment for Insert here. 

Parameters:
newItem Description of parameter newItem.
Exceptions:
<exception class> Description of criteria for throwing this exception.
Write detailed description for Insert here.
Remarks:
Write remarks for Insert here.
See also:
Separate items with the '|' character. 
template<class ItemType> bool OpenArena::list< ItemType >::IsEmpty () const
Write brief comment for IsEmpty here. 

Returns:
Write description of return value here.
Exceptions:
<exception class> Description of criteria for throwing this exception.
Write detailed description for IsEmpty here.
Remarks:
Write remarks for IsEmpty here.
See also:
Separate items with the '|' character. 
template<class ItemType> bool OpenArena::list< ItemType >::IsFirstPosition () const
Write brief comment for IsFirstPosition here. 

Returns:
Write description of return value here.
Exceptions:
<exception class> Description of criteria for throwing this exception.
Write detailed description for IsFirstPosition here.
Remarks:
Write remarks for IsFirstPosition here.
See also:
Separate items with the '|' character. 
template<class ItemType> bool OpenArena::list< ItemType >::IsFull () const
Write brief comment for IsFull here. 

Returns:
Write description of return value here.
Exceptions:
<exception class> Description of criteria for throwing this exception.
Write detailed description for IsFull here.
Remarks:
Write remarks for IsFull here.
See also:
Separate items with the '|' character. 
template<class ItemType> bool OpenArena::list< ItemType >::IsLastPosition () const
Write brief comment for IsLastPosition here. 

Returns:
Write description of return value here.
Exceptions:
<exception class> Description of criteria for throwing this exception.
Write detailed description for IsLastPosition here.
Remarks:
Write remarks for IsLastPosition here.
See also:
Separate items with the '|' character. 
template<class ItemType> void OpenArena::list< ItemType >::LastPosition ()
Write brief comment for LastPosition here. 

Exceptions:
<exception class> Description of criteria for throwing this exception.
Write detailed description for LastPosition here.
Remarks:
Write remarks for LastPosition here.
See also:
Separate items with the '|' character. 
template<class ItemType> unsigned int OpenArena::list< ItemType >::Length ()
Write brief comment for Length here. 

Returns:
Write description of return value here.
Exceptions:
<exception class> Description of criteria for throwing this exception.
Write detailed description for Length here.
Remarks:
Write remarks for Length here.
See also:
Separate items with the '|' character. 
template<class ItemType> bool OpenArena::list< ItemType >::NextPosition ()
Write brief comment for NextPosition here. 

Returns:
Write description of return value here.
Exceptions:
<exception class> Description of criteria for throwing this exception.
Write detailed description for NextPosition here.
Remarks:
Write remarks for NextPosition here.
See also:
Separate items with the '|' character. 
template<class ItemType> void OpenArena::list< ItemType >::operator= (const list< ItemType > &)
Write brief comment for operator = here. 

Parameters:
Description of parameter .
Exceptions:
<exception class> Description of criteria for throwing this exception.
Write detailed description for operator = here.
Remarks:
Write remarks for operator = here.
See also:
Separate items with the '|' character. 
template<class ItemType> ItemType & OpenArena::list< ItemType >::operator[] (LIST_ARRAY_INDEX_TYPE)
Write brief comment for operator [] here. 

Parameters:
Description of parameter .
Returns:
Write description of return value here.
Exceptions:
<exception class> Description of criteria for throwing this exception.
Write detailed description for operator [] here.
Remarks:
Write remarks for operator [] here.
See also:
Separate items with the '|' character. 
template<class ItemType> ItemType OpenArena::list< ItemType >::operator[] (LIST_ARRAY_INDEX_TYPE) const
Write brief comment for operator [] here. 

Parameters:
Description of parameter .
Returns:
Write description of return value here.
Exceptions:
<exception class> Description of criteria for throwing this exception.
Write detailed description for operator [] here.
Remarks:
Write remarks for operator [] here.
See also:
Separate items with the '|' character. 
template<class ItemType> bool OpenArena::list< ItemType >::PrevPosition ()
Write brief comment for PrevPosition here. 

Returns:
Write description of return value here.
Exceptions:
<exception class> Description of criteria for throwing this exception.
Write detailed description for PrevPosition here.
Remarks:
Write remarks for PrevPosition here.
See also:
Separate items with the '|' character. 
template<class ItemType> void OpenArena::list< ItemType >::Remove ()
Write brief comment for Remove here. 

Exceptions:
<exception class> Description of criteria for throwing this exception.
Write detailed description for Remove here.
Remarks:
Write remarks for Remove here.
See also:
Separate items with the '|' character. 
template<class ItemType> void OpenArena::list< ItemType >::Remove (ItemType target)
Write brief comment for Remove here. 

Parameters:
target Description of parameter target.
Exceptions:
<exception class> Description of criteria for throwing this exception.
Write detailed description for Remove here.
Remarks:
Write remarks for Remove here.
See also:
Separate items with the '|' character. 
template<class ItemType> ItemType OpenArena::list< ItemType >::Retrieve () const
Write brief comment for Retrieve here. 

Returns:
Write description of return value here.
Exceptions:
<exception class> Description of criteria for throwing this exception.
Write detailed description for Retrieve here.
Remarks:
Write remarks for Retrieve here.
See also:
Separate items with the '|' character. 

Member Data Documentation
template<class ItemType> listNode<ItemType>* OpenArena::list< ItemType >::currPos [private]
template<class ItemType> listNode<ItemType>* OpenArena::list< ItemType >::head [private]
template<class ItemType> listNode<ItemType>* OpenArena::list< ItemType >::tail [private]

The documentation for this class was generated from the following file:
src/list.h

OpenArena::listNode< ItemType > Class Template Reference
Write brief comment for listNode here. 
 #include <list.h>
Public Member Functions
listNode ()
Write brief comment for listNode here. 

Public Attributes
ItemType data
listNode< ItemType > * next

Detailed Description
template<class ItemType> class OpenArena::listNode< ItemType >
Write brief comment for listNode here. 

Parameters:
ItemType Description of parameter ItemType.
Write detailed description for listNode here.
Remarks:
Write remarks for listNode here.
See also:
Separate items with the '|' character. 

Constructor & Destructor Documentation
template<class ItemType> OpenArena::listNode< ItemType >::listNode ()
Write brief comment for listNode here. 

Exceptions:
<exception class> Description of criteria for throwing this exception.
Write detailed description for listNode here.
Remarks:
Write remarks for listNode here.
See also:
Separate items with the '|' character. 

Member Data Documentation
template<class ItemType> ItemType OpenArena::listNode< ItemType >::data
template<class ItemType> listNode<ItemType>* OpenArena::listNode< ItemType >::next

The documentation for this class was generated from the following file:
src/list.h

OpenArena::Logger Class Reference
Write brief comment for Logger here. 
 #include <Logger.h>
Inheritance diagram for OpenArena::Logger:

IMAGE
Public Types
MESSAGETYPE_ALL
MESSAGETYPE_NONE
MESSAGETYPE_INFORMATION
MESSAGETYPE_ERROR
MESSAGETYPE_DEBUG
enum MessageType { MESSAGETYPE_ALL, MESSAGETYPE_NONE, MESSAGETYPE_INFORMATION, MESSAGETYPE_ERROR, MESSAGETYPE_DEBUG }
Write brief comment for MESSAGETYPE_DEBUG here. 

Public Member Functions
virtual ~Logger (void)
Write brief comment for ~Logger here. 

virtual void Log (const char *message, MessageType type=MESSAGETYPE_INFORMATION)=0
Write brief comment for Log here. 

virtual void Log (const char *message, const char *classification, MessageType type=MESSAGETYPE_INFORMATION)=0
Write brief comment for Log here. 

Detailed Description
Write brief comment for Logger here. 

Write detailed description for Logger here.
Remarks:
Write remarks for Logger here.
See also:
Separate items with the '|' character. 

Member Enumeration Documentation
enum OpenArena::Logger::MessageType
Write brief comment for MESSAGETYPE_DEBUG here. 

Enumerator: 
MESSAGETYPE_ALL  
MESSAGETYPE_NONE  
MESSAGETYPE_INFORMATION  
MESSAGETYPE_ERROR  
MESSAGETYPE_DEBUG  

Constructor & Destructor Documentation
virtual OpenArena::Logger::~Logger (void) [inline, virtual]
Write brief comment for ~Logger here. 

Exceptions:
<exception class> Description of criteria for throwing this exception.
Write detailed description for ~Logger here.
Remarks:
Write remarks for ~Logger here.
See also:
Separate items with the '|' character. 

Member Function Documentation
virtual void OpenArena::Logger::Log (const char * message, const char * classification, MessageType type = MESSAGETYPE_INFORMATION) [pure virtual]
Write brief comment for Log here. 

Parameters:
message Description of parameter message.
classification Description of parameter classification.
type Description of parameter type.
Exceptions:
<exception class> Description of criteria for throwing this exception.
Write detailed description for Log here.
Remarks:
Write remarks for Log here.
See also:
Separate items with the '|' character. 
virtual void OpenArena::Logger::Log (const char * message, MessageType type = MESSAGETYPE_INFORMATION) [pure virtual]
Write brief comment for Log here. 

Parameters:
message Description of parameter message.
type Description of parameter type.
Exceptions:
<exception class> Description of criteria for throwing this exception.
Write detailed description for Log here.
Remarks:
Write remarks for Log here.
See also:
Separate items with the '|' character. 

The documentation for this class was generated from the following file:
src/Logger.h

OpenArena::NullVideoPlugin Class Reference
Write brief comment for NullVideoPlugin here. 
 #include <NullVideoPlugin.h>
Inheritance diagram for OpenArena::NullVideoPlugin:

IMAGE
Public Member Functions
NullVideoPlugin (void)
Write brief comment for NullVideoPlugin here. 

virtual ~NullVideoPlugin (void)
Write brief comment for ~NullVideoPlugin here. 

virtual Window * CreateNewWindow (uint32 width, uint32 height, uint32 bpp=32, bool fullscreen=false, const char *title=NULL)
Write brief comment for CreateNewWindow here. 

Detailed Description
Write brief comment for NullVideoPlugin here. 

Write detailed description for NullVideoPlugin here.
Remarks:
Write remarks for NullVideoPlugin here.
See also:
Separate items with the '|' character. 

Constructor & Destructor Documentation
OpenArena::NullVideoPlugin::NullVideoPlugin (void)
Write brief comment for NullVideoPlugin here. 

Exceptions:
<exception class> Description of criteria for throwing this exception.
Write detailed description for NullVideoPlugin here.
Remarks:
Write remarks for NullVideoPlugin here.
See also:
Separate items with the '|' character. 
OpenArena::NullVideoPlugin::~NullVideoPlugin (void) [virtual]
Write brief comment for ~NullVideoPlugin here. 

Exceptions:
<exception class> Description of criteria for throwing this exception.
Write detailed description for ~NullVideoPlugin here.
Remarks:
Write remarks for ~NullVideoPlugin here.
See also:
Separate items with the '|' character. 

Member Function Documentation
OpenArena::Window * OpenArena::NullVideoPlugin::CreateNewWindow (uint32 width, uint32 height, uint32 bpp = 32, bool fullscreen = false, const char * title = NULL) [virtual]
Write brief comment for CreateNewWindow here. 

Parameters:
width Description of parameter width.
height Description of parameter height.
bpp Description of parameter bpp.
fullscreen Description of parameter fullscreen.
title Description of parameter title.
Returns:
Write description of return value here.
Exceptions:
<exception class> Description of criteria for throwing this exception.
Write detailed description for CreateNewWindow here.
Remarks:
Write remarks for CreateNewWindow here.
See also:
Separate items with the '|' character. 
Implements OpenArena::VideoPlugin (p.pagenum).
The documentation for this class was generated from the following files:
src/NullVideoPlugin.h
src/NullVideoPlugin.cpp

OpenArena::Player Class Reference
Write brief comment for Player here. 
 #include <player.h>
Public Member Functions
void Load ()
Write brief comment for Load here. 

void Save ()
Write brief comment for Save here. 

void CreateCharacter ()
Write brief comment for CreateCharacter here. 

void AddItem (unsigned int item)
Write brief comment for AddItem here. 

void RemoveItem (unsigned int item)
Write brief comment for RemoveItem here. 

Public Attributes
ControlScheme controls
Camera camera

Detailed Description
Write brief comment for Player here. 

Write detailed description for Player here.
Remarks:
Write remarks for Player here.
See also:
Separate items with the '|' character. 

Member Function Documentation
void OpenArena::Player::AddItem (unsigned int item)
Write brief comment for AddItem here. 

Parameters:
item Description of parameter item.
Exceptions:
<exception class> Description of criteria for throwing this exception.
Write detailed description for AddItem here.
Remarks:
Write remarks for AddItem here.
See also:
Separate items with the '|' character. 
void OpenArena::Player::CreateCharacter ()
Write brief comment for CreateCharacter here. 

Exceptions:
<exception class> Description of criteria for throwing this exception.
Write detailed description for CreateCharacter here.
Remarks:
Write remarks for CreateCharacter here.
See also:
Separate items with the '|' character. 
void OpenArena::Player::Load ()
Write brief comment for Load here. 

Exceptions:
<exception class> Description of criteria for throwing this exception.
Write detailed description for Load here.
Remarks:
Write remarks for Load here.
See also:
Separate items with the '|' character. 
void OpenArena::Player::RemoveItem (unsigned int item)
Write brief comment for RemoveItem here. 

Parameters:
item Description of parameter item.
Exceptions:
<exception class> Description of criteria for throwing this exception.
Write detailed description for RemoveItem here.
Remarks:
Write remarks for RemoveItem here.
See also:
Separate items with the '|' character. 
void OpenArena::Player::Save ()
Write brief comment for Save here. 

Exceptions:
<exception class> Description of criteria for throwing this exception.
Write detailed description for Save here.
Remarks:
Write remarks for Save here.
See also:
Separate items with the '|' character. 

Member Data Documentation
Camera OpenArena::Player::camera
ControlScheme OpenArena::Player::controls

The documentation for this class was generated from the following files:
src/player.h
src/player.cpp

OpenArena::Plugin Class Reference
Write brief comment for Plugin here. 
 #include <Plugin.h>
Inheritance diagram for OpenArena::Plugin:

IMAGE
Public Types
VideoPlugin
AudioPlugin
InputPlugin
enum Type { VideoPlugin, AudioPlugin, InputPlugin }
Write brief comment for InputPlugin here. 

Public Member Functions
virtual ~Plugin (void)
Write brief comment for ~Plugin here. 

Detailed Description
Write brief comment for Plugin here. 

Write detailed description for Plugin here.
Remarks:
Write remarks for Plugin here.
See also:
Separate items with the '|' character. 

Member Enumeration Documentation
enum OpenArena::Plugin::Type
Write brief comment for InputPlugin here. 

Enumerator: 
VideoPlugin  
AudioPlugin  
InputPlugin  

Constructor & Destructor Documentation
virtual OpenArena::Plugin::~Plugin (void) [inline, virtual]
Write brief comment for ~Plugin here. 

Exceptions:
<exception class> Description of criteria for throwing this exception.
Write detailed description for ~Plugin here.
Remarks:
Write remarks for ~Plugin here.
See also:
Separate items with the '|' character. 

The documentation for this class was generated from the following file:
src/Plugin.h

OpenArena::PluginManager Class Reference
Write brief comment for PluginManager here. 
 #include <PluginManager.h>
Public Member Functions
PluginManager (void)
Write brief comment for PluginManager here. 

~PluginManager (void)
Write brief comment for ~PluginManager here. 

list< Plugin * > GetPluginsOfType (Plugin::Type type)
Write brief comment for GetPluginsOfType here. 

VideoPlugin * GetDefaultVideoPlugin (void)
Write brief comment for GetDefaultVideoPlugin here. 

Private Attributes
list< Plugin * > _plugins

Detailed Description
Write brief comment for PluginManager here. 

Write detailed description for PluginManager here.
Remarks:
Write remarks for PluginManager here.
See also:
Separate items with the '|' character. 

Constructor & Destructor Documentation
OpenArena::PluginManager::PluginManager (void)
Write brief comment for PluginManager here. 

Exceptions:
<exception class> Description of criteria for throwing this exception.
Write detailed description for PluginManager here.
Remarks:
Write remarks for PluginManager here.
See also:
Separate items with the '|' character. 
OpenArena::PluginManager::~PluginManager (void)
Write brief comment for ~PluginManager here. 

Exceptions:
<exception class> Description of criteria for throwing this exception.
Write detailed description for ~PluginManager here.
Remarks:
Write remarks for ~PluginManager here.
See also:
Separate items with the '|' character. 

Member Function Documentation
VideoPlugin * OpenArena::PluginManager::GetDefaultVideoPlugin (void)
Write brief comment for GetDefaultVideoPlugin here. 

Returns:
Write description of return value here.
Exceptions:
<exception class> Description of criteria for throwing this exception.
Write detailed description for GetDefaultVideoPlugin here.
Remarks:
Write remarks for GetDefaultVideoPlugin here.
See also:
Separate items with the '|' character. 
list< Plugin * > OpenArena::PluginManager::GetPluginsOfType (Plugin::Type type)
Write brief comment for GetPluginsOfType here. 

Parameters:
type Description of parameter type.
Returns:
Write description of return value here.
Exceptions:
<exception class> Description of criteria for throwing this exception.
Write detailed description for GetPluginsOfType here.
Remarks:
Write remarks for GetPluginsOfType here.
See also:
Separate items with the '|' character. 

Member Data Documentation
list<Plugin*> OpenArena::PluginManager::_plugins [private]

The documentation for this class was generated from the following files:
src/PluginManager.h
src/PluginManager.cpp

OpenArena::Screen Class Reference
Write brief comment for Screen here. 
 #include <screen.h>
Inheritance diagram for OpenArena::Screen:

IMAGE
Public Member Functions
Screen ()
Write brief comment for Screen here. 

int GetWidth ()
Write brief comment for GetWidth here. 

int GetHeight ()
Write brief comment for GetHeight here. 

int GetColorDepth ()
Write brief comment for GetColorDepth here. 

bool GetFullscreen ()
Write brief comment for GetFullscreen here. 

const char * GetName ()
Write brief comment for GetName here. 

void SetWidth (int)
Write brief comment for SetWidth here. 

void SetHeight (int)
Write brief comment for SetHeight here. 

void Resize (int, int)
Write brief comment for Resize here. 

void SetColorDepth (int)
Write brief comment for SetColorDepth here. 

void SetFullscreen (bool)
Write brief comment for SetFullscreen here. 

void ToggleFullscreen ()
Write brief comment for ToggleFullscreen here. 

void SetName (const char *)
Write brief comment for SetName here. 

void SetName (string)
Write brief comment for SetName here. 

Protected Attributes
short _width
short _height
char _colorDepth
bool _fullscreen
string _name

Detailed Description
Write brief comment for Screen here. 

Write detailed description for Screen here.
Remarks:
Write remarks for Screen here.
See also:
Separate items with the '|' character. 

Constructor & Destructor Documentation
OpenArena::Screen::Screen ()
Write brief comment for Screen here. 

Exceptions:
<exception class> Description of criteria for throwing this exception.
Write detailed description for Screen here.
Remarks:
Write remarks for Screen here.
See also:
Separate items with the '|' character. 

Member Function Documentation
int OpenArena::Screen::GetColorDepth ()
Write brief comment for GetColorDepth here. 

Returns:
Write description of return value here.
Exceptions:
<exception class> Description of criteria for throwing this exception.
Write detailed description for GetColorDepth here.
Remarks:
Write remarks for GetColorDepth here.
See also:
Separate items with the '|' character. 
bool OpenArena::Screen::GetFullscreen ()
Write brief comment for GetFullscreen here. 

Returns:
Write description of return value here.
Exceptions:
<exception class> Description of criteria for throwing this exception.
Write detailed description for GetFullscreen here.
Remarks:
Write remarks for GetFullscreen here.
See also:
Separate items with the '|' character. 
int OpenArena::Screen::GetHeight ()
Write brief comment for GetHeight here. 

Returns:
Write description of return value here.
Exceptions:
<exception class> Description of criteria for throwing this exception.
Write detailed description for GetHeight here.
Remarks:
Write remarks for GetHeight here.
See also:
Separate items with the '|' character. 
const char * OpenArena::Screen::GetName ()
Write brief comment for GetName here. 

Returns:
Write description of return value here.
Exceptions:
<exception class> Description of criteria for throwing this exception.
Write detailed description for GetName here.
Remarks:
Write remarks for GetName here.
See also:
Separate items with the '|' character. 
int OpenArena::Screen::GetWidth ()
Write brief comment for GetWidth here. 

Returns:
Write description of return value here.
Exceptions:
<exception class> Description of criteria for throwing this exception.
Write detailed description for GetWidth here.
Remarks:
Write remarks for GetWidth here.
See also:
Separate items with the '|' character. 
void OpenArena::Screen::Resize (int, int)
Write brief comment for Resize here. 

Parameters:
Description of parameter .
Description of parameter .
Exceptions:
<exception class> Description of criteria for throwing this exception.
Write detailed description for Resize here.
Remarks:
Write remarks for Resize here.
See also:
Separate items with the '|' character. 
void OpenArena::Screen::SetColorDepth (int)
Write brief comment for SetColorDepth here. 

Parameters:
Description of parameter .
Exceptions:
<exception class> Description of criteria for throwing this exception.
Write detailed description for SetColorDepth here.
Remarks:
Write remarks for SetColorDepth here.
See also:
Separate items with the '|' character. 
void OpenArena::Screen::SetFullscreen (bool)
Write brief comment for SetFullscreen here. 

Parameters:
Description of parameter .
Exceptions:
<exception class> Description of criteria for throwing this exception.
Write detailed description for SetFullscreen here.
Remarks:
Write remarks for SetFullscreen here.
See also:
Separate items with the '|' character. 
void OpenArena::Screen::SetHeight (int)
Write brief comment for SetHeight here. 

Parameters:
Description of parameter .
Exceptions:
<exception class> Description of criteria for throwing this exception.
Write detailed description for SetHeight here.
Remarks:
Write remarks for SetHeight here.
See also:
Separate items with the '|' character. 
void OpenArena::Screen::SetName (string)
Write brief comment for SetName here. 

Parameters:
Description of parameter .
Exceptions:
<exception class> Description of criteria for throwing this exception.
Write detailed description for SetName here.
Remarks:
Write remarks for SetName here.
See also:
Separate items with the '|' character. 
void OpenArena::Screen::SetName (const char *)
Write brief comment for SetName here. 

Parameters:
Description of parameter .
Exceptions:
<exception class> Description of criteria for throwing this exception.
Write detailed description for SetName here.
Remarks:
Write remarks for SetName here.
See also:
Separate items with the '|' character. 
void OpenArena::Screen::SetWidth (int)
Write brief comment for SetWidth here. 

Parameters:
Description of parameter .
Exceptions:
<exception class> Description of criteria for throwing this exception.
Write detailed description for SetWidth here.
Remarks:
Write remarks for SetWidth here.
See also:
Separate items with the '|' character. 
void OpenArena::Screen::ToggleFullscreen ()
Write brief comment for ToggleFullscreen here. 

Exceptions:
<exception class> Description of criteria for throwing this exception.
Write detailed description for ToggleFullscreen here.
Remarks:
Write remarks for ToggleFullscreen here.
See also:
Separate items with the '|' character. 

Member Data Documentation
char OpenArena::Screen::_colorDepth [protected]
bool OpenArena::Screen::_fullscreen [protected]
short OpenArena::Screen::_height [protected]
string OpenArena::Screen::_name [protected]
short OpenArena::Screen::_width [protected]

The documentation for this class was generated from the following files:
src/screen.h
src/screen.cpp

OpenArena::Texture Class Reference
Write brief comment for Texture here. 
 #include <myglTexture.h>
Public Member Functions
Texture ()
Write brief comment for Texture here. 

~Texture ()
Write brief comment for ~Texture here. 

string Filename ()
Write brief comment for Filename here. 

GLuint ID ()
Write brief comment for ID here. 

bool Load (string filename)
Write brief comment for Load here. 

bool Load (string filename, GLuint min, GLuint mag)
Write brief comment for Load here. 

void Free ()
Write brief comment for Free here. 

bool Loaded ()
Write brief comment for Loaded here. 

bool operator< (const Texture &)
Write brief comment for operator < here. 

bool operator<= (const Texture &)
Write brief comment for operator <= here. 

bool operator== (const Texture &)
Write brief comment for operator == here. 

bool operator!= (const Texture &)
Write brief comment for operator != here. 

bool operator>= (const Texture &)
Write brief comment for operator >= here. 

bool operator> (const Texture &)
Write brief comment for operator > here. 

Private Attributes
GLuint minFilter
GLuint magFilter
string filename
GLuint id

Detailed Description
Write brief comment for Texture here. 

Write detailed description for Texture here.
Remarks:
Write remarks for Texture here.
See also:
Separate items with the '|' character. 

Constructor & Destructor Documentation
OpenArena::Texture::Texture ()
Write brief comment for Texture here. 

Exceptions:
<exception class> Description of criteria for throwing this exception.
Write detailed description for Texture here.
Remarks:
Write remarks for Texture here.
See also:
Separate items with the '|' character. 
OpenArena::Texture::~Texture ()
Write brief comment for ~Texture here. 

Exceptions:
<exception class> Description of criteria for throwing this exception.
Write detailed description for ~Texture here.
Remarks:
Write remarks for ~Texture here.
See also:
Separate items with the '|' character. 

Member Function Documentation
string OpenArena::Texture::Filename ()
Write brief comment for Filename here. 

Returns:
Write description of return value here.
Exceptions:
<exception class> Description of criteria for throwing this exception.
Write detailed description for Filename here.
Remarks:
Write remarks for Filename here.
See also:
Separate items with the '|' character. 
void OpenArena::Texture::Free ()
Write brief comment for Free here. 

Exceptions:
<exception class> Description of criteria for throwing this exception.
Write detailed description for Free here.
Remarks:
Write remarks for Free here.
See also:
Separate items with the '|' character. 
GLuint OpenArena::Texture::ID ()
Write brief comment for ID here. 

Returns:
Write description of return value here.
Exceptions:
<exception class> Description of criteria for throwing this exception.
Write detailed description for ID here.
Remarks:
Write remarks for ID here.
See also:
Separate items with the '|' character. 
bool OpenArena::Texture::Load (string filename, GLuint min, GLuint mag)
Write brief comment for Load here. 

Parameters:
filename Description of parameter filename.
min Description of parameter min.
mag Description of parameter mag.
Returns:
Write description of return value here.
Exceptions:
<exception class> Description of criteria for throwing this exception.
Write detailed description for Load here.
Remarks:
Write remarks for Load here.
See also:
Separate items with the '|' character. 
bool OpenArena::Texture::Load (string filename)
Write brief comment for Load here. 

Parameters:
filename Description of parameter filename.
Returns:
Write description of return value here.
Exceptions:
<exception class> Description of criteria for throwing this exception.
Write detailed description for Load here.
Remarks:
Write remarks for Load here.
See also:
Separate items with the '|' character. 
bool OpenArena::Texture::Loaded ()
Write brief comment for Loaded here. 

Returns:
Write description of return value here.
Exceptions:
<exception class> Description of criteria for throwing this exception.
Write detailed description for Loaded here.
Remarks:
Write remarks for Loaded here.
See also:
Separate items with the '|' character. 
bool OpenArena::Texture::operator!= (const Texture &)
Write brief comment for operator != here. 

Parameters:
Description of parameter .
Returns:
Write description of return value here.
Exceptions:
<exception class> Description of criteria for throwing this exception.
Write detailed description for operator != here.
Remarks:
Write remarks for operator != here.
See also:
Separate items with the '|' character. 
bool OpenArena::Texture::operator< (const Texture &)
Write brief comment for operator < here. 

Parameters:
Description of parameter .
Returns:
Write description of return value here.
Exceptions:
<exception class> Description of criteria for throwing this exception.
Write detailed description for operator < here.
Remarks:
Write remarks for operator < here.
See also:
Separate items with the '|' character. 
bool OpenArena::Texture::operator<= (const Texture &)
Write brief comment for operator <= here. 

Parameters:
Description of parameter .
Returns:
Write description of return value here.
Exceptions:
<exception class> Description of criteria for throwing this exception.
Write detailed description for operator <= here.
Remarks:
Write remarks for operator <= here.
See also:
Separate items with the '|' character. 
bool OpenArena::Texture::operator== (const Texture &)
Write brief comment for operator == here. 

Parameters:
Description of parameter .
Returns:
Write description of return value here.
Exceptions:
<exception class> Description of criteria for throwing this exception.
Write detailed description for operator == here.
Remarks:
Write remarks for operator == here.
See also:
Separate items with the '|' character. 
bool OpenArena::Texture::operator> (const Texture &)
Write brief comment for operator > here. 

Parameters:
Description of parameter .
Returns:
Write description of return value here.
Exceptions:
<exception class> Description of criteria for throwing this exception.
Write detailed description for operator > here.
Remarks:
Write remarks for operator > here.
See also:
Separate items with the '|' character. 
bool OpenArena::Texture::operator>= (const Texture &)
Write brief comment for operator >= here. 

Parameters:
Description of parameter .
Returns:
Write description of return value here.
Exceptions:
<exception class> Description of criteria for throwing this exception.
Write detailed description for operator >= here.
Remarks:
Write remarks for operator >= here.
See also:
Separate items with the '|' character. 

Member Data Documentation
string OpenArena::Texture::filename [private]
GLuint OpenArena::Texture::id [private]
GLuint OpenArena::Texture::magFilter [private]
GLuint OpenArena::Texture::minFilter [private]

The documentation for this class was generated from the following files:
src/myglTexture.h
src/myglTexture.cpp

OpenArena::TextureImage Class Reference
Write brief comment for TextureImage here. 
 #include <texture.h>
Public Attributes
unsigned char * data
unsigned int bpp
unsigned int sizeX
unsigned int sizeY
unsigned int type

Detailed Description
Write brief comment for TextureImage here. 

Write detailed description for TextureImage here.
Remarks:
Write remarks for TextureImage here.
See also:
Separate items with the '|' character. 

Member Data Documentation
unsigned int OpenArena::TextureImage::bpp
unsigned char* OpenArena::TextureImage::data
unsigned int OpenArena::TextureImage::sizeX
unsigned int OpenArena::TextureImage::sizeY
unsigned int OpenArena::TextureImage::type

The documentation for this class was generated from the following file:
src/texture.h

OpenArena::TGA Struct Reference
Write brief comment for TGA here. 
 #include <tga.h>
Public Attributes
GLubyte header [6]
GLuint bytesPerPixel
GLuint imageSize
GLuint type
GLuint Height
GLuint Width
GLuint Bpp

Detailed Description
Write brief comment for TGA here. 

Write detailed description for TGA here.
Remarks:
Write remarks for TGA here.
See also:
Separate items with the '|' character. 

Member Data Documentation
GLuint OpenArena::TGA::Bpp
GLuint OpenArena::TGA::bytesPerPixel
GLubyte OpenArena::TGA::header[6]
GLuint OpenArena::TGA::Height
GLuint OpenArena::TGA::imageSize
GLuint OpenArena::TGA::type
GLuint OpenArena::TGA::Width

The documentation for this struct was generated from the following file:
src/tga.h

OpenArena::TGAHeader Struct Reference
Write brief comment for TGAHeader here. 
 #include <tga.h>
Public Attributes
GLubyte Header [12]

Detailed Description
Write brief comment for TGAHeader here. 

Write detailed description for TGAHeader here.
Remarks:
Write remarks for TGAHeader here.
See also:
Separate items with the '|' character. 

Member Data Documentation
GLubyte OpenArena::TGAHeader::Header[12]

The documentation for this struct was generated from the following file:
src/tga.h

OpenArena::Triangle Class Reference
Write brief comment for Triangle here. 
 #include <geometry.h>
Public Attributes
Texture texture
uint32 texID
Vec3f vertecies [3]
Vec2f texCoords [3]
Vec3f normal

Detailed Description
Write brief comment for Triangle here. 

Write detailed description for Triangle here.
Remarks:
Write remarks for Triangle here.
See also:
Separate items with the '|' character. 

Member Data Documentation
Vec3f OpenArena::Triangle::normal
Vec2f OpenArena::Triangle::texCoords[3]
uint32 OpenArena::Triangle::texID
Texture OpenArena::Triangle::texture
Vec3f OpenArena::Triangle::vertecies[3]

The documentation for this class was generated from the following file:
src/geometry.h

OpenArena::Vec2f Class Reference
Write brief comment for Vec2f here. 
 #include <vector.h>
Public Member Functions
Vec2f ()
Write brief comment for Vec2f here. 

Vec2f (const Vec2f &)
Write brief comment for Vec2f here. 

Vec2f (double)
Write brief comment for Vec2f here. 

Vec2f (double, double)
Write brief comment for Vec2f here. 

double lengthsquared () const 
Write brief comment for lengthsquared here. 

double length () const 
Write brief comment for length here. 

void normalize ()
Vec2f normalized () const 
Write brief comment for normalized here. 

Vec2f cross (const Vec2f &) const 
Write brief comment for cross here. 

Vec2f operator= (const Vec2f &)
Write brief comment for operator = here. 

Vec2f operator * (const Vec2f &) const 
Write brief comment for operator * here. 

Vec2f operator+ (const Vec2f &) const 
Write brief comment for operator + here. 

Vec2f operator- (const Vec2f &) const 
Write brief comment for operator - here. 

Vec2f operator * (double) const 
Write brief comment for operator * here. 

Vec2f operator/ (double) const 
Write brief comment for operator / here. 

Public Attributes
float x
float y

Detailed Description
Write brief comment for Vec2f here. 

Write detailed description for Vec2f here.
Remarks:
Write remarks for Vec2f here.
See also:
Separate items with the '|' character. 

Constructor & Destructor Documentation
OpenArena::Vec2f::Vec2f ()
Write brief comment for Vec2f here. 

Exceptions:
<exception class> Description of criteria for throwing this exception.
Write detailed description for Vec2f here.
Remarks:
Write remarks for Vec2f here.
See also:
Separate items with the '|' character. 
OpenArena::Vec2f::Vec2f (const Vec2f &)
Write brief comment for Vec2f here. 

Parameters:
Description of parameter .
Exceptions:
<exception class> Description of criteria for throwing this exception.
Write detailed description for Vec2f here.
Remarks:
Write remarks for Vec2f here.
See also:
Separate items with the '|' character. 
OpenArena::Vec2f::Vec2f (double)
Write brief comment for Vec2f here. 

Parameters:
Description of parameter .
Exceptions:
<exception class> Description of criteria for throwing this exception.
Write detailed description for Vec2f here.
Remarks:
Write remarks for Vec2f here.
See also:
Separate items with the '|' character. 
OpenArena::Vec2f::Vec2f (double, double)
Write brief comment for Vec2f here. 

Parameters:
Description of parameter .
Description of parameter .
Exceptions:
<exception class> Description of criteria for throwing this exception.
Write detailed description for Vec2f here.
Remarks:
Write remarks for Vec2f here.
See also:
Separate items with the '|' character. 

Member Function Documentation
Vec2f OpenArena::Vec2f::cross (const Vec2f &) const
Write brief comment for cross here. 

Parameters:
Description of parameter .
Returns:
Write description of return value here.
Exceptions:
<exception class> Description of criteria for throwing this exception.
Write detailed description for cross here.
Remarks:
Write remarks for cross here.
See also:
Separate items with the '|' character. 
double OpenArena::Vec2f::length () const
Write brief comment for length here. 

Returns:
Write description of return value here.
Exceptions:
<exception class> Description of criteria for throwing this exception.
Write detailed description for length here.
Remarks:
Write remarks for length here.
See also:
Separate items with the '|' character. 
double OpenArena::Vec2f::lengthsquared () const
Write brief comment for lengthsquared here. 

Returns:
Write description of return value here.
Exceptions:
<exception class> Description of criteria for throwing this exception.
Write detailed description for lengthsquared here.
Remarks:
Write remarks for lengthsquared here.
See also:
Separate items with the '|' character. 
void OpenArena::Vec2f::normalize ()
Vec2f OpenArena::Vec2f::normalized () const
Write brief comment for normalized here. 

Returns:
Write description of return value here.
Exceptions:
<exception class> Description of criteria for throwing this exception.
Write detailed description for normalized here.
Remarks:
Write remarks for normalized here.
See also:
Separate items with the '|' character. 
Vec2f OpenArena::Vec2f::operator * (double) const
Write brief comment for operator * here. 

Parameters:
Description of parameter .
Returns:
Write description of return value here.
Exceptions:
<exception class> Description of criteria for throwing this exception.
Write detailed description for operator * here.
Remarks:
Write remarks for operator * here.
See also:
Separate items with the '|' character. 
Vec2f OpenArena::Vec2f::operator * (const Vec2f &) const
Write brief comment for operator * here. 

Parameters:
Description of parameter .
Returns:
Write description of return value here.
Exceptions:
<exception class> Description of criteria for throwing this exception.
Write detailed description for operator * here.
Remarks:
Write remarks for operator * here.
See also:
Separate items with the '|' character. 
Vec2f OpenArena::Vec2f::operator+ (const Vec2f &) const
Write brief comment for operator + here. 

Parameters:
Description of parameter .
Returns:
Write description of return value here.
Exceptions:
<exception class> Description of criteria for throwing this exception.
Write detailed description for operator + here.
Remarks:
Write remarks for operator + here.
See also:
Separate items with the '|' character. 
Vec2f OpenArena::Vec2f::operator- (const Vec2f &) const
Write brief comment for operator - here. 

Parameters:
Description of parameter .
Returns:
Write description of return value here.
Exceptions:
<exception class> Description of criteria for throwing this exception.
Write detailed description for operator - here.
Remarks:
Write remarks for operator - here.
See also:
Separate items with the '|' character. 
Vec2f OpenArena::Vec2f::operator/ (double) const
Write brief comment for operator / here. 

Parameters:
Description of parameter .
Returns:
Write description of return value here.
Exceptions:
<exception class> Description of criteria for throwing this exception.
Write detailed description for operator / here.
Remarks:
Write remarks for operator / here.
See also:
Separate items with the '|' character. 
Vec2f OpenArena::Vec2f::operator= (const Vec2f &)
Write brief comment for operator = here. 

Parameters:
Description of parameter .
Returns:
Write description of return value here.
Exceptions:
<exception class> Description of criteria for throwing this exception.
Write detailed description for operator = here.
Remarks:
Write remarks for operator = here.
See also:
Separate items with the '|' character. 

Member Data Documentation
float OpenArena::Vec2f::x
float OpenArena::Vec2f::y

The documentation for this class was generated from the following files:
src/vector.h
src/vector.cpp

OpenArena::Vec2i Class Reference
Write brief comment for Vec2i here. 
 #include <vector.h>
Public Member Functions
Vec2i ()
Write brief comment for Vec2i here. 

Vec2i (const Vec2i &)
Write brief comment for Vec2i here. Write brief comment for Vec2i here. 

Vec2i (int)
Vec2i (int, int)
Write brief comment for Vec2i here. 

int lengthsquared () const 
Write brief comment for lengthsquared here. 

int length () const 
Write brief comment for length here. 

void normalize ()
Write brief comment for normalize here. 

Vec2i normalized () const 
Write brief comment for normalized here. 

Vec2i cross (const Vec2i &) const 
Write brief comment for cross here. 

Vec2i operator= (const Vec2i &)
Write brief comment for operator = here. 

Vec2i operator * (const Vec2i &) const 
Write brief comment for operator * here. 

Vec2i operator+ (const Vec2i &) const 
Write brief comment for operator + here. 

Vec2i operator- (const Vec2i &) const 
Write brief comment for operator - here. 

Vec2i operator * (int) const 
Write brief comment for operator * here. 

Vec2i operator/ (int) const 
Write brief comment for operator / here. 

bool operator== (const Vec2i &) const 
Write brief comment for operator == here. 

bool operator!= (const Vec2i &) const 
Write brief comment for operator != here. 

Public Attributes
int x
int y

Detailed Description
Write brief comment for Vec2i here. 

Write detailed description for Vec2i here.
Remarks:
Write remarks for Vec2i here.
See also:
Separate items with the '|' character. 

Constructor & Destructor Documentation
OpenArena::Vec2i::Vec2i ()
Write brief comment for Vec2i here. 

Exceptions:
<exception class> Description of criteria for throwing this exception.
Write detailed description for Vec2i here.
Remarks:
Write remarks for Vec2i here.
See also:
Separate items with the '|' character. 
OpenArena::Vec2i::Vec2i (const Vec2i &)
Write brief comment for Vec2i here. Write brief comment for Vec2i here. 

Parameters:
Description of parameter .
Exceptions:
<exception class> Description of criteria for throwing this exception.
Write detailed description for Vec2i here.
Remarks:
Write remarks for Vec2i here.
See also:
Separate items with the '|' character. 
OpenArena::Vec2i::Vec2i (int)
OpenArena::Vec2i::Vec2i (int, int)
Write brief comment for Vec2i here. 

Parameters:
Description of parameter .
Description of parameter .
Exceptions:
<exception class> Description of criteria for throwing this exception.
Write detailed description for Vec2i here.
Remarks:
Write remarks for Vec2i here.
See also:
Separate items with the '|' character. 

Member Function Documentation
Vec2i OpenArena::Vec2i::cross (const Vec2i &) const
Write brief comment for cross here. 

Parameters:
Description of parameter .
Returns:
Write description of return value here.
Exceptions:
<exception class> Description of criteria for throwing this exception.
Write detailed description for cross here.
Remarks:
Write remarks for cross here.
See also:
Separate items with the '|' character. 
int OpenArena::Vec2i::length () const
Write brief comment for length here. 

Returns:
Write description of return value here.
Exceptions:
<exception class> Description of criteria for throwing this exception.
Write detailed description for length here.
Remarks:
Write remarks for length here.
See also:
Separate items with the '|' character. 
int OpenArena::Vec2i::lengthsquared () const
Write brief comment for lengthsquared here. 

Returns:
Write description of return value here.
Exceptions:
<exception class> Description of criteria for throwing this exception.
Write detailed description for lengthsquared here.
Remarks:
Write remarks for lengthsquared here.
See also:
Separate items with the '|' character. 
void OpenArena::Vec2i::normalize ()
Write brief comment for normalize here. 

Exceptions:
<exception class> Description of criteria for throwing this exception.
Write detailed description for normalize here.
Remarks:
Write remarks for normalize here.
See also:
Separate items with the '|' character. 
Vec2i OpenArena::Vec2i::normalized () const
Write brief comment for normalized here. 

Returns:
Write description of return value here.
Exceptions:
<exception class> Description of criteria for throwing this exception.
Write detailed description for normalized here.
Remarks:
Write remarks for normalized here.
See also:
Separate items with the '|' character. 
Vec2i OpenArena::Vec2i::operator * (int) const
Write brief comment for operator * here. 

Parameters:
Description of parameter .
Returns:
Write description of return value here.
Exceptions:
<exception class> Description of criteria for throwing this exception.
Write detailed description for operator * here.
Remarks:
Write remarks for operator * here.
See also:
Separate items with the '|' character. 
Vec2i OpenArena::Vec2i::operator * (const Vec2i &) const
Write brief comment for operator * here. 

Parameters:
Description of parameter .
Returns:
Write description of return value here.
Exceptions:
<exception class> Description of criteria for throwing this exception.
Write detailed description for operator * here.
Remarks:
Write remarks for operator * here.
See also:
Separate items with the '|' character. 
bool OpenArena::Vec2i::operator!= (const Vec2i &) const
Write brief comment for operator != here. 

Parameters:
Description of parameter .
Returns:
Write description of return value here.
Exceptions:
<exception class> Description of criteria for throwing this exception.
Write detailed description for operator != here.
Remarks:
Write remarks for operator != here.
See also:
Separate items with the '|' character. 
Vec2i OpenArena::Vec2i::operator+ (const Vec2i &) const
Write brief comment for operator + here. 

Parameters:
Description of parameter .
Returns:
Write description of return value here.
Exceptions:
<exception class> Description of criteria for throwing this exception.
Write detailed description for operator + here.
Remarks:
Write remarks for operator + here.
See also:
Separate items with the '|' character. 
Vec2i OpenArena::Vec2i::operator- (const Vec2i &) const
Write brief comment for operator - here. 

Parameters:
Description of parameter .
Returns:
Write description of return value here.
Exceptions:
<exception class> Description of criteria for throwing this exception.
Write detailed description for operator - here.
Remarks:
Write remarks for operator - here.
See also:
Separate items with the '|' character. 
Vec2i OpenArena::Vec2i::operator/ (int) const
Write brief comment for operator / here. 

Parameters:
Description of parameter .
Returns:
Write description of return value here.
Exceptions:
<exception class> Description of criteria for throwing this exception.
Write detailed description for operator / here.
Remarks:
Write remarks for operator / here.
See also:
Separate items with the '|' character. 
Vec2i OpenArena::Vec2i::operator= (const Vec2i &)
Write brief comment for operator = here. 

Parameters:
Description of parameter .
Returns:
Write description of return value here.
Exceptions:
<exception class> Description of criteria for throwing this exception.
Write detailed description for operator = here.
Remarks:
Write remarks for operator = here.
See also:
Separate items with the '|' character. 
bool OpenArena::Vec2i::operator== (const Vec2i &) const
Write brief comment for operator == here. 

Parameters:
Description of parameter .
Returns:
Write description of return value here.
Exceptions:
<exception class> Description of criteria for throwing this exception.
Write detailed description for operator == here.
Remarks:
Write remarks for operator == here.
See also:
Separate items with the '|' character. 

Member Data Documentation
int OpenArena::Vec2i::x
int OpenArena::Vec2i::y

The documentation for this class was generated from the following files:
src/vector.h
src/vector.cpp

OpenArena::Vec3d Class Reference
Write brief comment for Vec3d here. 
 #include <vector.h>
Public Member Functions
Vec3d ()
Write brief comment for Vec3d here. 

Vec3d (const Vec3d &)
Write brief comment for Vec3d here. 

Vec3d (double, double)
Write brief comment for Vec3d here. 

Vec3d (double, double, double)
Write brief comment for Vec3d here. 

double lengthsquared () const 
Write brief comment for lengthsquared here. 

double length () const 
Write brief comment for length here. 

void normalize ()
Write brief comment for normalize here. 

Vec3d normalized () const 
Write brief comment for normalized here. 

Vec3d cross (const Vec3d &) const 
Write brief comment for cross here. 

void operator= (const Vec3d &)
Write brief comment for operator = here. 

Vec3d operator * (const Vec3d &) const 
Write brief comment for operator * here. 

Vec3d operator+ (const Vec3d &) const 
Write brief comment for operator + here. 

Vec3d operator- (const Vec3d &) const 
Write brief comment for operator - here. 

Vec3d operator * (double) const 
Write brief comment for operator * here. 

Vec3d operator/ (double) const 
Write brief comment for operator / here. 

Public Attributes
double x
double y
double z

Detailed Description
Write brief comment for Vec3d here. 

Write detailed description for Vec3d here.
Remarks:
Write remarks for Vec3d here.
See also:
Separate items with the '|' character. 

Constructor & Destructor Documentation
OpenArena::Vec3d::Vec3d ()
Write brief comment for Vec3d here. 

Exceptions:
<exception class> Description of criteria for throwing this exception.
Write detailed description for Vec3d here.
Remarks:
Write remarks for Vec3d here.
See also:
Separate items with the '|' character. 
OpenArena::Vec3d::Vec3d (const Vec3d &)
Write brief comment for Vec3d here. 

Parameters:
Description of parameter .
Exceptions:
<exception class> Description of criteria for throwing this exception.
Write detailed description for Vec3d here.
Remarks:
Write remarks for Vec3d here.
See also:
Separate items with the '|' character. 
OpenArena::Vec3d::Vec3d (double, double)
Write brief comment for Vec3d here. 

Parameters:
Description of parameter .
Description of parameter .
Exceptions:
<exception class> Description of criteria for throwing this exception.
Write detailed description for Vec3d here.
Remarks:
Write remarks for Vec3d here.
See also:
Separate items with the '|' character. 
OpenArena::Vec3d::Vec3d (double, double, double)
Write brief comment for Vec3d here. 

Parameters:
Description of parameter .
Description of parameter .
Description of parameter .
Exceptions:
<exception class> Description of criteria for throwing this exception.
Write detailed description for Vec3d here.
Remarks:
Write remarks for Vec3d here.
See also:
Separate items with the '|' character. 

Member Function Documentation
Vec3d OpenArena::Vec3d::cross (const Vec3d &) const
Write brief comment for cross here. 

Parameters:
Description of parameter .
Returns:
Write description of return value here.
Exceptions:
<exception class> Description of criteria for throwing this exception.
Write detailed description for cross here.
Remarks:
Write remarks for cross here.
See also:
Separate items with the '|' character. 
double OpenArena::Vec3d::length () const
Write brief comment for length here. 

Returns:
Write description of return value here.
Exceptions:
<exception class> Description of criteria for throwing this exception.
Write detailed description for length here.
Remarks:
Write remarks for length here.
See also:
Separate items with the '|' character. 
double OpenArena::Vec3d::lengthsquared () const
Write brief comment for lengthsquared here. 

Returns:
Write description of return value here.
Exceptions:
<exception class> Description of criteria for throwing this exception.
Write detailed description for lengthsquared here.
Remarks:
Write remarks for lengthsquared here.
See also:
Separate items with the '|' character. 
void OpenArena::Vec3d::normalize ()
Write brief comment for normalize here. 

Exceptions:
<exception class> Description of criteria for throwing this exception.
Write detailed description for normalize here.
Remarks:
Write remarks for normalize here.
See also:
Separate items with the '|' character. 
Vec3d OpenArena::Vec3d::normalized () const
Write brief comment for normalized here. 

Returns:
Write description of return value here.
Exceptions:
<exception class> Description of criteria for throwing this exception.
Write detailed description for normalized here.
Remarks:
Write remarks for normalized here.
See also:
Separate items with the '|' character. 
Vec3d OpenArena::Vec3d::operator * (double) const
Write brief comment for operator * here. 

Parameters:
Description of parameter .
Returns:
Write description of return value here.
Exceptions:
<exception class> Description of criteria for throwing this exception.
Write detailed description for operator * here.
Remarks:
Write remarks for operator * here.
See also:
Separate items with the '|' character. 
Vec3d OpenArena::Vec3d::operator * (const Vec3d &) const
Write brief comment for operator * here. 

Parameters:
Description of parameter .
Returns:
Write description of return value here.
Exceptions:
<exception class> Description of criteria for throwing this exception.
Write detailed description for operator * here.
Remarks:
Write remarks for operator * here.
See also:
Separate items with the '|' character. 
Vec3d OpenArena::Vec3d::operator+ (const Vec3d &) const
Write brief comment for operator + here. 

Parameters:
Description of parameter .
Returns:
Write description of return value here.
Exceptions:
<exception class> Description of criteria for throwing this exception.
Write detailed description for operator + here.
Remarks:
Write remarks for operator + here.
See also:
Separate items with the '|' character. 
Vec3d OpenArena::Vec3d::operator- (const Vec3d &) const
Write brief comment for operator - here. 

Parameters:
Description of parameter .
Returns:
Write description of return value here.
Exceptions:
<exception class> Description of criteria for throwing this exception.
Write detailed description for operator - here.
Remarks:
Write remarks for operator - here.
See also:
Separate items with the '|' character. 
Vec3d OpenArena::Vec3d::operator/ (double) const
Write brief comment for operator / here. 

Parameters:
Description of parameter .
Returns:
Write description of return value here.
Exceptions:
<exception class> Description of criteria for throwing this exception.
Write detailed description for operator / here.
Remarks:
Write remarks for operator / here.
See also:
Separate items with the '|' character. 
void OpenArena::Vec3d::operator= (const Vec3d &)
Write brief comment for operator = here. 

Parameters:
Description of parameter .
Exceptions:
<exception class> Description of criteria for throwing this exception.
Write detailed description for operator = here.
Remarks:
Write remarks for operator = here.
See also:
Separate items with the '|' character. 

Member Data Documentation
double OpenArena::Vec3d::x
double OpenArena::Vec3d::y
double OpenArena::Vec3d::z

The documentation for this class was generated from the following files:
src/vector.h
src/vector.cpp

OpenArena::VideoPlugin Class Reference
Write brief comment for VideoPlugin here. 
 #include <VideoPlugin.h>
Inheritance diagram for OpenArena::VideoPlugin:

IMAGE
Public Member Functions
virtual ~VideoPlugin ()
Write brief comment for ~VideoPlugin here. 

virtual Window * CreateNewWindow (uint32 width, uint32 height, uint32 bpp=32, bool fullscreen=false, const char *title=NULL)=0
Write brief comment for CreateNewWindow here. 

Detailed Description
Write brief comment for VideoPlugin here. 

Write detailed description for VideoPlugin here.
Remarks:
Write remarks for VideoPlugin here.
See also:
Separate items with the '|' character. 

Constructor & Destructor Documentation
virtual OpenArena::VideoPlugin::~VideoPlugin () [inline, virtual]
Write brief comment for ~VideoPlugin here. 

Exceptions:
<exception class> Description of criteria for throwing this exception.
Write detailed description for ~VideoPlugin here.
Remarks:
Write remarks for ~VideoPlugin here.
See also:
Separate items with the '|' character. 

Member Function Documentation
virtual Window* OpenArena::VideoPlugin::CreateNewWindow (uint32 width, uint32 height, uint32 bpp = 32, bool fullscreen = false, const char * title = NULL) [pure virtual]
Write brief comment for CreateNewWindow here. 

Parameters:
width Description of parameter width.
height Description of parameter height.
bpp Description of parameter bpp.
fullscreen Description of parameter fullscreen.
title Description of parameter title.
Returns:
Write description of return value here.
Exceptions:
<exception class> Description of criteria for throwing this exception.
Write detailed description for CreateNewWindow here.
Remarks:
Write remarks for CreateNewWindow here.
See also:
Separate items with the '|' character. 
Implemented in OpenArena::NullVideoPlugin (p.pagenum).
The documentation for this class was generated from the following file:
src/VideoPlugin.h

OpenArena::Window Class Reference
Write brief comment for Window here. 
 #include <window.h>
Inheritance diagram for OpenArena::Window:

IMAGE
Public Member Functions
Window ()
Write brief comment for Window here. 

~Window ()
Write brief comment for ~Window here. 

void Close ()
Write brief comment for Close here. 

bool Open ()
Write brief comment for Open here. 

bool Open (string title, int width, int height, int bits, bool fullscreenflag)
Write brief comment for Open here. 

void SetInitializer (Initializer *initializer)
Write brief comment for SetInitializer here. 

void SetResizer (Resizer *resizer)
Write brief comment for SetResizer here. Write brief comment for SetResizer here. 

void SwapBuffers ()
Write brief comment for SwapBuffers here. 

void Resize (GLsizei width, GLsizei height)
Write brief comment for Resize here. 

Vec2i GetMousePosition ()
Write brief comment for GetMousePosition here. 

void SetMousePosition (Vec2i pos)
Write brief comment for SetMousePosition here. 

Private Attributes
Resizer * _resizer
Initializer * _initializer
Classes
class Initializer
Write brief comment for Initializer here. 

class Resizer
Write brief comment for Resizer here. 

Detailed Description
Write brief comment for Window here. 

Write detailed description for Window here.
Remarks:
Write remarks for Window here.
See also:
Separate items with the '|' character. 

Constructor & Destructor Documentation
OpenArena::Window::Window ()
Write brief comment for Window here. 

Exceptions:
<exception class> Description of criteria for throwing this exception.
Write detailed description for Window here.
Remarks:
Write remarks for Window here.
See also:
Separate items with the '|' character. 
OpenArena::Window::~Window ()
Write brief comment for ~Window here. 

Exceptions:
<exception class> Description of criteria for throwing this exception.
Write detailed description for ~Window here.
Remarks:
Write remarks for ~Window here.
See also:
Separate items with the '|' character. 

Member Function Documentation
void OpenArena::Window::Close ()
Write brief comment for Close here. 

Exceptions:
<exception class> Description of criteria for throwing this exception.
Write detailed description for Close here.
Remarks:
Write remarks for Close here.
See also:
Separate items with the '|' character. 
Vec2i OpenArena::Window::GetMousePosition ()
Write brief comment for GetMousePosition here. 

Returns:
Write description of return value here.
Exceptions:
<exception class> Description of criteria for throwing this exception.
Write detailed description for GetMousePosition here.
Remarks:
Write remarks for GetMousePosition here.
See also:
Separate items with the '|' character. 
bool OpenArena::Window::Open (string title, int width, int height, int bits, bool fullscreenflag)
Write brief comment for Open here. 

Parameters:
title Description of parameter title.
width Description of parameter width.
height Description of parameter height.
bits Description of parameter bits.
fullscreenflag Description of parameter fullscreenflag.
Returns:
Write description of return value here.
Exceptions:
<exception class> Description of criteria for throwing this exception.
Write detailed description for Open here.
Remarks:
Write remarks for Open here.
See also:
Separate items with the '|' character. 
bool OpenArena::Window::Open ()
Write brief comment for Open here. 

Returns:
Write description of return value here.
Exceptions:
<exception class> Description of criteria for throwing this exception.
Write detailed description for Open here.
Remarks:
Write remarks for Open here.
See also:
Separate items with the '|' character. 
void OpenArena::Window::Resize (GLsizei width, GLsizei height)
Write brief comment for Resize here. 

Parameters:
width Description of parameter width.
height Description of parameter height.
Exceptions:
<exception class> Description of criteria for throwing this exception.
Write detailed description for Resize here.
Remarks:
Write remarks for Resize here.
See also:
Separate items with the '|' character. 
void OpenArena::Window::SetInitializer (Initializer * initializer)
Write brief comment for SetInitializer here. 

Parameters:
initializer Description of parameter initializer.
Exceptions:
<exception class> Description of criteria for throwing this exception.
Write detailed description for SetInitializer here.
Remarks:
Write remarks for SetInitializer here.
See also:
Separate items with the '|' character. 
void OpenArena::Window::SetMousePosition (Vec2i pos)
Write brief comment for SetMousePosition here. 

Parameters:
pos Description of parameter pos.
Exceptions:
<exception class> Description of criteria for throwing this exception.
Write detailed description for SetMousePosition here.
Remarks:
Write remarks for SetMousePosition here.
See also:
Separate items with the '|' character. 
void OpenArena::Window::SetResizer (Resizer * resizer)
Write brief comment for SetResizer here. Write brief comment for SetResizer here. 

Parameters:
resizer Description of parameter resizer.
Exceptions:
<exception class> Description of criteria for throwing this exception.
Write detailed description for SetResizer here.
Remarks:
Write remarks for SetResizer here.
See also:
Separate items with the '|' character. 
void OpenArena::Window::SwapBuffers ()
Write brief comment for SwapBuffers here. 

Exceptions:
<exception class> Description of criteria for throwing this exception.
Write detailed description for SwapBuffers here.
Remarks:
Write remarks for SwapBuffers here.
See also:
Separate items with the '|' character. 

Member Data Documentation
Initializer* OpenArena::Window::_initializer [private]
Resizer* OpenArena::Window::_resizer [private]

The documentation for this class was generated from the following files:
src/window.h
src/window.cpp

OpenArena::Window::Initializer Class Reference
Write brief comment for Initializer here. 
 #include <window.h>
Public Member Functions
int Initialize ()
Write brief comment for Initialize here. 

Detailed Description
Write brief comment for Initializer here. 

Write detailed description for Initializer here.
Remarks:
Write remarks for Initializer here.
See also:
Separate items with the '|' character. 

Member Function Documentation
int OpenArena::Window::Initializer::Initialize ()
Write brief comment for Initialize here. 

Returns:
Write description of return value here.
Exceptions:
<exception class> Description of criteria for throwing this exception.
Write detailed description for Initialize here.
Remarks:
Write remarks for Initialize here.
See also:
Separate items with the '|' character. 

The documentation for this class was generated from the following files:
src/window.h
src/window.cpp

OpenArena::Window::Resizer Class Reference
Write brief comment for Resizer here. 
 #include <window.h>
Public Member Functions
void Resize (GLsizei width, GLsizei height)
Write brief comment for Resize here. 

Detailed Description
Write brief comment for Resizer here. 

Write detailed description for Resizer here.
Remarks:
Write remarks for Resizer here.
See also:
Separate items with the '|' character. 

Member Function Documentation
void OpenArena::Window::Resizer::Resize (GLsizei width, GLsizei height)
Write brief comment for Resize here. 

Parameters:
width Description of parameter width.
height Description of parameter height.
Exceptions:
<exception class> Description of criteria for throwing this exception.
Write detailed description for Resize here.
Remarks:
Write remarks for Resize here.
See also:
Separate items with the '|' character. 

The documentation for this class was generated from the following files:
src/window.h
src/window.cpp

OpenArena::WindowsLogger Class Reference
Write brief comment for WindowsLogger here. 
 #include <WindowsLogger.h>
Inheritance diagram for OpenArena::WindowsLogger:

IMAGE
Public Member Functions
WindowsLogger ()
Write brief comment for WindowsLogger here. 

WindowsLogger (Logger::MessageType type)
Write brief comment for WindowsLogger here. 

virtual void Log (const char *message, MessageType type=MESSAGETYPE_INFORMATION)
Write brief comment for Log here. 

virtual void Log (const char *message, const char *classification, MessageType type=MESSAGETYPE_INFORMATION)
Write brief comment for Log here. 

virtual ~WindowsLogger ()
Write brief comment for ~WindowsLogger here. 

Private Member Functions
uint32 GetIconFromMessageType (MessageType type)
Write brief comment for GetIconFromMessageType here. 

Private Attributes
MessageType _type

Detailed Description
Write brief comment for WindowsLogger here. 

Write detailed description for WindowsLogger here.
Remarks:
Write remarks for WindowsLogger here.
See also:
Separate items with the '|' character. 

Constructor & Destructor Documentation
OpenArena::WindowsLogger::WindowsLogger ()
Write brief comment for WindowsLogger here. 

Exceptions:
<exception class> Description of criteria for throwing this exception.
Write detailed description for WindowsLogger here.
Remarks:
Write remarks for WindowsLogger here.
See also:
Separate items with the '|' character. 
OpenArena::WindowsLogger::WindowsLogger (Logger::MessageType type)
Write brief comment for WindowsLogger here. 

Parameters:
type Description of parameter type.
Exceptions:
<exception class> Description of criteria for throwing this exception.
Write detailed description for WindowsLogger here.
Remarks:
Write remarks for WindowsLogger here.
See also:
Separate items with the '|' character. 
OpenArena::WindowsLogger::~WindowsLogger () [virtual]
Write brief comment for ~WindowsLogger here. 

Exceptions:
<exception class> Description of criteria for throwing this exception.
Write detailed description for ~WindowsLogger here.
Remarks:
Write remarks for ~WindowsLogger here.
See also:
Separate items with the '|' character. 

Member Function Documentation
uint32 OpenArena::WindowsLogger::GetIconFromMessageType (MessageType type) [private]
Write brief comment for GetIconFromMessageType here. 

Parameters:
type Description of parameter type.
Returns:
Write description of return value here.
Exceptions:
<exception class> Description of criteria for throwing this exception.
Write detailed description for GetIconFromMessageType here.
Remarks:
Write remarks for GetIconFromMessageType here.
See also:
Separate items with the '|' character. 
void OpenArena::WindowsLogger::Log (const char * message, const char * classification, MessageType type = MESSAGETYPE_INFORMATION) [virtual]
Write brief comment for Log here. 

Parameters:
message Description of parameter message.
classification Description of parameter classification.
type Description of parameter type.
Exceptions:
<exception class> Description of criteria for throwing this exception.
Write detailed description for Log here.
Remarks:
Write remarks for Log here.
See also:
Separate items with the '|' character. 
void OpenArena::WindowsLogger::Log (const char * message, MessageType type = MESSAGETYPE_INFORMATION) [virtual]
Write brief comment for Log here. 

Parameters:
message Description of parameter message.
type Description of parameter type.
Exceptions:
<exception class> Description of criteria for throwing this exception.
Write detailed description for Log here.
Remarks:
Write remarks for Log here.
See also:
Separate items with the '|' character. 

Member Data Documentation
MessageType OpenArena::WindowsLogger::_type [private]

The documentation for this class was generated from the following files:
src/WindowsLogger.h
src/WindowsLogger.cpp

OpenArena File Documentation
src/bmp.cpp File Reference
#include <cstdio>
#include <GL/gl.h>
#include "bmp.h"
#include "datatypes.h"
Namespaces
namespace OpenArena
Classes
struct OpenArena::BITMAP_HEADER
struct OpenArena::BITMAP_INFO
struct OpenArena::BITMAP_QUAD
Defines
#define BITMAP_MAGIC  19778
Functions
void OpenArena::PrintBMPHeader (BITMAP_HEADER header)
void OpenArena::PrintBMPInfo (BITMAP_INFO info)
TextureImage * OpenArena::LoadBMP (const char *Filename)
Loads a bitmap (*.bmp) file and returns a pointer to a TextureImage object. 

Define Documentation
#define BITMAP_MAGIC  19778

src/bmp.h File Reference
#include "texture.h"
Namespaces
namespace OpenArena
Functions
TextureImage * OpenArena::LoadBMP (const char *Filename)
Loads a bitmap (*.bmp) file and returns a pointer to a TextureImage object. 

src/camera.cpp File Reference
#include "camera.h"
Namespaces
namespace OpenArena

src/camera.h File Reference
#include <cmath>
#include "vector.h"
#include "mygl.h"
#include "screen.h"
Namespaces
namespace OpenArena
Classes
class OpenArena::Camera
The Camera class represents a camera or view in 3-dimensional space. 

src/ctrls.cpp File Reference
#include "ctrls.h"
Namespaces
namespace OpenArena

src/ctrls.h File Reference
#include "keys.h"
#include "datatypes.h"
#include "list.h"
Namespaces
namespace OpenArena
Classes
class OpenArena::ControlScheme
This class represents a user's control scheme. 

src/datatypes.h File Reference

src/geometry.h File Reference
#include "vector.h"
#include "myglTexture.h"
Namespaces
namespace OpenArena
Classes
class OpenArena::Triangle
Write brief comment for Triangle here. 

src/image.h File Reference
#include "datatypes.h"
Namespaces
namespace OpenArena
Classes
class OpenArena::Image
Write brief comment for Image here. 

src/keys.cpp File Reference
#include "keys.h"
Functions
char OpenArena::KeyToASCII (Keys key, bool shift)
Write brief comment for KeyToASCII here. 

src/keys.h File Reference
Namespaces
namespace OpenArena
Enumerations
enum OpenArena::Keys { OpenArena::KEY_UNKNOWN =  0, OpenArena::KEY_BUTTON0, OpenArena::KEY_BUTTON1, OpenArena::KEY_BUTTON2, OpenArena::KEY_BUTTON3, OpenArena::KEY_BUTTON4, OpenArena::KEY_LEFT, OpenArena::KEY_RIGHT, OpenArena::KEY_UP, OpenArena::KEY_DOWN, OpenArena::KEY_SPACE, OpenArena::KEY_RETURN, OpenArena::KEY_SHIFT, OpenArena::KEY_PAUSE, OpenArena::KEY_CONTROL, OpenArena::KEY_CAPITAL, OpenArena::KEY_ESCAPE, OpenArena::KEY_PRIOR, OpenArena::KEY_NEXT, OpenArena::KEY_END, OpenArena::KEY_HOME, OpenArena::KEY_INSERT, OpenArena::KEY_DELETE, OpenArena::KEY_LWIN, OpenArena::KEY_RWIN, OpenArena::KEY_APPS, OpenArena::KEY_NUMPAD0, OpenArena::KEY_NUMPAD1, OpenArena::KEY_NUMPAD2, OpenArena::KEY_NUMPAD3, OpenArena::KEY_NUMPAD4, OpenArena::KEY_NUMPAD5, OpenArena::KEY_NUMPAD6, OpenArena::KEY_NUMPAD7, OpenArena::KEY_NUMPAD8, OpenArena::KEY_NUMPAD9, OpenArena::KEY_MULTIPLY, OpenArena::KEY_ADD, OpenArena::KEY_SUBTRACT, OpenArena::KEY_DIVIDE, OpenArena::KEY_F1, OpenArena::KEY_F2, OpenArena::KEY_F3, OpenArena::KEY_F4, OpenArena::KEY_F5, OpenArena::KEY_F6, OpenArena::KEY_F7, OpenArena::KEY_F8, OpenArena::KEY_F9, OpenArena::KEY_F10, OpenArena::KEY_F11, OpenArena::KEY_F12, OpenArena::KEY_NUMLOCK, OpenArena::KEY_SCROLL, OpenArena::KEY_SEPARATOR, OpenArena::KEY_OEM_1, OpenArena::KEY_OEM_2, OpenArena::KEY_OEM_3, OpenArena::KEY_OEM_4, OpenArena::KEY_OEM_5, OpenArena::KEY_OEM_6, OpenArena::KEY_OEM_7, OpenArena::KEY_OEM_PERIOD, OpenArena::KEY_OEM_PLUS, OpenArena::KEY_OEM_MINUS, OpenArena::KEY_OEM_COMMA, OpenArena::KEY_BACK, OpenArena::KEY_TAB, OpenArena::KEY_0, OpenArena::KEY_1, OpenArena::KEY_2, OpenArena::KEY_3, OpenArena::KEY_4, OpenArena::KEY_5, OpenArena::KEY_6, OpenArena::KEY_7, OpenArena::KEY_8, OpenArena::KEY_9, OpenArena::KEY_A, OpenArena::KEY_B, OpenArena::KEY_C, OpenArena::KEY_D, OpenArena::KEY_E, OpenArena::KEY_F, OpenArena::KEY_G, OpenArena::KEY_H, OpenArena::KEY_I, OpenArena::KEY_J, OpenArena::KEY_K, OpenArena::KEY_L, OpenArena::KEY_M, OpenArena::KEY_N, OpenArena::KEY_O, OpenArena::KEY_P, OpenArena::KEY_Q, OpenArena::KEY_R, OpenArena::KEY_S, OpenArena::KEY_T, OpenArena::KEY_U, OpenArena::KEY_V, OpenArena::KEY_W, OpenArena::KEY_X, OpenArena::KEY_Y, OpenArena::KEY_Z }
Write brief comment for Keys here. 

Functions
char OpenArena::KeyToASCII (Keys key, bool shift)
Write brief comment for KeyToASCII here. 

Variables
const Keys OpenArena::KEY_LBUTTON = KEY_BUTTON0
Write brief comment for KEY_LBUTTON here. 

const Keys OpenArena::KEY_RBUTTON = KEY_BUTTON1
Write brief comment for KEY_RBUTTON here. 

const Keys OpenArena::KEY_MBUTTON = KEY_BUTTON2
Write brief comment for KEY_MBUTTON here. 

src/level.cpp File Reference
#include "level.h"
#include "version.h"
Namespaces
namespace OpenArena
namespace std

src/level.h File Reference
#include <string>
#include <fstream>
#include <cctype>
#include <cmath>
#include <iostream>
#include <cstdio>
#include "mydefs.h"
#include "bmp.h"
#include "tga.h"
#include "list.h"
#include "vector.h"
#include "camera.h"
#include "geometry.h"
#include "myglFont.h"
#include "myglTexture.h"
#include "player.h"
#include "strmanip.h"
#include "keys.h"
Namespaces
namespace OpenArena
Classes
class OpenArena::Level
Enumerations
enum { OpenArena::GL_MY_TEXTURE_CONSOLEBACKGROUND = 0, OpenArena::NUM_MENU_TEXTURES }
Write brief comment for GL_MY_TEXTURE_CONSOLEBACKGROUND here. 

Variables
const float OpenArena::piover180 = 0.0174532925f
Write brief comment for piover180 here. 

const string OpenArena::DEFAULT_TEXTURE_NAME = "oa/textures/default.bmp"
Write brief comment for DEFAULT_TEXTURE_NAME here. 

const unsigned int OpenArena::MAX_CONSOLE_LINES = 30
Write brief comment for MAX_CONSOLE_LINES here. 

const unsigned int OpenArena::MAX_CONSOLE_HISTORY_LINES = MAX_CONSOLE_LINES + 20
Write brief comment for MAX_CONSOLE_HISTORY_LINES here. 

const unsigned int OpenArena::MAX_CONSOLE_OUTPUT_LINES = MAX_CONSOLE_LINES
Write brief comment for MAX_CONSOLE_OUTPUT_LINES here. 

const unsigned int OpenArena::MAX_OUTPUT_TEXT_LINES = 4
Write brief comment for MAX_OUTPUT_TEXT_LINES here. 

src/linux.cpp File Reference

src/list.h File Reference
#include <cstdlib>
Namespaces
namespace OpenArena
Classes
class OpenArena::listNode< ItemType >
Write brief comment for listNode here. 

class OpenArena::list< ItemType >
Write brief comment for list here. 

Typedefs
typedef unsigned int OpenArena::LIST_ARRAY_INDEX_TYPE

src/Logger.h File Reference
Namespaces
namespace OpenArena
Classes
class OpenArena::Logger
Write brief comment for Logger here. 

src/macosx.cpp File Reference

src/main.h File Reference
#include <cstdio>
#include <math.h>
#include "camera.h"
#include "level.h"
#include "mygl.h"
#include "worlddefs.h"
#include "mydefs.h"
#include "screen.h"
#include "window.h"
#include "vector.h"
Functions
void InitControls ()
Write brief comment for InitControls here. 

int InitGL ()
Write brief comment for InitGL here. 

void ReSizeGLScene (GLsizei width, GLsizei height)
Write brief comment for ReSizeGLScene here. 

Variables
static bool keys [256]
static bool keys2 [256]
static bool active = true
static bool fullscreen = true
static OpenArena::Vec2i g_mousePosition
static float lastTime = 0.0f
static float currentTime

Function Documentation
void InitControls ()
Write brief comment for InitControls here. 

Exceptions:
<exception class> Description of criteria for throwing this exception.
Write detailed description for InitControls here.
Remarks:
Write remarks for InitControls here.
See also:
Separate items with the '|' character. 
int InitGL ()
Write brief comment for InitGL here. 

Returns:
Write description of return value here.
Exceptions:
<exception class> Description of criteria for throwing this exception.
Write detailed description for InitGL here.
Remarks:
Write remarks for InitGL here.
See also:
Separate items with the '|' character. 
void ReSizeGLScene (GLsizei width, GLsizei height)
Write brief comment for ReSizeGLScene here. 

Parameters:
width Description of parameter width.
height Description of parameter height.
Exceptions:
<exception class> Description of criteria for throwing this exception.
Write detailed description for ReSizeGLScene here.
Remarks:
Write remarks for ReSizeGLScene here.
See also:
Separate items with the '|' character. 

Variable Documentation
bool active = true [static]
float currentTime [static]
bool fullscreen = true [static]
OpenArena::Vec2i g_mousePosition [static]
bool keys[256] [static]
bool keys2[256] [static]
float lastTime = 0.0f [static]

src/mydefs.h File Reference

src/mygl.cpp File Reference
#include "mygl.h"
Namespaces
namespace OpenArena
Functions
void OpenArena::FreeGLTexture (GLuint &)
Write brief comment for FreeGLTexture here. 

bool OpenArena::LoadGLTexture (string, GLuint &, GLuint=GL_LINEAR, GLuint=GL_LINEAR)
Write brief comment for LoadGLTexture here. 

Variables
OpenArena::Window g_Screen

Variable Documentation
OpenArena::Window g_Screen

src/mygl.h File Reference
#include <string>
#include "datatypes.h"
#include "screen.h"
#include "tga.h"
#include "bmp.h"
#include "strmanip.h"
#include "window.h"
Namespaces
namespace OpenArena
Functions
bool OpenArena::LoadGLTexture (string, GLuint &, GLuint=GL_LINEAR, GLuint=GL_LINEAR)
Write brief comment for LoadGLTexture here. 

void OpenArena::FreeGLTexture (GLuint &)
Write brief comment for FreeGLTexture here. 

Variables
OpenArena::Window g_Screen

Variable Documentation
OpenArena::Window g_Screen

src/myglFont.cpp File Reference
#include "myglFont.h"
Namespaces
namespace OpenArena

src/myglFont.h File Reference
#include "mygl.h"
Namespaces
namespace OpenArena
Classes
class OpenArena::Font
Write brief comment for Font here. 

src/myglTexture.cpp File Reference
#include "myglTexture.h"
Namespaces
namespace OpenArena

src/myglTexture.h File Reference
#include <string>
#include "datatypes.h"
#include "mygl.h"
Namespaces
namespace OpenArena
Classes
class OpenArena::Texture
Write brief comment for Texture here. 

src/NullVideoPlugin.cpp File Reference
#include "NullVideoPlugin.h"
Namespaces
namespace OpenArena

src/NullVideoPlugin.h File Reference
#include "VideoPlugin.h"
Namespaces
namespace OpenArena
Classes
class OpenArena::NullVideoPlugin
Write brief comment for NullVideoPlugin here. 

src/player.cpp File Reference
#include "player.h"
Namespaces
namespace OpenArena

src/player.h File Reference
#include "camera.h"
#include "ctrls.h"
Namespaces
namespace OpenArena
Classes
class OpenArena::Player
Write brief comment for Player here. 

src/Plugin.h File Reference
Namespaces
namespace OpenArena
Classes
class OpenArena::Plugin
Write brief comment for Plugin here. 

src/PluginManager.cpp File Reference
#include "PluginManager.h"
#include "NullVideoPlugin.h"
Namespaces
namespace OpenArena

src/PluginManager.h File Reference
#include "list.h"
#include "Plugin.h"
#include "VideoPlugin.h"
Namespaces
namespace OpenArena
Classes
class OpenArena::PluginManager
Write brief comment for PluginManager here. 

src/screen.cpp File Reference
#include "screen.h"
Namespaces
namespace OpenArena

src/screen.h File Reference
#include <string>
Namespaces
namespace OpenArena
Classes
class OpenArena::Screen
Write brief comment for Screen here. 

src/strmanip.cpp File Reference
#include <cctype>
#include "strmanip.h"
Functions
bool Truth (std::string str)
int Integer (std::string str)
float Floating (std::string str)
string KeyString (uint8 key)
Write brief comment for KeyString here. 

uint8 KeyName (std::string str)
string Right (string str, uint32 len)
Write brief comment for Right here. 

string Left (string str, uint32 len)
Write brief comment for Left here. 

string tolower (string str)
Write brief comment for tolower here. 

string toupper (string str)
Write brief comment for toupper here. 

string word (string str, uint32 wordNum)
Write brief comment for word here. 

Function Documentation
float Floating (std::string str)
int Integer (std::string str)
uint8 KeyName (std::string str)
string KeyString (uint8)
Write brief comment for KeyString here. 

Parameters:
Description of parameter .
Returns:
Write description of return value here.
Exceptions:
<exception class> Description of criteria for throwing this exception.
Write detailed description for KeyString here.
Remarks:
Write remarks for KeyString here.
See also:
Separate items with the '|' character. 
string Left (string, uint32)
Write brief comment for Left here. 

Parameters:
Description of parameter .
Description of parameter .
Returns:
Write description of return value here.
Exceptions:
<exception class> Description of criteria for throwing this exception.
Write detailed description for Left here.
Remarks:
Write remarks for Left here.
See also:
Separate items with the '|' character. 
string Right (string, uint32)
Write brief comment for Right here. 

Parameters:
Description of parameter .
Description of parameter .
Returns:
Write description of return value here.
Exceptions:
<exception class> Description of criteria for throwing this exception.
Write detailed description for Right here.
Remarks:
Write remarks for Right here.
See also:
Separate items with the '|' character. 
string tolower (string)
Write brief comment for tolower here. 

Parameters:
Description of parameter .
Returns:
Write description of return value here.
Exceptions:
<exception class> Description of criteria for throwing this exception.
Write detailed description for tolower here.
Remarks:
Write remarks for tolower here.
See also:
Separate items with the '|' character. 
string toupper (string)
Write brief comment for toupper here. 

Parameters:
Description of parameter .
Returns:
Write description of return value here.
Exceptions:
<exception class> Description of criteria for throwing this exception.
Write detailed description for toupper here.
Remarks:
Write remarks for toupper here.
See also:
Separate items with the '|' character. 
bool Truth (std::string str)
string word (string, uint32)
Write brief comment for word here. 

Parameters:
Description of parameter .
Description of parameter .
Returns:
Write description of return value here.
Exceptions:
<exception class> Description of criteria for throwing this exception.
Write detailed description for word here.
Remarks:
Write remarks for word here.
See also:
Separate items with the '|' character. 

src/strmanip.h File Reference
#include <string>
#include <cmath>
#include "keys.h"
#include "datatypes.h"
Functions
bool Truth (string str)
Write brief comment for Truth here. 

int Integer (string str)
Write brief comment for Integer here. 

float Floating (string str)
Write brief comment for Floating here. 

uint8 KeyName (string str)
Write brief comment for KeyName here. 

string KeyString (uint8)
Write brief comment for KeyString here. 

string Right (string, uint32)
Write brief comment for Right here. 

string Left (string, uint32)
Write brief comment for Left here. 

string tolower (string)
Write brief comment for tolower here. 

string toupper (string)
Write brief comment for toupper here. 

string word (string, uint32)
Write brief comment for word here. 

Function Documentation
float Floating (string str)
Write brief comment for Floating here. 

Parameters:
str Description of parameter str.
Returns:
Write description of return value here.
Exceptions:
<exception class> Description of criteria for throwing this exception.
Write detailed description for Floating here.
Remarks:
Write remarks for Floating here.
See also:
Separate items with the '|' character. 
int Integer (string str)
Write brief comment for Integer here. 

Parameters:
str Description of parameter str.
Returns:
Write description of return value here.
Exceptions:
<exception class> Description of criteria for throwing this exception.
Write detailed description for Integer here.
Remarks:
Write remarks for Integer here.
See also:
Separate items with the '|' character. 
uint8 KeyName (string str)
Write brief comment for KeyName here. 

Parameters:
str Description of parameter str.
Returns:
Write description of return value here.
Exceptions:
<exception class> Description of criteria for throwing this exception.
Write detailed description for KeyName here.
Remarks:
Write remarks for KeyName here.
See also:
Separate items with the '|' character. 
string KeyString (uint8)
Write brief comment for KeyString here. 

Parameters:
Description of parameter .
Returns:
Write description of return value here.
Exceptions:
<exception class> Description of criteria for throwing this exception.
Write detailed description for KeyString here.
Remarks:
Write remarks for KeyString here.
See also:
Separate items with the '|' character. 
string Left (string, uint32)
Write brief comment for Left here. 

Parameters:
Description of parameter .
Description of parameter .
Returns:
Write description of return value here.
Exceptions:
<exception class> Description of criteria for throwing this exception.
Write detailed description for Left here.
Remarks:
Write remarks for Left here.
See also:
Separate items with the '|' character. 
string Right (string, uint32)
Write brief comment for Right here. 

Parameters:
Description of parameter .
Description of parameter .
Returns:
Write description of return value here.
Exceptions:
<exception class> Description of criteria for throwing this exception.
Write detailed description for Right here.
Remarks:
Write remarks for Right here.
See also:
Separate items with the '|' character. 
string tolower (string)
Write brief comment for tolower here. 

Parameters:
Description of parameter .
Returns:
Write description of return value here.
Exceptions:
<exception class> Description of criteria for throwing this exception.
Write detailed description for tolower here.
Remarks:
Write remarks for tolower here.
See also:
Separate items with the '|' character. 
string toupper (string)
Write brief comment for toupper here. 

Parameters:
Description of parameter .
Returns:
Write description of return value here.
Exceptions:
<exception class> Description of criteria for throwing this exception.
Write detailed description for toupper here.
Remarks:
Write remarks for toupper here.
See also:
Separate items with the '|' character. 
bool Truth (string str)
Write brief comment for Truth here. 

Parameters:
str Description of parameter str.
Returns:
Write description of return value here.
Exceptions:
<exception class> Description of criteria for throwing this exception.
Write detailed description for Truth here.
Remarks:
Write remarks for Truth here.
See also:
Separate items with the '|' character. 
string word (string, uint32)
Write brief comment for word here. 

Parameters:
Description of parameter .
Description of parameter .
Returns:
Write description of return value here.
Exceptions:
<exception class> Description of criteria for throwing this exception.
Write detailed description for word here.
Remarks:
Write remarks for word here.
See also:
Separate items with the '|' character. 

src/texture.h File Reference
Namespaces
namespace OpenArena
Classes
class OpenArena::TextureImage
Write brief comment for TextureImage here. 

src/tga.cpp File Reference
#include "tga.h"
#include "datatypes.h"
Namespaces
namespace OpenArena
Functions
TextureImage * OpenArena::LoadTGA (const char *filename)
Write brief comment for LoadTGA here. 

TextureImage * OpenArena::LoadUncompressedTGA (FILE *fTGA)
TextureImage * OpenArena::LoadCompressedTGA (FILE *fTGA)

src/tga.h File Reference
#include <GL/gl.h>
#include <cstdio>
#include <string>
#include "texture.h"
Namespaces
namespace OpenArena
Classes
struct OpenArena::TGAHeader
Write brief comment for TGAHeader here. 

struct OpenArena::TGA
Write brief comment for TGA here. 

Functions
TextureImage * OpenArena::LoadTGA (const char *filename)
Write brief comment for LoadTGA here. 

TextureImage * OpenArena::LoadUncompressedTGA (FILE *fTGA)
TextureImage * OpenArena::LoadCompressedTGA (FILE *fTGA)
Variables
const GLubyte OpenArena::uTGAcompare [12] = {0,0,2, 0,0,0,0,0,0,0,0,0}
const GLubyte OpenArena::cTGAcompare [12] = {0,0,10,0,0,0,0,0,0,0,0,0}

src/vector.cpp File Reference
#include "vector.h"
Namespaces
namespace OpenArena

src/vector.h File Reference
#include <cmath>
Namespaces
namespace OpenArena
Classes
class OpenArena::Vec3d
Write brief comment for Vec3d here. 

class OpenArena::Vec2f
Write brief comment for Vec2f here. 

class OpenArena::Vec2i
Write brief comment for Vec2i here. 

Typedefs
typedef Vec3d OpenArena::Vec3f
Functions
Vec3d OpenArena::Vector (double, double)
Write brief comment for Vector here. 

src/version.h File Reference
Defines
#define OPENARENA_VERSION  "OpenArena: CVS"

Define Documentation
#define OPENARENA_VERSION  "OpenArena: CVS"

src/VideoPlugin.h File Reference
#include "Plugin.h"
#include "window.h"
#include "datatypes.h"
Namespaces
namespace OpenArena
Classes
class OpenArena::VideoPlugin
Write brief comment for VideoPlugin here. 

src/window.cpp File Reference
#include "window.h"

src/window.h File Reference
#include "screen.h"
#include "vector.h"
Namespaces
namespace OpenArena
Classes
class OpenArena::Window
Write brief comment for Window here. 

class OpenArena::Window::Resizer
Write brief comment for Resizer here. 

class OpenArena::Window::Initializer
Write brief comment for Initializer here. 

src/windows.cpp File Reference

src/WindowsLogger.cpp File Reference
#include <cstdlib>
#include "WindowsLogger.h"
#include <windows.h>
Namespaces
namespace OpenArena

src/WindowsLogger.h File Reference
#include "logger.h"
#include "datatypes.h"
Namespaces
namespace OpenArena
Classes
class OpenArena::WindowsLogger
Write brief comment for WindowsLogger here. 

src/worlddefs.h File Reference
#include "level.h"
Variables
static OpenArena::Level level

Variable Documentation
OpenArena::Level level [static]

Index
INDEX