DD::Image::LinkableKnobInfo Class Reference

#include <LinkableI.h>

Public Member Functions
	LinkableKnobInfo (Knob *knob=nullptr, bool enabled=true, bool absolute=true)
	LinkableKnobInfo (std::string displayName, Knob *knob=nullptr, bool enabled=true, bool absolute=true)
Knob *	knob () const
bool	enabled () const
bool	absolute () const
std::string	displayName () const
const std::vector< int > &	indices () const
void	indices (const std::vector< int > &indices)

Detailed Description

Information about a knob that may be linked. Contains the actual knob as well as some meta information that may be used to make some decisions about it, such as whether it's enabled or not.

Additionally, you can specify custom expressions for how the link string is derived. For example, to address a particular cell of a TableKnobI, you would add an expression std::string to the std::vector with syntax: "row.columnname". This also lets you create arbitrary links to non-knob data if desired. For example, you could set knob to NULL, display name to "sin of frame number" and add an expression "sin(t)".