jpt-archive/cpp_photon
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

documentation cleanup

Browse Source
This commit is contained in:
James Turk 2005-11-13 07:59:48 +00:00
parent 9c8f42df8d
commit f7bc2ac6dd
33 changed files with 496 additions and 470 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
CHANGELOG.txt
View File

@ -1,11 +1,17 @@
Changelog for Photon Changelog for Photon
$Id: CHANGELOG.txt,v 1.12 2005/08/23 21:55:03 cozman Exp $ $Id: CHANGELOG.txt,v 1.13 2005/11/13 07:59:48 cozman Exp $
! : Major Changes (potentially breaking existing code) ! : Major Changes (potentially breaking existing code)
+ : New Features + : New Features
* : Minor Changes (bugfixes and behind-the-scenes changes) * : Minor Changes (bugfixes and behind-the-scenes changes)
0.1.0 0.1.0
* Major documentation sweep, much more useful for casual users. Also fixed
tons of documentation mismatches.
* Fixed bug where app would hang if run() was called with no active state or
before the display was created.
* Changed AudioCore to be pure virtual with OALAudioCore implementing it.
* Fixed issues with OpenAL 1.1 new types.
* Rewrote circle drawing code in Pen, major speed up. * Rewrote circle drawing code in Pen, major speed up.
0.0.2 - Released 2005-18-08 0.0.2 - Released 2005-18-08

32
LIBRARIES.txt
View File

@ -1,8 +1,9 @@
$Id: LIBRARIES.txt,v 1.1 2005/07/20 21:56:33 cozman Exp $ $Id: LIBRARIES.txt,v 1.2 2005/11/13 07:59:48 cozman Exp $
Photon uses several other libraries, which fall under a variety of licenses: Photon uses several other libraries, which fall under a variety of licenses:
GLFW - http://glfw.sourceforge.net/ - zlib license GLFW - http://glfw.sourceforge.net/ - zlib license
Boost - http://boost.org/ - Boost Software License
PhysFS - http://icculus.org/physfs/ - zlib license PhysFS - http://icculus.org/physfs/ - zlib license
Corona - http://corona.sourceforge.net/ - zlib license Corona - http://corona.sourceforge.net/ - zlib license
Freetype2 - http://freetype.org/ - Freetype License (FTL) Freetype2 - http://freetype.org/ - Freetype License (FTL)
@ -20,11 +21,14 @@ uses photon and it's dependencies you must do the following:
1) To satisfy the zlib license that photon and most of the other libs use, 1) To satisfy the zlib license that photon and most of the other libs use,
you simply must not claim you wrote them & not remove the zlib license you simply must not claim you wrote them & not remove the zlib license
in license.txt, also any changes must be marked if that applies to you. in license.txt, also any changes must be marked if that applies to you.
2) To comply with the Freetype license you must not claim you wrote it, 2) Complying with the Boost Software License is the easiest, if distributing
Boost source code, you must include the BSL, if distributing object
code (eg. library or executable) nothing actually needs to be done.
3) To comply with the Freetype license you must not claim you wrote it,
but you must also give credit to the authors. The credit clause is but you must also give credit to the authors. The credit clause is
the only real difference between the Freetype License and the zlib the only real difference between the Freetype License and the zlib
license. license.
3) If you are using OpenAL, you are most likely dynamically linking (using 4) If you are using OpenAL, you are most likely dynamically linking (using
a .dll or .so) which means that in order to comply with the LGPL you a .dll or .so) which means that in order to comply with the LGPL you
must: Make it clear that you are using OpenAL in your credits file, must: Make it clear that you are using OpenAL in your credits file,
include a copy of the LGPL with any binaries, provide a link to the include a copy of the LGPL with any binaries, provide a link to the
@ -45,13 +49,15 @@ libraries which isn't necessary but I feel it's proper.)
This application uses Photon which is available from This application uses Photon which is available from
http://photon.sourceforge.net/ and is licensed under a zlib license. http://photon.sourceforge.net/ and is licensed under a zlib license.
Photon (and this application) uses several other zlib-licensed libraries: Other libraries used indirectly or directly by this program include:
GLFW - http://glfw.sourceforge.net/ GLFW - http://glfw.sourceforge.net/ - zlib license
PhysFS - http://icculus.org/physfs/ Boost - http://boost.org/ - Boost Software License
Corona - http://corona.sourceforge.net/ PhysFS - http://icculus.org/physfs/ - zlib license
Photon (and this application) also uses Freetype2 which is licensed under the Corona - http://corona.sourceforge.net/ - zlib license
Freetype license. Freetype2 - http://freetype.org/ - Freetype License (FTL)
Photon (and this application) also uses OpenAL which is licensed under the LGPL OpenAL - http://openal.org/ - LGPL
To comply with the LGPL a copy of a copy of the LGPL is provided in this
directory as LGPL.txt. A copy of the OpenAL source is available from To comply with the LGPL a copy of a copy of the LGPL is provided in this
http://openal.org/ directory as LGPL.txt.
A copy of the OpenAL source is available from http://openal.org/

10
README.txt
View File

@ -4,10 +4,10 @@ accelerated 2D games with OpenGL and other open source & cross platform
libraries. Photon aims to simplify portable game development, enabling libraries. Photon aims to simplify portable game development, enabling
developers to focus on the gameplay. Photon uses OpenGL for hardware accelerated developers to focus on the gameplay. Photon uses OpenGL for hardware accelerated
rotation, alpha blending, resizing, and drawing. Photon is built entirely on rotation, alpha blending, resizing, and drawing. Photon is built entirely on
free software, using libraries like GLFW, PhysFS, OpenAL, and boost. Using free software, using libraries including including GLFW, PhysFS, OpenAL, Corona,
Photon does not require knowledge of any of these libraries as their needed Freetype and boost.. Using Photon does not require knowledge of any of these
functionality is wrapped entirely within Photon’s rich class library so that libraries as their needed functionality is wrapped entirely within Photon’s rich
anyone with a decent grasp of C++ can use Photon. class library so that anyone with a decent grasp of C++ can use Photon.
photon is a cross platform API, designed primarily for game development. photon is a cross platform API, designed primarily for game development.
photon is designed to run on as many operating systems as possible, and OS photon is designed to run on as many operating systems as possible, and OS
support is only limited by libraries which Photon depends on, at the moment support is only limited by libraries which Photon depends on, at the moment
@ -27,4 +27,4 @@ with your applications.
If you need any help or have any questions check out IFAQ.txt or visit photon's If you need any help or have any questions check out IFAQ.txt or visit photon's
homepage at http://photon.sourceforge.net/. homepage at http://photon.sourceforge.net/.
$Id: README.txt,v 1.1 2005/07/17 22:41:03 cozman Exp $ $Id: README.txt,v 1.2 2005/11/13 07:59:48 cozman Exp $

11
SConstruct
View File

@ -5,7 +5,7 @@
# James Turk (jpt2433@rit.edu) # James Turk (jpt2433@rit.edu)
# #
# Version: # Version:
# $Id: SConstruct,v 1.23 2005/08/18 02:23:47 cozman Exp $ # $Id: SConstruct,v 1.24 2005/11/13 07:59:48 cozman Exp $
import os,os.path import os,os.path
import glob import glob
@ -70,10 +70,13 @@ if not env.GetOption('clean'):
Exit(1) Exit(1)
if not conf.CheckLibWithHeader('freetype', 'ft2build.h', 'C++'): if not conf.CheckLibWithHeader('freetype', 'ft2build.h', 'C++'):
print 'Freetype2 not found, exiting.' print 'Freetype2 not found, exiting.'
Exit(1) Exit(1)
if not conf.CheckLibWithHeader('corona', 'corona.h', 'C++'): if not conf.CheckLibWithHeader('corona', 'corona.h', 'C++'):
print 'Corona not found, exiting.' print 'Corona not found, exiting.'
Exit(1) Exit(1)
if not conf.CheckCXXHeader('boost/utility.hpp'):
print 'Boost not found, exiting.'
Exit(1)
if conf.CheckLibWithHeader(OAL_LIB, 'AL/al.h', 'C++'): if conf.CheckLibWithHeader(OAL_LIB, 'AL/al.h', 'C++'):
conf.env.Append(CPPFLAGS='-DPHOTON_USE_OPENAL') conf.env.Append(CPPFLAGS='-DPHOTON_USE_OPENAL')
else: else:
@ -93,8 +96,10 @@ env.Default(LIBRARY)
# Documentation # Documentation
ndoc = env.Command('docs/index.html', './include', ndoc = env.Command('docs/index.html', './include',
"""NaturalDocs -nag -i $SOURCES -o HTML ./docs -p ./ndoc""") """NaturalDocs -nag -i $SOURCES -i ndoc/pages -o HTML ./docs -p ./ndoc""")
env.Alias("docs",ndoc) env.Alias("docs",ndoc)
env.AlwaysBuild(ndoc)
# Tests: # Tests:
tests = [] tests = []

67
include/Application.hpp
View File

