DD::Image::WriteGeo Class Reference

Inherits DD::Image::GeoOp, DD::Image::FileOp, and DD::Image::Executable.

Public Member Functions

 WriteGeo (Node *node)
 ~WriteGeo ()
Executableexecutable ()
virtual bool isWrite () const
virtual void beginExecuting ()
virtual void endExecuting ()
virtual ExecMode execViewMode ()
virtual ExecMode execFrameMode ()
const std::set< int > & views ()
virtual int split_input (int i) const
void execute ()
virtual FileHandler * handler () const
const char * filename () const
const char * getFilename () const
const char * fname () const
void filename (const char *f)
virtual const char * file_type () const
bool set_file_type (const char *)
bool set_file_type_from_filename (Knob *knob=nullptr)
void internalError (const char *fmt,...)
void filetype_knobs (Knob_Callback f)
void knobs (Knob_Callback)
int knob_changed (Knob *)
const char * Class () const
const char * node_help () const
- Public Member Functions inherited from DD::Image::GeoOp
virtual ~GeoOp ()
Scenescene () const
void build_scene (Scene &scene)
void get_geometry (Scene &, GeometryList &out)
void setupScene ()
bool evaluate_transform (int obj, GeometryList &out, bool transform_normals=true)
int minimum_inputs () const override
int maximum_inputs () const override
Opdefault_input (int input) const override
bool test_input (int input, Op *op) const override
GeoOpinput (int n) const
GeoOpinput0 () const
GeoOpinput1 () const
const char * node_shape () const override
unsigned node_color () const override
void shadow_knobs (Knob_Callback f)
void knobs (Knob_Callback, bool sourcegeo, bool geoselectSaves=false)
virtual void print_info (std::ostream &o)
unsigned objects () const
unsigned vertices (int obj) const
std::vector< GeoInfo::Cache > & getCacheList ()
HandlesMode doAnyHandles (ViewerContext *) override
void build_matrix_handles (ViewerContext *ctx, const Matrix4 *localMatrix=nullptr)
void build_handles (ViewerContext *ctx) override
virtual void select_geometry (ViewerContext *, GeometryList &scene_objects)
void assign_drawlists (int obj, GeoInfo &info)
Display3DMode display3d () const
RenderMode render_mode () const
bool selectable () const
virtual bool selection3DChanged (ViewerContext *ctx)
virtual bool selection3DCleared ()
virtual bool selection3DMouseDown (ViewerContext *ctx)
virtual bool selection3DMouseUp (ViewerContext *ctx)
virtual bool selection3DMouseDrag (ViewerContext *ctx)
const Hashhash (int i) const
const GeometryMaskrebuild_mask () const
bool rebuild (const GeometryMask &m=GeometryMask(Mask_All_Geometry)) const
void set_rebuild (const GeometryMask &m)
void clear_rebuild (const GeometryMask &m)
const GeneralInfogeneralInfo () const override
GeoOpgeoOp () override
 Cast to a GeoOp. This is much cheaper and safer than using dynamic_cast.
const GeoOpgeoOp () const override
OpHints opHints () const override
 Return hints to control when and how this op will be evaluated by the top-down system.
- Public Member Functions inherited from DD::Image::Op
PrevalidateResult preValidate (ViewerContext *ctx=nullptr, PreValidateContext *=nullptr)
OprootOp () const
bool preValidateAborted (int treeStartingVersion, PrevalidateResult &result) const
const OutputSetgetOutputs () const
 return all the outputs of this node
virtual void setInputsValid (bool nowValid)
 set whether the input ops are valid (are for the right context)
bool inputsValid () const
 return whether the input ops are valid (are for the right context)
virtual bool can_clone () const
 returns whether or not an op can be cloned in the dag
bool haveHash () const
 return true if the hash() value is meaningful and globally unique
virtual std::vector< DD::Image::OutputContextgetPrevVersionsWanted () const
virtual const MetaData::Bundle_fetchMetaData (const char *keyname)
const MetaData::BundlefetchMetaData (const char *keyname)
Node * node () const
DD::Image::NodeI * getNode () const
void node (Node *v)
OpfirstOp () const
void firstOp (Op *v)
Opparent () const
void parent (Op *lpOp)
virtual void detach ()
 node has been deleted in DAG
