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

Specialization of Uniform for vectors of values. More...

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

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

## Public Member Functions

virtual size_t | getNumElements () const =0
| Returns the number of elements. More...
virtual void | setElement (size_t index, const T &value)=0
| Sets the value of one of the uniform's elements. More...
virtual void | set (const std::vector< T > &value)=0
| Sets the value of all of the uniform's elements. More...
virtual std::vector< T >::const_reference | getElement (size_t index) const =0
| Gets the value of one of the uniform's elements. More...
virtual const std::vector< T > & | get () const =0
| Gets the value of all of the uniform's elements. 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< std::vector< T > >

Specialization of Uniform for vectors of values.

Template Parameters

  Value | type stored in the vector

## Member Function Documentation

## get()

template<class T >

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

pure virtual

Gets the value of all of the uniform's elements.

Returns
  Vector of values

Implemented in SurgSim::Graphics::OsgUniform< std::vector< T > >.

## getElement()

template<class T >

virtual std::vector<T>::const_reference SurgSim::Graphics::Uniform< std::vector< T > >::getElement | ( | size_t | index | ) | const

pure virtual

Gets the value of one of the uniform's elements.

Parameters

  index | Index of the element

Returns
  Value of the element

Implemented in SurgSim::Graphics::OsgUniform< std::vector< T > >.

## getNumElements()

template<class T >

virtual size_t SurgSim::Graphics::Uniform< std::vector< T > >::getNumElements | ( |  | ) | const

pure virtual

Returns the number of elements.

Implemented in SurgSim::Graphics::OsgUniform< std::vector< T > >.

## set()

template<class T >

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

pure virtual

Sets the value of all of the uniform's elements.

Parameters

  value | Vector of values

Implemented in SurgSim::Graphics::OsgUniform< std::vector< T > >.

## setElement()

template<class T >

virtual void SurgSim::Graphics::Uniform< std::vector< T > >::setElement | ( | size_t | index,
|  | const T & | value
| ) |  |

pure virtual

Sets the value of one of the uniform's elements.

Parameters

  index | Index of the element
  value | Value to set

Implemented in SurgSim::Graphics::OsgUniform< std::vector< T > >.

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

- SurgSim/Graphics/Uniform.h