@ -5,7 +5,7 @@
// James Turk (jpt2433@rit.edu) // James Turk (jpt2433@rit.edu)
// //
// Version: // Version:
// $Id: Application.hpp,v 1.22 2005/08/17 06:35:56 cozman Exp $ // $Id: Application.hpp,v 1.23 2005/11/13 07:59:48 cozman Exp $
#ifndef PHOTON_APPLICATION_HPP #ifndef PHOTON_APPLICATION_HPP
#define PHOTON_APPLICATION_HPP #define PHOTON_APPLICATION_HPP
@ -28,8 +28,9 @@ namespace photon
{ {
// Class: Application // Class: Application
// Photon main class, contains functions that control creation of the display, // Application main class, contains functions that control creation of the
// setting the OpenGL view, input handling, timing, and <State> management. // display, setting the OpenGL view, input handling, timing, and <State>
// management.
// //
// Application is a <Singleton> and therefore should be accessed through // Application is a <Singleton> and therefore should be accessed through
// Application::getInstance(). (Application Singleton is created/destroyed // Application::getInstance(). (Application Singleton is created/destroyed
@ -51,17 +52,18 @@ public:
public: public:
// Function: run // Function: run
// Runs application until a quit is requested either via the operating // Runs application until a quit is requested either via the operating
// system (ex. Alt-F4) or through a call to <quit>. // system (ex Alt-F4) or through a call to <quit>.
// //
// Should not be called before a <State> has been set and a display has // Throws:
// been created via <createDisplay>. // <PreconditionException> if called before a <State> has been set
// and a display has been created via <createDisplay>.
void run(); void run();
// called by run while !quit() // called internally by run while !quit()
void update(); void update();
// Function: quit // Function: quit
// Sets Quit flag, terminating application. // Sets quit flag, terminating application.
void quit(); void quit();
// Function: getUpdateTaskManager // Function: getUpdateTaskManager
@ -69,7 +71,7 @@ public:
// this TaskManager are executed after the current <State::update>. // this TaskManager are executed after the current <State::update>.
// //
// Returns: // Returns:
// Reference to "Update TaskManager" // Reference to "Update <TaskManager>"
util::TaskManager& getUpdateTaskManager(); util::TaskManager& getUpdateTaskManager();
// Function: getRenderTaskManager // Function: getRenderTaskManager
@ -77,7 +79,7 @@ public:
// this TaskManager are executed after the current <State::render>. // this TaskManager are executed after the current <State::render>.
// //
// Returns: // Returns:
// Reference to "Render TaskManager" // Reference to "Render <TaskManager>"
util::TaskManager& getRenderTaskManager(); util::TaskManager& getRenderTaskManager();
// Function: isActive // Function: isActive
@ -91,7 +93,8 @@ public:
// Group: Window // Group: Window
public: public:
// Function: createDisplay // Function: createDisplay
// This function attempts to create a display with the given parameters. // This function attempts to create a display with the given parameters.
// Takes arguments for R,G,B,A values separately, generally not needed.
// //
// Parameters: // Parameters:
// width - desired width of display // width - desired width of display
@ -103,7 +106,7 @@ public:
// depthBits - desired bitdepth of depth buffer // depthBits - desired bitdepth of depth buffer
// stencilBits - desired bitdepth of stencil buffer // stencilBits - desired bitdepth of stencil buffer
// fullscreen - true: fullscreen, false: windowed // fullscreen - true: fullscreen, false: windowed
// [title - title of application, optional] // [title - title of application, optional]
void createDisplay(uint width, uint height, void createDisplay(uint width, uint height,
uint redBits, uint greenBits, uint blueBits, uint redBits, uint greenBits, uint blueBits,
uint alphaBits, uint depthBits, uint stencilBits, uint alphaBits, uint depthBits, uint stencilBits,
@ -111,6 +114,8 @@ public:
// Function: createDisplay // Function: createDisplay
// This function attempts to create a display with the given parameters. // This function attempts to create a display with the given parameters.
// Takes one consolidated bpp value, which is generally preferred over
// separate R,G,B,A values.
// //
// Parameters: // Parameters:
// width - desired width of display // width - desired width of display
@ -180,7 +185,7 @@ public:
// Creates a viewport with a given 3D perspective inside of a rectangular // Creates a viewport with a given 3D perspective inside of a rectangular
// portion of the screen. // portion of the screen.
// //
// Note that <setDepthTestMode>(true) will be called as a side effect. // Note that <setDepthBufferParams> (true) will be called as a side effect.
// //
// Parameters: // Parameters:
// x - X coord for top left corner of new viewport. // x - X coord for top left corner of new viewport.
@ -196,7 +201,7 @@ public:
// Function: setPerspectiveView // Function: setPerspectiveView
// Sets entire screen as current viewport with a given 3D perspective. // Sets entire screen as current viewport with a given 3D perspective.
// //
// Note that <setDepthTestMode>(true) will be called as a side effect. // Note that <setDepthBufferParams> (true) will be called as a side effect.
// //
// Parameters: // Parameters:
// fovy - The y axis field of view angle, in degrees. // fovy - The y axis field of view angle, in degrees.
@ -329,7 +334,7 @@ public:
// Function: setFixedUpdateStep // Function: setFixedUpdateStep
// Sets a fixed timestep to be used in calls to the current <State's> // Sets a fixed timestep to be used in calls to the current <State's>
// update method. This allows stability in physics systems. // update method. This greatly enhances stability in physics systems.
// //
// Parameters: // Parameters:
// enable - if true, will enable fixed timestepping (if false will disable) // enable - if true, will enable fixed timestepping (if false will disable)
@ -343,10 +348,10 @@ public:
// Group: State Management // Group: State Management
public: public:
// Function: setState // Function: setState
// Set the current Application <State>, removing all other <States>. // Set the current Application <State>, first popping all current states.
// //
// Template Parameters: // Template Parameters:
// StateT - Class derived from <State> to set as current. // StateT - <State>-derived class to make current state.
template<class StateT> template<class StateT>
void setState(); void setState();
@ -354,7 +359,7 @@ public:
// Push a new <State>, does not remove old <State>. // Push a new <State>, does not remove old <State>.
// //
// Template Parameters: // Template Parameters:
// StateT - Class derived from <State> to push. // StateT - <State>-derived class to push.
template<class StateT> template<class StateT>
void pushState(); void pushState();
@ -369,18 +374,24 @@ public:
// Get the Application's <AudioCore>, should only be called after // Get the Application's <AudioCore>, should only be called after
// <initAudioCore>. // <initAudioCore>.
// //
// Note that this function only exists if photon is compiled with Audio
// support enabled.
//
// Return: // Return:
// Reference to the <AudioCore>. // Reference to the <AudioCore>.
audio::AudioCore& getAudioCore(); audio::AudioCore& getAudioCore();
// Function: initAudioCore // Function: initAudioCore
// Initialize the <AudioCore>, should be done before attempting to access // Initialize the <AudioCore>, should be done before attempting to access
// it via <getAudioCore>. // it via <getAudioCore>.
// //
// Arguments: // Note that this function only exists if photon is compiled with Audio
// deviceName - Optional name for desired Audio device, will use default // support enabled.
// device if none specified. //
void initAudioCore(const std::string& deviceName=""); // Arguments:
// deviceName - Optional name for desired Audio device, will use default
// device if none specified.
void initAudioCore(const std::string& deviceName="");
#endif //PHOTON_USE_OPENAL #endif //PHOTON_USE_OPENAL
// Callbacks // Callbacks

6
include/Log.hpp
View File

@ -5,7 +5,7 @@
// James Turk (jpt2433@rit.edu) // James Turk (jpt2433@rit.edu)
// //
// Version: // Version:
// $Id: Log.hpp,v 1.8 2005/08/02 23:07:52 cozman Exp $ // $Id: Log.hpp,v 1.9 2005/11/13 07:59:48 cozman Exp $
#ifndef PHOTON_LOG_HPP #ifndef PHOTON_LOG_HPP
#define PHOTON_LOG_HPP #define PHOTON_LOG_HPP
@ -28,11 +28,11 @@ class Log
// Group: (Con/De)structors // Group: (Con/De)structors
public: public:
// Function: Log // Function: Log
// Log constructor, initializes log singleton. // Log constructor, initializes a log with no sinks.
Log(); Log();
// Function: ~Log // Function: ~Log
// Log destructor, destroys log singleton. // Log destructor, destroys log, flushing output streams/closing sinks.
~Log(); ~Log();
// Group: Sink Maintenance // Group: Sink Maintenance

10
include/LogSink.hpp
View File

@ -5,7 +5,7 @@
// James Turk (jpt2433@rit.edu) // James Turk (jpt2433@rit.edu)
// //
// Version: // Version:
// $Id: LogSink.hpp,v 1.2 2005/02/16 06:58:05 cozman Exp $ // $Id: LogSink.hpp,v 1.3 2005/11/13 07:59:48 cozman Exp $
#ifndef PHOTON_LOGSINK_HPP #ifndef PHOTON_LOGSINK_HPP
#define PHOTON_LOGSINK_HPP #define PHOTON_LOGSINK_HPP
@ -42,8 +42,8 @@ enum LogLevel
}; };
// Class: LogSink // Class: LogSink
// Base class for all LogSinks to be used with <Log>, derived classes must // Virtual base class for all LogSinks to be used with <Log>, derived classes
// define message(LogLevel level, std::string string). // must define writeMessage(LogLevel level, std::string string).
// A LogSink recieves any messages passed to the log it's registered with. // A LogSink recieves any messages passed to the log it's registered with.
// //
// Children: // Children:
@ -103,7 +103,9 @@ private:
typedef shared_ptr<LogSink> LogSinkPtr; typedef shared_ptr<LogSink> LogSinkPtr;
// Class: ConsoleSink // Class: ConsoleSink
// <LogSink> to be used with <Log> for simple console output. // <LogSink> to be used with <Log> for simple console output. Note that due
// to nature of buffered I/O it is important to flush the stream to see output
// in realtime with ConsoleSink
// //
// See Also: // See Also:
// <TextSink>, <HTMLSink> // <TextSink>, <HTMLSink>

34
include/ResourceManaged.hpp
View File

@ -5,7 +5,7 @@
// James Turk (jpt2433@rit.edu) // James Turk (jpt2433@rit.edu)
// //
// Version: // Version:
// $Id: ResourceManaged.hpp,v 1.8 2005/08/08 19:19:24 cozman Exp $ // $Id: ResourceManaged.hpp,v 1.9 2005/11/13 07:59:48 cozman Exp $
#ifndef PHOTON_RESOURCEMANAGED_HPP #ifndef PHOTON_RESOURCEMANAGED_HPP
#define PHOTON_RESOURCEMANAGED_HPP #define PHOTON_RESOURCEMANAGED_HPP
@ -22,20 +22,24 @@ namespace photon
// resources that can be controlled, such as textures and music, can be // resources that can be controlled, such as textures and music, can be
// derived. Resource managed classes rely on a <ResourceManager>. // derived. Resource managed classes rely on a <ResourceManager>.
// //
// Unless extending Photon, generally ResourceManaged does not need to be
// directly used. For this reason public documentation is not availble. See
// ResourceManaged.hpp for documentation.
//
// Children: // Children:
// <Texture>, <Image> // <Texture>, <Image>
// //
// <Sample> // <Source>
template<class ResMgrT> template<class ResMgrT>
class ResourceManaged class ResourceManaged
{ {
// Group: (Con/De)structors // Nondoc-Group: (Con/De)structors
public: public:
// Function: ResourceManaged // Nondoc-Function: ResourceManaged
// Default constructor. // Default constructor.
ResourceManaged(); ResourceManaged();
// Function: ResourceManaged // Nondoc-Function: ResourceManaged
// Initializing constructor, calls <open> with a filename/zipname. // Initializing constructor, calls <open> with a filename/zipname.
// //
// Parameters: // Parameters:
@ -45,45 +49,45 @@ public:
// <open> // <open>
ResourceManaged(const std::string& name); ResourceManaged(const std::string& name);
// Function: ~ResourceManaged // Nondoc-Function: ~ResourceManaged
// Destructor, calls <release>. // Destructor, calls <release>.
virtual ~ResourceManaged(); virtual ~ResourceManaged();
ResourceManaged& operator=(const ResourceManaged &rhs); ResourceManaged& operator=(const ResourceManaged &rhs);
// Group: General // Nondoc-Group: General
public: public:
// Function: open // Nondoc-Function: open
// Opens new resource via the associated <ResourceManager>. // Opens new resource via the associated <ResourceManager>.
// //
// Parameters: // Parameters:
// name - name of resource // name - name of resource
virtual void open(const std::string& name); virtual void open(const std::string& name);
// Function: release // Nondoc-Function: release
// Removes a reference to the resource, releasing if needed. // Removes a reference to the resource, releasing if needed.
// Generally called by destructor, so should rarely be called. // Generally called by destructor, so should rarely be called.
virtual void release(); virtual void release();
// Group: Accessors // Nondoc-Group: Accessors
public: public:
// Function: getName // Nondoc-Function: getName
// Get the name associated with the resource. // Get the name associated with the resource.
// //
// Returns: // Returns:
// Name of resource, or empty string if no resource is loaded. // Name of resource, or empty string if no resource is loaded.
std::string getName() const; std::string getName() const;
// Group: Resource Manager Access // Nondoc-Group: Resource Manager Access
public: public:
static ResMgrT resMgr_; static ResMgrT resMgr_;
// Function: cleanUp // Nondoc-Function: cleanUp
// Cleans up any unused resources of the type. // Cleans up any unused resources of the type.
// (Ex. Image::cleanUp() will unload all images.) // (Ex. Image::cleanUp() will unload all images.)
static void cleanUp(); static void cleanUp();
// Function: addResource // Nondoc-Function: addResource
// Define a new named resource. // Define a new named resource.
// (Ex. Image::addResource("monkey","images/monkey.png") would // (Ex. Image::addResource("monkey","images/monkey.png") would
// make it so that any attempts to load "monkey" would load the image // make it so that any attempts to load "monkey" would load the image
@ -95,7 +99,7 @@ public:
static void addResource(const std::string& name, static void addResource(const std::string& name,
const typename ResMgrT::ResDescT& desc); const typename ResMgrT::ResDescT& desc);
// Function: addResource // Nondoc-Function: addResource
// Define a new unaliased resource. (name == path). // Define a new unaliased resource. (name == path).
// (Ex. Image::addResource("images/monkey.png") is essentially the same as // (Ex. Image::addResource("images/monkey.png") is essentially the same as
// Image::addResource("images/monkey.png","images/monkey.png") // Image::addResource("images/monkey.png","images/monkey.png")

14
include/State.hpp
View File

@ -5,7 +5,7 @@
// James Turk (jpt2433@rit.edu) // James Turk (jpt2433@rit.edu)
// //
// Version: // Version:
// $Id: State.hpp,v 1.4 2005/08/16 06:32:39 cozman Exp $ // $Id: State.hpp,v 1.5 2005/11/13 07:59:48 cozman Exp $
#ifndef PHOTON_STATE_HPP #ifndef PHOTON_STATE_HPP
#define PHOTON_STATE_HPP #define PHOTON_STATE_HPP
@ -24,10 +24,10 @@ namespace photon
// to manage the state that the game is in. // to manage the state that the game is in.
// //
// Implement as many or as few of the members of State as needed (the only // Implement as many or as few of the members of State as needed (the only
// necessary member being <render>) and make the state as current via // necessary member being <render>) and make the state current via
// <Application::setState>. Once a state is made current it's // <Application::setState>/<Application::pushState>. Once a state is made
// update and render methods will be called every frame until either a new // current it's update and render methods will be called every frame until
// state is made current or the application ends. // either a new state is made current or the application ends.
// //
// The active state is also notified of events as they occur, overloading any // The active state is also notified of events as they occur, overloading any
// of the on* functions will result in the overloaded version being called // of the on* functions will result in the overloaded version being called
@ -111,8 +111,8 @@ public:
// Called when the mouse is moved with the amount the mouse was moved by // Called when the mouse is moved with the amount the mouse was moved by
// NOT with the new position. // NOT with the new position.
// //
// If the new position is needed it can be obtained via <getMouseX> and // If the new position is needed it can be obtained via
// <getMouseY>. // <Application::getMouseX> and <Application::getMouseY>.
// //
// Parameters: // Parameters:
// delta - Change in mouse position. // delta - Change in mouse position.

8
include/exceptions.hpp
View File

@ -5,7 +5,7 @@
// James Turk (jpt2433@rit.edu) // James Turk (jpt2433@rit.edu)
// //
// Version: // Version:
// $Id: exceptions.hpp,v 1.6 2005/07/19 01:31:37 cozman Exp $ // $Id: exceptions.hpp,v 1.7 2005/11/13 07:59:48 cozman Exp $
#ifndef PHOTON_EXCEPTIONS_HPP #ifndef PHOTON_EXCEPTIONS_HPP
#define PHOTON_EXCEPTIONS_HPP #define PHOTON_EXCEPTIONS_HPP
@ -101,8 +101,8 @@ public:
}; };
// Class: ArgumentException // Class: ArgumentException
// ArgumentException should be thrown when an argument is passed to a function // ArgumentException should be thrown when an invalid argument is passed to a
// that is invalid. // function.
// //
// Parent: // Parent:
// <Exception> // <Exception>
@ -130,7 +130,7 @@ public:
}; };
// Class: RangeException // Class: RangeException
// RangeException should be thrown if something (such as an array bound) is out // RangeException should be thrown if something (such as an array index) is out
// of bounds. // of bounds.
// //
// Parent: // Parent:

