om::engine::base::OpaqueComponentSet Class Reference

A class that manages a single type of opaque components for an engine context. More...

#include <omEngineOpaqueComponentSet.h>

Public Member Functions
	OpaqueComponentSet ()
	Create a new empty opaque component set. More...
Size	getComponentCount () const
	Return the number of unique components there are in this component set. More...
void *	getComponent (Index componentIndex) const
	Return a pointer to the component at the specified index. More...
void *const *	getComponents () const
	Return a pointer to the internal packed array of component pointers in this component set. More...
Bool	addComponent (const OpaqueResource &resource)
	Add a new component to this component set. More...
Bool	removeComponent (const void *component)
	Remove the specified component from this component set. More...
void	clearComponents ()
	Remove all components from this component set. More...

Detailed Description

A class that manages a single type of opaque components for an engine context.

Usually it is not necessary to interact directly with this class. Instead, this class should be wrapped with a ComponentSet<T> of the concrete component type.

Constructor & Destructor Documentation

om::engine::base::OpaqueComponentSet::OpaqueComponentSet

(

)

Create a new empty opaque component set.

Member Function Documentation

Size om::engine::base::OpaqueComponentSet::getComponentCount ( ) const

inline

Return the number of unique components there are in this component set.

void* om::engine::base::OpaqueComponentSet::getComponent ( Index  componentIndex ) const

inline

Return a pointer to the component at the specified index.

void* const* om::engine::base::OpaqueComponentSet::getComponents ( ) const

inline

Return a pointer to the internal packed array of component pointers in this component set.

Bool om::engine::base::OpaqueComponentSet::addComponent

(

const OpaqueResource &

resource

)

Add a new component to this component set.

The method returns whether or not the resource was added.

Bool om::engine::base::OpaqueComponentSet::removeComponent

(

const void *

component

)

Remove the specified component from this component set.

The method returns whether or not the resource was removed.

void om::engine::base::OpaqueComponentSet::clearComponents

(

)

Remove all components from this component set.

---

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

• omEngineOpaqueComponentSet.h