Main Page | Namespace List | Class Hierarchy | Class List | File List | Namespace Members | Class Members | File Members | Related Pages
ONE::util

ONE::util Namespace Reference

Detailed Description

contains utility classes for I/O management, event dispatching and resource management


Classes

class  _OABase
class  ActionControl
 an action command Controls More...
class  ActionDispatcher
 ActionEvent dispatcher More...
class  ActionEvent
 representation for a (switchable) command More...
class  ActionListener
 ActionEvent listener More...
struct  ActionRelay
class  AllowConversion
 allows implicit conversion to raw pointer More...
class  ArrayConstIterator
class  ArrayIterator
class  AssertDereference
 uses assert to safeguard against dereferenced 0 pointers More...
class  Automatic
 automatic singleton Lifetime policy More...
class  Cloneable
 interface for objects that may be cloned More...
class  Condition
 a thread condition object More...
class  ConnectFailedException
 thrown if attemp to connect failed More...
class  ConstIterator
class  Control
class  ControlDispatcher
 a ControlEvent dispatcher More...
class  ControlEvent
 used to notify listeners of Controls More...
class  Controlled
 Abstract base class for objects that are under some form of control. More...
class  ControlListener
 a ControlEvent listener More...
struct  ControlRelay
struct  Creator
 interface for LazyValue initializers More...
class  DeepCopy
 deep copy ownership policy More...
class  DefaultStorage
struct  DeleteCleanup
 LazyValue cleanup policy that deletes the value with the surrounding lazy. More...
class  DestructiveCopy
 destructive copy ownership policy More...
class  DisallowConversion
 prevents implicit conversion to raw pointer More...
class  EngineException
 base class that all exceptions thrown by the engine must be derived from. More...
class  EngineOptions
 Options singleton for engine-related options More...
class  Event
 Base class for all system events. More...
class  EventDispatcher
 The Event Dispatcher base class. More...
class  FactoryGenericPlugin
class  FactoryPlugin
class  FileNotFoundException
 thrown if a file is not found More...
class  FPController
class  Handle
 a handle for resources managed by a ResourceManager More...
class  IDManager
class  InputManager
 performs event conversion and dispatching More...
class  InputMap
 maps KeyStroke s to Command s More...
class  InvalidArgumentException
 thrown if a passed argument is invalid More...
class  InvalidStateException
class  IOException
class  Iterator
class  KeyDispatcher
class  KeyEvent
 abstraction for key events More...
class  KeyListener
struct  KeyRelay
class  LazyValue
 a value that will not be created until it is actually used More...
class  LinkedConstIterator
class  LinkedIterator
class  Lock
 a thread lock More...
class  LockSmith
 abstract base for thread synchronization objects that create Lock objects More...
class  Managers
 a manager monostate More...
class  Manual
 manual singleton Lifetime policy More...
class  MotionControl
 a mouse motion Controls More...
class  MouseDispatcher
class  MouseEvent
class  MouseListener
struct  MouseRelay
class  Mutex
 used to synchronize multiple threads More...
struct  NoArgCreator
 Creator implementation for objects that are created through a no-argument ctor More...
class  NoChecking
 performs no checking More...
struct  NoCleanup
 LazyValue cleanup policy that does nothing More...
class  NullPointerException
 thrown if an unexpected 0 pointer is encountered More...
class  Options
 manages string to value bindings More...
class  OrderedAutomatic
 automatic singleton Lifetime policy More...
class  PluggableFactory
struct  PointerTraits
 splits pointer and actual type More...
struct  PointerTraits< T * >
class  Profiler
 used to time functions More...
class  Random
class  ReferenceCounting
 reference counting ownership policy More...
class  RegisterableType
class  ResourceManager
 manages acquisition and cleanup of resources More...
class  ResourceManager< T, Key, Handle< T > >
 ResourceManager partial specialization for handle based managers More...
class  ResourceManager< T, Key, T * >
 ResourceManager partial specialization for simple pointers More...
class  ResourceManagerBase
 ResourceManager base class More...
class  SafeDereference
 throws an exception when a 0 pointer is dereferenced More...
struct  Selector
 selects one of two types More...
struct  Selector< false, T, U >
class  Serializable
class  Singleton
 template for classes that allow only one active instance. More...
class  SmartPointer
 a smart pointer that handles destruction of its pointee based on policies More...
class  STLConstIterator
class  STLIterator
class  Task
 interface for Thread tasks More...
