Knobs.h File Reference

Knob creation functions. More...

Classes
struct	DD::Image::IRange

Namespaces
namespace	DD::Image

Macros
#define	CustomKnob0(knobclass, cb, name)
#define	CustomKnob1(knobclass, cb, pointer, name)
#define	CustomKnob2(knobclass, cb, pointer, name, label)
#define	CustomKnobA(knobclass, cb, pointer, name, args)

Enumerations
enum	FileKnob_Type {   Normal_File , Read_File_Proxy , Write_File_Proxy , Geo_File ,   Write_File_Normal , Script_File , Read_File_Cached , Read_File_NoProxy ,   OCIO_File , Particle_Cache_File , Cube_File }
enum	{   TRANSFORM , POSITIONER , TO_PROXY , NO_SCALE ,   NO_UNIFORM_SCALE , NO_SKEW , NO_CENTER , T2D_GAUGE ,   T2D_INVERT }

Functions
void	DD::Image::Tooltip (Knob_Callback f, const char *)
void	DD::Image::Tooltip (Knob_Callback f, const std::string &text)
void	DD::Image::SetFlags (Knob_Callback f, Knob::FlagMask n)
void	DD::Image::ClearFlags (Knob_Callback f, Knob::FlagMask n)
void	DD::Image::SetRange (Knob_Callback f, double minimum, double maximum)
Knob *	DD::Image::Obsolete_knob (Knob_Callback f, const char *linkto, NAME name, const char *script)
Knob *	DD::Image::Obsolete_knob (Knob_Callback f, NAME name, const char *script)
Knob *	DD::Image::Op_knob (Knob_Callback f, Op *op, NAME name)
Knob *	DD::Image::String_knob (Knob_Callback f, const char **p, NAME n, LABEL l=nullptr)
Knob *	DD::Image::Password_knob (Knob_Callback f, const char **p, NAME n, LABEL l=nullptr)
Knob *	DD::Image::String_knob (Knob_Callback f, std::string *p, NAME n, LABEL l=nullptr)
Knob *	DD::Image::String_knob (Knob_Callback f, NAME n, LABEL l=nullptr)
Knob *	DD::Image::File_knob (Knob_Callback f, const char **p, NAME n, LABEL l=nullptr, FileKnob_Type type=Normal_File)
Knob *	DD::Image::Read_File_knob (ReadFileKnobOwner *ptr, Knob_Callback f, const char **p, NAME n, LABEL l=nullptr)
Knob *	DD::Image::Read_File_knob (ReadFileKnobOwner *ptr, Knob_Callback f, std::string *p, NAME n, LABEL l=nullptr)
Knob *	DD::Image::Cached_File_knob (Knob_Callback f, const char **p, NAME n, LABEL l=nullptr, FileKnob_Type type=Normal_File)
Knob *	DD::Image::Write_File_knob (Knob_Callback f, const char **p, NAME n, LABEL l=nullptr)
Knob *	DD::Image::Write_File_knob (Knob_Callback f, std::string *p, NAME n, LABEL l=nullptr)
Knob *	DD::Image::Proxyless_Read_File_knob (ReadFileKnobOwner *ptr, Knob_Callback f, const char **p, NAME n, LABEL l=nullptr)
Knob *	DD::Image::Int_knob (Knob_Callback f, int *p, NAME n, LABEL l=nullptr)
Knob *	DD::Image::Enumeration_knob (Knob_Callback f, int *p, ENUM_LABELS e, NAME n, LABEL l=nullptr)
Knob *	DD::Image::CascadingEnumeration_knob (Knob_Callback f, int *p, ENUM_LABELS e, NAME n, LABEL l=nullptr)
Knob *	DD::Image::Colorspace_knob (Knob_Callback f, int *p, const char *e, NAME n, LABEL l=nullptr)
Knob *	DD::Image::SceneGraph_knob (Knob_Callback f, int *p, std::vector< SceneItem > *e, NAME n, LABEL l=nullptr)
Knob *	DD::Image::SceneView_knob (Knob_Callback f, int *p, ENUM_LABELS e, NAME n, LABEL l=nullptr)
Knob *	DD::Image::SceneView_knob (Knob_Callback f, SceneView_KnobI::ItemList *p, NAME n, LABEL l=nullptr)
Knob *	DD::Image::FreeTypeFont_knob (Knob_Callback f, StlStringIntPair *p, NAME n, LABEL l=nullptr)
Knob *	DD::Image::OneView_knob (Knob_Callback f, int *p, NAME n, LABEL l=nullptr, const char *defcaption=nullptr)
Knob *	DD::Image::ViewPair_knob (Knob_Callback f, std::pair< int, int > *p, NAME n, LABEL l=nullptr)
Knob *	DD::Image::MetaData_knob (Knob_Callback f, NAME n, LABEL l=nullptr)
Knob *	DD::Image::MultiView_knob (Knob_Callback f, std::set< int > *p, NAME n, LABEL l=nullptr)
Knob *	DD::Image::ViewView_knob (Knob_Callback f, std::map< int, int > *p, NAME n, std::pair< std::string, std::string > *headings, LABEL l=nullptr)
Knob *	DD::Image::ParticleChannels_knob (Knob_Callback f, unsigned int *p, NAME n, LABEL l=nullptr)
	Makes a particle channels knob. This displays a dropdown menu of particle channels with a checkbox by each to turn it on, and an option to create new channels.
Knob *	DD::Image::Bitmask_knob (Knob_Callback f, unsigned int *p, ENUM_LABELS e, NAME n, LABEL l=nullptr)
Knob *	DD::Image::Dynamic_Bitmask_knob (Knob_Callback f, unsigned int *p, std::map< int, std::string > *e, NAME n, LABEL l=nullptr)
Knob *	DD::Image::Bool_knob (Knob_Callback f, bool *p, NAME n, LABEL l=nullptr)
Knob *	DD::Image::Float_knob (Knob_Callback f, double *p, NAME n, LABEL l=nullptr)
Knob *	DD::Image::Float_knob (Knob_Callback f, float *p, NAME n, LABEL l=nullptr)
Knob *	DD::Image::Frame_knob (Knob_Callback f, float *p, NAME n, LABEL l=nullptr)
Knob *	DD::Image::Deep_knob (Knob_Callback f, float *p, NAME n, LABEL l=nullptr)
Knob *	DD::Image::MultiFloat_knob (Knob_Callback f, double *p, int dim, NAME n, LABEL l=nullptr)
Knob *	DD::Image::MultiFloat_knob (Knob_Callback f, float *p, int dim, NAME n, LABEL l=nullptr)
Knob *	DD::Image::MultiInt_knob (Knob_Callback f, int *p, int dim, NAME n, LABEL l=nullptr)
Knob *	DD::Image::PixelAspect_knob (Knob_Callback f, double *p, NAME n, LABEL l=nullptr)
Knob *	DD::Image::PathExpression_knob (Knob_Callback f, std::string *p, NAME n, LABEL l=nullptr)
	Controls a string containing a prim path matching expression.
Knob *	DD::Image::PathExpression_knob (Knob_Callback f, std::string *p, const std::string &filters, NAME n, LABEL l=nullptr)
Knob *	DD::Image::Input_PathExpression_knob (Knob_Callback f, std::string *p, int input, NAME n, LABEL l=nullptr)
Knob *	DD::Image::Input_PathExpression_knob (Knob_Callback f, std::string *p, int input, const std::string &filters, NAME n, LABEL l=nullptr)
Knob *	DD::Image::Path_knob (Knob_Callback f, std::string *p, NAME n, LABEL l=nullptr)
	Controls a string containing a prim path.