virtual void attach ()
 node has been created in DAG
virtual void pre_write_knobs ()
int replace_knobs (Knob *afterthis, int n, void(*f)(void *, Knob_Callback), void *, const char *fileExt=nullptr)
int add_knobs (void(*f)(void *, Knob_Callback), void *, Knob_Callback)
void set_unlicensed ()
Knobknob (const char *name) const
Knobknob (int) const
bool pushed () const
bool panel_visible () const
bool node_disabled () const
bool node_selected () const
unsigned node_gl_color () const
void * field (const char *name)
void * field (const char *name, int &type)
void * set_field (const char *name, const void *source, int size)
void * get_field (const char *name, void *dest, int size)
void beginHandle (HandleType command, ViewerContext *ctx, EventCallback *cb, int index, float x=0, float y=0, float z=0, ViewerContext::Cursor cursor=ViewerContext::kNoCursor)
void endHandle (ViewerContext *ctx)
virtual int knob_change_finished (Knob *knob, bool changedByUser=true)
void addTime (OpTimer::Category category, long long microsecondsCPU, long long microsecondsWall, bool isTopLevel=true)
void getPerformanceInfo (OpTimer::Category category, OpTimer::PerformanceInfo &info) const
 return the amount of CPU time taken by this op
virtual bool inputs_clockwise () const
 whether unconnected inputs on the DAG should be arranged clockwise or anticlockwise (default)
virtual std::vector< int > input_order () const
virtual int inputArrows (int nodeInputs) const
bool script_command (const char *command, bool py=true, bool eval=true) const
bool script_expand (const char *str) const
HandlesMode anyHandles (ViewerContext *ctx)
void add_draw_handle (ViewerContext *)
virtual void draw_handle (ViewerContext *)
virtual void add_input_handle (int input, ViewerContext *)
void add_op_handle (ViewerContext *ctx)
void add_knob_handle (Knob *, ViewerContext *)
virtual int getViewableModes () const
virtual int optional_input () const
int inputs () const
int node_inputs () const
Opnode_input (int, GenerateType=OUTPUT_OP) const
Opnode_input (int, GenerateType, const DD::Image::OutputContext *outputContext) const
Opinput_op (int n=0) const
virtual void inputs (int n)
Opinput (int) const
int inputNumber (int input, int offset) const
Opinput (int input, int offset) const
Opinput0 () const
 return the primary input More...
Opinput1 () const
 return the second input, if it exists More...
const std::vector< Op * > & getInputs () const
const std::vector< Op * > & getChildren () const
virtual void set_input (int i, Op *op, int input, int offset)
void set_input0 (Op *op)
void set_input (int i, Op *op)
void set_input (int i, Op &op)
void set_input (int input, int offset, Op *op)
const OutputContextoutputContext () const
virtual void setOutputContext (const OutputContext &c)
virtual void append (Hash &)
virtual float uses_input (int) const
virtual void build_splits ()
virtual const OutputContextinputContext (int n, int offset, OutputContext &) const
virtual const OutputContextinputUIContext (int n, OutputContext &) const
const Hashhash () const
virtual bool frameTransformImplemented () const
virtual bool frameTransformDownstream (const OutputContext &context, unsigned int input, float inFrame, float &outFrame) const
virtual bool frameTransformUpstream (const OutputContext &context, unsigned int input, float outFrame, float &inFrame) const
virtual DopeItemFlags::Mask getDopeItemFlags () const
virtual bool shouldHideInDopeSheet (Knob *knob) const
virtual DD::Image::KnobgetDopeItemKnob () const
virtual ViewSet viewsProduced () const
virtual ViewSet viewsWantOn (int i) const
virtual ViewSet splitForViews () const
bool requested () const
void setRequested ()
void forgetRequestShallow ()
void forget_request ()
void forget_request (std::set< Op * > &forgotten)
DD::Image::Hash curveHash () const
bool opCurrent () const
virtual const char * input_label (int, char *) const
virtual std::string input_longlabel (int) const
void node_redraw ()
void print_name (std::ostream &o) const
NodeContext nodeContext () const
std::string node_name () const
void invalidateSameHash ()
bool invalidate ()
bool invalidate (const Hash &hash)
bool update (const Box *=nullptr)
void asapUpdate ()
void asapUpdate (const Box &box, int direction=0)
void validate (bool for_real=true)
virtual void force_validate (bool for_real=true)
void update_handles () const
bool valid () const
 Returns true if it has been validated - including if there was an error. More...
