Knobs supporting a value provider should implement this interface. More...

#include <ValueProvider.h>

Inheritance diagram for DD::Image::ValueProvidableI:

Public Member Functions
virtual void	setValueProvider (ValueProvider *valueProvider, bool enabled=true)=0

virtual void	enableValueProvider (bool enable=true)=0

virtual bool	isValueProviderEnabled () const =0
	Returns true if the value provider is assigned and globally enabled.

virtual int	getValueProviderMode () const =0
	Returns the value provider mode (<=0 means disable, 1 or above means enabled when not overriden by authoring)

virtual ValueProvider *	getValueProvider () const =0
	Returns the assigned ValueProvider, or nullptr if none is assigned.

Detailed Description

Knobs supporting a value provider should implement this interface.

Member Function Documentation

virtual void DD::Image::ValueProvidableI::setValueProvider	(	ValueProvider *	valueProvider,
		bool	enabled = `true`
	)

pure virtual

Assign a custom value provider to the knob. The knob will call this when it needs to display or return a value.

virtual void DD::Image::ValueProvidableI::enableValueProvider ( bool enable = true )

pure virtual

Global enable or disable the assigned ValueProvider. When enabled the knob cannot be edited and will only display or return a value.