Clarisse 5.0 SP8 SDK  5.0.5.8.0
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
Public Member Functions | Friends | List of all members
ShadingVariableManagerAccessor Class Reference

Defines a container to read/write a shading variable value. More...

Public Member Functions

bool is_string (const unsigned int value_index) const
 Test whether the value is a string or a number.
 
unsigned int get_value_count () const
 Returns the number of accessible values.
 
const UniqueStringget_string_value (const unsigned int value_index) const
 Returns the value as a string.
 
void set_string_value (const CoreString &value, const unsigned int value_index)
 Set the value as a string.
 
const double & get_double_value (const unsigned int value_index) const
 Returns the value as a number.
 
void set_double_value (const double &value, const unsigned int value_index) const
 Set the value as a number.
 
bool operator== (const ShadingVariableManagerAccessor &other) const
 
bool operator!= (const ShadingVariableManagerAccessor &other) const
 

Friends

class ShadingVariableManager
 

Detailed Description

Defines a container to read/write a shading variable value.

Member Function Documentation

const double& ShadingVariableManagerAccessor::get_double_value ( const unsigned int  value_index) const
inline

Returns the value as a number.

Parameters
[in]value_indexThe index of the value.
const UniqueString& ShadingVariableManagerAccessor::get_string_value ( const unsigned int  value_index) const
inline

Returns the value as a string.

Parameters
[in]value_indexThe index of the value.
bool ShadingVariableManagerAccessor::is_string ( const unsigned int  value_index) const
inline

Test whether the value is a string or a number.

Parameters
[out]trueif the value is a string.
[in]value_indexThe index of the value.
void ShadingVariableManagerAccessor::set_double_value ( const double &  value,
const unsigned int  value_index 
) const
inline

Set the value as a number.

Parameters
[in]valueThe value to set.
[in]value_indexThe index of the value.
void ShadingVariableManagerAccessor::set_string_value ( const CoreString value,
const unsigned int  value_index 
)
inline

Set the value as a string.

Parameters
[in]valueThe value to set.
[in]value_indexThe index of the value.