Odyssey Namespace Reference

Declares ActionMapInputAdapter. More...


Classes

class  ActionMapInputAdapter
 Implementation of Action mapping. More...
class  Any
class  Buffer
 Represents a string of raw binary data. More...
class  Callable
 A Callable is a generic, invokable object. More...
class  Callback
 Implements a Callback mechanism using delegates and callable pointers. More...
class  CastException
class  Clock
 This class is a global timer. More...
class  color
 Standard, flexible color representation. More...
class  Option
 Multi-valued containers for setting configurable options. More...
class  Config
class  ConsoleLogWriter
class  Delegate
 Acts as a multiple call target container and invoker. More...
class  DynamicPlugin
class  DynLib
class  Element
 This class represents a single entity within the simulation. More...
class  ElementManager
 This is the manager for the Elements within the system. More...
class  Exception
class  Facet
 Contains behaviors for Elements and links to Models. More...
class  FileLogWriter
class  auto_ctor
class  auto_dtor
class  auto_holder
class  InputAdapter
 Adapter class for OIS listeners. More...
class  InputAdapterDecorator
class  InputCombo
 Acts as the base class for all input combos. More...
class  TimedInputCombo
 This is the timed input combo, using order and timings. More...
class  AndInputCombo
 This combo embodies an "and" condition between input events. More...
class  TriggerInputCombo
 This combo combines the "and" combo with a one-shot trigger. More...
class  InputSystem
 The singleton manager for all input in the system. More...
class  Iterator
class  MapIterator
class  ContainerIterator
class  ConstContainerIterator
class  MapContainerIterator
class  ConstMapContainerIterator
class  Job
class  DelegateJob
 Executes a callable for the job. More...
class  JobQueue
class  LogManager
class  LogWriter
class  Manager
class  MapProperty
 This class maps Strings to values. More...
class  Message
class  MessageListener
 This class acts as a listener for messages and message related events. More...
class  MessageAdapter
 This class wraps the MessageListener events, as well as providing a message handling mechanism based on subscriptions. More...
class  MessageMarshaller
class  StdMessageMarshaller
class  AggregateMessageMarshaller
class  MessageQueue
class  Model
class  ModelListener
class  ModelManager
class  MultiInputAdapter
class  NotImplementedException
struct  Empty
class  Plugin
class  PluginManager
class  Profiler
 The main profiling class for the library. More...
class  PropertyListener
 This base class is notified through the PropertyBase notifyListeners. More...
class  PropertyBase
 The base class for all Property types. More...
class  Property
 Single-value property implementation. More...
class  PropertyLink
 Embodies the symbolic link between two properties. More...
class  DefaultPropertyLink
 Performs the default linking behavior between two properties. More...
class  CallablePropertyLink
 Delegates the linking of properties to a callable. More...
class  PropertyLinkConnector
 Links two PropertyLink instances together to form link chains. More...
class  PropertyProxy
class  PropertyValueProxy
class  RuntimeException
class  Script
class  ScriptFactory
class  ScriptManager
class  State
 A state is a discrete, executable member of a finite state machine. More...
class  FSM
 A state machine represents an executable finite state machine. More...
class  System
 Wraps entire subsystems in a consistent interface. More...
class  SystemManager
 Manages the System within the framework. More...
class  Task
class  TaskManager
class  ThreadedJob
 This class implements a job that will run in a new, separate thread. More...
class  DelegateThreadedJob
 This class will execute a delegate in a separate thread. More...
class  Timer
 Tracks the passage of time with high precision. More...
class  TimerEventListener
 The callback super class for events from a Timer. More...
class  TimerListener
class  TraceLogWriter
class  NullConverter
 This is a utility class for null (do-nothing) conversions. More...
class  ExceptionConverter
 A utility stream converter that throws a CastException every time it's called. More...
class  AnyConverter
 A utility converter to convert to and from Any. More...
class  variable_traits
 This is the standard traits holder class for generic data. More...
class  variable_traits_ex
 A mix-in class for generating variable traits. More...
class  Local
 This is a utility type for wrapping a known type with conversion routines. More...
class  Variable
 The Variable is a generic data component with built-in conversions. More...
class  VariableProxy
 Wraps a variable and notifies a delegate when the variable is changed. More...
class  ConstVariableProxy
 This variant of VariableProxy allows read-only access. It is meant as a way to provide a standard interface. More...
class  VectorProperty

Namespaces

namespace  Details
namespace  Dynamic
namespace  Impl

