mortic Namespace Reference

The namespace where everything in mortic is. More...

Classes
class	IConfigSet
	The configuration set holder. More...
class	IConfigManager
	The Configuration Manager. More...
union	UValue
	A general container for all objects. More...
class	IEvent
	An event generated by the engine. More...
class	IEventManager
	Generates and Dispatches Events. More...
class	IFile
	A read/write file wrapper. More...
class	IMount
	Mountable object on the VFS. More...
class	IFileManager
	Manages and opens files. More...
class	ILogManager
	Prints messages to a log file. More...
class	IObject
	A generic object class in mortic. More...
class	IRoot
	The root class, which manages all objects. More...
class	IScene
	A scene or state in mortic. More...
class	ISceneManager
	The Scene Manager. More...
class	IScript
	A wrapper to a python script. More...
class	IScriptManager
	A script manager for loading scripts. More...
class	IVideoManager
	A manager for video and textures. More...
Namespaces
namespace	utilities
	A namespace that contains generic helper functions.
Enumerations
enum	EEventType { EET_NULL, EET_MORTIC, EET_USER, EET_IRRLICHT }
	An enumeration for different event types. More...
enum	EValueType {   EVT_OBJECT, EVT_STRING, EVT_INTEGER, EVT_FLOATINGPOINT,   EVT_NONE }
	An enumeration for different value types. More...
enum	ELogLevel {   ELL_ERROR, ELL_WARNING, ELL_NOTIFY, ELL_PESSIMISTIC,   ELL_DEBUG, ELL_CONSPIRATIVE, ELL_COUNT }
	Possible log levels. More...
enum	EManagerType {   EMT_ROOT, EMT_CONFIGMANAGER, EMT_FILEMANAGER, EMT_EVENTMANAGER,   EMT_LOGMANAGER, EMT_LOGMANAGERFILE, EMT_SCENEMANAGER, EMT_SCENEEND,   EMT_VIDEOMANAGER, EMT_SCRIPTMANAGER, EMT_COUNT }
	An enumeration of all the objects that are guaranteed to exist. More...
Functions
IRoot *	createRoot (std::string configFilename="settings.xml", IConfigSet *defaults=NULL, IConfigSet *overrides=NULL)
	Create a Root.
void	destroyRoot (IRoot *root)
	Destroy a Root.
IRoot *	getLastRoot ()
	Get the last-created root.

---

Detailed Description

The namespace where everything in mortic is.

---

Enumeration Type Documentation

enum mortic::EEventType

An enumeration for different event types. All these values are used in IEvent to describe the type of event. See also: IEvent Enumerator: EET_NULL  EET_MORTIC  An event of nothing. EET_USER  An event generated by Mortic. EET_IRRLICHT  An event generated by Irrlicht. Definition at line 32 of file IEventManager.h.

enum mortic::ELogLevel

Possible log levels. This enumeration lists the possible thresholds for ILogManager. Any message with a log level higher on the list than the threshold will be logged. This lets you limit the size of your logfiles by only logging important things. We recommend the ELL_NOTIFY log level. Enumerator: ELL_ERROR  Fatal, app-killing errors only. ELL_WARNING  Warnings of bad usage, but not fatal. ELL_NOTIFY  Information, like scene-changes. ELL_PESSIMISTIC  Messages from Internal Libraries. ELL_DEBUG  Debug messages, usually used only during development. ELL_CONSPIRATIVE  Super-Development messages. More than any mortal should know. ELL_COUNT  Not a log level, but how many there are. Definition at line 32 of file ILogManager.h.

enum mortic::EManagerType

An enumeration of all the objects that are guaranteed to exist. This is an easy way to keep track of what the first set of object's IDs are. Use these in place of numbers whenever possible. See also: IObject, IRoot Enumerator: EMT_ROOT  the root object (not real, just a dummy placeholder) EMT_CONFIGMANAGER  the IConfigManager instance EMT_FILEMANAGER  the IFileManager instance EMT_EVENTMANAGER  the IEventManager instance EMT_LOGMANAGER  the ILogManager instance EMT_LOGMANAGERFILE  the IFile that the log manager logs to EMT_SCENEMANAGER  the ISceneManager instance EMT_SCENEEND  the IScene instance that stops the program EMT_VIDEOMANAGER  the IVideoManager instance EMT_SCRIPTMANAGER  the IScriptManager instance EMT_COUNT  not an object, just how many values there are in this enumeration Definition at line 43 of file IRoot.h.

enum mortic::EValueType

An enumeration for different value types. This is used in IEvent to describe the type of value in UValue. See also: IEvent UValue Enumerator: EVT_OBJECT  EVT_STRING  An IObject. EVT_INTEGER  A string. EVT_FLOATINGPOINT  An Integer. EVT_NONE  Nothing! Definition at line 46 of file IEventManager.h.

---

Function Documentation

IRoot* mortic::createRoot (  std::string  configFilename = "settings.xml", IConfigSet *  defaults = NULL, IConfigSet *  overrides = NULL )

Create a Root. This is the function you call when you wish to start using mortic. Never, ever, create a root any other way. configFilename - real, harddisk path to xml configuration file defaults - defaults for the configuration overrides - configuration options to override Returns: your new root See also: destroyRoot()

void mortic::destroyRoot (  IRoot *  root  )

Destroy a Root. This function destroys a root created with createRoot. Never, ever, destroy a root any other way. root - the root to destroy See also: createRoot()

IRoot* mortic::getLastRoot (   )

Get the last-created root. This function gets the last root created with createRoot. It is here for your convenience. There should never be more than one root. Returns: the last-created root

---