OpenWalnut  1.4.0
Public Types | Public Member Functions | Protected Attributes
WGEPropertyUniform< T > Class Template Reference

Class implementing a uniform which can be controlled by a property instance. More...

#include <WGEPropertyUniform.h>

+ Inheritance diagram for WGEPropertyUniform< T >:

List of all members.

Public Types

typedef osg::ref_ptr
< WGEPropertyUniform
RefPtr
 Convenience typedef for an osg::ref_ptr.
typedef osg::ref_ptr< const
WGEPropertyUniform
ConstRefPtr
 Convenience typedef for an osg::ref_ptr; const.
typedef
WGEPropertyUniformCallback< T >
::UniformType 
UniformType
 The type which is used for this uniform.

Public Member Functions

 WGEPropertyUniform (std::string name, T property)
 Creates a new uniform with controlled by the specified property.
virtual ~WGEPropertyUniform ()
 Destructor.

Protected Attributes

m_property
 The property controlling the uniform.
std::string m_name
 The name of the uniform.

Detailed Description

template<typename T>
class WGEPropertyUniform< T >

Class implementing a uniform which can be controlled by a property instance.

This is mainly a convenience class for WGEPropertyUniformCallback (which is used here).

Template Parameters:
theclass used as controlling mechanism. The class needs to be a boost::shared_ptr to a type supporting get() method: T->get() returns the value (bool, int, double, WPosition supported). For other types specialize the template.

Definition at line 44 of file WGEPropertyUniform.h.


Member Typedef Documentation

template<typename T >
typedef osg::ref_ptr< const WGEPropertyUniform > WGEPropertyUniform< T >::ConstRefPtr

Convenience typedef for an osg::ref_ptr; const.

Definition at line 55 of file WGEPropertyUniform.h.

template<typename T >
typedef osg::ref_ptr< WGEPropertyUniform > WGEPropertyUniform< T >::RefPtr

Convenience typedef for an osg::ref_ptr.

Definition at line 50 of file WGEPropertyUniform.h.

template<typename T >
typedef WGEPropertyUniformCallback< T >::UniformType WGEPropertyUniform< T >::UniformType

The type which is used for this uniform.

Definition at line 73 of file WGEPropertyUniform.h.


Constructor & Destructor Documentation

template<typename T >
WGEPropertyUniform< T >::WGEPropertyUniform ( std::string  name,
property 
)

Creates a new uniform with controlled by the specified property.

Parameters:
namethe name of the uniform; consider our style guide for uniform names.
propertythe property controlling it

Definition at line 89 of file WGEPropertyUniform.h.

template<typename T >
WGEPropertyUniform< T >::~WGEPropertyUniform ( ) [virtual]

Destructor.

Definition at line 99 of file WGEPropertyUniform.h.


Member Data Documentation

template<typename T >
std::string WGEPropertyUniform< T >::m_name [protected]

The name of the uniform.

Definition at line 84 of file WGEPropertyUniform.h.

template<typename T >
T WGEPropertyUniform< T >::m_property [protected]

The property controlling the uniform.

Definition at line 79 of file WGEPropertyUniform.h.


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