bool real_valid () const
 Returns true if it has been real-validated - including if there was an error. More...
bool inErrorState () const
bool inInvalidState () const
bool opened () const
void open ()
void unopen ()
bool running () const
void running (bool v)
bool not_closed () const
void close ()
void callCloseAfter (double seconds)
void copyState (Op *input)
bool cached () const
void cached (bool b)
virtual bool inUse () const
void setKnobsToContext (const OutputContext &)
void gotoContext (const OutputContext &, bool update)
void progressFraction (double fraction, StatusFlags flags=StatusNone)
void progressFraction (int a, int b, StatusFlags flags=StatusNone)
void progressMessage (const char *fmt,...)
void progressModalMessage (const char *fmt,...)
void progressDismiss ()
int slowness () const
void slowness (int newval)
virtual bool firstEngineRendersWholeRequest () const
virtual bool updateUI (const OutputContext &context)
const Formatinput_format () const
const OutputContextuiContext () const
void error (const char *fmt,...)
void warning (const char *fmt,...)
void critical (const char *fmt,...)
void debug (const char *fmt,...)
void abort () const
 Abort all trees the op is in.
bool aborted () const
 True if one of the trees the op is in was aborted; ops should check this while processing and return quickly when true.
void cancel () const
 Cancel all trees the op is in. Make sure you also call abort() to stop processing.
bool cancelled () const
 True if one of the trees the op is in was cancelled (by user interaction)
bool addToTree (OpTree *lpTree)
 Returns true if the op was added to the tree, or false if its reference count increased.
bool removeFromTree (OpTree *lpTree)
 Returns false if the op was removed from the tree, or true if its reference count decreased.
bool isInTree (OpTree *lpTree) const
 Checks if an op is in a particular tree, for debugging purposes.
bool isInAnyTree () const
 Checks if an op is in any tree at all.
OpTreeHandlergetTreeHandler () const
 Returns the treeHandler for a given Op.
bool hasError () const
bool opOrChildHasError () const
const OpgetErroredOp () const
void setPopUpScheme (PopUpScheme lScheme)
PopUpScheme getPopUpScheme () const
bool arePopUpsEnabled ()
 Returns whether a pop-up should be enabled for the next message, modifying internal data when necessary.
OpMessageHandlergetMsgHandler ()
const OpMessageHandlergetMsgHandler () const
std::string getDebugInfo () const
 Returns a string of debug information about the op. For internal use.
std::string getDetailedDebugInfo () const
bool tryValidate (bool for_real=true)
virtual Iopiop ()
 Cast to an Iop. This is much cheaper and safer than using dynamic_cast.
virtual const Iopiop () const
virtual ParticleOpparticleOp ()
 Cast to a ParticleOp. This is much cheaper and safer than using dynamic_cast.
virtual const ParticleOpparticleOp () const
virtual DeepOnlyOpdeepOnlyOp ()
 Cast to a DeepOnlyOp. This is much cheaper and safer than using dynamic_cast.
virtual const DeepOnlyOpdeepOnlyOp () const
virtual std::string getLibraryName () const
 Return a label and version string to display library version info for the Node.
virtual VersionInfo getLibraryVersion () const
const std::string libraryDisplayName () const
virtual const char * displayName () const
virtual std::string docsPath () const
virtual bool onAction (const ViewerContext *c, const DD::Image::Flags f, void *d)
Opget (const Description *description)
- Public Member Functions inherited from DD::Image::FileOp
 FileOp ()
