iSharedVariable Struct Reference
[Crystal Space 3D Engine, Crystal Space 3D Engine]
iSharedVariable implements a refcounted value which can be shared across many objects and updated efficiently.
More...
#include <iengine/sharevar.h>
Inheritance diagram for iSharedVariable:

Public Types | |
enum | SharedVariableType |
Possible types stored by this class. More... | |
Public Member Functions | |
virtual void | AddListener (iSharedVariableListener *listener)=0 |
Add a listener to variables. | |
virtual float | Get () const =0 |
Get the floating point version of the var value. | |
virtual const csColor & | GetColor () const =0 |
Get the csColor from the variable. | |
virtual const char * | GetName () const =0 |
Get the name of this variable. | |
virtual int | GetType () const =0 |
Get the type currently stored by this variable. | |
virtual const csVector3 & | GetVector () const =0 |
Get the vector from the variable. | |
virtual iObject * | QueryObject ()=0 |
Get the private object interface. | |
virtual void | RemoveListener (iSharedVariableListener *listener)=0 |
Remove a listener. | |
virtual void | Set (float val)=0 |
Set the variable to a floating pt value. | |
virtual void | SetColor (const csColor &col)=0 |
Set the variable to store a csColor. | |
virtual void | SetName (const char *name)=0 |
iSharedVariables are referenced by name. Here is where you set it. | |
virtual void | SetVector (const csVector3 &v)=0 |
Set the variable to store a csVector3. |
Detailed Description
iSharedVariable implements a refcounted value which can be shared across many objects and updated efficiently.
Definition at line 43 of file sharevar.h.
Member Enumeration Documentation
|
Possible types stored by this class.
Definition at line 73 of file sharevar.h. |
Member Function Documentation
|
Add a listener to variables.
|
|
Get the floating point version of the var value.
|
|
Get the csColor from the variable.
|
|
Get the name of this variable.
|
|
Get the type currently stored by this variable.
|
|
Get the vector from the variable.
|
|
Get the private object interface.
|
|
Remove a listener.
|
|
Set the variable to a floating pt value.
|
|
Set the variable to store a csColor.
|
|
iSharedVariables are referenced by name. Here is where you set it.
|
|
Set the variable to store a csVector3.
|
The documentation for this struct was generated from the following file:
- iengine/sharevar.h
Generated for Crystal Space by doxygen 1.4.4