15
include/math/Circle.hpp
View File

@ -5,7 +5,7 @@
// James Turk (jpt2433@rit.edu) // James Turk (jpt2433@rit.edu)
// //
// Version: // Version:
// $Id: Circle.hpp,v 1.3 2005/07/18 05:58:03 cozman Exp $ // $Id: Circle.hpp,v 1.4 2005/11/13 07:59:48 cozman Exp $
#ifndef PHOTON_MATH_CIRCLE_HPP #ifndef PHOTON_MATH_CIRCLE_HPP
#define PHOTON_MATH_CIRCLE_HPP #define PHOTON_MATH_CIRCLE_HPP
@ -23,7 +23,10 @@ class Rect;
// Defines geometric entity known as a circle. // Defines geometric entity known as a circle.
// //
// A plane curve everywhere equidistant from a given fixed point, the center. // A plane curve everywhere equidistant from a given fixed point, the center.
// <http://dictionary.com> // (<http://dictionary.com>)
//
// Exists mainly to provide a bounding circle for objects, simplifying
// collision detection.
// //
// Operators: // Operators:
// - Circle == Circle // - Circle == Circle
@ -116,17 +119,11 @@ public:
// Group: Accessors // Group: Accessors
public: public:
// Function: getCenter // Function: getCenter
// Get center <Point2>. // Get center <Vector2::Point2>.
//
// Returns:
// Center point.
Point2 getCenter() const; Point2 getCenter() const;
// Function: getRadius // Function: getRadius
// Get radius of Circle. // Get radius of Circle.
//
// Returns:
// Radius of circle.
scalar getRadius() const; scalar getRadius() const;
friend std::ostream& operator<<(std::ostream &o, const Circle &circle); friend std::ostream& operator<<(std::ostream &o, const Circle &circle);

59
include/math/Rect.hpp
View File

@ -5,7 +5,7 @@
// James Turk (jpt2433@rit.edu) // James Turk (jpt2433@rit.edu)
// //
// Version: // Version:
// $Id: Rect.hpp,v 1.2 2005/03/03 09:25:19 cozman Exp $ // $Id: Rect.hpp,v 1.3 2005/11/13 07:59:48 cozman Exp $
#ifndef PHOTON_MATH_RECT_HPP #ifndef PHOTON_MATH_RECT_HPP
#define PHOTON_MATH_RECT_HPP #define PHOTON_MATH_RECT_HPP
@ -22,8 +22,11 @@ class Circle;
// Class: Rect // Class: Rect
// Defines geometric entity known as a rectangle. // Defines geometric entity known as a rectangle.
// //
// A four-sided plane figure with four right angles. <http://dictionary.com> // A four-sided plane figure with four right angles. (<http://dictionary.com>)
// //
// Exists mainly to provide a bounding rectangle for objects, simplifying
// collision detection.
//
// Operators: // Operators:
// - Rect == Rect // - Rect == Rect
// - ostream& << Rect // - ostream& << Rect
@ -33,7 +36,7 @@ class Rect
public: public:
// Function: Rect // Function: Rect
// Initializes rectangle at (0,0) with size of 0. // Initializes rectangle at (0,0) with width/height of 0.
Rect(); Rect();
// Function: Rect // Function: Rect
@ -64,14 +67,14 @@ bool operator==(const Rect &rhs) const;
public: public:
// Function: moveTo // Function: moveTo
// move rectangle to new location. // Move rectangle to new location.
// //
// Parameters: // Parameters:
// topleft - Point describing new top left corner. // topleft - Point describing new top left corner.
void moveTo(const Point2 &topleft); void moveTo(const Point2 &topleft);
// Function: moveRel // Function: moveRel
// move rectangle relative to current position. // Move rectangle relative to current position.
// //
// Parameters: // Parameters:
// xMove - Distance to move horizontally. // xMove - Distance to move horizontally.
@ -79,7 +82,7 @@ public:
void moveRel(scalar xMove, scalar yMove); void moveRel(scalar xMove, scalar yMove);
// Function: resize // Function: resize
// set new size for rectangle. // Set new size for rectangle.
// //
// Parameters: // Parameters:
// width - New width for rectangle. // width - New width for rectangle.
@ -87,7 +90,7 @@ public:
void resize(scalar width, scalar height); void resize(scalar width, scalar height);
// Function: resizeRel // Function: resizeRel
// set new size for rectangle, relative to current size. // Set new size for rectangle, relative to current size.
// //
// Parameters: // Parameters:
// widthDelta - Change to be applied to width of rectangle. // widthDelta - Change to be applied to width of rectangle.
@ -139,7 +142,7 @@ public:
bool contains(const Rect &rect) const; bool contains(const Rect &rect) const;
// Function: calcIntersection // Function: calcIntersection
// calculates & returns the intersection of two rectangles. // Calculates & returns the intersection of two rectangles.
// //
// Parameters: // Parameters:
// rect - Rectangle to find & calculate area of intersection with. // rect - Rectangle to find & calculate area of intersection with.
@ -155,87 +158,51 @@ public:
public: public:
// Function: getX // Function: getX
// Get x coord of rectangle. (top left corner) // Get x coord of top left corner of rectangle.
//
// Returns:
// Returns x coord of top left corner of rectangle.
scalar getX() const; scalar getX() const;
// Function: getY // Function: getY
// Get y coord of rectangle. (top left corner) // Get y coord of top left corner of rectangle.
//
// Returns:
// Returns y coord of top left corner of rectangle.
scalar getY() const; scalar getY() const;
// Function: getTop // Function: getTop
// Get y coord of top side of rectangle. // Get y coord of top side of rectangle.
//
// Returns:
// Returns y coord of top side of rectangle.
scalar getTop() const; scalar getTop() const;
// Function: getLeft // Function: getLeft
// Get x coord of left side of rectangle. // Get x coord of left side of rectangle.
//
// Returns:
// Returns x coord of left side rectangle.
scalar getLeft() const; scalar getLeft() const;
// Function: getBottom // Function: getBottom
// Get y coord of bottom side of rectangle. // Get y coord of bottom side of rectangle.
//
// Returns:
// Returns y coord of bottom side of rectangle.
scalar getBottom() const; scalar getBottom() const;
// Function: getRight // Function: getRight
// Get x coord of right side of rectangle. // Get x coord of right side of rectangle.
//
// Returns:
// Returns x coord of right side rectangle.
scalar getRight() const; scalar getRight() const;
// Function: getWidth // Function: getWidth
// Get width of rectangle. // Get width of rectangle.
//
// Returns:
// Returns width of rectangle.
scalar getWidth() const; scalar getWidth() const;
// Function: getHeight // Function: getHeight
// Get height of rectangle. // Get height of rectangle.
//
// Returns:
// Height of rectangle.
scalar getHeight() const; scalar getHeight() const;
// Function: getTopLeft // Function: getTopLeft
// Get top left corner of rectangle. // Get top left corner of rectangle.
//
// Returns:
// Top left corner of rectangle.
Point2 getTopLeft() const; Point2 getTopLeft() const;
// Function: getTopRight // Function: getTopRight
// Get top right corner of rectangle. // Get top right corner of rectangle.
//
// Returns:
// Top right corner of rectangle.
Point2 getTopRight() const; Point2 getTopRight() const;
// Function: getBottomLeft // Function: getBottomLeft
// Get bottom left corner of rectangle. // Get bottom left corner of rectangle.
//
// Returns:
// Bottom left corner of rectangle.
Point2 getBottomLeft() const; Point2 getBottomLeft() const;
// Function: getBottomRight // Function: getBottomRight
// Get bottom right corner of rectangle. // Get bottom right corner of rectangle.
//
// Returns:
// Bottom right corner of rectangle.
Point2 getBottomRight() const; Point2 getBottomRight() const;
friend std::ostream& operator<<(std::ostream &o, const Rect &rect); friend std::ostream& operator<<(std::ostream &o, const Rect &rect);

16
include/math/Vector2.hpp
View File

@ -5,7 +5,7 @@
// James Turk (jpt2433@rit.edu) // James Turk (jpt2433@rit.edu)
// //
// Version: // Version:
// $Id: Vector2.hpp,v 1.5 2005/07/17 02:40:58 cozman Exp $ // $Id: Vector2.hpp,v 1.6 2005/11/13 07:59:48 cozman Exp $
#ifndef PHOTON_MATH_VECTOR2_HPP #ifndef PHOTON_MATH_VECTOR2_HPP
#define PHOTON_MATH_VECTOR2_HPP #define PHOTON_MATH_VECTOR2_HPP
@ -21,7 +21,7 @@ namespace math
// Class: Vector2 // Class: Vector2
// Represents a two-dimensional vector. A quantity specified by a magnitude // Represents a two-dimensional vector. A quantity specified by a magnitude
// and a direction. Vector is oriented in classical 2D graphics format with // and a direction. Vector is oriented in classic 2D graphics format with
// origin at top corner of screen. // origin at top corner of screen.
// //
// Operators: // Operators:
@ -83,7 +83,7 @@ public:
void set(scalar nx, scalar ny); void set(scalar nx, scalar ny);
// Function: resolveDeg // Function: resolveDeg
// resolve vector, given a magnitude & angle in degrees. // Resolve vector, given a magnitude & angle in degrees.
// //
// Parameters: // Parameters:
// magnitude - Magnitude of new vector. // magnitude - Magnitude of new vector.
@ -95,7 +95,7 @@ public:
// Function: resolveRad // Function: resolveRad
// resolve vector, given a magnitude & angle in radians. // Resolve vector, given a magnitude & angle in radians.
// //
// Parameters: // Parameters:
// magnitude - Magnitude of new vector. // magnitude - Magnitude of new vector.
@ -137,7 +137,7 @@ public:
public: public:
// Function: getMagnitude // Function: getMagnitude
// Get length of vector. // Determine length of vector.
// //
// Returns: // Returns:
// Length of the vector. // Length of the vector.
@ -147,13 +147,13 @@ public:
// Angle of vector in degrees, angle is calculated with respect to positive // Angle of vector in degrees, angle is calculated with respect to positive
// X axis. // X axis.
// //
// | |90<EFBFBD> // | |90
// | | // | |
// | | // | |
// |180<EFBFBD>-----------------------0<EFBFBD> or 360<EFBFBD> // |180-----------------------0 or 360
// | | // | |
// | | // | |
// | |270<EFBFBD> // | |270
// //
// Returns: // Returns:
// Angle of vector (in degrees). // Angle of vector (in degrees).

4
include/math/math.hpp
View File

@ -5,7 +5,7 @@
// James Turk (jpt2433@rit.edu) // James Turk (jpt2433@rit.edu)
// //
// Version: // Version:
// $Id: math.hpp,v 1.6 2005/07/18 05:58:03 cozman Exp $ // $Id: math.hpp,v 1.7 2005/11/13 07:59:48 cozman Exp $
#ifndef PHOTON_MATH_MATH_HPP #ifndef PHOTON_MATH_MATH_HPP
#define PHOTON_MATH_MATH_HPP #define PHOTON_MATH_MATH_HPP
@ -48,7 +48,7 @@ T clamp(T val, C low, C high);
// Parameters: // Parameters:
// val1 - First value to compare. // val1 - First value to compare.
// val2 - Second value to compare. // val2 - Second value to compare.
// epsilon - Epsilon value, defaults to 0.0001. // epsilon - Epsilon value, defaults to 0.000001.
// //
// Returns: // Returns:
// true if |val1-val2| < epsilon, meaning values are approximately equal // true if |val1-val2| < epsilon, meaning values are approximately equal