virtual ~FileOp ()
void Reload_Button (Knob_Callback f)
int version () const
void setVersion (int newVersion)
void internalError (const char *fmt,...)
void internalErrorV (const char *fmt, va_list args)
int replaced_knobs () const
int extra_knobs () const
Knobplacemarker () const
KnobextraPlacemarker () const
virtual void filehandler_knobs (Knob_Callback f)
virtual int filehandler_knob_changed (Knob *k)
virtual int filehandler_knob_change_finished (Knob *k, bool changeByUser)
virtual void filehandler_extra_knobs (Knob_Callback f)
virtual void replaceable_knobs (Knob_Callback f)
virtual void extra_knobs (Knob_Callback f)
void replace_knobs (const void *id, const char *fileExt)
 Change the set of knobs in response to the user changing the filename or the file type pulldown. More...
const void * replaced_knobs_id () const
void add_extra_knobs (const void *id, const char *fileExt)
const void * extra_knobs_id () const
- Public Member Functions inherited from DD::Image::Executable
 Executable (Op *op)
virtual bool isExecuteThreadSafe () const
virtual unsigned int getFrameProgress () const
virtual std::string getFrameProgressMessage () const
void setViewsToExecute (const std::set< int > &view)
void clearViewsToExecute ()
const std::set< int > & viewsToExecute ()
void frameRangeKnobs (Knob_Callback)
 provide frame range knobs and a 'limit to frame range'
virtual bool skipForContext (const OutputContext &context) const
int frameRangeKnobsChanged (DD::Image::Knob *knob)

Static Public Member Functions

static const char *const * file_types ()
- Static Public Member Functions inherited from DD::Image::GeoOp
static void transform_points (PointList *out, const PointList *in, const Matrix4 &)
static void transform_points (PointList *out, const PointList *in, int start, int end, const Matrix4 &)
static void clear_drawlist_trashbin ()
- Static Public Member Functions inherited from DD::Image::Op
static int treeVersion ()
 get the current tree version
static bool nukeBusy ()
 is nuke processing something on a parallel thread?
static Opcreate (Node *node, const char *name, Op *p_op)
static Opcreate (const char *name, Op *p_op)
static void resetTimers ()
 reset all the performance timers
static void setTimingEnabled (bool enabled)
 turn performance timing on or off
static bool isTimingEnabled ()
 return whether performance timing is on or not
static const char * script_result (bool py=false)
static void script_unlock ()
static void all_forget_request ()
static void new_request_pass ()
static double callPendingClose (double seconds)
static void clearPendingClose ()
static Operror_op ()
static const char * error_message ()
static void clearAbortAndError ()
 To be removed.
static void SetDefaultPopUpEnable (bool lEnable)
 This is used by Nuke to indicate when ops using the default pop-up scheme should show pop-ups. Not recommended for customisation.
static std::string getVersionInfoStr (const VersionInfo &versionInfo)
static const Descriptionfind_description (const char *name, const Op *op_)
static int message_f (char t, const char *,...)
static int message_vf (char t, const char *, va_list)
static void add_timeout (float t, TimeoutHandler, void *v=nullptr)
static void repeat_timeout (float t, TimeoutHandler, void *=nullptr)
static bool has_timeout (TimeoutHandler, void *=nullptr)
static void remove_timeout (TimeoutHandler, void *=nullptr)
- Static Public Member Functions inherited from DD::Image::FileOp
static const char * StripPrefix (const char *filename, std::string *prefix=nullptr)
static const char * StripSuffix (const char *filename, std::string *suffix=nullptr)
static bool GetFormatAndName (const char *fname, std::string &format, std::string &name)
static const char *const * file_types (const char *suffix, const char *altsuffix, const char **prefixBlacklist, const char **extras, const char **obsoleteIDs=nullptr)
 Return an array of names of file types known about. This is generated by searching the pluigin directories for any plugins called "*Writer.plugin_ext". The first location in the array is a blank string for 'unknown' and the array is NULL-terminated. More...
static void AddAlias (const char *from, const char *to)
static const char * LookupAlias (const char *from)

Static Public Attributes

