om::engine::base::Scene Class Reference

A class that represents a spatial multimedia scene that contains arbitrary resource types. More...

#include <omEngineScene.h>

Public Member Functions
	Scene ()
	Create a new empty scene with no contexts. More...
Size	getResourceCount () const
	Return the number of resources there are in this scene. More...
OpaqueResource &	getResource (Index resourceIndex)
	Return a reference to the resource at the specified index in this scene. More...
const OpaqueResource &	getResource (Index resourceIndex) const
	Return a const reference to the resource at the specified index in this scene. More...
void	setResource (Index resourceIndex, const OpaqueResource &resource)
	Set the resource at the specified index in this scene. More...
Bool	addResource (const OpaqueResource &newResource)
	Add a new resource to this scene. More...
void	removeResource (Index resourceIndex)
	Remove the resource in this scene at the specified index. More...
void	clearResources ()
	Remove all resources from this scene. More...
Size	getContextCount () const
	Return the number of contexts there are in this scene. More...
SceneContext *	getContext (Index contextIndex) const
	Return a const reference to the context at the specified index in this scene. More...
Bool	addContext (SceneContext *newContext)
	Add a new context to this scene. More...
void	removeContext (Index contextIndex)
	Remove the context in this scene at the specified index. More...
void	clearContexts ()
	Remove all contexts from this scene. More...

Static Public Attributes
static const ResourceType	RESOURCE_TYPE
	The resource type for a scene. More...

Detailed Description

A class that represents a spatial multimedia scene that contains arbitrary resource types.

A scene is a container for resources that should be simulated as part of the scene. The simulation is performed by various SceneContext objects that operate on the resources in different ways.

Constructor & Destructor Documentation

om::engine::base::Scene::Scene

(

)

Create a new empty scene with no contexts.

Member Function Documentation

Size om::engine::base::Scene::getResourceCount ( ) const

inline

Return the number of resources there are in this scene.

OpaqueResource& om::engine::base::Scene::getResource ( Index  resourceIndex )

inline

Return a reference to the resource at the specified index in this scene.

const OpaqueResource& om::engine::base::Scene::getResource ( Index  resourceIndex ) const

inline

Return a const reference to the resource at the specified index in this scene.

void om::engine::base::Scene::setResource ( Index  resourceIndex, const OpaqueResource &  resource  )

inline

Set the resource at the specified index in this scene.

Bool om::engine::base::Scene::addResource

(

const OpaqueResource &

newResource

)

Add a new resource to this scene.

The method returns whether or not the resource was able to be added.

void om::engine::base::Scene::removeResource

(

Index

resourceIndex

)

Remove the resource in this scene at the specified index.

void om::engine::base::Scene::clearResources

(

)

Remove all resources from this scene.

Size om::engine::base::Scene::getContextCount ( ) const

inline

Return the number of contexts there are in this scene.

SceneContext* om::engine::base::Scene::getContext ( Index  contextIndex ) const

inline

Return a const reference to the context at the specified index in this scene.

Bool om::engine::base::Scene::addContext

(

SceneContext *

newContext

)

Add a new context to this scene.

The method returns whether or not the context was able to be added.

void om::engine::base::Scene::removeContext

(

Index

contextIndex

)

Remove the context in this scene at the specified index.

void om::engine::base::Scene::clearContexts

(

)

Remove all contexts from this scene.

Member Data Documentation

const ResourceType om::engine::base::Scene::RESOURCE_TYPE

static

The resource type for a scene.

---

The documentation for this class was generated from the following file:

• omEngineScene.h