11
include/types.hpp
View File

@ -5,7 +5,7 @@
// James Turk (jpt2433@rit.edu) // James Turk (jpt2433@rit.edu)
// //
// Version: // Version:
// $Id: types.hpp,v 1.8 2005/08/12 06:26:00 cozman Exp $ // $Id: types.hpp,v 1.9 2005/11/13 07:59:48 cozman Exp $
#ifndef PHOTON_TYPES_HPP #ifndef PHOTON_TYPES_HPP
#define PHOTON_TYPES_HPP #define PHOTON_TYPES_HPP
@ -39,7 +39,7 @@ typedef double scalar;
// Group: STL/Boost Types // Group: STL/Boost Types
// Type: StrVec // Type: StrVec
// Typedef for vector of strings, which is used all throughout photon. // Typedef for vector of strings, which is used throughout photon.
typedef std::vector<std::string> StrVec; typedef std::vector<std::string> StrVec;
// Type: shared_ptr // Type: shared_ptr
@ -49,7 +49,10 @@ using boost::shared_ptr;
// Group: Enums // Group: Enums
// Enum: KeyCode // Enum: KeyCode
// Enumeration defining keys, used in <Application::keyPressed>. // Enumeration for keys, includes printable characters and special keys.
//
// Keys are shown roughly in the order they appear on the keyboard to aid
// finding a specific key.
// //
// Enums: // Enums:
// KEY_ESC - Escape key // KEY_ESC - Escape key
@ -305,7 +308,7 @@ enum KeyCode
}; };
// Enum: MouseButton // Enum: MouseButton
// Enumeration defining buttons, used in <Application::mouseButtonPressed>. // Enumeration defining mouse buttons.
// //
// MB_LEFT - Left mouse button. // MB_LEFT - Left mouse button.
// MB_MIDDLE - Middle mouse button. // MB_MIDDLE - Middle mouse button.

4
include/util/ConfigFile.hpp
View File

@ -5,7 +5,7 @@
// James Turk (jpt2433@rit.edu) // James Turk (jpt2433@rit.edu)
// //
// Version: // Version:
// $Id: ConfigFile.hpp,v 1.6 2005/07/19 01:31:37 cozman Exp $ // $Id: ConfigFile.hpp,v 1.7 2005/11/13 07:59:48 cozman Exp $
#ifndef PHOTON_UTIL_CONFIGFILE_HPP #ifndef PHOTON_UTIL_CONFIGFILE_HPP
#define PHOTON_UTIL_CONFIGFILE_HPP #define PHOTON_UTIL_CONFIGFILE_HPP
@ -69,7 +69,7 @@ public:
public: public:
// Function: open // Function: open
// open a file, processing it as an INI-like config file. // Open a file, processing it as an INI-like config file.
// //
// Parameters: // Parameters:
// filename - Name of ConfigFile to open. // filename - Name of ConfigFile to open.

25
include/util/FileBuffer.hpp
View File

@ -5,7 +5,7 @@
// James Turk (jpt2433@rit.edu) // James Turk (jpt2433@rit.edu)
// //
// Version: // Version:
// $Id: FileBuffer.hpp,v 1.4 2005/06/10 07:06:06 cozman Exp $ // $Id: FileBuffer.hpp,v 1.5 2005/11/13 07:59:48 cozman Exp $
#ifndef PHOTON_UTIL_FILEBUFFER_HPP #ifndef PHOTON_UTIL_FILEBUFFER_HPP
#define PHOTON_UTIL_FILEBUFFER_HPP #define PHOTON_UTIL_FILEBUFFER_HPP
@ -23,8 +23,14 @@ namespace util
{ {
// Class: FileBuffer // Class: FileBuffer
// Class for reading data from a file, uses PhysFS <http://physfs.icculus.org> // Class for reading data from a file, uses PhysFS
// and is capable of reading from archives on the search path. // (<http://physfs.icculus.org>)
// and is capable of reading from archives on the search path.
//
// All paths used are relative to the search path.
// By default only files within the directory the application is running or
// it's subdirectories are accessible. Additional directories may be added
// to the search path via <addToSearchPath>.
class FileBuffer class FileBuffer
{ {
@ -38,7 +44,8 @@ public:
// Initializing constructor, calls <open>. // Initializing constructor, calls <open>.
// //
// Parameters: // Parameters:
// filename - Name of file to load. // filename - Name of file to load. (See notes on how FileBuffer handles
// paths at top of page)
FileBuffer(const std::string& filename); FileBuffer(const std::string& filename);
// Function: ~FileBuffer // Function: ~FileBuffer
@ -51,18 +58,20 @@ public:
// Loads a file into the FileBuffer. // Loads a file into the FileBuffer.
// //
// Parameters: // Parameters:
// filename - Name of file to load. // filename - Name of file to load. (See notes on how FileBuffer handles
// paths at top of page)
void open(const std::string& filename); void open(const std::string& filename);
// Function: close // Function: close
// Frees memory occupied by loaded data. // Closes the file, all future read attempts will fail until <open> is
// called agian.
void close(); void close();
// Group: Accessors // Group: Accessors
public: public:
// Function: getData // Function: getData
// Loads an amount of data, returns a pointer to the loaded data. // Reads data from file into a <ubyte>-vector.
// If the requested amount of data wasn't available, returns only // If the requested amount of data wasn't available, returns only
// what could be loaded. If amount is 0 (default), returns entire buffer. // what could be loaded. If amount is 0 (default), returns entire buffer.
// //
@ -88,7 +97,7 @@ public:
uint getSize() const; uint getSize() const;
// Function: isEOF // Function: isEOF
// Checks if internal cursor is at end of file. // Checks if internal cursor has reached end of file.
// //
// Returns: // Returns:
// True iff eof, false otherwise. // True iff eof, false otherwise.

50
include/util/Singleton.hpp
View File

@ -5,7 +5,7 @@
// James Turk (jpt2433@rit.edu) // James Turk (jpt2433@rit.edu)
// //
// Version: // Version:
// $Id: Singleton.hpp,v 1.8 2005/07/18 06:18:51 cozman Exp $ // $Id: Singleton.hpp,v 1.9 2005/11/13 07:59:48 cozman Exp $
#ifndef PHOTON_UTIL_SINGLETON_HPP #ifndef PHOTON_UTIL_SINGLETON_HPP
#define PHOTON_UTIL_SINGLETON_HPP #define PHOTON_UTIL_SINGLETON_HPP
@ -44,19 +44,19 @@ template<class T>
class Singleton : public boost::noncopyable class Singleton : public boost::noncopyable
{ {
public: public:
// Function: initialize
// Initialize the instance of the singleton, can be done explicitly if
// order of construction matters. Will be done on first call to
// getInstance otherwise.
static void initialize();
// Function: destroy // Function: destroy
// Destroy the instance of the singleton, can be done explicitly if order // Destroy the instance of the singleton, must be done for every singleton
// of destruction matters. Will be done automatically if not done. // created.
//
// Throws:
// <PreconditionException> if called for uninitialized singleton
static void destroy(); static void destroy();
// Function: getInstance // Function: getInstance
// Get a reference to the instance of the derived class. // Get a reference to the instance of the derived class.
//
// Throws:
// <PreconditionException> if called for uninitialized singleton
static T& getInstance(); static T& getInstance();
protected: protected:
@ -70,22 +70,6 @@ private:
// template implementation // template implementation
template<class T>
Singleton<T>::Singleton()
{
if(instance_ != 0)
{
throw PreconditionException("Attempt to double-initialize singleton.");
}
instance_ = static_cast<T*>(this); // cast self to type of T*
}
template<class T>
Singleton<T>::~Singleton()
{
}
template<class T> template<class T>
void Singleton<T>::destroy() void Singleton<T>::destroy()
{ {
@ -112,6 +96,22 @@ T& Singleton<T>::getInstance()
return *instance_; //return dereferenced instance return *instance_; //return dereferenced instance
} }
template<class T>
Singleton<T>::Singleton()
{
if(instance_ != 0)
{
throw PreconditionException("Attempt to double-initialize singleton.");
}
instance_ = static_cast<T*>(this); // cast self to type of T*
}
template<class T>
Singleton<T>::~Singleton()
{
}
template<class T> template<class T>
T* Singleton<T>::instance_(0); T* Singleton<T>::instance_(0);

38
include/util/Task.hpp
View File

@ -5,7 +5,7 @@
// James Turk (jpt2433@rit.edu) // James Turk (jpt2433@rit.edu)
// //
// Version: // Version:
// $Id: Task.hpp,v 1.1 2005/08/17 06:35:56 cozman Exp $ // $Id: Task.hpp,v 1.2 2005/11/13 07:59:48 cozman Exp $
#ifndef PHOTON_UTIL_TASK_HPP #ifndef PHOTON_UTIL_TASK_HPP
#define PHOTON_UTIL_TASK_HPP #define PHOTON_UTIL_TASK_HPP
@ -21,15 +21,18 @@ namespace util
// Title: Task // Title: Task
// Group: Task-Related
// Two helper types related to the <Task> class.
// Enum: PriorityLevel // Enum: PriorityLevel
// Enumeration defining priority of a Task. // Enumeration defining priority of a Task.
// //
// Values: // Values:
// PRI_LOWEST - Lowest priority available.
// PRI_LOW - Lower-than-usual priority.
// PRI_NORMAL - Normal priority, suitable for most tasks.
// PRI_HIGH - Lower-than-usual priority.
// PRI_HIGHEST - Highest priority available. // PRI_HIGHEST - Highest priority available.
// PRI_HIGH - Lower-than-usual priority.
// PRI_NORMAL - Normal priority, suitable for most tasks.
// PRI_LOW - Lower-than-usual priority.
// PRI_LOWEST - Lowest priority available.
enum PriorityLevel enum PriorityLevel
{ {
PRI_HIGHEST, PRI_HIGHEST,
@ -39,6 +42,12 @@ enum PriorityLevel
PRI_LOWEST PRI_LOWEST
}; };
// Type: TaskPtr
// Pointer to a task, used since Task is abstract and will always be accessed
// via a pointer.
class Task;
typedef shared_ptr<Task> TaskPtr;
// Class: Task // Class: Task
// Abstract class for tasks, which are runnable classes for use with // Abstract class for tasks, which are runnable classes for use with
// <TaskManager>. // <TaskManager>.
@ -53,9 +62,9 @@ public:
// //
// Parameters: // Parameters:
// name - Name for task, must be unique! // name - Name for task, must be unique!
// priority - Optional argument for desired priority for the Task, // priority - Optional <PriorityLevel> argument for desired priority for
// controls order in which tasks are run by the <TaskManager>. // the Task, controls order in which tasks are run by the
// Default Priority is PRI_NORMAL // <TaskManager>. Default Priority is PRI_NORMAL.
Task(const std::string& name, PriorityLevel priority=PRI_NORMAL); Task(const std::string& name, PriorityLevel priority=PRI_NORMAL);
// Function: ~Task // Function: ~Task
@ -86,8 +95,8 @@ public:
// task is paused. // task is paused.
// //
// Note: // Note:
// Children of onPause should call Task::onPause to let the task know it's // Derived tasks with overloaded onPause methods should call Task::onPause
// been paused. // to let the task know it's been paused.
virtual void onPause(); virtual void onPause();
// Function: onUnpause // Function: onUnpause
@ -95,8 +104,8 @@ public:
// task is unpaused. // task is unpaused.
// //
// Note: // Note:
// Children of onUnpause should call Task::onUnpause to let the task know // Derived tasks with overloaded onUnpaus methods should call
// it's been paused. // Task::onUnpause to let the task know it's been paused.
virtual void onUnpause(); virtual void onUnpause();
// Function: kill // Function: kill
@ -142,11 +151,6 @@ private:
bool paused_; // if false task won't be executed bool paused_; // if false task won't be executed
}; };
// Type: TaskPtr
// Pointer to a task, used since Task is abstract and will always be accessed
// via a pointer.
typedef shared_ptr<Task> TaskPtr;
} }
} }

9
include/util/TaskManager.hpp
View File

