Nuke binary plugins 15.1.4
 
Loading...
Searching...
No Matches
DD::Image::PlanarIop Class Referenceabstract

#include <PlanarIop.h>

Inheritance diagram for DD::Image::PlanarIop:
DD::Image::Iop DD::Image::PlanarI DD::Image::Op DD::Image::IopInfoOwner DD::Image::Read DD::Image::TimelineRead

Classes

class  AutoMemoryFreeDisabler
 Used to allow/prevent Nuke from freeing the internal planar cache. More...
 

Public Member Functions

 PlanarIop (Node *node)
 
virtual void getRequests (const Box &box, const ChannelSet &channels, int count, RequestOutput &reqData) const
 
virtual void renderStripe (ImagePlane &plane)=0
 
PlanarIgetPlanarI () override
 
virtual bool useStripes () const
 This should be overridden by subclasses if they want striping.
 
virtual size_t stripeHeight () const
 This should be overridden by subclasses to return the desired stripe height.
 
PackedPreference packedPreference () const override
 
virtual bool renderFullPlanes () const
 Whether this PlanarIop needs to render in full planes.
 
Box expandToFullTiles (const Box &box) const
 This expands the bounding box so as to cover the full extent of all overlapping tiles.
 
ChannelSet expandChannelsToFullPlanes (const ChannelSet &channelSet)
 
PlanarI::PlaneSet expandToFullPlanes (ChannelSet channelSet)
 
LocalPlaneCache * getCache () override
 Return the planar cache for this iop.
 
- Public Member Functions inherited from DD::Image::Iop
void fetchPlane (ImagePlane &imagePlane)
 
virtual PlanarIgetPlanarI ()
 
void force_validate (bool for_real=true) override
 
IopImpl * pImpl ()
 
virtual void engine (int y, int x, int r, ChannelMask, Row &)=0
 
Iopiop () override
 Cast to an Iop. This is much cheaper and safer than using dynamic_cast.
 
const Iopiop () const override
 
 ~Iop () override
 
virtual bool isBlackIop () const
 
bool test_input (int, Op *) const override
 
Opdefault_input (int) const override
 
Iopinput (int n) const
 
Iopinput (int n, int m) const
 
Iopinput0 () const
 
Iopinput1 () const
 
Cache * cache () const
 
bool cached () const
 
void cached (bool b)
 
virtual void in_channels (int, ChannelSet &) const
 
ChannelMask out_channels () const
 
int raw_channels_from () const
 
virtual bool pass_transform () const
 
void request (int x, int y, int r, int t, ChannelMask channels, int count)
 
void request (DD::Image::Box box, ChannelMask channels, int count)
 
void request (ChannelMask channels, int count)
 
void _copyState (Iop *input)
 
const BoxrequestedBox () const
 
const BoxunclampedRequestedBox () const
 
ChannelMask requested_channels () const
 
ChannelMask multi_requested_channels () const
 
ChannelMask unclamped_requested_channels () const
 
int requested_count () const
 
virtual void get (int y, int x, int r, ChannelMask, Row &)
 
void at (int x, int y, Pixel &out)
 
float at (int x, int y, Channel)
 
ChannelSet peek (int x, int y, int r, int t, Pixel &out)
 
bool peek (int x, int y, int w, int h, ChannelMask pixelChannels, PixelCallbackI &callback)
 
virtual TransformgetTransform ()
 
TextureImageInfo getTextureImageInfo (int maxWidth, int maxHeight, bool extractBbox=true, bool keepImageAspect=false) const
 
TextureImageInfo::UVTransform getTextureTransform () const
 
virtual bool set_texturemap (ViewerContext *, bool gl=true)
 
virtual TextureImage get_texturemap (ViewerContext *ctx)
 
virtual void unset_texturemap (ViewerContext *)
 
virtual bool shade_GL (ViewerContext *, GeoInfo &)
 
virtual void vertex_shader (VertexContext &)
 
virtual void fragment_shader (const VertexContext &, Pixel &out)
 
virtual void displacement_shader (const VertexContext &vtx, VArray &out)
 
virtual float displacement_bound () const
 
virtual void blending_shader (const Pixel &in, Pixel &out)
 
virtual void render_state (GeoInfoRenderState &state)
 
virtual void sample (float cx, float cy, float w, float h, Filter *, Pixel &out)
 
void sample (float cx, float cy, float w, float h, Pixel &out)
 
virtual void sample (const Vector2 &center, const Vector2 &dU, const Vector2 &dV, Filter *filter, Pixel &out)
 
void sample (const Vector2 &center, const Vector2 &dU, const Vector2 &dV, Pixel &out)
 
virtual float sample_shadowmap (Iop *map, bool map_is_one_over_z, float cx, float cy, float W, float H, Filter *filter, float Pz)
 
void build_handles (ViewerContext *) override
 
virtual void inputsAttached ()
 
virtual void gpuEngine_useTextureTransform (bool useTransform)
 GPU support code.
 
virtual void gpuEngine_setupTextureTransform (const Matrix4 &postOpTransform)
 
virtual const char * gpuEngine_decl () const
 
virtual const char * gpuEngine_body () const
 
virtual Hash gpuEngine_shader_hash_at (double time)
 
virtual int gpuEngine_getNumRequiredTexUnits () const
 
virtual void gpuEngine_GL_begin (GPUContext *context)
 
virtual void gpuEngine_GL_end (GPUContext *context)
 
virtual IopviewerPassThrough () const
 
OpHints opHints () const override
 Return hints to control when and how this op will be evaluated by the top-down system.
 
virtual void setExtendedOpProperties (std::shared_ptr< ExtendedOpProperties > extendedOpProperties)
 Sets the pointer to object implementing extended properties.
 
virtual std::shared_ptr< ExtendedOpPropertiesgetExtendedOpProperties () const
 Returns the pointer to object implementing extended properties.
 
- 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
 
bool varyingOutputHash () const
 
void setVaryingOutputHash (bool varyingHashes)
 Set the varyingOutputHash indicator to a specific state.
 
void enableVaryingOutputHash ()
 Enable the varyingOutputHash indicator.
 
virtual Hash editState () const
 
virtual void setEditState (const Hash &h)
 
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)
 
const char * nodeName () const
 Return NodeI::name() which is the Node's local name with no parent path.
 
std::string nodeFullPath (char separator='.') const
 
Hash nodeTopologyHash () const
 
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 ()
 
void knobStorePrep (const OutputContext &storeContext)
 
virtual void knobs (Knob_Callback)
 
void knobStorePost (const OutputContext &storeContext, Hash &hash)
 
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_changed (Knob *)
 
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)
 
virtual void build_handles (ViewerContext *)
 
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
 
virtual int minimum_inputs () const
 
virtual int maximum_inputs () const
 
virtual bool test_input (int, Op *) 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
 
Opinput1 () const
 return the second input, if it exists
 
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 int split_input (int) const
 
virtual const OutputContextinputContext (int n, int offset, OutputContext &) const
 
virtual const OutputContextinputUIContext (int n, OutputContext &) const
 
virtual Opdefault_input (int) 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)
 
virtual const char * node_shape () const
 
DD::Image::Hash curveHash () const
 
bool opCurrent () const
 
virtual unsigned node_color () const
 
virtual const char * node_help () const =0
 
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
 Returns the same string as printed by print_name(ostream).
 
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.
 
bool real_valid () const
 Returns true if it has been real-validated - including if there was an error.
 
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
 
virtual Executableexecutable ()
 
void setKnobsToContext (const OutputContext &, bool force=false)
 
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 GeoOpgeoOp ()
 Cast to a GeoOp. This is much cheaper and safer than using dynamic_cast.
 
virtual const GeoOpgeoOp () const
 
virtual GeomOpgeomOp ()
 Cast to a GeomOp. This is much cheaper and safer than using dynamic_cast.
 
virtual const GeomOpgeomOp () 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 AxisOpaxisOp ()
 Cast to an AxisOp. This is much cheaper and safer than using dynamic_cast.
 
virtual const AxisOpaxisOp () const
 
virtual CameraOpcameraOp ()
 Cast to an CameraOp. This is much cheaper and safer than using dynamic_cast.
 
virtual const CameraOpcameraOp () const
 
virtual LightOplightOp ()
 Cast to an LightOp. This is much cheaper and safer than using dynamic_cast.
 
virtual const LightOplightOp () const
 
virtual std::string getLibraryName () const
 Return a label and version string to display library version info for the Node.
 
virtual VersionInfo getLibraryVersion () const
 
virtual OpHints opHints () const
 Return hints to control when and how this op will be evaluated by the top-down system.
 
virtual std::string resolveKnobAsset (Knob *knob, const std::string &assetPath)
 
virtual bool updateKnobsFromAsset (Knob *knob)
 
virtual void _updateKnobsFromAsset (Knob *assetKnob, const ndk::asset::AssetData &assetData)
 
virtual const char * Class () const =0
 
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::IopInfoOwner
const Infoinfo () const
 
int x () const
 
int y () const
 
int r () const
 
int t () const
 
int w () const
 
int h () const
 
bool is_constant () const
 
int clampx (int x) const
 
int clampy (int y) const
 
const Formatformat () const
 
const Formatfull_size_format () const
 
int ydirection () const
 
bool black_outside () const
 
ChannelMask channels () const
 
const GeneralInfogeneralInfo () const override
 
const Info2Dinfo2D () const override
 
int first_frame () const
 
int last_frame () const
 
void format (const Format &f)
 
void full_size_format (const Format &f)
 
- Public Member Functions inherited from DD::Image::PlanarI
virtual PackedPreference packedPreference () const =0
 
virtual size_t getStripeCount () const =0
 
virtual Box getStripeBox (int idx) const =0
 
virtual size_t rowToStripeIndex (int y) const =0
 
Box getOutputBox () const
 
PlaneID getRequestedPlaneFromChannel (Channel channel)
 
PlaneSet getAllPlanes (const ChannelSet &channels)
 
ChannelSet getAllChannels (const ChannelSet &channels)
 
virtual LocalPlaneCache * getCache ()
 
virtual bool stripesCanBeRenderedInParallel ()
 
virtual PlaneID getPlaneFromChannel (Channel chan)
 

Static Public Member Functions

static void EnablePlaneInterests ()
 
static void DisablePlaneInterests ()
 
- Static Public Member Functions inherited from DD::Image::Iop
static Iopdefault_input (const OutputContext &)
 
static Opdefault_input (const Op *op)
 
static Channel channel (const char *name)
 
static const char * channel_name (Channel c)
 
- Static Public Member Functions inherited from DD::Image::Op
static int treeVersion ()
 
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 OpretrieveOp (const char *node_path, GenerateType generate_op_type, const OutputContext *generate_op_context=nullptr)
 
static OpretrieveOp (const char *node_path, const Hash &op_hash, int tree_version)
 
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)
 Helper function to convert a VersionInfo tuple into a string.
 
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)
 

Protected Member Functions

void _open () override
 Protected implementation of this Iop function. Will initialise the planar cache as necessary.
 
void engine (int y, int x, int r, ChannelMask channels, Row &row) override
 Protected implementation of engine(). Should not be overriden further (but some plugins do).
 
void getRowFromPlanes (int y, int x, int r, const DD::Image::ChannelSet &channels, DD::Image::Row &row)
 Helper function used by engine() to lock the planar cache and call through renderStripe().
 
void _request (int x, int y, int r, int t, ChannelMask chans, int count) override
 This should not be overriden by subclasses (but some plugins do, notoriously Read).
 
void doFetchPlane (ImagePlane &plane) override
 
virtual ImagePlane renderStripe (size_t stripe, const ChannelSet &planeID)
 Render the given stripe and planeID and return the ImagePlane.
 
size_t getStripeCount () const override
 Implementation of this function based on useStripes() and stripeHeight().
 
Box getStripeBox (int idx) const override
 Implementation of these functions based on useStripes() and stripeHeight().
 
size_t rowToStripeIndex (int y) const override
 
ChannelSet getRawChannels (const ChannelSet &channels) const
 Determines the set of channels to pass through.
 
PlaneID getPlaneIDToRender (const ChannelSet &channels)
 Get all the planes that we need to go through to render the given channels.
 
PlaneSet getPlaneIDsToRender (const ChannelSet &channels)
 
- Protected Member Functions inherited from DD::Image::Iop
 Iop (Node *node)
 
void _invalidate () override
 
void _validate (bool for_real) override
 
virtual void _request (int x, int y, int r, int t, ChannelMask, int count)
 
void _open () override
 
void _close () override
 
virtual void doFetchPlane (ImagePlane &imagePlane)
 
bool inUse () const override
 
void copy_info (int input)
 
void copy_info (int input, ChannelMask)
 
void copy_info ()
 
void clear_info ()
 
void merge_info (int input=0)
 
void merge_info (int input, ChannelMask)
 
void mergeFrameRange (int input)
 
void set_out_channels (ChannelMask m)
 
void set_out_channels (ChannelSetInit m)
 
void set_out_channels (Channel z)
 
void raw_channels_from (int n)
 
void set_out_channels (ChannelMask m, int n)
 
IopasIop (Op *op) const
 
TransformgetDefaultTransform () const
 
template<class TileType >
void doSample (float cx, float cy, float w, float h, Filter *, Pixel &out)
 
template<class TileType >
float do_sample_shadowmap (Iop *map, bool map_is_one_over_z, float cx, float cy, float W, float H, Filter *filter, float Pz)
 
- 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 _knobStorePrep (const OutputContext &storeContext)
 The subclass-specific portion of knobStorePrep(). See that method for more info.
 
virtual void _knobStorePost (const OutputContext &storeContext, Hash &hash)
 The subclass-specific portion of knobStorePost(). See that method for more info.
 
virtual void _invalidate ()
 
virtual void _validate (bool for_real)
 
virtual void _open ()
 
virtual void _close ()
 
Opcreate (Node *node, const char *name)
 
Opcreate (const char *name)
 
HandlesMode anyInputHandles (ViewerContext *)
 return if any of the inputs (recursively) wish to draw handles
 
HandlesMode anyKnobHandles (ViewerContext *)
 return if any of the knobs on this node wish to draw handles
 
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 HandlesMode doAnyHandles (ViewerContext *ctx)
 
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 ,
  eAllHandles
}
 
enum  ViewableModes { eViewableMode2D , eViewableMode3D , eViewableMode3D_2DReference }
 
enum  GenerateType {
  OUTPUT_OP , ANY_CONTEXT , INPUT_OP , INPUT_OP_PEEK ,
  EXECUTABLE , EXECUTABLE_SKIP , EXECUTABLE_INPUT , UICONTEXT_ONLY
}
 
enum  NodeContext { eNodeGraph , eTimeline , eOpGraph }
 
enum  StatusFlags { StatusNone , StatusModal , StatusUseCallback }
 
enum  PopUpScheme {
  ePU_Never , ePU_Done , ePU_Once , ePU_Default ,
  ePU_Always
}
 Pop-up schemes determine when pop-up messages are displayed for op errors. More...
 
enum  VersionComponents { eMajor , eMinor , ePoint , eRevision }
 Enum to help get the desired version component from the VersionInfo tuple.
 
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 >
 Contains version components with each index defined by the VersionComponents enum.
 
- Public Types inherited from DD::Image::IopInfoOwner
typedef IopInfo Info
 
- Public Types inherited from DD::Image::PlanarI
enum  PackedPreference { ePackedPreferenceNone , ePackedPreferencePacked , ePackedPreferenceUnpacked }
 
typedef ChannelSet PlaneID
 
typedef std::set< PlaneIDPlaneSet
 
- Public Attributes inherited from DD::Image::Op
const MetaData::BundlemetaCache
 
Hash metaCacheHash
 
- Static Public Attributes inherited from DD::Image::Iop
static bool sPreserveCaches
 
- 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 const int kInvalidVersion
 
static const VersionInfo kUnsetVersion
 
- Protected Attributes inherited from DD::Image::Iop
ChannelSet out_channels_
 protected so validate() can directly modify it
 
int raw_channels_from_
 
- Protected Attributes inherited from DD::Image::Op
bool _haveHash
 whether the _hash actually has been set by a call to invalidate(Hash) ever.
 
bool _varyingOutputHash
 whether the hash value will animate over time
 
Hash _editState
 Op's current edit state, usually the combination of input & knob edit states.
 
- Protected Attributes inherited from DD::Image::IopInfoOwner
Info info_
 

Detailed Description

Base class for an Iop which strongly wishes to output planar data, possibly with striping. This implements PlanarI to hint as to how the data should be accessed, and adds ImagePlaneCache (privately) to provide a cache.

Member Function Documentation

◆ getRequests()

virtual void DD::Image::PlanarIop::getRequests ( const Box box,
const ChannelSet channels,
int  count,
RequestOutput reqData 
) const
inlinevirtual

The function _request() on Iops is eventually going to be deprecated, because it is stateful.

For PlanarIops you should never override it. Instead, please implement this getRequests() function. It should place the regions to be requested to the RequestOutput passed in. This will be used for more complex render management in future.

Overrides of this function should have no side-effects other than filling in reqData.

References DD::Image::RequestOutput::request().

◆ renderStripe()

virtual void DD::Image::PlanarIop::renderStripe ( ImagePlane plane)
pure virtual

This is the actual rendering function that subclasses should implement.

The subclass is responsible for filling plane to the extent of its bbox and channels. It is guaranteed that the plane will never have more than 4 channels, and that its bounding box will be one of those that getStripeBox() returns. The ChannelSet will be a full layer, but no more than one layer. It might be packed or not depending upon the results of negotiation.

It will only be called for channels in the out_channels as set by _validate.

Implemented in DD::Image::Read.

◆ getPlanarI()

PlanarI * DD::Image::PlanarIop::getPlanarI ( )
inlineoverridevirtual

Reimplemented from DD::Image::Iop.

Reimplemented in DD::Image::Read.

◆ useStripes()

virtual bool DD::Image::PlanarIop::useStripes ( ) const
inlinevirtual

This should be overridden by subclasses if they want striping.

Reimplemented in DD::Image::Read.

Referenced by getStripeCount().

◆ stripeHeight()

virtual size_t DD::Image::PlanarIop::stripeHeight ( ) const
inlinevirtual

This should be overridden by subclasses to return the desired stripe height.

Reimplemented in DD::Image::Read.

Referenced by getStripeCount().

◆ packedPreference()

PackedPreference DD::Image::PlanarIop::packedPreference ( ) const
inlineoverridevirtual

Implements DD::Image::PlanarI.

Reimplemented in DD::Image::Read.

◆ expandChannelsToFullPlanes()

DD::Image::ChannelSet DD::Image::PlanarIop::expandChannelsToFullPlanes ( const ChannelSet channelSet)

This expands a channel set to include all channels in the planes that contain any of the channels passed in, not just those that have been requested.

◆ expandToFullPlanes()

DD::Image::PlanarI::PlaneSet DD::Image::PlanarIop::expandToFullPlanes ( ChannelSet  channelSet)

This expands a channel set to include all channels in the planes that contain any of the channels passed in, not just those that have been requested, and returns them as a plane set.

◆ getCache()

DD::Image::LocalPlaneCache * DD::Image::PlanarIop::getCache ( )
overridevirtual

Return the planar cache for this iop.

Reimplemented from DD::Image::PlanarI.

◆ EnablePlaneInterests()

void DD::Image::PlanarIop::EnablePlaneInterests ( )
static

Function to be called by Nuke before the image is rendered (e.g. in Viewer_Image and Execute) to enable plane interests so that the planar cache is not cleared while rows are reading from it.

◆ DisablePlaneInterests()

void DD::Image::PlanarIop::DisablePlaneInterests ( )
static

Function to be called by Nuke after the image is rendered to make sure that the planar cache's memory can be released (e.g. in Viewer_Image and Execute).

◆ _open()

void DD::Image::PlanarIop::_open ( )
overrideprotectedvirtual

Protected implementation of this Iop function. Will initialise the planar cache as necessary.

Reimplemented from DD::Image::Iop.

Reimplemented in DD::Image::Read.

Referenced by DD::Image::Read::_open().

◆ engine()

void DD::Image::PlanarIop::engine ( int  y,
int  x,
int  r,
ChannelMask  channels,
Row row 
)
overrideprotectedvirtual

Protected implementation of engine(). Should not be overriden further (but some plugins do).

Implements DD::Image::Iop.

Reimplemented in DD::Image::Read.

References DD::Image::Row::get().

Referenced by DD::Image::Read::engine().

◆ _request()

void DD::Image::PlanarIop::_request ( int  x,
int  y,
int  r,
int  t,
ChannelMask  chans,
int  count 
)
overrideprotectedvirtual

This should not be overriden by subclasses (but some plugins do, notoriously Read).

Reimplemented from DD::Image::Iop.

References DD::Image::RequestOutput::doRequest().

◆ doFetchPlane()

void DD::Image::PlanarIop::doFetchPlane ( ImagePlane plane)
overrideprotectedvirtual

Private implementation of this Iop function. Calls renderStripe to do actual work, which is the one that subclasses should implement.

Reimplemented from DD::Image::Iop.

Reimplemented in DD::Image::Read.

References DD::Image::ImagePlane::copyIntersectionFrom(), DD::Image::ImagePlane::fillChannel(), DD::Image::ImagePlane::makeWritable(), DD::Image::ImagePlane::readable(), DD::Image::ChannelSet::size(), DD::Image::Box::t(), and DD::Image::Box::y().

Referenced by DD::Image::Read::doFetchPlane().

◆ getStripeCount()

size_t DD::Image::PlanarIop::getStripeCount ( ) const
overrideprotectedvirtual

Implementation of this function based on useStripes() and stripeHeight().

calculate the number of stripes. if striping is used this will be the height of the bbox divided by the stripe height (rounded up)

Implements DD::Image::PlanarI.

References DD::Image::IopInfoOwner::h(), DD::Image::IopInfoOwner::info(), stripeHeight(), and useStripes().

◆ getStripeBox()

DD::Image::Box DD::Image::PlanarIop::getStripeBox ( int  idx) const
overrideprotectedvirtual

Implementation of these functions based on useStripes() and stripeHeight().

calculate the size of stripe /idx/.

the last stripe shouldn't go any higher than the top of the bbox (this is not a problem for the first stripe, as it starts at the bottom of the bbox always)

Implements DD::Image::PlanarI.

References DD::Image::Box::x().

◆ rowToStripeIndex()

size_t DD::Image::PlanarIop::rowToStripeIndex ( int  y) const
overrideprotectedvirtual

Implements DD::Image::PlanarI.



©2024 The Foundry Visionmongers, Ltd. All Rights Reserved.
www.foundry.com