Knob *	DD::Image::Path_knob (Knob_Callback f, std::string *p, const std::string &filters, NAME n, LABEL l=nullptr)
Knob *	DD::Image::Input_Path_knob (Knob_Callback f, std::string *p, int input, NAME n, LABEL l=nullptr)
Knob *	DD::Image::Input_Path_knob (Knob_Callback f, std::string *p, int input, const std::string &filters, NAME n, LABEL l=nullptr)
Knob *	DD::Image::Array_knob (Knob_Callback f, ConvolveArray *p, int width, int height, NAME n, LABEL l=nullptr, bool defaultData=false)
Knob *	DD::Image::ResizableArray_knob (Knob_Callback f, ConvolveArray *p, int width, int height, NAME n, LABEL l=nullptr, bool defaultData=false)
Knob *	DD::Image::ChannelSet_knob (Knob_Callback f, ChannelSet *p, NAME n, LABEL l=nullptr)
Knob *	DD::Image::Input_ChannelSet_knob (Knob_Callback f, ChannelSet *p, int input, NAME n, LABEL l=nullptr)
Knob *	DD::Image::InputOnly_ChannelSet_knob (Knob_Callback f, ChannelSet *p, int input, NAME n, LABEL l=nullptr)
Knob *	DD::Image::Channel_knob (Knob_Callback f, Channel *p, int count, NAME n, LABEL l=nullptr)
Knob *	DD::Image::Input_Channel_knob (Knob_Callback f, Channel *p, int count, int input, NAME n, LABEL l=nullptr)
Knob *	DD::Image::InputOnly_Channel_knob (Knob_Callback f, Channel *p, int count, int input, NAME n, LABEL l=nullptr)
Knob *	DD::Image::XY_knob (Knob_Callback f, double *p, NAME n, LABEL l, Knob *parent=nullptr)
Knob *	DD::Image::XY_knob (Knob_Callback f, double *p, NAME n, Knob *parent=nullptr)
Knob *	DD::Image::XY_knob (Knob_Callback f, float *p, NAME n, LABEL l, Knob *parent=nullptr)
Knob *	DD::Image::XY_knob (Knob_Callback f, float *p, NAME n, Knob *parent=nullptr)
Knob *	DD::Image::XYZ_knob (Knob_Callback f, double *p, NAME n, LABEL l=nullptr, Knob *parent=nullptr)
Knob *	DD::Image::XYZ_knob (Knob_Callback f, float *p, NAME n, LABEL l=nullptr, Knob *parent=nullptr)
Knob *	DD::Image::UV_knob (Knob_Callback f, double *p, NAME n, LABEL l=nullptr)
Knob *	DD::Image::UV_knob (Knob_Callback f, float *p, NAME n, LABEL l=nullptr)
Knob *	DD::Image::CP_knob (Knob_Callback f, float *p, int dim, NAME n, LABEL l=nullptr)
Knob *	DD::Image::WH_knob (Knob_Callback f, double *p, NAME n, LABEL l=nullptr)
Knob *	DD::Image::WH_knob (Knob_Callback f, float *p, NAME n, LABEL l=nullptr)
Knob *	DD::Image::BBox_knob (Knob_Callback f, double *p, NAME n, LABEL l=nullptr, Knob *parent=nullptr)
Knob *	DD::Image::BBox_knob (Knob_Callback f, float *p, NAME n, LABEL l=nullptr, Knob *parent=nullptr)
Knob *	DD::Image::Format_knob (Knob_Callback f, FormatPair *p, NAME n, LABEL l=nullptr)
Knob *	DD::Image::Color_knob (Knob_Callback f, float *p, NAME n, LABEL l=nullptr)
Knob *	DD::Image::Color_knob (Knob_Callback f, double *p, NAME n, LABEL l=nullptr)
Knob *	DD::Image::AColor_knob (Knob_Callback f, float *p, NAME n, LABEL l=nullptr)
Knob *	DD::Image::AColor_knob (Knob_Callback f, double *p, NAME n, LABEL l=nullptr)
Knob *	DD::Image::Eyedropper_knob (Knob_Callback f, float *p, NAME n, LABEL l=nullptr)
Knob *	DD::Image::Range_knob (Knob_Callback f, double *p, int np, NAME n, LABEL l=nullptr)
Knob *	DD::Image::Range_knob (Knob_Callback f, float *p, int np, NAME n, LABEL l=nullptr)
void	DD::Image::FrameRange_knob (Knob_Callback f, FrameRange p, const std::string &n, LABEL l=nullptr)
Knob *	DD::Image::Transform2d_knob (Knob_Callback f, Matrix4 *p, NAME n, int type=0)
Knob *	DD::Image::Transform2d_knob (Knob_Callback f, Matrix4 *p, NAME n, LABEL l, int type=0)
Knob *	DD::Image::LookupCurves_knob (Knob_Callback f, LookupCurves *p, DD::Image::LookupCurvesType type, NAME n, LABEL l=nullptr)
Knob *	DD::Image::LookupCurves_knob (Knob_Callback f, LookupCurves *p, NAME n, LABEL l=nullptr)
Knob *	DD::Image::Axis_knob (Knob_Callback f, fdk::Mat4d *p, NAME n, LABEL l=nullptr)
Knob *	DD::Image::Axis_knob (Knob_Callback f, Matrix4 *p, NAME n, LABEL l=nullptr)
Knob *	DD::Image::PositionVector_knob (Knob_Callback f, float *p, NAME n, LABEL l=nullptr)
Knob *	DD::Image::Box3_knob (Knob_Callback f, float *p, NAME n, LABEL l=nullptr)
Knob *	DD::Image::Histogram_knob (Knob_Callback f, Histogram_Data *p, NAME n, LABEL l=nullptr)
Knob *	DD::Image::Keyer_knob (Knob_Callback f, double *p, NAME n, LABEL l=nullptr)
Knob *	DD::Image::ColorChip_knob (Knob_Callback f, unsigned *p, NAME n, LABEL l=nullptr)
Knob *	DD::Image::Tab_knob (Knob_Callback f, LABEL label)
Knob *	DD::Image::MultiArray_knob (Knob_Callback f, NAME n, LABEL l=nullptr)
Knob *	DD::Image::BeginGroup (Knob_Callback f, NAME name, LABEL label=nullptr)
Knob *	DD::Image::BeginClosedGroup (Knob_Callback f, NAME name, LABEL label=nullptr)
Knob *	DD::Image::EndGroup (Knob_Callback f)
Knob *	DD::Image::BeginToolbar (Knob_Callback f, NAME name, LABEL label=nullptr, int position=Knob::TOOLBAR_TOP)
Knob *	DD::Image::EndToolbar (Knob_Callback f)
Knob *	DD::Image::BeginTabGroup (Knob_Callback f, NAME name, LABEL label=nullptr)
Knob *	DD::Image::EndTabGroup (Knob_Callback f)
Knob *	DD::Image::BeginExoGroup (Knob_Callback f, NAME name, LABEL label=nullptr)
Knob *	DD::Image::EndExoGroup (Knob_Callback f)
Knob *	DD::Image::Text_knob (Knob_Callback f, LABEL text)
Knob *	DD::Image::Text_knob (Knob_Callback f, LABEL label, LABEL text)
Knob *	DD::Image::Named_Text_knob (Knob_Callback f, LABEL name, LABEL text)
Knob *	DD::Image::Named_Text_knob (Knob_Callback f, LABEL name, LABEL label, LABEL text)
Knob *	DD::Image::Newline (Knob_Callback f, LABEL label=" ")
Knob *	DD::Image::Divider (Knob_Callback f, LABEL label=nullptr)
Knob *	DD::Image::Spacer (Knob_Callback f, int spaceInPixels)
Knob *	DD::Image::VSpacer (Knob_Callback f, int spaceInPixels)
Knob *	DD::Image::Icon_knob (Knob_Callback f, const char *icon)
Knob *	DD::Image::Help_knob (Knob_Callback f, LABEL text)
Knob *	DD::Image::Help_knob (Knob_Callback f, LABEL label, LABEL text)
Knob *	DD::Image::Button (Knob_Callback f, NAME n, LABEL l=nullptr)
Knob *	DD::Image::Script_knob (Knob_Callback f, NAME command, NAME n, LABEL l=nullptr)
Knob *	DD::Image::PyScript_knob (Knob_Callback f, NAME command, NAME n, LABEL l=nullptr)
Knob *	DD::Image::CancelExecution_knob (Knob_Callback f, NAME n, LABEL l=nullptr)
Knob *	DD::Image::Menu_knob (Knob_Callback f, const char *menuName, NAME name, LABEL label=nullptr)
Knob *	DD::Image::Python_knob (Knob_Callback f, NAME command, NAME n, LABEL l=nullptr)
Knob *	DD::Image::Pulldown_knob (Knob_Callback f, ENUM_LABELS e, NAME n, LABEL l=nullptr)
Knob *	DD::Image::PyPulldown_knob (Knob_Callback f, ENUM_LABELS e, NAME n, LABEL l=nullptr)
Knob *	DD::Image::Multiline_String_knob (Knob_Callback f, const char **p, NAME n, LABEL l=nullptr, int lines=5)
Knob *	DD::Image::RangeStuff (Knob_Callback f, Knob *knob, const IRange &r)
Knob *	DD::Image::Int_knob (Knob_Callback f, int *p, const IRange &r, NAME n, LABEL l=nullptr)
Knob *	DD::Image::Double_knob (Knob_Callback f, double *p, NAME n, LABEL l=nullptr)
Knob *	DD::Image::Double_knob (Knob_Callback f, double *p, const IRange &r, NAME n, LABEL l=nullptr)
Knob *	DD::Image::Float_knob (Knob_Callback f, double *p, const IRange &r, NAME n, LABEL l=nullptr)
Knob *	DD::Image::Float_knob (Knob_Callback f, float *p, const IRange &r, NAME n, LABEL l=nullptr)
Knob *	DD::Image::ChannelMask_knob (Knob_Callback f, ChannelSet *p, NAME n, LABEL l=nullptr)
Knob *	DD::Image::Input_ChannelMask_knob (Knob_Callback f, ChannelSet *p, int input, NAME n, LABEL l=nullptr)
Knob *	DD::Image::InputOnly_ChannelMask_knob (Knob_Callback f, ChannelSet *p, int input, NAME n, LABEL l=nullptr)
Knob *	DD::Image::WH_knob (Knob_Callback f, double *p, const IRange &r, NAME n, LABEL l=nullptr)
Knob *	DD::Image::Scale_knob (Knob_Callback f, double *p, NAME n, LABEL l=nullptr)
Knob *	DD::Image::Scale_knob (Knob_Callback f, double *p, const IRange &r, NAME n, LABEL l=nullptr)
Knob *	DD::Image::Color_knob (Knob_Callback f, float *p, const IRange &r, NAME n, LABEL l=nullptr)
Knob *	DD::Image::Color_knob (Knob_Callback f, double *p, const IRange &r, NAME n, LABEL l=nullptr)
Knob *	DD::Image::AColor_knob (Knob_Callback f, float *p, const IRange &r, NAME n, LABEL l=nullptr)
Knob *	DD::Image::List_knob (Knob_Callback f, std::vector< std::vector< std::string > > *p, NAME n, LABEL l=nullptr)
Knob *	DD::Image::Table_knob (Knob_Callback f, NAME n, LABEL l=nullptr)
Knob *	DD::Image::Range_knob (Knob_Callback f, double *p, int np, int ixp, NAME n, LABEL l=nullptr, double min=0.0, double max=1.0)
Knob *	DD::Image::Tab_knob (Knob_Callback f, int level, LABEL label)
Knob *	DD::Image::Link_knob (Knob_Callback f, const char *linkto, NAME name, LABEL label=nullptr)
Knob *	DD::Image::Multiline_Eval_String_knob (Knob_Callback f, const char **p, NAME n, LABEL l=nullptr, int lines=5)
Knob *	DD::Image::Eval_String_knob (Knob_Callback f, const char **p, NAME n, LABEL l=nullptr)
Knob *	DD::Image::TextEditor_knob (Knob_Callback f, const char **p, NAME n, LABEL l=nullptr, int lines=5)
Knob *	DD::Image::Toolbox_knob (Knob_Callback f, int *p, bool expanded, ENUM_LABELS e, NAME n, LABEL l=nullptr, bool changeOnClick=false)
Knob *	DD::Image::GeoSelect_knob (DD::Image::Knob_Callback f, const char *name)
Knob *	DD::Image::ControlPointCollection_knob (Knob_Callback f, NAME n, LABEL l=nullptr)
Knob *	DD::Image::MetaKeyFrame_knob (Knob_Callback f, NAME n, LABEL l=nullptr, const DD::Image::MetaKeyFrameOptions &options=DD::Image::MetaKeyFrameOptions())
Knob *	DD::Image::TransformJack_knob (Knob_Callback f, NAME n)
Knob *	DD::Image::Ripple_knob (Knob_Callback f, NAME n, LABEL l=nullptr)
Knob *	DD::Image::Disable_knob (Knob_Callback f, bool *p, NAME n, LABEL l=nullptr)
Knob *	DD::Image::FrameExtent_knob (Knob_Callback f, DD::Image::FrameExtentProviderI *prov, NAME n, LABEL l=nullptr)
Knob *	DD::Image::Radio_knob (Knob_Callback f, int *p, ENUM_LABELS e, NAME n, LABEL l=nullptr)

