VVISF & VVGL
Public Member Functions | Related Functions | List of all members
VVISF::ISFAttr Class Reference
VVISF- Basic Classes

Describes a single ISF attribute. More...

#include <ISFAttr.hpp>

Public Member Functions

string & name () const
 Returns the attribute's name, or null.
 
string & description () const
 Returns the attribute's description, or null.
 
string & label () const
 Returns the attribute's label, or null.
 
ISFValType & type () const
 Returns the attribute's value type.
 
ISFVal & currentVal ()
 Returns the attribute's current value.
 
void setCurrentVal (const ISFVal &n)
 Sets the attribute's current value.
 
bool shouldHaveImageBuffer () const
 Returns a true if this attribute's value is expressed with an image buffer.
 
VVGL::GLBufferRef getCurrentImageBuffer ()
 Returns the receiver's image buffer.
 
void setCurrentImageBuffer (const VVGL::GLBufferRef &n)
 Sets the receiver's current value with the passed image buffer.
 
ISFVal & minVal ()
 Gets the attribute's min val.
 
ISFVal & maxVal ()
 Gets the attribute's max val.
 
ISFVal & defaultVal ()
 Gets the attribute's default val (the value which will be assigned to the attribute when it is first created and used for rendering)
 
ISFVal & identityVal ()
 Gets the attribute's identity val (the value at which this attribute's effects are indistinguishable from its raw input).
 
vector< string > & labelArray ()
 Gets the attribute's labels as a vector of string values. Only used if the attribute is a 'long'.
 
vector< int32_t > & valArray ()
 Gets the attribute's values as a vector of int values. Only used if the attribute is a 'long'.
 
bool isFilterInputImage ()
 Returns a true if this attribute is used to send the input image to the filter.
 
bool isTransStartImage ()
 Returns a true if this attribute is used to send the start image to the transition.
 
bool isTransEndImage ()
 Returns a true if this attribute is used to send the end image to the transition.
 
bool isTransProgressFloat ()
 Returns a true if this attribute is used to send the progress value to the transition.
 
string getAttrDescription ()
 Returns a human-readable string that briefly describes the attribute.
 

Related Functions

(Note that these are not member functions.)

using ISFAttrRef = std::shared_ptr< ISFAttr >
 ISFAttrRef is a shared pointer around an ISFAttr instance.
 

Detailed Description

Describes a single ISF attribute.

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