om::engine::base::ComponentSet< T > Class Template Reference

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

#include <omEngineComponentSet.h>

Public Member Functions
	ComponentSet (OpaqueComponentSet *newComponents)
	Create a new component set for the specified opaque component set. More...
const ResourceType &	getResourceType () const
	Return the resource type of the components that this set has. More...
Size	getComponentCount () const
	Return the number of unique components there are in this component set. More...
T *const *	getComponents () const
	Return a pointer to the internal packed array of component pointers in this component set. More...
Bool	addComponent (const T *component, ResourceID *componentID=((void *) 0))
	Remove the specified component from this component set. More...
Bool	removeComponent (const T *component)
	Remove the specified component from this component set. More...
void	clearComponents ()
	Remove all components from this component set. More...
Bool	isValid () const
	Return whether or not this component set is valid and can be used. More...
	operator Bool () const
	Return whether or not this component set is valid and can be used. More...

Detailed Description

template<typename T>
class om::engine::base::ComponentSet< T >

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

Constructor & Destructor Documentation

template<typename T >

om::engine::base::ComponentSet< T >::ComponentSet ( OpaqueComponentSet< T > *  newComponents )

inline

Create a new component set for the specified opaque component set.

Member Function Documentation

template<typename T >

const ResourceType& om::engine::base::ComponentSet< T >::getResourceType ( ) const

inline

Return the resource type of the components that this set has.

template<typename T >

Size om::engine::base::ComponentSet< T >::getComponentCount ( ) const

inline

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

template<typename T >

T* const* om::engine::base::ComponentSet< T >::getComponents ( ) const

inline

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

template<typename T >

Bool om::engine::base::ComponentSet< T >::addComponent ( const T *  component, ResourceID *  componentID = ((void *)0)  )

inline

Remove the specified component from this component set.

The method returns whether or not the component was removed.

template<typename T >

Bool om::engine::base::ComponentSet< T >::removeComponent ( const T *  component )

inline

Remove the specified component from this component set.

The method returns whether or not the component was removed.

template<typename T >

void om::engine::base::ComponentSet< T >::clearComponents ( )

inline

Remove all components from this component set.

template<typename T >

Bool om::engine::base::ComponentSet< T >::isValid ( ) const

inline

Return whether or not this component set is valid and can be used.

template<typename T >

om::engine::base::ComponentSet< T >::operator Bool ( ) const

inline

Return whether or not this component set is valid and can be used.

---

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

• omEngineComponentSet.h