Typedefs

typedef boost::shared_ptr<
LogWriter
LogWriterPtr
typedef boost::shared_ptr<
Script
ScriptPtr
typedef boost::shared_ptr<
ScriptFactory
ScriptFactoryPtr
typedef boost::shared_ptr<
InputAdapter
InputAdapterPtr
typedef boost::shared_ptr<
InputCombo
InputComboPtr
typedef boost::shared_ptr<
Plugin
PluginPtr
typedef boost::shared_ptr<
Job
JobPtr
typedef boost::shared_ptr<
Task
TaskPtr
typedef boost::weak_ptr< TaskTaskWeakPtr
typedef boost::shared_ptr<
Element
ElementPtr
typedef boost::weak_ptr< ElementElementWeakPtr
typedef boost::shared_ptr<
Facet
FacetPtr
typedef boost::shared_ptr<
System
SystemPtr
typedef boost::weak_ptr< SystemSystemWeakPtr
typedef boost::shared_ptr<
PropertyLink
PropertyLinkPtr
typedef boost::shared_ptr<
Model
ModelPtr
typedef boost::weak_ptr< ModelModelWeakPtr
typedef double float64
typedef float float32
typedef __int64 int64
typedef __int32 int32
typedef __int16 int16
typedef __int8 int8
typedef unsigned __int64 uint64
typedef unsigned __int32 uint32
typedef unsigned __int16 uint16
typedef unsigned __int8 uint8
typedef float real
typedef char char_t
typedef std::string String
typedef Iterator< VariablePropertyValueIterator
 An Iterator to access the values stored in a Property.
typedef boost::shared_ptr<
PropertyValueIterator
PropertyValueIteratorPtr
 This is the smart pointer for the PropertyValueIterator.

Enumerations

enum  LogLevel { LL_DEBUG = 0, LL_INFO = 1, LL_WARNING = 2, LL_ERROR = 3 }

Functions

template<class T>
T * any_cast (Any *rhs)
template<class T>
const T * any_cast (const Any *rhs)
template<class T>
any_cast (const Any &rhs)
template<class Signature, class T>
Callable callable (T t)
 Constructs a callable using a functional object.
template<class Signature, class T>
Callable callable (const boost::reference_wrapper< T > &ref)
 Constructs a callable using a reference to a functional object.
template<color::ColorSystem cs>
color color_cast (const color &src)
 Casts color objects from one color system to another.
_EXPORT_ODYSSEY InputAdapterkey_press (OIS::KeyCode code)
_EXPORT_ODYSSEY InputAdapterkey_release (OIS::KeyCode code)
_EXPORT_ODYSSEY InputAdaptermouse_up ()
_EXPORT_ODYSSEY InputAdaptermouse_down ()
_EXPORT_ODYSSEY InputAdaptermouse_right ()
_EXPORT_ODYSSEY InputAdaptermouse_left ()
_EXPORT_ODYSSEY InputAdaptermouse_in ()
_EXPORT_ODYSSEY InputAdaptermouse_out ()
_EXPORT_ODYSSEY InputAdaptermouse_move (int32 x, int32 y, int32 z)
_EXPORT_ODYSSEY InputAdaptermouse_move_greater (int32 x, int32 y, int32 z)
_EXPORT_ODYSSEY InputAdaptermouse_move_less (int32 x, int32 y, int32 z)
_EXPORT_ODYSSEY InputAdaptermouse_press (OIS::MouseButtonID id)
_EXPORT_ODYSSEY InputAdaptermouse_release (OIS::MouseButtonID id)
_EXPORT_ODYSSEY InputAdapteraxis_up (uint32 axis)
_EXPORT_ODYSSEY InputAdapteraxis_down (uint32 axis)
_EXPORT_ODYSSEY InputAdapteraxis_right (uint32 axis)
_EXPORT_ODYSSEY InputAdapteraxis_left (uint32 axis)
_EXPORT_ODYSSEY InputAdapteraxis_in (uint32 axis)
_EXPORT_ODYSSEY InputAdapteraxis_out (uint32 axis)
_EXPORT_ODYSSEY InputAdapteraxis_move (uint32 axis, int32 x, int32 y, int32 z)
_EXPORT_ODYSSEY InputAdapteraxis_move_greater (uint32 axis, int32 x, int32 y, int32 z)
_EXPORT_ODYSSEY InputAdapteraxis_move_less (uint32 axis, int32 x, int32 y, int32 z)
_EXPORT_ODYSSEY InputAdapterpov_up (uint32 axis)
_EXPORT_ODYSSEY InputAdapterpov_down (uint32 axis)
_EXPORT_ODYSSEY InputAdapterpov_right (uint32 axis)
_EXPORT_ODYSSEY InputAdapterpov_left (uint32 axis)
_EXPORT_ODYSSEY InputAdapterpov_in (uint32 axis)
_EXPORT_ODYSSEY InputAdapterpov_out (uint32 axis)
_EXPORT_ODYSSEY InputAdapterpov_move (uint32 axis, int32 x, int32 y, int32 z)
_EXPORT_ODYSSEY InputAdapterpov_move_greater (uint32 axis, int32 x, int32 y, int32 z)
_EXPORT_ODYSSEY InputAdapterpov_move_less (uint32 axis, int32 x, int32 y, int32 z)
_EXPORT_ODYSSEY InputAdapterjoystick_press (int id)
_EXPORT_ODYSSEY InputAdapterjoystick_release (int id)
_EXPORT_ODYSSEY InputAdapteror (InputAdapter *operand1, InputAdapter *operand2)
_EXPORT_ODYSSEY InputAdapternot (InputAdapter *operand)
template<class T, class F>
void forEach (Iterator< T > &i, F f)
template<class T, class A, class F>
void forEach (MapIterator< T, A > &i, F f)
template<class T>
eval (ScriptPtr script)
 This evaluates a script returning the value as the requested type.
