RegWrapper< T > Class Template Reference

A Wrapper class that allows to use any type of object as a Registerable. More...

Inheritance diagram for RegWrapper< T >:
Registerable

List of all members.

Public Member Functions

 RegWrapper (const T &object=T())
 Default constructor of RegWrapper.
T & get ()
 Gets a reference on the inner object.
const T & get () const
 Gets a constant reference on the inner object.

Static Public Member Functions

static RegWrapper< T > * create (const T &object=T())
 Creates and registers a new RegWrapper.

Detailed Description

template<class T>
class SPK::RegWrapper< T >

A Wrapper class that allows to use any type of object as a Registerable.

It simply encapsulates an object of type defined at compilation time.
It allows to define the behavior of these Group attributes when a copy of the Group occurs.

The user can use it to define an attribute of a custom Registerable child class that needs to act as a Registerable.

WARNING : T must obviously not be itself a Registerable.

Since:
1.03.00

Definition at line 46 of file SPK_RegWrapper.h.


Constructor & Destructor Documentation

RegWrapper ( const T &  object = T()  ) 

Default constructor of RegWrapper.

Parameters:
object : the inner object

Member Function Documentation

RegWrapper< T > * create ( const T &  object = T()  )  [static]

Creates and registers a new RegWrapper.

Parameters:
object : the inner object
Returns:
A new registered RegWrapper
Since:
1.04.00

Definition at line 93 of file SPK_RegWrapper.h.

const T & get (  )  const

Gets a constant reference on the inner object.

Returns:
a constant reference on the inner object

Definition at line 108 of file SPK_RegWrapper.h.

T & get (  ) 

Gets a reference on the inner object.

Returns:
a reference on the inner object

Definition at line 102 of file SPK_RegWrapper.h.


Generated on Wed Apr 27 21:09:26 2011 for SPARK Particle Engine by  doxygen 1.6.1