DD::Image::GeomOpEngine::KnobBinding Class Reference

#include <GeomOp.h>

Public Member Functions
	KnobBinding (const GeomOpEngine &engine, const char *knobName)
	KnobBinding (const KnobBinding &other)=default
	operator bool () const
	Returns true if the reference to the knob is valid.
Knob *	knob () const
	Returns the bound knob, if there is one.
bool	isAnimated () const
	Returns true if the knob is animated.
bool	isUniform () const
	Returns true if the knob is not animated.
const Authoring::Mode	getAuthoringMode () const
	Returns the authoring mode of the knob.
OutputContext	getContext (const fdk::TimeValue &time=fdk::defaultTimeValue(), int view=-1) const
template<class T >
T	get (int view=-1) const
template<class T >
T	get (const fdk::TimeValue &time, int view=-1) const
const char *	getText () const

Detailed Description

A class which gives a read handle onto a Knob, allowing GeomEngines to fetch knob values and query animation state.

Member Function Documentation

getContext()

OutputContext DD::Image::GeomOpEngine::KnobBinding::getContext ( const fdk::TimeValue &  time = fdk::defaultTimeValue(), int  view = -1  ) const

inline

Builds a context for this KnobBinding with the GraphScope from the engine and the time/view args.

References DD::Image::GeomOpEngine::graphScopeId().

get() [1/2]

template<class T >

T DD::Image::GeomOpEngine::KnobBinding::get ( int  view = -1 ) const

inline

Return the value of the knob at a 'default' time of 0.0, since Nuke Knobs do not support a separate 'no-time' value. This is primarily for non-animating Knob values like strings. Uses the GeomOpEngine's GraphScope context.

Referenced by DD::Image::GeomOpEngine::getValue().

get() [2/2]

template<class T >

T DD::Image::GeomOpEngine::KnobBinding::get ( const fdk::TimeValue &  time, int  view = -1  ) const

inline

Returns the value of the knob at the given time and optional view, and the GraphScope of the GeomOpEngine owner.

getText()

const char * DD::Image::GeomOpEngine::KnobBinding::getText ( ) const

inline

Returns the text string from the knob, possibly evaluated, at the engine's GraphScope context.