@ -5,7 +5,7 @@
// James Turk (jpt2433@rit.edu) // James Turk (jpt2433@rit.edu)
// //
// Version: // Version:
// $Id: TaskManager.hpp,v 1.1 2005/08/17 06:35:56 cozman Exp $ // $Id: TaskManager.hpp,v 1.2 2005/11/13 07:59:48 cozman Exp $
#ifndef PHOTON_UTIL_TASKMANAGER_HPP #ifndef PHOTON_UTIL_TASKMANAGER_HPP
#define PHOTON_UTIL_TASKMANAGER_HPP #define PHOTON_UTIL_TASKMANAGER_HPP
@ -25,8 +25,8 @@ namespace util
// handles adding, deleting, pausing, and unpausing tasks. // handles adding, deleting, pausing, and unpausing tasks.
// //
// To use TaskManager: // To use TaskManager:
// - (1) Add any tasks (should be derived from <Task>) // - Add any tasks (should be derived from <Task>)
// - (2) Call step() every frame when task should update. // - Call step() every frame when task should update.
class TaskManager class TaskManager
{ {
@ -49,8 +49,7 @@ public:
// tasks have the same priority, they are run in the order they were added. // tasks have the same priority, they are run in the order they were added.
// //
// Parameters: // Parameters:
// timeDelta - The time elapsed between frames, possibly fixed via // timeDelta - The time elapsed between frames.
// <Application::setFixedUpdateStep>.
void step(scalar timeDelta); void step(scalar timeDelta);
// Group: Task Management // Group: Task Management

12
include/util/Timer.hpp
View File

@ -5,7 +5,7 @@
// James Turk (jpt2433@rit.edu) // James Turk (jpt2433@rit.edu)
// //
// Version: // Version:
// $Id: Timer.hpp,v 1.4 2005/08/08 07:27:50 cozman Exp $ // $Id: Timer.hpp,v 1.5 2005/11/13 07:59:48 cozman Exp $
#ifndef PHOTON_UTIL_TIMER_HPP #ifndef PHOTON_UTIL_TIMER_HPP
#define PHOTON_UTIL_TIMER_HPP #define PHOTON_UTIL_TIMER_HPP
@ -18,7 +18,7 @@ namespace util
// Class: Timer // Class: Timer
// Class capable of keeping track of time. // Class capable of keeping track of time.
// Time is returned in double format, in seconds. // Time is kept in double format, representing seconds.
class Timer class Timer
{ {
@ -30,7 +30,7 @@ public:
// //
// Parameters: // Parameters:
// appTimeLinked - Option only available on creation of timer. When true // appTimeLinked - Option only available on creation of timer. When true
// timer will pause when the <Application::timer> is paused. // timer will pause when the Application timer is paused.
// [default: true] // [default: true]
Timer(bool appTimeLinked=true); Timer(bool appTimeLinked=true);
@ -57,16 +57,10 @@ public:
public: public:
// Function: getTime // Function: getTime
// Get time in seconds. (ie. A value of .001 means 1 millisecond.) // Get time in seconds. (ie. A value of .001 means 1 millisecond.)
//
// Returns:
// Time on timer, in seconds.
double getTime() const; double getTime() const;
// Function: isPaused // Function: isPaused
// Check paused/unpaused status of timer. // Check paused/unpaused status of timer.
//
// Returns:
// True if timer is paused, false if timer is running.
bool isPaused() const; bool isPaused() const;
private: private:

12
include/util/VersionInfo.hpp
View File

@ -5,7 +5,7 @@
// James Turk (jpt2433@rit.edu) // James Turk (jpt2433@rit.edu)
// //
// Version: // Version:
// $Id: VersionInfo.hpp,v 1.7 2005/07/18 06:18:51 cozman Exp $ // $Id: VersionInfo.hpp,v 1.8 2005/11/13 07:59:48 cozman Exp $
#ifndef PHOTON_UTIL_VERSIONINFO_HPP #ifndef PHOTON_UTIL_VERSIONINFO_HPP
#define PHOTON_UTIL_VERSIONINFO_HPP #define PHOTON_UTIL_VERSIONINFO_HPP
@ -20,7 +20,7 @@ namespace util
// Class: VersionInfo // Class: VersionInfo
// Class which stores version information, such as release numbers. // Class which stores version information, such as release numbers.
// Format is majorRelease.Minor.Release [ExtraInfo]. // Format is Major.Minor.Patch [ExtraInfo].
// //
// Operators: // Operators:
// - VersionInfo < VersionInfo // - VersionInfo < VersionInfo
@ -35,12 +35,12 @@ public:
// Group: Variables // Group: Variables
// Variable: majorRelease // Variable: majorRelease
// major release version number, should be changed when major changes take // Major release version number, should be changed when major changes take
// place. // place.
unsigned int majorRelease; unsigned int majorRelease;
// Variable: minor // Variable: minor
// minor release version number, should be changed when key features are // Minor release version number, should be changed when key features are
// added/removed/changed. // added/removed/changed.
unsigned int minorRelease; unsigned int minorRelease;
@ -54,7 +54,7 @@ public:
std::string extra; std::string extra;
// Group: (Con/De)structors // Group: (Con/De)structors
public:
// Function: VersionInfo // Function: VersionInfo
// Default constructor. // Default constructor.
VersionInfo(); VersionInfo();
@ -63,7 +63,7 @@ public:
// Initializing constructor. // Initializing constructor.
// //
// Parameters: // Parameters:
// maj - majorRelease version number. // maj - Major version number.
// min - Minor version number. // min - Minor version number.
// pat - Patch number. // pat - Patch number.
// ext - Extra info string. [default: ""] // ext - Extra info string. [default: ""]

45
include/util/filesys/filesys.hpp
View File

@ -5,7 +5,7 @@
// James Turk (jpt2433@rit.edu) // James Turk (jpt2433@rit.edu)
// //
// Version: // Version:
// $Id: filesys.hpp,v 1.4 2005/07/20 07:30:13 cozman Exp $ // $Id: filesys.hpp,v 1.5 2005/11/13 07:59:48 cozman Exp $
#ifndef PHOTON_UTIL_FILESYS_FILESYS_HPP #ifndef PHOTON_UTIL_FILESYS_FILESYS_HPP
#define PHOTON_UTIL_FILESYS_FILESYS_HPP #define PHOTON_UTIL_FILESYS_FILESYS_HPP
@ -18,6 +18,34 @@
#include <vector> #include <vector>
// Title: filesys:: // Title: filesys::
// The util::filesys:: namespace is a group of functions all related to dealing
// with the filesystem. Photon uses PhysFS (http://physfs.icculus.org) to
// provide this functionality.
//
// The Search Path:
// The search path is an important concept in Photon, due to the nature of
// PhysFS when a file is referenced Photon attempts to resolve it by checking
// for it within the search path. By default the search path only includes
// the directory where the application resides. Nothing which is not within
// this directory or a directory within it can be accessed.
//
// It is possible to add other directories to the search path using
// <addToSearchPath>. Keep in mind that the search path is a list of
// directories which will be searched in order for any requested files.
// In other words if you wish to store your game media in a format like:
// | game/
// | bin/
// | images/
// | audio/
// | user-audio/
// |
//
// You will need to add images/ and audio/ to the search path since they
// do not reside within bin (where the game is stored). Also assuming
// users are allowed to place custom audio files within user-audio/ you must
// also add it to the path. If you wish for files within it to override
// existing audio files, it should preceed audio/ in the search path, otherwise
// it should come be placed in the search path after audio/.
namespace photon namespace photon
{ {
@ -30,21 +58,24 @@ namespace filesys
// Function: getCDDirs // Function: getCDDirs
// Gets a listing of the CD directories on a system (not supported on all // Gets a listing of the CD directories on a system (not supported on all
// systems) // systems) On Windows it would return something like D:/ or E:/, whereas on
// Linux it would return something like /media/cdrom0.
// //
// Returns: // Returns:
// A vector of strings containing the path to the CD directories. // A vector of strings containing the path to the CD directories.
std::vector<std::string> getCDDirs(); std::vector<std::string> getCDDirs();
// Function: getBaseDir // Function: getBaseDir
// Get the path to the directory that the application is running in. // Get the path of the directory that the application is running in.
// //
// Returns: // Returns:
// Path to directory that application is running from. // Path to directory that application is running from.
std::string getBaseDir(); std::string getBaseDir();
// Function: getUserDir // Function: getUserDir
// Get the path to the directory that the OS specifies for the user's home. // Get the path of the directory that the OS specifies for the user's home.
// On Windows would resemble C:/Documents and Settings/User, on Linux something
// like /home/user/
// //
// Returns: // Returns:
// Path to user's home directory. // Path to user's home directory.
@ -69,8 +100,7 @@ void addToSearchPath(const std::string& dir, bool append=true);
// Removes a directory from the search path, if it exists on the path. // Removes a directory from the search path, if it exists on the path.
// //
// Parameters: // Parameters:
// dir - Directory to remove from the search path, if it doesn't exist // dir - Directory to remove from the search path. Ignored if nonexistant.
// nothing happens.
// //
// See Also: // See Also:
// <addToSearchPath> // <addToSearchPath>
@ -91,7 +121,8 @@ std::vector<std::string> getSearchPath();
// Group: Manipulation ///////////////////////////////////////////////////////// // Group: Manipulation /////////////////////////////////////////////////////////
// Function: setWriteDir // Function: setWriteDir
// Sets the writing directory, used by <mkdir> and <remove>. // Sets the writing directory, used by <mkdir> and <remove>. Unlike search
// path only one writable directory can be set at once.
// //
// Parameters: // Parameters:
// dir - Directory to make writeable // dir - Directory to make writeable

8
include/video/Color.hpp
View File

@ -5,7 +5,7 @@
// James Turk (jpt2433@rit.edu) // James Turk (jpt2433@rit.edu)
// //
// Version: // Version:
// $Id: Color.hpp,v 1.1 2005/03/02 08:40:11 cozman Exp $ // $Id: Color.hpp,v 1.2 2005/11/13 07:59:49 cozman Exp $
#ifndef PHOTON_VIDEO_COLOR_HPP #ifndef PHOTON_VIDEO_COLOR_HPP
#define PHOTON_VIDEO_COLOR_HPP #define PHOTON_VIDEO_COLOR_HPP
@ -23,6 +23,8 @@ namespace video
// Class for storing components of a color. // Class for storing components of a color.
// //
// Operators: // Operators:
// - Color = Color
// - Color == Color
// - ostream& << Color // - ostream& << Color
class Color class Color
{ {
@ -65,7 +67,7 @@ public:
// Group: Utility // Group: Utility
public: public:
// Functions: setColor // Function: setColor
// Creates color, component by component. // Creates color, component by component.
// //
// Parameters: // Parameters:
@ -75,7 +77,7 @@ public:
// a - Value for alpha component. [default: 255] // a - Value for alpha component. [default: 255]
void setColor(ubyte r, ubyte g, ubyte b, ubyte a=255); void setColor(ubyte r, ubyte g, ubyte b, ubyte a=255);
// Functions: makeGLColor // Function: makeGLColor
// Makes the Color the current openGL color. (glColor4ub) // Makes the Color the current openGL color. (glColor4ub)
void makeGLColor() const; void makeGLColor() const;

25
include/video/Font.hpp
View File

@ -5,7 +5,7 @@
// James Turk (jpt2433@rit.edu) // James Turk (jpt2433@rit.edu)
// //
// Version: // Version:
// $Id: Font.hpp,v 1.8 2005/10/15 04:56:37 cozman Exp $ // $Id: Font.hpp,v 1.9 2005/11/13 07:59:49 cozman Exp $
#ifndef PHOTON_VIDEO_FONT_HPP #ifndef PHOTON_VIDEO_FONT_HPP
#define PHOTON_VIDEO_FONT_HPP #define PHOTON_VIDEO_FONT_HPP
@ -23,16 +23,19 @@ class StreamFlusher { };
std::ostream& operator<<(std::ostream& os, const StreamFlusher& rhs); std::ostream& operator<<(std::ostream& os, const StreamFlusher& rhs);
// Class: Font // Class: Font
// Simple OO wrapper around a TrueType font that can be drawn to textures and // Simple wrapper object around a TrueType font that can be drawn to textures
// rendered via OpenGL. // and rendered via OpenGL.
// //
// Since Font is a child of <ResourceManaged>, all memory management is // Since Font is a child of <ResourceManaged>, all memory management is
// taken care of. // taken care of.
//
// Font is a resource managed class, and therefore all resources should
// be registered using <Font::addResource> and then loaded by their assigned
// name via <Font::open> or the appropriate constructor.
// //
// Operators: // Operators:
// - Font = Font // - Font = Font
// - bool : True if font is loaded, false if not. // - bool : True if font is loaded, false if not.
// - ostream& << Font
class Font : public ResourceManaged<FontResourceManager> class Font : public ResourceManaged<FontResourceManager>
{ {
// Group: (Con/De)structors // Group: (Con/De)structors
@ -127,7 +130,7 @@ public:
// y - Y position to start drawing text at. // y - Y position to start drawing text at.
// //
// Returns: // Returns:
// std::ostream& to stream, anything written to the stream before // std::ostream reference, anything written to the stream before
// <endDraw> will be drawn starting at the specified position. // <endDraw> will be drawn starting at the specified position.
std::ostream& beginDraw(scalar x, scalar y); std::ostream& beginDraw(scalar x, scalar y);
@ -162,9 +165,9 @@ public:
public: public:
// Function: addResource // Function: addResource
// Define a new named resource. // Define a new named resource.
// (Ex. Image::addResource("monkey","images/monkey.png") would // (Ex. Font::addResource("sans","freesans.ttf") would
// make it so that any attempts to load "monkey" would load the image // make it so that any attempts to load "sans" would load the font
// images/monkey.png) // freesans.ttf)
// //
// Parameters: // Parameters:
// name - Name to give to resource. // name - Name to give to resource.
@ -174,10 +177,10 @@ public:
// Function: addResource // Function: addResource
// Define a new unaliased resource. (name == path). // Define a new unaliased resource. (name == path).
// (Ex. Image::addResource("images/monkey.png") is essentially the same as // (Ex. Font::addResource("freesans.ttf") is essentially the same as
// Image::addResource("images/monkey.png","images/monkey.png") // Font::addResource("freesans.ttf","freesans.ttf")
// //
// Parameters:. // Parameters:
// path - Path of resource data file. // path - Path of resource data file.
static void addResource(const std::string& path, uint size); static void addResource(const std::string& path, uint size);

14
include/video/Image.hpp
View File

@ -5,7 +5,7 @@
// James Turk (jpt2433@rit.edu) // James Turk (jpt2433@rit.edu)
// //
// Version: // Version:
// $Id: Image.hpp,v 1.2 2005/07/18 07:19:48 cozman Exp $ // $Id: Image.hpp,v 1.3 2005/11/13 07:59:49 cozman Exp $
#ifndef PHOTON_VIDEO_IMAGE_HPP #ifndef PHOTON_VIDEO_IMAGE_HPP
#define PHOTON_VIDEO_IMAGE_HPP #define PHOTON_VIDEO_IMAGE_HPP
@ -21,17 +21,15 @@ namespace video
// Image is a class which is used to store a single image, for use in 2D games. // Image is a class which is used to store a single image, for use in 2D games.
// //
// Image is derived from <Texture>, which is a resource managed class. // Image is derived from <Texture>, which is a resource managed class.
// <Texture> is a simple OO wrapper around the concept of a texture in OpenGL. // An Image simply adds the ability to draw to a quad, as well as some scaling,
// An Image simply adds the ability to draw to a quad, as well as some rotation // rotation, per-vertex tinting, and several other bonuses.
// per-vertex tinting, and several other bonuses.
// //
// Since Image is a child of <ResourceManaged>, all memory management is taken // Since Image is a child of <ResourceManaged>, all memory management is taken
// care of. // care of.
// //
// Operators: // Operators:
// - Texture = Texture // - Image = Image
// - operator bool // - bool : True if texture is loaded, false if not.
// - ostream& << Texture
class Image : public Texture class Image : public Texture
{ {
@ -67,7 +65,7 @@ public:
// Opens an image file, currently supported image types are BMP, GIF, JPEG, // Opens an image file, currently supported image types are BMP, GIF, JPEG,
// PCX, PNG, and TGA. (Images can be any dimensions) // PCX, PNG, and TGA. (Images can be any dimensions)
// //
// Loading is done via <a href="http://corona.sf.net">Corona</a>. // Loading is done via Corona (<http://corona.sf.net>)
// //
// Parameters: // Parameters:
// name - Name of the Image <Resource> to open. // name - Name of the Image <Resource> to open.

5
include/video/Pen.hpp
View File

@ -5,7 +5,7 @@
// James Turk (jpt2433@rit.edu) // James Turk (jpt2433@rit.edu)
// //
// Version: // Version:
// $Id: Pen.hpp,v 1.4 2005/08/23 21:55:03 cozman Exp $ // $Id: Pen.hpp,v 1.5 2005/11/13 07:59:49 cozman Exp $
#ifndef PHOTON_VIDEO_PEN_HPP #ifndef PHOTON_VIDEO_PEN_HPP
#define PHOTON_VIDEO_PEN_HPP #define PHOTON_VIDEO_PEN_HPP
@ -25,7 +25,8 @@ namespace video
// Class which is used for drawing primitives. // Class which is used for drawing primitives.
// //
// Each instance of pen has a color, and the various members simply draw // Each instance of pen has a color, and the various members simply draw
// primitives in that color. // primitives in that color. Since it is possible to change the color
// associated with a pen, there is often no need for multiple instances of Pen.
class Pen class Pen
{ {

17
include/video/Texture.hpp
View File

@ -5,7 +5,7 @@
// James Turk (jpt2433@rit.edu) // James Turk (jpt2433@rit.edu)
// //
// Version: // Version:
// $Id: Texture.hpp,v 1.4 2005/07/04 03:06:48 cozman Exp $ // $Id: Texture.hpp,v 1.5 2005/11/13 07:59:49 cozman Exp $
#ifndef PHOTON_VIDEO_TEXTURE_HPP #ifndef PHOTON_VIDEO_TEXTURE_HPP
#define PHOTON_VIDEO_TEXTURE_HPP #define PHOTON_VIDEO_TEXTURE_HPP
@ -19,10 +19,12 @@ namespace video
{ {
// Class: Texture // Class: Texture
// Simple OO wrapper around the concept of a texture in openGL. // Simple OO wrapper around the concept of a texture in OpenGL.
// //
// Since Texture is a child of <ResourceManaged>, all memory management is // Since Texture is a child of <ResourceManaged>, all memory management is
// taken care of. // taken care of.
//
// Texture loading is done via Corona (<http://corona.sf.net>)
// //
// Children: // Children:
// <Image> // <Image>
@ -30,7 +32,6 @@ namespace video
// Operators: // Operators:
// - Texture = Texture // - Texture = Texture
// - bool : True if texture is loaded, false if not. // - bool : True if texture is loaded, false if not.
// - ostream& << Texture
class Texture : public ResourceManaged<TextureResourceManager> class Texture : public ResourceManaged<TextureResourceManager>
{ {
@ -65,7 +66,7 @@ public:
// Opens an image file, currently supported image types are BMP, GIF, JPEG, // Opens an image file, currently supported image types are BMP, GIF, JPEG,
// PCX, PNG, and TGA. // PCX, PNG, and TGA.
// //
// Loading is done via <a href="http://corona.sf.net">Corona</a>. // Loading is done via Corona (<http://corona.sf.net>)
// //
// Parameters: // Parameters:
// name - Name of the Texture <Resource> to open. // name - Name of the Texture <Resource> to open.
@ -102,7 +103,7 @@ public:
// Function: addResource // Function: addResource
// Define a new named resource. // Define a new named resource.
// (Ex. Image::addResource("monkey","images/monkey.png") would // (Ex. Texture::addResource("monkey","images/monkey.png") would
// make it so that any attempts to load "monkey" would load the image // make it so that any attempts to load "monkey" would load the image
// images/monkey.png) // images/monkey.png)
// //
@ -113,10 +114,10 @@ public:
// Function: addResource // Function: addResource
// Define a new unaliased resource. (name == path). // Define a new unaliased resource. (name == path).
// (Ex. Image::addResource("images/monkey.png") is essentially the same as // (Ex. Texture::addResource("images/monkey.png") is essentially the same
// Image::addResource("images/monkey.png","images/monkey.png") // as Texture::addResource("images/monkey.png","images/monkey.png")
// //
// Parameters:. // Parameters:
// path - Path of resource data file. // path - Path of resource data file.
static void addResource(const std::string& path); static void addResource(const std::string& path);

70
ndoc/Menu.txt
View File

@ -24,55 +24,61 @@ Footer: Documentation for <a href="http://photon.sourceforge.net">photon</a>. Co
# time it is run. When working with groups, just deal with the braces and # time it is run. When working with groups, just deal with the braces and
# forget about the indentation and comments. # forget about the indentation and comments.
# #
# You can use this file on other computers even if they use different
# directories. As long as the command line points to the same source files,
# Natural Docs will be able to correct the locations automatically.
#
# -------------------------------------------------------------------------- # --------------------------------------------------------------------------
File: Photon Documentation (/home/james/src/photon/ndoc/pages/index.txt)
Group: photon:: { Group: photon:: {
File: Application (Application.hpp) File: Application (/home/james/src/photon/include/Application.hpp)
File: Basic Types (types.hpp) File: Basic Types (/home/james/src/photon/include/types.hpp)
File: Exception/Error Types (exceptions.hpp) File: Exception/Error Types (/home/james/src/photon/include/exceptions.hpp)
File: Log (Log.hpp) File: Log (/home/james/src/photon/include/Log.hpp)
File: Logging Utilities (LogSink.hpp) File: Logging Utilities (/home/james/src/photon/include/LogSink.hpp)
File: PhotonMain (entrypoint.hpp) File: PhotonMain (/home/james/src/photon/include/entrypoint.hpp)
File: ResourceManaged (ResourceManaged.hpp) File: ResourceManaged (/home/james/src/photon/include/ResourceManaged.hpp)
File: ResourceManager (ResourceManager.hpp) File: ResourceManager (/home/james/src/photon/include/ResourceManager.hpp)
File: State (State.hpp) File: State (/home/james/src/photon/include/State.hpp)
File: Task (Task.hpp)
File: TaskManager (Kernel.hpp)
Group: Audio:: { Group: Audio:: {
File: AudioCore (audio/AudioCore.hpp) File: AudioCore (/home/james/src/photon/include/audio/AudioCore.hpp)
File: Source (audio/Source.hpp) File: Source (/home/james/src/photon/include/audio/Source.hpp)
} # Group: Audio:: } # Group: Audio::
Group: Math:: { Group: Math:: {
File: Circle (math/Circle.hpp) File: Circle (/home/james/src/photon/include/math/Circle.hpp)
File: Math Utilities (math/math.hpp) File: Math Utilities (/home/james/src/photon/include/math/math.hpp)
File: Rect (math/Rect.hpp) File: Rect (/home/james/src/photon/include/math/Rect.hpp)
File: Vector2 (math/Vector2.hpp) File: Vector2 (/home/james/src/photon/include/math/Vector2.hpp)
} # Group: Math:: } # Group: Math::
Group: Util:: { Group: Util:: {
File: ConfigFile (util/ConfigFile.hpp) File: ConfigFile (/home/james/src/photon/include/util/ConfigFile.hpp)
File: FileBuffer (util/FileBuffer.hpp) File: FileBuffer (/home/james/src/photon/include/util/FileBuffer.hpp)
File: filesys:: (util/filesys/filesys.hpp) File: filesys:: (/home/james/src/photon/include/util/filesys/filesys.hpp)
File: RandGen (util/RandGen.hpp) File: RandGen (/home/james/src/photon/include/util/RandGen.hpp)
File: Singleton (util/Singleton.hpp) File: Singleton (/home/james/src/photon/include/util/Singleton.hpp)
File: Timer (util/Timer.hpp) File: Task (/home/james/src/photon/include/util/Task.hpp)
File: VersionInfo (util/VersionInfo.hpp) File: TaskManager (/home/james/src/photon/include/util/TaskManager.hpp)
File: Timer (/home/james/src/photon/include/util/Timer.hpp)
File: VersionInfo (/home/james/src/photon/include/util/VersionInfo.hpp)
} # Group: Util:: } # Group: Util::
Group: Video:: { Group: Video:: {
File: Color (video/Color.hpp) File: Color (/home/james/src/photon/include/video/Color.hpp)
File: Font (video/Font.hpp) File: Font (/home/james/src/photon/include/video/Font.hpp)
File: Image (video/Image.hpp) File: Image (/home/james/src/photon/include/video/Image.hpp)
File: Pen (video/Pen.hpp) File: Pen (/home/james/src/photon/include/video/Pen.hpp)
File: Texture (video/Texture.hpp) File: Texture (/home/james/src/photon/include/video/Texture.hpp)
} # Group: Video:: } # Group: Video::
} # Group: photon:: } # Group: photon::
@ -85,5 +91,11 @@ Group: Index {
Function Index: Functions Function Index: Functions
Type Index: Types Type Index: Types
Variable Index: Variables Variable Index: Variables
File Index: Files
} # Group: Index } # Group: Index
##### Do not change or remove these lines. #####
Data: 1(D3333RuEG3lpEG636H93IRutu\38\9oNfG)
Data: 1(h3333RuEG3lpEG636H93IRutu\3\fu93Ip`G6)

24
ndoc/pages/index.txt Normal file
View File

@ -0,0 +1,24 @@
Document: Photon Documentation
Introduction:
This is the photon developer documentation, generated via NaturalDocs (http://naturaldocs.org) from
comments embedded directly in the code. If you're writing something with public documentation I'd
highly recommend it, since as you can see it's output looks signifigantly better than some of those
other documentation generators ;).
How To Use The Docs:
In the left pane the public namespaces are listed, click on a namespace name
to expand or collapse it. Clicking on a class/topic name will show the documentation
for that class or topic.
Helping Out:
If you see anything that is incorrect, incomplete, or is just poorly described .
and could use clarification, please be sure to let me know (cozman@users.sf.net).
I want this documentation to be as helpful as possible to both new and
experienced users of photon, so feel free to contact me with quesions, criticisms,
or suggestions of any kind.
If you're interested in helping out, but don't feel like you could contribute useful code
someone to help keep the documentation current would be appreciated. If interested
in helping out in any way, I'd love to hear from you.

277
photon.mm
View File

@ -1,195 +1,142 @@
<map version="0.8.0 RC2"> <map version="0.8.0">
<!-- To view this file, download free mind mapping software FreeMind from http://freemind.sourceforge.net --> <!-- To view this file, download free mind mapping software FreeMind from http://freemind.sourceforge.net -->
<node ID="_Freemind_Link_1676542623" TEXT="Photon"> <node CREATED="1129352407401" ID="_Freemind_Link_1676542623" MODIFIED="1129352407401" TEXT="Photon">
<cloud/> <cloud/>
<font BOLD="true" NAME="SansSerif" SIZE="12"/> <font BOLD="true" NAME="SansSerif" SIZE="12"/>
<node ID="_Freemind_Link_682620075" POSITION="right" TEXT="0.1 Series"> <node CREATED="1129352407402" ID="_Freemind_Link_682620075" MODIFIED="1129352407402" POSITION="right" TEXT="0.1 Series">
<font BOLD="true" NAME="SansSerif" SIZE="12"/> <font BOLD="true" NAME="SansSerif" SIZE="12"/>
<node ID="_" TEXT="0.0.2"> <node CREATED="1129352407402" ID="_Freemind_Link_115594103" MODIFIED="1130559303873" TEXT="0.1.0" VSHIFT="-14">
<font BOLD="true" NAME="SansSerif" SIZE="12"/> <font BOLD="true" NAME="SansSerif" SIZE="12"/>
<node FOLDED="true" ID="_Freemind_Link_71129066" TEXT="Features"> <node CREATED="1129352407404" ID="_Freemind_Link_1084322991" MODIFIED="1129352407404" TEXT="Publicity">
<icon BUILTIN="button_ok"/> <node CREATED="1129352407404" ID="_Freemind_Link_482028560" MODIFIED="1129352407404" TEXT="Tutorials">
<node ID="_Freemind_Link_424443985" TEXT="variable timeStep config"> <node CREATED="1130465655991" ID="Freemind_Link_1572314923" MODIFIED="1130465660152" TEXT="NDocTorials"/>
<icon BUILTIN="button_ok"/>
<node ID="_Freemind_Link_1489086385" TEXT="average of X frames">
<icon BUILTIN="button_ok"/>
</node> </node>
<node ID="_Freemind_Link_576151122" TEXT="fixed timeStep"> <node CREATED="1129352407404" ID="_Freemind_Link_1870184326" MODIFIED="1129352407404" TEXT="example game">
<icon BUILTIN="button_ok"/> <node CREATED="1130471560606" ID="Freemind_Link_613629773" MODIFIED="1130471562533" TEXT="tank game"/>
</node> </node>
</node> </node>
<node ID="_Freemind_Link_1902843385" TEXT="depthBuffer enable/disable">
<icon BUILTIN="button_ok"/>
</node> </node>
<node ID="_Freemind_Link_1912839994" TEXT="dual Kernels (TaskManager)"> <node CREATED="1129352407405" HGAP="65" ID="_Freemind_Link_1151493849" MODIFIED="1130559300141" TEXT="0.1.x" VSHIFT="38">
<icon BUILTIN="button_ok"/> <font BOLD="true" NAME="SansSerif" SIZE="12"/>
<node CREATED="1129352407407" ID="_Freemind_Link_650619873" MODIFIED="1129352407407" TEXT="Features">
<node CREATED="1129352407407" FOLDED="true" ID="_Freemind_Link_1825420810" MODIFIED="1129352407407" TEXT="Music">
<node CREATED="1129352407407" ID="_Freemind_Link_1677795490" MODIFIED="1129352407407" TEXT="ogg"/>
<node CREATED="1129352407407" ID="_Freemind_Link_510415734" MODIFIED="1129352407407" TEXT="wav"/>
</node> </node>
</node> </node>
<node FOLDED="true" ID="_Freemind_Link_1999404091" TEXT="Improvements"> <node CREATED="1129352407407" ID="_Freemind_Link_1634165944" MODIFIED="1129352407407" TEXT="Improvements">
<icon BUILTIN="button_ok"/> <node CREATED="1129352407407" ID="Freemind_Link_442862681" MODIFIED="1129352407407" TEXT="vc7">
<node ID="_Freemind_Link_878549222" TEXT="drop alut dependency"> <node CREATED="1129352407407" ID="Freemind_Link_1309064355" MODIFIED="1129352407407" TEXT="photon-0.1.x-win32-msvc"/>
<icon BUILTIN="button_ok"/>
</node> </node>
<node FOLDED="true" ID="_Freemind_Link_1174215789" TEXT="bugfixes"> <node CREATED="1130644868777" ID="Freemind_Link_1077081589" MODIFIED="1130644894214" TEXT="allow compilation without PhysFS?"/>
<icon BUILTIN="button_ok"/>
<node ID="_Freemind_Link_51999594" TEXT="fullscreen X11">
<icon BUILTIN="button_ok"/>
</node> </node>
<node ID="_Freemind_Link_469175607" TEXT="input listener bug(s)"> <node CREATED="1129352407407" ID="_Freemind_Link_172144087" MODIFIED="1129352407407" TEXT="Publicity"/>
<icon BUILTIN="button_ok"/>
</node>
<node ID="_Freemind_Link_789850536" TEXT="pause on lost focus">
<icon BUILTIN="button_ok"/>
</node> </node>
</node> </node>
<node FOLDED="true" ID="_Freemind_Link_858443899" TEXT="IDE support"> <node CREATED="1129352407407" ID="_Freemind_Link_486829238" MODIFIED="1130559294471" POSITION="right" TEXT="0.2 Release" VSHIFT="107">
<font BOLD="true" NAME="SansSerif" SIZE="12"/>
<node CREATED="1129352407407" FOLDED="true" ID="_Freemind_Link_103747781" MODIFIED="1130472449741" TEXT="Features">
<font NAME="SansSerif" SIZE="12"/> <font NAME="SansSerif" SIZE="12"/>
<icon BUILTIN="button_ok"/> <node COLOR="#000000" CREATED="1129352407408" ID="_Freemind_Link_420721466" MODIFIED="1129352407408" TEXT="XML/XSLT sink"/>
<node ID="_Freemind_Link_1591642442" TEXT="Dev-C++"> <node CREATED="1129352407409" ID="_Freemind_Link_1298931281" MODIFIED="1129352407409" TEXT="XML resource files"/>
<icon BUILTIN="button_ok"/> <node CREATED="1129352407409" FOLDED="true" ID="_Freemind_Link_1070201117" MODIFIED="1129352407409" TEXT="Transitions">
<node CREATED="1129352407410" ID="_Freemind_Link_664044389" MODIFIED="1129352407410" TEXT="investigate what other libs do"/>
<node CREATED="1129352407411" ID="_Freemind_Link_1667343634" MODIFIED="1129352407411" TEXT="render to texture?"/>
<node CREATED="1129352407411" ID="_Freemind_Link_518905568" MODIFIED="1129352407411" TEXT="pixel shaders?"/>
</node> </node>
<node ID="_Freemind_Link_1446425822" TEXT="Code::Blocks"> <node CREATED="1129352407411" ID="_Freemind_Link_1339011485" MODIFIED="1129352407411" TEXT="Tilemap System"/>
<icon BUILTIN="button_ok"/> <node CREATED="1129352407411" ID="_Freemind_Link_1497432478" MODIFIED="1129352407411" TEXT="Particle System"/>
</node> <node CREATED="1129352407411" ID="_Freemind_Link_216021234" MODIFIED="1129352407411" TEXT="Sprite System">
<node ID="_Freemind_Link_1481289143" TEXT="Visual C++">
<icon BUILTIN="clanbomber"/>
<node TEXT="unstable"/>
</node>
<node ID="_Freemind_Link_1628154157" TEXT="Eclipse/CDT">
<icon BUILTIN="button_cancel"/>
</node>
</node>
<node ID="_Freemind_Link_1906242625" TEXT="State/Task/Kernel demo">
<icon BUILTIN="button_ok"/>
</node>
</node>
<node ID="_Freemind_Link_1112766084" TEXT="Publicity">
<node ID="_Freemind_Link_1943285529" TEXT="precompiled versions">
<node ID="_Freemind_Link_586970647" TEXT="gcc3 Linux">
<icon BUILTIN="button_ok"/>
<node ID="_Freemind_Link_1651083711" TEXT="photon-0.0.2-linux-gcc"/>
</node>
<node ID="_Freemind_Link_1983304402" TEXT="gcc3 MingW">
<node ID="_Freemind_Link_952617031" TEXT="photon-0.0.2-win32-mingw"/>
</node>
</node>
</node>
</node>
<node FOLDED="true" ID="_Freemind_Link_115594103" TEXT="0.1">
<font BOLD="true" NAME="SansSerif" SIZE="12"/>
<node ID="_Freemind_Link_1755478147" TEXT="Features"/>
<node ID="_Freemind_Link_589338965" TEXT="Improvements">
<node ID="_Freemind_Link_1716705807" TEXT="clean up naturaldocs">
<icon BUILTIN="button_ok"/>
</node>
</node>
<node ID="_Freemind_Link_1084322991" TEXT="Publicity">
<node ID="_Freemind_Link_1156475066" TEXT="update site with more info (distribution .txt files)"/>
<node FOLDED="true" ID="_Freemind_Link_482028560" TEXT="Tutorials">
<node ID="_Freemind_Link_772709351" TEXT="Wikitorials?"/>
</node>
<node FOLDED="true" ID="_Freemind_Link_1870184326" TEXT="example game">
<node COLOR="#000000" ID="_Freemind_Link_597173063" TEXT="Asteroids"/>
<node ID="_Freemind_Link_719722821" TEXT="Lunar Lander"/>
<node ID="_Freemind_Link_173048174" TEXT="Missile Command"/>
<node COLOR="#010101" ID="_Freemind_Link_1447936394" TEXT="Frogger"/>
</node>
</node>
</node>
<node ID="_Freemind_Link_1151493849" TEXT="0.1.x">
<font BOLD="true" NAME="SansSerif" SIZE="12"/>
<node ID="_Freemind_Link_650619873" TEXT="Features">
<node FOLDED="true" ID="_Freemind_Link_1825420810" TEXT="Music">
<node ID="_Freemind_Link_1677795490" TEXT="ogg"/>
<node ID="_Freemind_Link_510415734" TEXT="wav"/>
</node>
</node>
<node ID="_Freemind_Link_1634165944" TEXT="Improvements">
<node ID="Freemind_Link_442862681" TEXT="vc7">
<node ID="Freemind_Link_1309064355" TEXT="photon-0.1.x-win32-msvc"/>
</node>
</node>
<node ID="_Freemind_Link_172144087" TEXT="Publicity"/>
</node>
</node>
<node FOLDED="true" ID="_Freemind_Link_486829238" POSITION="right" TEXT="0.2 Release">
<font BOLD="true" NAME="SansSerif" SIZE="12"/>
<node FOLDED="true" ID="_Freemind_Link_103747781" TEXT="Features">
<font NAME="SansSerif" SIZE="12"/>
<node COLOR="#000000" ID="_Freemind_Link_420721466" TEXT="XML/XSLT sink"/>
<node ID="_Freemind_Link_1298931281" TEXT="XML resource files"/>
<node FOLDED="true" ID="_Freemind_Link_1070201117" TEXT="Transitions">
<node ID="_Freemind_Link_664044389" TEXT="investigate what other libs do"/>
<node ID="_Freemind_Link_1667343634" TEXT="render to texture?"/>
<node ID="_Freemind_Link_518905568" TEXT="pixel shaders?"/>
</node>
<node ID="_Freemind_Link_1339011485" TEXT="Tilemap System"/>
<node ID="_Freemind_Link_1497432478" TEXT="Particle System"/>
<node ID="_Freemind_Link_216021234" TEXT="Sprite System">
<font NAME="SansSerif" SIZE="12"/> <font NAME="SansSerif" SIZE="12"/>
</node> </node>
<node ID="_Freemind_Link_639177837" TEXT="interpolation/Extrapolation in calls to State::render"/> <node CREATED="1129352407411" ID="_Freemind_Link_639177837" MODIFIED="1129352407411" TEXT="interpolation/Extrapolation in calls to State::render"/>
</node> </node>
<node FOLDED="true" ID="_Freemind_Link_903043501" TEXT="Improvements"> <node CREATED="1129352407411" FOLDED="true" ID="_Freemind_Link_903043501" MODIFIED="1129352407411" TEXT="Improvements">
<node ID="_Freemind_Link_1362733907" TEXT="investigate dropping Corona"/> <node CREATED="1129352407411" ID="_Freemind_Link_1362733907" MODIFIED="1129352407411" TEXT="investigate dropping Corona"/>
</node> </node>
<node FOLDED="true" ID="_Freemind_Link_1821669119" TEXT="Publicity"> <node CREATED="1129352407411" FOLDED="true" ID="_Freemind_Link_1821669119" MODIFIED="1129352407411" TEXT="Publicity">
<node FOLDED="true" ID="_Freemind_Link_654490435" TEXT="Second Example Game"> <node CREATED="1129352407411" FOLDED="true" ID="_Freemind_Link_654490435" MODIFIED="1129352407411" TEXT="Second Example Game">
<node ID="_Freemind_Link_1191623789" TEXT="Public Project?"/> <node CREATED="1129352407411" ID="_Freemind_Link_1191623789" MODIFIED="1129352407411" TEXT="Public Project?"/>
</node> </node>
</node> </node>
</node> </node>
<node FOLDED="true" ID="_Freemind_Link_1111954089" POSITION="right" TEXT="Future..."> <node COLOR="#147f1e" CREATED="1129352407415" ID="_Freemind_Link_438641521" MODIFIED="1129352407415" POSITION="left" TEXT="Version: $Id: photon.mm,v 1.31 2005/11/13 07:59:48 cozman Exp $">
<font BOLD="true" NAME="SansSerif" SIZE="12"/>
<node FOLDED="true" ID="_Freemind_Link_1066996987" TEXT="Features">
<font NAME="SansSerif" SIZE="12"/>
<node ID="_Freemind_Link_539015028" TEXT="physics:: (similar to math::)"/>
<node FOLDED="true" ID="_Freemind_Link_1107695046" TEXT="gui::">
<node ID="_Freemind_Link_548983970" TEXT="skinnable XML based"/>
</node>
<node FOLDED="true" ID="_Freemind_Link_304523376" TEXT="network::">
<node ID="_Freemind_Link_717482997" TEXT="wrap enet?"/>
</node>
<node FOLDED="true" ID="_Freemind_Link_1766405270" TEXT="scripting">
<node ID="_Freemind_Link_918658782" TEXT="lua"/>
<node ID="_Freemind_Link_1079584283" TEXT="python"/>
<node ID="_Freemind_Link_512949260" TEXT="angelscript"/>
<node ID="_Freemind_Link_1813241804" TEXT="custom"/>
<node ID="_Freemind_Link_1220379011" TEXT="other"/>
</node>
</node>
<node FOLDED="true" ID="_Freemind_Link_1155128082" TEXT="Improvements">
<node FOLDED="true" ID="_Freemind_Link_1067043723" TEXT="allow for alternate backends ">
<node FOLDED="true" ID="_Freemind_Link_1997175841" TEXT="audiere for audio">
<node ID="_Freemind_Link_1142976123" TEXT="is there a point?">
<node ID="_Freemind_Link_396200365" TEXT="compatibility?"/>
</node>
</node>
<node ID="_Freemind_Link_961284194" TEXT="SDL backend">
<icon BUILTIN="help"/>
</node>
</node>
<node FOLDED="true" ID="_Freemind_Link_1036629371" TEXT="other languages">
<node ID="_Freemind_Link_21483700" TEXT="python interface">
<icon BUILTIN="help"/>
</node>
<node ID="_Freemind_Link_1083759822" TEXT="java interface">
<icon BUILTIN="help"/>
</node>
</node>
</node>
<node FOLDED="true" ID="_Freemind_Link_1364557080" TEXT="Publicity">
<node ID="_Freemind_Link_1945740551" TEXT="Prepackaged Versions"/>
<node ID="_Freemind_Link_836096408" TEXT="Dependencies"/>
<node ID="_Freemind_Link_1316865000" TEXT="Wiki"/>
<node ID="_Freemind_Link_959094471" TEXT="Contest"/>
</node>
</node>
<node COLOR="#147f1e" ID="_Freemind_Link_438641521" POSITION="left" TEXT="Version: $Id: photon.mm,v 1.30 2005/08/19 06:14:50 cozman Exp $">
<font ITALIC="true" NAME="SansSerif" SIZE="12"/> <font ITALIC="true" NAME="SansSerif" SIZE="12"/>
</node> </node>
<node ID="_Freemind_Link_853483912" POSITION="left" TEXT="Current Problems"> <node CREATED="1129352407415" ID="_Freemind_Link_853483912" MODIFIED="1129352407415" POSITION="left" TEXT="Current Problems">
<font BOLD="true" NAME="SansSerif" SIZE="12"/> <font BOLD="true" NAME="SansSerif" SIZE="12"/>
</node> </node>
<node CREATED="1129352407411" FOLDED="true" ID="_Freemind_Link_1111954089" MODIFIED="1130559286266" POSITION="left" TEXT="Future..." VSHIFT="-1">
<font BOLD="true" NAME="SansSerif" SIZE="12"/>
<node CREATED="1129352407411" FOLDED="true" ID="_Freemind_Link_1066996987" MODIFIED="1129352407411" TEXT="Features">
<font NAME="SansSerif" SIZE="12"/>
<node CREATED="1129352407411" ID="_Freemind_Link_539015028" MODIFIED="1129352407411" TEXT="physics:: (similar to math::)"/>
<node CREATED="1129352407412" FOLDED="true" ID="_Freemind_Link_1107695046" MODIFIED="1129352407412" TEXT="gui::">
<node CREATED="1129352407412" ID="_Freemind_Link_548983970" MODIFIED="1129352407412" TEXT="skinnable XML based"/>
</node>
<node CREATED="1129352407412" FOLDED="true" ID="_Freemind_Link_304523376" MODIFIED="1129352407412" TEXT="network::">
<node CREATED="1129352407412" ID="_Freemind_Link_717482997" MODIFIED="1129352407412" TEXT="wrap enet?"/>
</node>
<node CREATED="1129352407412" FOLDED="true" ID="_Freemind_Link_1766405270" MODIFIED="1129352407412" TEXT="scripting">
<node CREATED="1129352407412" ID="_Freemind_Link_918658782" MODIFIED="1129352407412" TEXT="lua"/>
<node CREATED="1129352407412" ID="_Freemind_Link_1079584283" MODIFIED="1129352407412" TEXT="python"/>
<node CREATED="1129352407413" ID="_Freemind_Link_512949260" MODIFIED="1129352407413" TEXT="angelscript"/>
<node CREATED="1129352407413" ID="_Freemind_Link_1813241804" MODIFIED="1129352407413" TEXT="custom"/>
<node CREATED="1129352407413" ID="_Freemind_Link_1220379011" MODIFIED="1129352407413" TEXT="other"/>
</node>
</node>
<node CREATED="1129352407413" ID="_Freemind_Link_1155128082" MODIFIED="1129352407413" TEXT="Improvements">
<node CREATED="1129352407413" FOLDED="true" ID="_Freemind_Link_1067043723" MODIFIED="1129352407413" TEXT="allow for alternate backends ">
<node CREATED="1129352407413" FOLDED="true" ID="_Freemind_Link_1997175841" MODIFIED="1129352407413" TEXT="audiere for audio">
<node CREATED="1129352407414" ID="_Freemind_Link_1142976123" MODIFIED="1129352407414" TEXT="is there a point?">
<node CREATED="1129352407414" ID="_Freemind_Link_396200365" MODIFIED="1129352407414" TEXT="compatibility?"/>
</node>
</node>
<node CREATED="1129352407414" ID="_Freemind_Link_961284194" MODIFIED="1129352407414" TEXT="SDL backend">
<icon BUILTIN="help"/>
</node>
</node>
<node CREATED="1129352407414" ID="_Freemind_Link_1036629371" MODIFIED="1129352407414" TEXT="other languages">
<node CREATED="1129352407414" ID="_Freemind_Link_21483700" MODIFIED="1129352407414" TEXT="python interface">
<icon BUILTIN="help"/>
<node CREATED="1130472430178" FOLDED="true" ID="Freemind_Link_1181436549" MODIFIED="1130472451458" TEXT="hotyth">
<font BOLD="true" NAME="SansSerif" SIZE="12"/>
<node CREATED="1130472573323" ID="Freemind_Link_577743930" MODIFIED="1130472686339" TEXT="potentially the justification for photon altogether">
<node CREATED="1130472687051" FOLDED="true" ID="Freemind_Link_1124537894" MODIFIED="1130472780347" TEXT="potentially much faster than PyGame">
<node CREATED="1130472717147" ID="Freemind_Link_1689800437" MODIFIED="1130472725955" TEXT="look into using Psyco"/>
<node CREATED="1130472785878" ID="Freemind_Link_464299414" MODIFIED="1130472790515" TEXT="already using OpenGL-based backend"/>
</node>
<node CREATED="1130472695759" ID="Freemind_Link_284363350" MODIFIED="1130472714269" TEXT="more game-oriented"/>
</node>
<node CREATED="1130472815278" ID="Freemind_Link_1495903252" MODIFIED="1130472816993" TEXT="how?">
<node CREATED="1130472475758" ID="Freemind_Link_145040084" MODIFIED="1130472479477" TEXT="custom wrapped code">
<node CREATED="1130472481825" ID="Freemind_Link_304193465" MODIFIED="1130472489589" TEXT="extremely hard for something the size of photon"/>
</node>
<node CREATED="1130472461642" ID="Freemind_Link_974152072" MODIFIED="1130472463393" TEXT="SWIG">
<node CREATED="1130472491657" ID="Freemind_Link_203364687" MODIFIED="1130472503947" TEXT="evaluation needed"/>
</node>
<node CREATED="1130472453122" ID="Freemind_Link_681824771" MODIFIED="1130472457183" TEXT="boost::python">
<node CREATED="1130472504752" ID="Freemind_Link_1098125228" MODIFIED="1130472509211" TEXT="hard to get working on Windows"/>
<node CREATED="1130472513731" ID="Freemind_Link_615148079" MODIFIED="1130472516889" TEXT="evalution needed"/>
</node>
</node>
</node>
</node>
<node CREATED="1129352407414" ID="_Freemind_Link_1083759822" MODIFIED="1129352407414" TEXT="java interface">
<icon BUILTIN="help"/>
</node>
</node>
</node>
<node CREATED="1129352407415" FOLDED="true" ID="_Freemind_Link_1364557080" MODIFIED="1129352407415" TEXT="Publicity">
<node CREATED="1129352407415" FOLDED="true" ID="_Freemind_Link_1945740551" MODIFIED="1129352407415" TEXT="Prepackaged Versions">
<node CREATED="1130472887914" ID="Freemind_Link_1188152165" MODIFIED="1130472889315" TEXT="deb"/>
<node CREATED="1130472893474" ID="Freemind_Link_1518311946" MODIFIED="1130472894690" TEXT="rpm"/>
<node CREATED="1130472896908" ID="Freemind_Link_1315075072" MODIFIED="1130472904857" TEXT="Dev-C++ .devpak"/>
</node>
<node CREATED="1129352407415" ID="_Freemind_Link_836096408" MODIFIED="1129352407415" TEXT="Dependencies"/>
<node CREATED="1129352407415" ID="_Freemind_Link_1316865000" MODIFIED="1129352407415" TEXT="Wiki"/>
<node CREATED="1129352407415" ID="_Freemind_Link_959094471" MODIFIED="1129352407415" TEXT="Contest"/>
</node>
</node>
</node> </node>
</map> </map>

16
test/config1.ini
View File

@ -1,11 +1,11 @@
[] []
#config1.ini #config1.ini
[sec2] [sec2]
fancy = 0 fancy = 0
fancy2 = "james" fancy2 = "james"
[sec] [sec]
int=3 int=3
float=3 float=3
string=three string=three

10
test/config2.ini
View File

@ -1,9 +1,9 @@
[] []
#config2.ini #config2.ini
[sec] [sec]
var = 0 var = 0
hex = 0xff hex = 0xff
[sec2] [sec2]
var = 2 var = 2