SurgSim::Graphics::Uniform< T > Class Template Referenceabstract

Base class for a graphics uniform with a value of type T. More...

`#include <SurgSim/Graphics/Uniform.h>`

Inheritance diagram for SurgSim::Graphics::Uniform< T >:

## Public Member Functions

| Uniform ()
virtual void | set (const T &value)=0
| Sets the value of the uniform. More...
virtual const T & | get () const =0
| Returns the value of the uniform. More...
Public Member Functions inherited from SurgSim::Graphics::UniformBase
virtual | ~UniformBase ()=0
| Destructor. More...
Public Member Functions inherited from SurgSim::Framework::Accessible
| Accessible ()
| Default Constructor. More...
| ~Accessible ()
| Destructor. More...
template<class T >
T | getValue (const std::string &name) const
| Retrieves the value with the name by executing the getter if it is found and tries to convert it to the given type. More...
boost::any | getValue (const std::string &name) const
| Retrieves the value with the name by executing the getter if it is found. More...
template<class T >
bool | getValue (const std::string &name, T *value) const
| Retrieves the value with the name by executing the getter if it is found, and converts it to the type of the output parameter. More...
void | setValue (const std::string &name, const boost::any &value)
| Sets a value of a property that has setter. More...
bool | isReadable (const std::string &name) const
| Check whether a property is readable. More...
bool | isWriteable (const std::string &name) const
| Check whether a property is writable. More...
void | setGetter (const std::string &name, GetterType func)
| Sets a getter for a given property. More...
void | setSetter (const std::string &name, SetterType func)
| Sets a setter for a given property. More...
void | setAccessors (const std::string &name, GetterType getter, SetterType setter)
| Sets the accessors getter and setter in one function. More...
void | removeAccessors (const std::string &name)
| Removes all the accessors (getter and setter) for a given property. More...
void | forwardProperty (const std::string &name, const Accessible &target, const std::string &targetProperty)
| Adds a property with the given name that uses the targets accessors, in effect forwarding the value to the target. More...
void | setSerializable (const std::string &name, EncoderType encoder, DecoderType decoder)
| Sets the functions used to convert data from and to a YAML::Node. More...
void | setDecoder (const std::string &name, DecoderType decoder)
| Sets the functions used to convert data from a YAML::Node. More...
YAML::Node | encode () const
| Encode this Accessible to a YAML::Node. More...
void | decode (const YAML::Node &node, const std::vector< std::string > &ignoredProperties=std::vector< std::string >())
| Decode this Accessible from a YAML::Node, will throw an exception if the data type cannot be converted. More...
template<>
boost::any | getValue (const std::string &name) const

## Additional Inherited Members

Public Types inherited from SurgSim::Framework::Accessible
typedef std::function< boost::any(void)> | GetterType
typedef std::function< void(boost::any)> | SetterType
typedef std::function< YAML::Node(void)> | EncoderType
typedef std::function< void(const YAML::Node *)> | DecoderType

## Detailed Description

### template<class T>
class SurgSim::Graphics::Uniform< T >

Base class for a graphics uniform with a value of type T.

Template Parameters

  Value | type

## Constructor & Destructor Documentation

## Uniform()

template<class T>

SurgSim::Graphics::Uniform< T >::Uniform | ( |  | ) |

inline

## Member Function Documentation

## get()

template<class T>

virtual const T& SurgSim::Graphics::Uniform< T >::get | ( |  | ) | const

pure virtual

Returns the value of the uniform.

Implemented in SurgSim::Graphics::OsgTextureUniform< T >, SurgSim::Graphics::OsgUniform< T >, SurgSim::Graphics::OsgTextureUniform< OsgTexture3d >, SurgSim::Graphics::OsgTextureUniform< OsgTexture2d >, SurgSim::Graphics::OsgTextureUniform< OsgTextureRectangle >, SurgSim::Graphics::OsgTextureUniform< OsgTexture1d >, and SurgSim::Graphics::OsgTextureUniform< OsgTextureCubeMap >.

## set()

template<class T>

virtual void SurgSim::Graphics::Uniform< T >::set | ( | const T & | value | ) |

pure virtual

Sets the value of the uniform.

Implemented in SurgSim::Graphics::OsgTextureUniform< T >, SurgSim::Graphics::OsgTextureUniform< OsgTexture3d >, SurgSim::Graphics::OsgTextureUniform< OsgTexture2d >, SurgSim::Graphics::OsgTextureUniform< OsgTextureRectangle >, SurgSim::Graphics::OsgTextureUniform< OsgTexture1d >, SurgSim::Graphics::OsgTextureUniform< OsgTextureCubeMap >, and SurgSim::Graphics::OsgUniform< T >.

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

- SurgSim/Graphics/Uniform.h