DD::Image::FileHandler Class Reference

#include <FileOp.h>

Inheritance diagram for DD::Image::FileHandler:

Public Member Functions
virtual void	knobs (Knob_Callback cb)
virtual int	knob_changed (Knob *k)
virtual int	knob_change_finished (Knob *k, bool changeByUser)
virtual void	extraKnobs (Knob_Callback cb)
virtual void	initDynamicKnobs ()
virtual const char *	help ()

Detailed Description

This is a file format handler interface. Writers implement this directly, but because of the way Readers work (multi-readers per Node), if they want this they have to make a new class.

Subclasses should implement knobs() just as an Op(Node) would.

FileHandler is different from FileOp since there needs to be a FileOp instance per file, whereas the single FileHandler knob interface applies for the entire file sequence.

Member Function Documentation

knobs()

virtual void DD::Image::FileHandler::knobs ( Knob_Callback  cb )

inlinevirtual

Reimplemented in DD::Image::GeoWriter, and DD::Image::Writer.

knob_changed()

virtual int DD::Image::FileHandler::knob_changed ( Knob *  k )

inlinevirtual

Reimplemented in DD::Image::GeoWriter.

extraKnobs()

virtual void DD::Image::FileHandler::extraKnobs ( Knob_Callback  cb )

inlinevirtual

Extra knobs can be used to define knobs that get added after all other knobs. This can be used, for example, if you want format-specific tab knobs.

Referenced by DD::Image::FileOp::filehandler_extra_knobs().

initDynamicKnobs()

virtual void DD::Image::FileHandler::initDynamicKnobs ( )

inlinevirtual

Reevaluate dynamic knobs, those which react to loaded settings. This might include setting default values based on file parameters.

Referenced by DD::Image::FileOp::filehandler_extra_knobs(), DD::Image::FileOp::filehandler_knobs(), and DD::Image::Read::make_format().

help()

virtual const char * DD::Image::FileHandler::help ( )

inlinevirtual

Get a description of the file format