template<class T>
eval (const Script &script)
 This evaluates a script returning the value as the requested type.
_EXPORT_ODYSSEY ScriptPtr script_s (const String &type, const String &code)
 Create a script of the given type for a string.
_EXPORT_ODYSSEY ScriptPtr script_f (const String &type, const String &file)
 Create a scipt of the given type for a file.
template<class TargetT, class SourceT>
TargetT smart_cast (const boost::shared_ptr< SourceT > &src)
template<class TargetT, class SourceT>
TargetT smart_cast (const std::auto_ptr< SourceT > &src)
template<class TargetT, class SourceT>
TargetT stream_cast (SourceT source)
template<class T>
Variable var (T t)
 Constructs a variable from an object.
template<class T>
Variable var (const boost::reference_wrapper< T > &t)
 Constructs a variable from a reference to an object.
Variable var (const Variable &rhs)
template<class T, class U>
Variable var_ex (U u)
 Constructs a variable from an object with the given traits.
template<class T, class U>
Variable var_ex (const boost::reference_wrapper< U > &u)
 Constructs a variable from a reference to an object with the given traits.
template<class T>
Variable var_ex (const Variable &rhs)


Detailed Description

Declares ActionMapInputAdapter.

Typedef Documentation

typedef char Odyssey::char_t
 

This is the character type used within the engine. Its size depends on the value of ODYSSEY_UNICODE. If this value is 1, char_t is a wide character, otherwise it is 8 bits.

See also:
OdysseyConfig.h

typedef boost::shared_ptr<Element> Odyssey::ElementPtr
 

typedef boost::weak_ptr<Element> Odyssey::ElementWeakPtr
 

typedef boost::shared_ptr<Facet> Odyssey::FacetPtr
 

typedef float Odyssey::float32
 

32-bit floating point number

typedef double Odyssey::float64
 

64-bit floating point number

typedef boost::shared_ptr<InputAdapter> Odyssey::InputAdapterPtr
 

typedef boost::shared_ptr<InputCombo> Odyssey::InputComboPtr
 

typedef __int16 Odyssey::int16
 

16-bit signed fixed point number

typedef __int32 Odyssey::int32
 

32-bit signed fixed point number

typedef __int64 Odyssey::int64
 

64-bit signed fixed point number

typedef __int8 Odyssey::int8
 

8-bit signed fixed point number

typedef boost::shared_ptr<Job> Odyssey::JobPtr
 

typedef boost::shared_ptr<LogWriter> Odyssey::LogWriterPtr
 

typedef boost::shared_ptr<Model> Odyssey::ModelPtr
 

typedef boost::weak_ptr<Model> Odyssey::ModelWeakPtr
 

typedef boost::shared_ptr<Plugin> Odyssey::PluginPtr
 

typedef boost::shared_ptr<PropertyLink> Odyssey::PropertyLinkPtr
 

typedef Iterator<Variable> Odyssey::PropertyValueIterator
 