class  TextDispatcher
 TextEvent dispatcher More...
class  TextEvent
 an Event that carries a string More...
class  TextListener
 TextEvent listener More...
struct  TextRelay
class  Thread
 a thread abstraction object More...
class  Type
struct  XMLAttribute
class  XMLNode
class  XMLTree

Typedefs

typedef int Command
typedef SDLKey Key
typedef SDL_keysym KeyStroke
typedef SDLKey MapKey
typedef std::pair< Mod, Command > MapValue
typedef SDLMod Mod
typedef Uint32 ThreadID
typedef unsigned short ushort

Enumerations

enum  { LEFT_MOUSE_KEY = 324, MIDDLE_MOUSE_KEY, RIGHT_MOUSE_KEY }
 key codes for mouse buttons More...
enum  { UNDEFINED_COMMAND = 0x7FFFFFFF }

Functions

template<typename T, template< class > class OP, class CoP, template< class > class ChP, template< class > class SP, typename U>
bool operator!= (const U *l, const SmartPointer< T, OP, CoP, ChP, SP > &r)
template<typename T, template< class > class OP, class CoP, template< class > class ChP, template< class > class SP, typename U>
bool operator!= (const SmartPointer< T, OP, CoP, ChP, SP > &l, const U *r)
template<typename T, template< class > class OP, class CoP, template< class > class ChP, template< class > class SP, typename U>
bool operator< (const U *l, const SmartPointer< T, OP, CoP, ChP, SP > &r)
template<typename T, template< class > class OP, class CoP, template< class > class ChP, template< class > class SP, typename U>
bool operator< (const SmartPointer< T, OP, CoP, ChP, SP > &l, const U *r)
template<typename T, template< class > class OP, class CoP, template< class > class ChP, template< class > class SP, typename U>
bool operator<= (const U *l, const SmartPointer< T, OP, CoP, ChP, SP > &r)
template<typename T, template< class > class OP, class CoP, template< class > class ChP, template< class > class SP, typename U>
bool operator<= (const SmartPointer< T, OP, CoP, ChP, SP > &l, const U *r)
template<typename T, template< class > class OP, class CoP, template< class > class ChP, template< class > class SP, typename U>
bool operator== (const U *l, const SmartPointer< T, OP, CoP, ChP, SP > &r)
template<typename T, template< class > class OP, class CoP, template< class > class ChP, template< class > class SP, typename U>
bool operator== (const SmartPointer< T, OP, CoP, ChP, SP > &l, const U *r)
template<typename T, template< class > class OP, class CoP, template< class > class ChP, template< class > class SP, typename U>
bool operator> (const U *l, const SmartPointer< T, OP, CoP, ChP, SP > &r)
template<typename T, template< class > class OP, class CoP, template< class > class ChP, template< class > class SP, typename U>
bool operator> (const SmartPointer< T, OP, CoP, ChP, SP > &l, const U *r)
template<typename T, template< class > class OP, class CoP, template< class > class ChP, template< class > class SP, typename U>
bool operator>= (const U *l, const SmartPointer< T, OP, CoP, ChP, SP > &r)
template<typename T, template< class > class OP, class CoP, template< class > class ChP, template< class > class SP, typename U>
bool operator>= (const SmartPointer< T, OP, CoP, ChP, SP > &l, const U *r)
void parseTransform (const std::string &source, CoordinateFrame &frame)
void parseVector2 (const std::string &source, Vector2 &vector)
void parseVector3 (const std::string &source, Vector3 &vector)
template<class T>
void registerType (string name="")
void waitFor (Thread *)
 blocks the current thread until the given thread dies

Typedef Documentation

typedef int ONE::util::Command
 

typedef SDLKey ONE::util::Key
 

typedef SDL_keysym ONE::util::KeyStroke
 

typedef SDLKey ONE::util::MapKey
 

typedef std::pair<Mod,Command> ONE::util::MapValue
 

typedef SDLMod ONE::util::Mod
 

typedef Uint32 ONE::util::ThreadID
 

typedef unsigned short ONE::util::ushort
 

Enumeration Type Documentation

anonymous enum
 

key codes for mouse buttons

Enumerator:
LEFT_MOUSE_KEY 
MIDDLE_MOUSE_KEY 
RIGHT_MOUSE_KEY 

anonymous enum
 

Enumerator:
UNDEFINED_COMMAND  unknown or invalid command