Detailed Description

Knob creation functions.

Definition of callbacks for the Op::knob() method. These are wrappers around the actual callback, providing type-safe Knob calls.

Macro Definition Documentation

CustomKnob0

#define CustomKnob0	(		knobclass,
			cb,
			name
	)

Use this macro in Op::knobs to create your own class of knob. Your class must have a constructor that takes (&cb, name) as arguemnts, and the store() function will not be called.

CustomKnob1

#define CustomKnob1	(		knobclass,
			cb,
			pointer,
			name
	)

Use this macro in Op::knobs to create your own class of knob. A constructor for your class must take (&cb, pointer, name) as arguments, and store(pointer,...) will be called if pointer is not zero.

CustomKnob2

#define CustomKnob2	(		knobclass,
			cb,
			pointer,
			name,
			label
	)

Use this macro in Op::knobs to create your own class of knob. A constructor for your class must take (&cb, pointer, name, label) as arguments (note label can be an arbitrary type), and store(pointer,...) will be called if pointer is not zero.

CustomKnobA

#define CustomKnobA	(		knobclass,
			cb,
			pointer,
			name,
			args
	)

Use this macro in Op::knobs to create your own class of knob. The args is a parenthesized set of arguments to pass to the constructor, and store(pointer...) will be called if pointer is not zero. This is not type safe as nothing makes sure the type in pointer is correct because it is not passed to the constructor.