An Iterator to access the values stored in a Property.

This is the typedef for an iterator which gives access to the value(s) within a Property. It is mostly used for the property algorithms. It is meant to function in an Iterator hierarchy and so it is different than the standard Odyssey Iterators.

typedef boost::shared_ptr<PropertyValueIterator> Odyssey::PropertyValueIteratorPtr
 

This is the smart pointer for the PropertyValueIterator.

typedef float Odyssey::real
 

The size of this type depends on the value in ODYSSEY_DOUBLE_PRECISION. If this value is equal to 1, the type is 64-bits. Otherwise it is 32.

See also:
OdysseyConfig.h

typedef boost::shared_ptr<ScriptFactory> Odyssey::ScriptFactoryPtr
 

typedef boost::shared_ptr<Script> Odyssey::ScriptPtr
 

typedef std::string Odyssey::String
 

This is the string type used within the engine. Its size depends on the value of ODYSSEY_UNICODE. If this value is 1, String is a wide string, otherwise it is narrow (8-bit characters).

See also:
OdysseyConfig.h

typedef boost::shared_ptr<System> Odyssey::SystemPtr
 

typedef boost::weak_ptr<System> Odyssey::SystemWeakPtr
 

typedef boost::shared_ptr<Task> Odyssey::TaskPtr
 

typedef boost::weak_ptr<Task> Odyssey::TaskWeakPtr
 

typedef unsigned __int16 Odyssey::uint16
 

16-bit unsigned fixed point number

typedef unsigned __int32 Odyssey::uint32
 

32-bit unsigned fixed point number

typedef unsigned __int64 Odyssey::uint64
 

64-bit unsigned fixed point number

typedef unsigned __int8 Odyssey::uint8
 

8-bit unsigned fixed point number


Enumeration Type Documentation

enum Odyssey::LogLevel
 

Enumerator:
LL_DEBUG 
LL_INFO 
LL_WARNING 
LL_ERROR 


Function Documentation

template<class T>
T Odyssey::any_cast const Any &  rhs  ) 
 

template<class T>
const T* Odyssey::any_cast const Any *  rhs  ) 
 

template<class T>
T* Odyssey::any_cast Any *  rhs  ) 
 

_EXPORT_ODYSSEY InputAdapter* Odyssey::axis_down uint32  axis  ) 
 

_EXPORT_ODYSSEY InputAdapter* Odyssey::axis_in uint32  axis  ) 
 

_EXPORT_ODYSSEY InputAdapter* Odyssey::axis_left uint32  axis  ) 
 

_EXPORT_ODYSSEY InputAdapter* Odyssey::axis_move uint32  axis,
int32  x,
int32  y,
int32  z
 

_EXPORT_ODYSSEY InputAdapter* Odyssey::axis_move_greater uint32  axis,
int32  x,
int32  y,
int32  z
 

_EXPORT_ODYSSEY InputAdapter* Odyssey::axis_move_less uint32  axis,
int32  x,
int32  y,
int32  z
 

_EXPORT_ODYSSEY InputAdapter* Odyssey::axis_out uint32  axis  ) 
 

_EXPORT_ODYSSEY InputAdapter* Odyssey::axis_right uint32  axis  ) 
 

_EXPORT_ODYSSEY InputAdapter* Odyssey::axis_up uint32  axis  ) 
 

template<class Signature, class T>
Callable Odyssey::callable const boost::reference_wrapper< T > &  ref  ) 
 

Constructs a callable using a reference to a functional object.

template<class Signature, class T>
Callable Odyssey::callable t  ) 
 

Constructs a callable using a functional object.

template<color::ColorSystem cs>
color Odyssey::color_cast const color &  src  ) 
 

Casts color objects from one color system to another.

This utility function will cast the given color to a new color in a different color system. The function performs mathematical transformations to convert the color to the new color system. The new color system should be specified as the single template parameter.

Parameters:
src the color that you wish to cast

template<class T>
T Odyssey::eval const Script &  script  ) 
 

This evaluates a script returning the value as the requested type.

template<class T>
T Odyssey::eval ScriptPtr  script  ) 
 

This evaluates a script returning the value as the requested type.

template<class T, class A, class F>
void Odyssey::forEach MapIterator< T, A > &  i,
f
 

template<class T, class F>
void Odyssey::forEach Iterator< T > &  i,
f
 

_EXPORT_ODYSSEY InputAdapter* Odyssey::joystick_press int  id  ) 
 