Function Documentation

template<typename T, template< class > class OP, class CoP, template< class > class ChP, template< class > class SP, typename U>
bool ONE::util::operator!= (  const U *  l,
const SmartPointer< T, OP, CoP, ChP, SP > &  r
)  [inline]
  

 raw pointer != SmartPointer

template<typename T, template< class > class OP, class CoP, template< class > class ChP, template< class > class SP, typename U>
bool ONE::util::operator!= (  const SmartPointer< T, OP, CoP, ChP, SP > &  l,
const U *  r
)  [inline]
  

 SmartPointer != raw pointer

template<typename T, template< class > class OP, class CoP, template< class > class ChP, template< class > class SP, typename U>
bool ONE::util::operator< (  const U *  l,
const SmartPointer< T, OP, CoP, ChP, SP > &  r
)  [inline]
  

 raw pointer < SmartPointer
Note:
this operator is not defined.

template<typename T, template< class > class OP, class CoP, template< class > class ChP, template< class > class SP, typename U>
bool ONE::util::operator< (  const SmartPointer< T, OP, CoP, ChP, SP > &  l,
const U *  r
)  [inline]
  

 SmartPointer < raw pointer
Note:
this operator is not defined.

template<typename T, template< class > class OP, class CoP, template< class > class ChP, template< class > class SP, typename U>
bool ONE::util::operator<= (  const U *  l,
const SmartPointer< T, OP, CoP, ChP, SP > &  r
)  [inline]
  

 raw pointer <= SmartPointer
Note:
this operator is defined using the < operator.

template<typename T, template< class > class OP, class CoP, template< class > class ChP, template< class > class SP, typename U>
bool ONE::util::operator<= (  const SmartPointer< T, OP, CoP, ChP, SP > &  l,
const U *  r
)  [inline]
  

 SmartPointer <= raw pointer
Note:
this operator is defined using the < operator.

template<typename T, template< class > class OP, class CoP, template< class > class ChP, template< class > class SP, typename U>
bool ONE::util::operator== (  const U *  l,
const SmartPointer< T, OP, CoP, ChP, SP > &  r
)  [inline]
  

 raw pointer == SmartPointer

template<typename T, template< class > class OP, class CoP, template< class > class ChP, template< class > class SP, typename U>
bool ONE::util::operator== (  const SmartPointer< T, OP, CoP, ChP, SP > &  l,
const U *  r
)  [inline]
  

 SmartPointer == raw pointer

template<typename T, template< class > class OP, class CoP, template< class > class ChP, template< class > class SP, typename U>
bool ONE::util::operator> (  const U *  l,
const SmartPointer< T, OP, CoP, ChP, SP > &  r
)  [inline]
  

 raw pointer > SmartPointer
Note:
this operator is defined using the < operator.

template<typename T, template< class > class OP, class CoP, template< class > class ChP, template< class > class SP, typename U>
bool ONE::util::operator> (  const SmartPointer< T, OP, CoP, ChP, SP > &  l,
const U *  r
)  [inline]
  

 SmartPointer > raw pointer
Note:
this operator is defined using the < operator

template<typename T, template< class > class OP, class CoP, template< class > class ChP, template< class > class SP, typename U>
bool ONE::util::operator>= (  const U *  l,
const SmartPointer< T, OP, CoP, ChP, SP > &  r
)  [inline]
  

 raw pointer >= SmartPointer
Note:
this operator is defined using the < operator.

template<typename T, template< class > class OP, class CoP, template< class > class ChP, template< class > class SP, typename U>
bool ONE::util::operator>= (  const SmartPointer< T, OP, CoP, ChP, SP > &  l,
const U *  r
)  [inline]
  

 SmartPointer >= raw pointer
Note:
this operator is defined using the < operator.

void ONE::util::parseTransform (  const std::string &  source,
CoordinateFrame &  frame
) 
 

void ONE::util::parseVector2 (  const std::string &  source,
Vector2 &  vector
) 
 

void ONE::util::parseVector3 (  const std::string &  source,
Vector3 &  vector
) 
 

template<class T>
void ONE::util::registerType (  string  name = ""  ) 
 

void ONE::util::waitFor (  Thread *   ) 
 

blocks the current thread until the given thread dies

Exceptions:
InvalidArgumentException if the calling thread equals the given thread

Generated on Wed Sep 7 19:03:30 2005 for ONEngine by  doxygen 1.4.3