static const Description d
- Static Public Attributes inherited from DD::Image::Op
static unsigned current_request_pass
static void(* node_redraw_cb )(const Op *)
static void(* print_name_cb )(std::ostream &, const Op *)
static void(* status_callback )(const Op *, float, float, const char *, StatusFlags)
static constexpr int kInvalidVersion
static constexpr VersionInfo kUnsetVersion

Protected Member Functions

void _validate (bool)
void _close ()
- Protected Member Functions inherited from DD::Image::GeoOp
 GeoOp (Node *)
 Base class constructor. More...
virtual void updateGeneralInfo ()
void display3d (Display3DMode v)
void selectable (bool v)
void render_mode (RenderMode v)
void backface_culling (int v)
void update_geometry_hashes ()
virtual void get_geometry_hash ()
void delete_cache ()
void synchronize_cache (GeometryList &out)
void delete_allocations (GeoInfo::Cache &cache)
virtual void geometry_engine (Scene &, GeometryList &out)
void add_draw_geometry (ViewerContext *)
- Protected Member Functions inherited from DD::Image::Op
 Op (Node *node)
 The constructor is protected so only subclasses can create the base class.
virtual void _invalidate ()
virtual void _open ()
Opcreate (Node *node, const char *name)
Opcreate (const char *name)
HandlesMode anyInputHandles (ViewerContext *)
 return if any of the inputs (recursively) wish to draw handles More...
HandlesMode anyKnobHandles (ViewerContext *)
 return if any of the knobs on this node wish to draw handles More...
void build_input_handles (ViewerContext *)
void build_knob_handles (ViewerContext *)
void disallowNoTrees ()
 Call this to tell the op that it should always have op trees for normal behaviour (for internal use)
virtual PrevalidateResult doPreValidate (ViewerContext *ctx=nullptr, PreValidateContext *=nullptr)

Additional Inherited Members

- Public Types inherited from DD::Image::Op
enum  HandlesMode { eNoHandles, eHandlesUncooked, eHandlesCooked, eHandlesMax }
enum  PrevalidateResult { eFinished, eCancelled, eAbandoned }
 This is a tribool return value. Do not extend.