_EXPORT_ODYSSEY InputAdapter* Odyssey::joystick_release int  id  ) 
 

_EXPORT_ODYSSEY InputAdapter* Odyssey::key_press OIS::KeyCode  code  ) 
 

_EXPORT_ODYSSEY InputAdapter* Odyssey::key_release OIS::KeyCode  code  ) 
 

_EXPORT_ODYSSEY InputAdapter* Odyssey::mouse_down  ) 
 

_EXPORT_ODYSSEY InputAdapter* Odyssey::mouse_in  ) 
 

_EXPORT_ODYSSEY InputAdapter* Odyssey::mouse_left  ) 
 

_EXPORT_ODYSSEY InputAdapter* Odyssey::mouse_move int32  x,
int32  y,
int32  z
 

_EXPORT_ODYSSEY InputAdapter* Odyssey::mouse_move_greater int32  x,
int32  y,
int32  z
 

_EXPORT_ODYSSEY InputAdapter* Odyssey::mouse_move_less int32  x,
int32  y,
int32  z
 

_EXPORT_ODYSSEY InputAdapter* Odyssey::mouse_out  ) 
 

_EXPORT_ODYSSEY InputAdapter* Odyssey::mouse_press OIS::MouseButtonID  id  ) 
 

_EXPORT_ODYSSEY InputAdapter* Odyssey::mouse_release OIS::MouseButtonID  id  ) 
 

_EXPORT_ODYSSEY InputAdapter* Odyssey::mouse_right  ) 
 

_EXPORT_ODYSSEY InputAdapter* Odyssey::mouse_up  ) 
 

_EXPORT_ODYSSEY InputAdapter* Odyssey::not InputAdapter *  operand  ) 
 

_EXPORT_ODYSSEY InputAdapter* Odyssey::or InputAdapter *  operand1,
InputAdapter *  operand2
 

_EXPORT_ODYSSEY InputAdapter* Odyssey::pov_down uint32  axis  ) 
 

_EXPORT_ODYSSEY InputAdapter* Odyssey::pov_in uint32  axis  ) 
 

_EXPORT_ODYSSEY InputAdapter* Odyssey::pov_left uint32  axis  ) 
 

_EXPORT_ODYSSEY InputAdapter* Odyssey::pov_move uint32  axis,
int32  x,
int32  y,
int32  z
 

_EXPORT_ODYSSEY InputAdapter* Odyssey::pov_move_greater uint32  axis,
int32  x,
int32  y,
int32  z
 

_EXPORT_ODYSSEY InputAdapter* Odyssey::pov_move_less uint32  axis,
int32  x,
int32  y,
int32  z
 

_EXPORT_ODYSSEY InputAdapter* Odyssey::pov_out uint32  axis  ) 
 

_EXPORT_ODYSSEY InputAdapter* Odyssey::pov_right uint32  axis  ) 
 

_EXPORT_ODYSSEY InputAdapter* Odyssey::pov_up uint32  axis  ) 
 

_EXPORT_ODYSSEY ScriptPtr Odyssey::script_f const String type,
const String file
 

Create a scipt of the given type for a file.

_EXPORT_ODYSSEY ScriptPtr Odyssey::script_s const String type,
const String code
 

Create a script of the given type for a string.

template<class TargetT, class SourceT>
TargetT Odyssey::smart_cast const std::auto_ptr< SourceT > &  src  ) 
 

template<class TargetT, class SourceT>
TargetT Odyssey::smart_cast const boost::shared_ptr< SourceT > &  src  ) 
 

template<class TargetT, class SourceT>
TargetT Odyssey::stream_cast SourceT  source  ) 
 

Variable Odyssey::var const Variable &  rhs  )  [inline]
 

template<class T>
Variable Odyssey::var const boost::reference_wrapper< T > &  t  ) 
 

Constructs a variable from a reference to an object.

template<class T>
Variable Odyssey::var t  ) 
 

Constructs a variable from an object.

template<class T>
Variable Odyssey::var_ex const Variable &  rhs  ) 
 

template<class T, class U>
Variable Odyssey::var_ex const boost::reference_wrapper< U > &  u  ) 
 

Constructs a variable from a reference to an object with the given traits.

template<class T, class U>
Variable Odyssey::var_ex u  ) 
 

Constructs a variable from an object with the given traits.


Generated on Sun Jan 7 01:18:52 2007 for Odyssey Meta-Engine by  doxygen 1.4.6-NO