CrystalSpace

Public API Reference

Main Page   Modules   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  

iSharedVariable Struct Reference
[Crystal Space 3D Engine]

iSharedVariable implements a refcounted float value which can be shared across many objects and updated efficiently. More...

#include <sharevar.h>

Inheritance diagram for iSharedVariable:

iBase List of all members.

Public Types

enum  SharedVariableType
 Possible types stored by this class. More...


Public Methods

virtual iObjectQueryObject ()=0
 Get the private object interface. More...

virtual void SetName (const char *name)=0
 iSharedVariables are referenced by name. Here is where you set it. More...

virtual const char * GetName () const=0
 Get the name of this variable. More...

virtual void Set (float val)=0
 Set the variable to a floating pt value. More...

virtual float Get () const=0
 Get the floating point version of the var value. More...

virtual void SetColor (const csColor &col)=0
 Set the variable to store a csColor. More...

virtual const csColorGetColor () const=0
 Get the csColor from the variable. More...

virtual void SetVector (const csVector3 &v)=0
 Set the variable to store a csVector3. More...

virtual const csVector3GetVector () const=0
 Get the vector from the variable. More...

virtual int GetType () const=0
 Get the type currently stored by this variable. More...


Detailed Description

iSharedVariable implements a refcounted float value which can be shared across many objects and updated efficiently.

Definition at line 39 of file iengine/sharevar.h.


Member Enumeration Documentation

enum iSharedVariable::SharedVariableType
 

Possible types stored by this class.

Definition at line 69 of file iengine/sharevar.h.


Member Function Documentation

virtual float iSharedVariable::Get   const [pure virtual]
 

Get the floating point version of the var value.

virtual const csColor& iSharedVariable::GetColor   const [pure virtual]
 

Get the csColor from the variable.

virtual const char* iSharedVariable::GetName   const [pure virtual]
 

Get the name of this variable.

virtual int iSharedVariable::GetType   const [pure virtual]
 

Get the type currently stored by this variable.

virtual const csVector3& iSharedVariable::GetVector   const [pure virtual]
 

Get the vector from the variable.

virtual iObject* iSharedVariable::QueryObject   [pure virtual]
 

Get the private object interface.

virtual void iSharedVariable::Set float    val [pure virtual]
 

Set the variable to a floating pt value.

virtual void iSharedVariable::SetColor const csColor   col [pure virtual]
 

Set the variable to store a csColor.

virtual void iSharedVariable::SetName const char *    name [pure virtual]
 

iSharedVariables are referenced by name. Here is where you set it.

virtual void iSharedVariable::SetVector const csVector3   v [pure virtual]
 

Set the variable to store a csVector3.


The documentation for this struct was generated from the following file:
Generated for Crystal Space by doxygen 1.2.14