enum  HandleType {
  eNone, eMouseLeftClick, eMouseRightClick, eMouseMove,
  eMouseDrag, eMouseRelease, eSelectionChanged, eSelectionChangeFinished,
  eHandleDragTranslate, eHandleDragRotate, eHandleDragScale, eHandleDragPivot,
enum  ViewableModes { eViewableMode2D, eViewableMode3D, eViewableMode3D_2DReference }
enum  GenerateType {
enum  NodeContext { eNodeGraph, eTimeline, eOpGraph }
enum  StatusFlags { StatusNone, StatusModal, StatusUseCallback }
enum  PopUpScheme {
  ePU_Never, ePU_Done, ePU_Once, ePU_Default,
 Pop-up schemes determine when pop-up messages are displayed for op errors. More...
enum  VersionComponents { eMajor, eMinor, ePoint, eRevision }
typedef std::pair< int, DD::Image::Op * > Output
 Combination of input number and pointer to Op.
typedef std::set< OutputOutputSet
 Set of all outputs from this Op.
typedef std::map< Hash, std::vector< unsigned int > > ItemSelectionList
typedef bool( EventCallback) (Op *op, EventContext eventCtx)
using VersionInfo = std::tuple< int, int, int, int >
- Public Types inherited from DD::Image::Executable
enum  ExecMode { WriteOne, WriteAny, WriteMany }
- Public Attributes inherited from DD::Image::Op
const MetaData::BundlemetaCache
Hash metaCacheHash
- Protected Attributes inherited from DD::Image::GeoOp
Hash geo_hash [Group_Last]
 Points to scene if it is turned on.
GeneralInfo info_
std::vector< GeoInfo::Cachecache_list
 Geometry cache structures.
Hash cache_hash [Group_Last]
 Cache out-of-dateness hashes.
GeometryMask rebuild_mask_
 What groups need updating.
bool cache_resursive
Hash cache_build_hash
int display3d_
 GUI display setting.
bool selectable_
 GUI selectable checkmark.
int render_mode_
 Render setting.
int backface_culling_
 Backface cull setting.
bool cast_shadow_
bool receive_shadow_
- Protected Attributes inherited from DD::Image::Op
bool _haveHash
 whether the _hash actually has been set by a call to invalidate(Hash) ever.
- Protected Attributes inherited from DD::Image::FileOp
bool _readerError
 whether or not the reader is in error (set by internalError)
std::string _readerErrorString
 the last reader error (set by internalError)
- Static Protected Attributes inherited from DD::Image::GeoOp
static Hash sInitialGeoHash
static Hash sInitialCacheHash

Detailed Description

This is a base class for a file writer.

All the work is done by the various subclasses of GeoWriter. WriteGeo just chooses what subclass to instantiate and returns the output from it, and correctly destroys and instantiates new ones as needed.

Calling Op::execute() initiates writing the file.

Constructor & Destructor Documentation

WriteGeo::~WriteGeo ( )

calls _close()

References _close().

Member Function Documentation

void WriteGeo::_close ( )

Closes file that may be left open. That should not happen, though.

Reimplemented from DD::Image::Op.

References DD::Image::GeoWriter::animation().

Referenced by ~WriteGeo().

void WriteGeo::endExecuting ( )

call finish() on the writer if it is writing an animation file.

Reimplemented from DD::Image::Executable.

References DD::Image::GeoWriter::animation(), and DD::Image::GeoWriter::finish().

Executable::ExecMode WriteGeo::execViewMode ( )

Returns WriteMany if the Writer object asks for more than one in Writer::split_input(), indicating that (most likely) more than one view is wanted. Returns WriteOne otherwise, indicating it is a waste of time to call this with different views. Nuke will detect if the filename changes when the view changes and will call this multiple times with different filenames, otherwise complain if the user asks for more than one view to execute.

Reimplemented from DD::Image::Executable.

References DD::Image::GeoWriter::split_input(), DD::Image::Executable::WriteMany, and DD::Image::Executable::WriteOne.

Executable::ExecMode WriteGeo::execFrameMode ( )

Returns WriteMany if the Writer object returns true for animation(). Returns WriteOne otherwise, indicating it is a waste of time to call this with different frames. Nuke will detect if the filename changes when the frame changes and will call this multiple times with different filenames, otherwise complain if the user asks for more than one frame to execute.

Reimplemented from DD::Image::Executable.

References DD::Image::GeoWriter::animation(), DD::Image::Executable::WriteMany, and DD::Image::Executable::WriteOne.

int WriteGeo::split_input ( int  i) const
const char * WriteGeo::file_type ( ) const

Return the type of file this will write. This is set by set_file_type() or set_file_type_from_filename() or by validate() if neither of these is done. This is actually the null-sepearted list of names from the DD::Image::Writer::Description object.

Implements DD::Image::FileOp.

Referenced by set_file_type().

bool WriteGeo::set_file_type ( const char *  name)

Set the type of file the Writer will write. The type is a string like "cin" or "jpeg". Returns true if the new type is different than the previous one. Notice that if the type changes all settings on Writer-specific knobs are lost.

If this type is not found or is zero then file_type() is set to zero. If the node is then executed it will attempt to figure out the type from the filename, and if that fails it will cause an error.

file_types() returns a list of available names. You may also be able to set other names like "sgi16" that are not in this list, these typically initialize some knobs to non-default values.

References DD::Image::GeoWriter::Description::constructor, file_type(), and DD::Image::GeoWriter::Description::find().

Referenced by set_file_type_from_filename().

bool WriteGeo::set_file_type_from_filename ( Knob knob = nullptr)

If the filename has "name:" near the start, try using that to set the file type. If that fails, try using the file extension. This is automatically done by execute() and validate() if this or set_file_type() has not been called.

References DD::Image::Op::error_message(), DD::Image::Knob::get_text(), DD::Image::plugin_error(), and set_file_type().

void WriteGeo::internalError ( const char *  fmt,

©2022 The Foundry Visionmongers, Ltd. All Rights Reserved.