DD::Image::Path_KnobI Class Reference

Abstract base class for a single Path knob. More...

#include <PathKnobI.h>

Public Types
enum class	InputStageMode { NodeInput , File , None }

Public Member Functions
virtual bool	inError () const =0
	Check if an error is set.
virtual bool	inWarning () const =0
	Check if a warning is set.
virtual std::string	errorMessage () const =0
	Get the error message.
virtual void	showError (const std::string &message)=0
	Show a error message in the knob.
virtual void	showWarning (const std::string &message)=0
	Show a warning message in the knob.
virtual void	clearErrorsAndWarnings ()=0
	Clear the error and warning messages.
virtual void	setInputStageMode (InputStageMode mode)=0
virtual void	setInputStageIndex (int index)=0
virtual void	setInputStageFileKnobName (const std::string knobName)=0
virtual void	setScenegraphFilter (const std::string &filter)=0

Detailed Description

Abstract base class for a single Path knob.

Member Function Documentation

setInputStageIndex()

virtual void DD::Image::Path_KnobI::setInputStageIndex ( int  index )

pure virtual

Set the node input number to retrieve the stage from. Only used in InputStageMode::NodeInput mode.

setInputStageFileKnobName()

virtual void DD::Image::Path_KnobI::setInputStageFileKnobName ( const std::string  knobName )

pure virtual

Set the name of the file path knob to retrieve the stage from. Only used in InputStageMode::File mode. Default is 'file'.

setScenegraphFilter()

virtual void DD::Image::Path_KnobI::setScenegraphFilter ( const std::string &  filter )

pure virtual

Sets the filter string used in the popup dialog to filter the prims. For example 'filter:"Type:Camera"'.