Index
$#! · 0-9 · A · B · C · D · E · F · G · H · I · J · K · L · M · N · O · P · Q · R · S · T · U · V · W · X · Y · Z
L
 listDir
 Log
~Log, Log
 LOG_CRITICAL
 LOG_ERROR
 LOG_NOTE
 LOG_VERBOSE
 LOG_WARNING
 Logging Utilities
 LogLevel
 LogSink
~LogSink, LogSink
 LogSinkPtr, LogSink
M
 magnitude, Vector2
 majorRelease, VersionInfo
 makeGLColor, Color
 Manipulation
 Math Utilities
 MB_LEFT
 MB_MIDDLE
 MB_RIGHT
 MemoryError
 minor, VersionInfo
 mkdir
 Mouse Actions, State
 MouseButton
 mouseButtonPressed, Application
 Movement/ Scaling
 moveRel
 moveTo
N
 normalize, Vector2
 note, Log
O
 onKeyPress, State
 onKeyRelease, State
 onKill, Task
 onMouseButtonPress, State
 onMouseButtonRelease, State
 onMouseMove, State
 onMouseScroll, State
 onPause
 onResume, State
 onStart, Task
 onUnpause, Task
 open
 Ortho, Application
 Other
P
 patch, VersionInfo
 pause
 pauseTask, TaskManager
 Pen
 permitSymbolicLinks
 Perspective, Application
 PhotonMain
 PI
 play, Source
 Point2, Vector2
 popState, Application
 PreconditionException
 PRI_HIGH
 PRI_HIGHEST
 PRI_LOW
 PRI_LOWEST
 PRI_NORMAL
 PriorityLevel
 pushState, Application
Q
 quit, Application
std::vector<std::string> listDir(const std::string &dir)
Lists the contents of a directory.
Log class for photon, Log passes all messages to any attached LogSinks, which can then take care of any output which is desired.
Log()
Log constructor, initializes log singleton.
~Log()
Log destructor, destroys log singleton.
Critical error, used for failures which are threats to stability.
Normal error, used for potential serious failures.
A note, highest priority so that they are always printed, not used for errors, only for temporary notes.
Verbose warning, lowest priority.
A warning, used for non critical failures.
Enumeration defining severity of an error.
Base class for all LogSinks to be used with Log, derived classes must define message(LogLevel level, std::string string).
LogSink(const std::string &name)
LogSink constructor, requires a name.
virtual ~LogSink()
Virtual destructor, available to make inheritance safe.
Pointer to a log sink, used since LogSink is abstract and will always be accessed via a pointer.
scalar magnitude(const Vector2 &v)
Find length of a vector.
unsigned int majorRelease
major release version number, should be changed when major changes take place.
Makes the Color the current openGL color.
Left mouse button.
Middle mouse button.
Right mouse button.
MemoryError should be thrown if an error occurs while allocating memory.
unsigned int minorRelease
minor release version number, should be changed when key features are added/removed/changed.
bool mkdir(const std::string &dir)
Attempts to create a directory.
Enumeration defining buttons, used in Application::mouseButtonPressed.
bool mouseButtonPressed(MouseButton button)
Check if a given mouse button is currently pressed.
void moveRel(scalar xMove,
scalar yMove)
Move the center of the Circle a given x and y distance.
void moveRel(scalar xMove,
scalar yMove)
move rectangle relative to current position.
void moveTo(const Point2 &center)
Move the center of the Circle to a new location.
void moveTo(const Point2 &topleft)
move rectangle to new location.
void normalize()
Normalizes the vector.
std::ostream& note()
Accesses stream, any messages passed into note are given to associated LogSinks with a LogLevel of LOG_NOTE.
virtual void onKeyPress(KeyCode key)
Called when a key is pressed.
virtual void onKeyRelease(KeyCode key)
Called when a key is released.
virtual void onKill()
Virtual function, overload to define behavior when the task is killed.
virtual void onMouseButtonPress(MouseButton button)
Called when a mouse button is pressed.
virtual void onMouseButtonRelease(MouseButton button)
Called when a mouse button is released.
virtual void onMouseMove(const math::Vector2 &delta)
Called when the mouse is moved with the amount the mouse was moved by NOT with the new position.
virtual void onMouseScroll(ScrollDir dir)
Called when mouse wheel is scrolled.
virtual void onPause()
If a state is executing and a new state is pushed onto the stack via Application::pushState the state will be paused until a time that it is either unpaused or popped from the stack itself.
virtual void onPause()
Virtual function, overload to define behavior every time that the task is paused.
virtual void onResume()
If a state has been paused and is then made current again by the state(s) pushed on top of it being popped, the state management system will call onResume allowing the state to undo any work that had been done in onPause.
virtual void onStart()
Virtual function, overload to define behavior when the task is started.
virtual void onUnpause()
Virtual function, overload to define behavior every time that the task is unpaused.
void open(const std::string &filename)
open a file, processing it as an INI-like config file.
void open(const std::string &filename)
Loads a file into the FileBuffer.
void open(const std::string &name)
Opens an TrueType font.
void open(const std::string &name)
Opens an image file, currently supported image types are BMP, GIF, JPEG, PCX, PNG, and TGA.
virtual void open(const std::string &name)
Opens new resource via the associated ResourceManager.
void open(const std::string &name)
Opens an audio file, supported formats are WAV and Ogg.
void open(const std::string &name)
Opens an image file, currently supported image types are BMP, GIF, JPEG, PCX, PNG, and TGA.
unsigned int patch
Patch number, should be changed upon every release that isn’t signifigant enough to reflect a change in the minor versioning number.
void pause()
Pauses the playback of the sound attached to the source.
void pause()
Pause timer.
void pauseTask(const std::string &taskName)
Pause a task in the TaskManager task list.
Class which is used for drawing primitives.
Pen()
Default constructor, sets color to white.
void permitSymbolicLinks(bool allow)
Enables or disables symbolic linking.
PhotonMain is the entrypoint for all Photon applications, attempting to use main will result in an error message since main is defined within the library.
Defined constant for pi: 3.1415926535897932384626433832795
void play()
Starts the playback of the sound attached to the source.
Alias for Vector2 type.
void popState()
Pop the current State, returning to the prior State on the stack.
PreconditionException should be thrown when a precondition is not met.
Lower-than-usual priority.
Highest priority available.
Lower-than-usual priority.
Lowest priority available.
Normal priority, suitable for most tasks.
Enumeration defining priority of a Task.
template<class StateT> void pushState()
Push a new State, does not remove old State.
void quit()
Sets Quit flag, terminating application.