Cortex  10.0.0-a4
Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
IECoreNuke::ObjectKnob Class Reference

A nuke knob capable of holding arbitrary IECore::Objects. More...

#include <ObjectKnob.h>

Inherits Knob.

Public Member Functions

bool setValue (IECore::ConstObjectPtr value)
 
IECore::ConstObjectPtr getValue () const
 

Static Public Member Functions

static ObjectKnobobjectKnob (DD::Image::Knob_Callback f, IECore::ObjectPtr *storage, const char *name, const char *label)
 

Protected Member Functions

 ObjectKnob (DD::Image::Knob_Closure *f, IECore::ObjectPtr *storage, const char *name, const char *label=0)
 
virtual const char * Class () const
 
virtual void to_script (std::ostream &os, const DD::Image::OutputContext *context, bool quote) const
 
virtual bool from_script (const char *value)
 
virtual bool not_default () const
 
virtual void store (DD::Image::StoreType storeType, void *storage, DD::Image::Hash &hash, const DD::Image::OutputContext &context)
 

Detailed Description

A nuke knob capable of holding arbitrary IECore::Objects.

Member Function Documentation

static ObjectKnob* IECoreNuke::ObjectKnob::objectKnob ( DD::Image::Knob_Callback  f,
IECore::ObjectPtr *  storage,
const char *  name,
const char *  label 
)
static

Call this from an Op::knobs() implementation to create an ObjectKnob. The value placed in storage by the knob must be treated as read only.

bool IECoreNuke::ObjectKnob::setValue ( IECore::ConstObjectPtr  value)

A copy of the value is taken. Returns true if the new value is different to the old value and false otherwise.


The documentation for this class was generated from the following file: