|
Nuke binary plugins 16.1.1
|
|
|
Nuke binary plugins 16.1.1
|
|
AxisOp is the base class for all the 3D 'scene' objects like locators, cameras and lights. More...
#include <AxisOp.h>
Public Member Functions | |
| AxisOp (Node *node, int defaultLookAtAxis=LookAt::kAxisZPlus) | |
| const AxisOp * | axisOp () const override |
| Cast this Op to an AxisOp. This is much cheaper and safer than using dynamic_cast. | |
| AxisOp * | axisOp () override |
| AxisOp * | getAxisOpAt (const OutputContext &context) |
| Retrieve a version of this AxisOp at a specific OutputContext. | |
| bool | can_link () const override |
| const char * | node_shape () const override |
| Draw node as a circular shape. | |
| unsigned | node_color () const override |
| virtual AxisOp * | parentInputOp () const |
| Convenience that casts parent input 0 to an AxisOp. | |
| virtual int32_t | parentInput () const |
| virtual AxisOp * | constrainInputOp () const |
| Return the constrainInput() input cast to an AxisOp, if possible. | |
| virtual int32_t | constrainInput () const |
| int | minimum_inputs () const override |
| Default is 2: axis and scene(optional) | |
| int | maximum_inputs () const override |
| Default is 3: axis, constraint and scene. | |
| int | optional_input () const override |
| Optional input index. | |
| bool | test_input (int node_input, Op *op) const override |
| AxisOp and null works on 0, GeomOp or null on input 1 and AxisOp or null on input 2. | |
| Op * | default_input (int node_input) const override |
| Returns null for all inputs. Override this so Op::test_input() doesn't produce warnings. | |
| const char * | input_label (int node_input, char *) const override |
| mFnDeprecatedLegacy3DSystemInNuke14 ("isLegacyAxisOp() has been deprecated, port AxisOp sublass to AxisSceneOp.") bool isLegacyAxisOp() const | |
| void | knobs (Knob_Callback f) override |
| int | knob_changed (Knob *k) override |
| void | _validate (bool for_real) override |
| virtual bool | localParentTransformVaries () const |
| virtual bool | localTransformVaries () const |
| virtual const ndk::XformComponents & | transformComponents () const |
| virtual const fdk::Mat4d & | inputParentTransform () const |
| virtual void | setInputParentTransform (const fdk::Mat4d &) |
| virtual const fdk::Mat4d & | localParentAxisTransform () const |
| virtual void | setLocalParentAxisTransform (const fdk::Mat4d &) |
| virtual const fdk::Mat4d & | localAxisTransform () const |
| virtual void | setLocalAxisTransform (const fdk::Mat4d &) |
| const fdk::Mat4d & | parentTransform () const |
| void | setParentTransform (const fdk::Mat4d &) |
| const fdk::Mat4d & | localTransform () const |
| void | setLocalTransform (const fdk::Mat4d &) |
| const fdk::Mat4d & | worldTransform () const |
| const fdk::Mat4d & | invWorldTransform () |
| void | setWorldTransform (const fdk::Mat4d &) |
| int | display3d () const |
| int | display3d () |
| void | setDisplay3d (int mode) |
| mFnDeprecatedLegacy3DSystemInNuke14 ("isLegacyAxisOp() has been deprecated, port AxisOp sublass to AxisSceneOp.") virtual bool _isLegacyAxisOp() const | |
| mFnDeprecatedLegacy3DSystemInNuke14("worldTransformAt() deprecated on AxisOp, use the static AxisOp::GetWorldTransformAt(AxisOp) " "method instead. If implementing an override of this method implement _getWorldTransformAt().") virtual fdk | mFnDeprecatedLegacy3DSystemInNuke14 ("getAxis() deprecated on AxisOp, now implemented on AxisSceneOp::getLocalAxisKnob().") Axis_KnobI *getAxis() |
| mFnDeprecatedLegacy3DSystemInNuke14 ("enableAxisKnobs() deprecated on AxisOp, now implemented on AxisSceneOp.") void enableAxisKnobs(bool on) | |
| mFnDeprecatedLegacy3DSystemInNuke14("enableKnobs() deprecated on AxisOp, now implemented on AxisSceneOp.") void enableKnobs(const std | mFnDeprecatedLegacy3DSystemInNuke14 ("doAnyHandle() deprecated on AxisOp, implement on AxisSceneOp instead.") HandlesMode doAnyHandles(ViewerContext *) override |
| mFnDeprecatedLegacy3DSystemInNuke14 ("draw_handle() deprecated on AxisOp, implement on AxisSceneOp instead.") void build_handles(ViewerContext *) override | |
| mFnDeprecatedLegacy3DSystemInNuke14 ("draw_handle() deprecated on AxisOp, implement on AxisSceneOp instead.") void draw_handle(ViewerContext *) override | |
| bool | selectable () const |
| void | setSelectable (bool v) |
| mFnDeprecatedLegacy3DSystemInNuke14 ("editable() deprecated on AxisOp, implement on AxisSceneOp instead.") bool editable() const | |
| mFnDeprecatedLegacy3DSystemInNuke14 ("setEditable() deprecated on AxisOp, implement on AxisSceneOp instead.") void setEditable(bool v) | |
| mFnDeprecatedLegacy3DSystemInNuke14 ("Class() has been deprecated, implement on subclass plugin instead.") const char *Class() const override | |
| mFnDeprecatedLegacy3DSystemInNuke14 ("node_help() has been deprecated, implement on subclass plugin instead.") const char *node_help() const override | |
| mFnDeprecatedLegacy3DSystemInNuke14 ("selectable(bool mode) has been deprecated, use AxisSceneOp::setSelectable() instead.") void selectable(bool v) | |
| mFnDeprecatedLegacy3DSystemInNuke14 ("display3d(int mode) has been deprecated, use setDisplay3d() instead.") void display3d(int mode) | |
| mFnDeprecatedLegacy3DSystemInNuke14 ("input0() has been deprecated, use parentInput() instead.") AxisOp *input0() const | |
| mFnDeprecatedLegacy3DSystemInNuke14 ("lookAtEnabled() has been deprecated") virtual bool lookAtEnabled() const | |
| mFnDeprecatedLegacy3DSystemInNuke14 ("lookat_input() has been deprecated") Op *lookat_input() const override | |
| mFnDeprecatedLegacy3DSystemInNuke14 ("matrix(const Matrix4&) has been deprecated, use setWorldTransform() instead.") void matrix(const Matrix4 &) | |
| mFnDeprecatedLegacy3DSystemInNuke14 ("local() has been deprecated, use localTransform() instead.") const Matrix4 &local() const | |
| mFnDeprecatedLegacy3DSystemInNuke14 ("matrix() has been deprecated, use worldTransform() instead.") const Matrix4 &matrix() const | |
| mFnDeprecatedLegacy3DSystemInNuke14 ("imatrix() has been deprecated, use invWorldTransform() instead.") const Matrix4 &imatrix() | |
| mFnDeprecatedLegacy3DSystemInNuke14 ("matrixAt() has been deprecated, use worldTransformAt() instead.") virtual void matrixAt(const OutputContext & | |
 Public Member Functions inherited from DD::Image::Op | |
| PrevalidateResult | preValidate (ViewerContext *ctx=nullptr, PreValidateContext *=nullptr) |
| Op * | rootOp () const |
| bool | preValidateAborted (int treeStartingVersion, PrevalidateResult &result) const |
| const OutputSet & | getOutputs () 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 | |
| virtual bool | can_link () const |
| returns whether or not an op can be linked in the dag | |
| const Hash & | hash () const |
| 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 | editVersionHash () const |
| virtual void | setEditVersionHash (const Hash &h) |
| virtual std::vector< DD::Image::OutputContext > | getPrevVersionsWanted () const |
| virtual const MetaData::Bundle & | _fetchMetaData (const char *keyname) |
| const MetaData::Bundle & | fetchMetaData (const char *keyname) |
| Node * | node () const |
| DD::Image::NodeI * | getNode () const |
| void | node (Node *v) |
| virtual const char * | nodeClass () const |
| virtual const char * | nodeName () const |
| virtual std::string | nodeFullPath (char separator='.') const |
| Hash | nodeTopologyHash () const |
| Hash | nodeEditVersionHash () const |
| Op * | firstOp () const |
| void | firstOp (Op *v) |
| Op * | parent () 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 &opStoreContext) |
| virtual void | knobs (Knob_Callback) |
| void | knobStorePost (const OutputContext &opStoreContext, Hash &newOpHash, Hash &newOpEditVersionHash) |
| 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 () |
| Knob * | knob (const char *name) const |
| Knob * | knob (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 |
| OpGraphLocation | nodeInputConnection (int32_t nodeInput, GenerateType type=OUTPUT_OP) const |
| OpGraphLocation | nodeInputConnection (int32_t nodeInput, GenerateType type, const OutputContext *context) const |
| Op * | node_input (int, GenerateType=OUTPUT_OP) const |
| Op * | node_input (int, GenerateType, const OutputContext *context) const |
| Op * | input_op (int n=0) const |
| virtual void | inputs (int n) |
| Op * | input (int) const |
| Op * | inputAt (int input, const OutputContext &context, GenerateType type=EXECUTABLE_INPUT) const |
| int | inputNumber (int input, int offset) const |
| Op * | input (int input, int offset) const |
| Op * | input0 () const |
| return the primary input | |
| Op * | input1 () const |
| return the second input, if it exists | |
| const Input & | inputConnection (int32_t input) const |
| const Input & | inputConnection (int32_t base, int32_t offset) const |
| mFnDeprecatedInNuke17 ("getInputs() has been deprecated, use getInputOps() instead") const OpList &getInputs() const | |
| OpList | getInputOps () const |
| const InputList & | getInputConnections () const |
| const OpList & | getChildren () const |
| mFnDeprecatedInNuke17 ("set_input(int, Op*, int, int) has been deprecated, use setInput(int, Input) and implement _setInput() instead") virtual void set_input(int i | |
| 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) |
| Same as setInput(inputNumber(n, offset), op, n, offset);. | |
| void | setInput (int32_t input, const OpGraphLocation &connection) |
| Same as setInput(input, connection, input, 0). | |
| void | setInput (int32_t input, const OpGraphLocation &connection, int32_t base, int32_t offset) |
| const OutputContext & | outputContext () 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 OutputContext & | inputContext (int n, int offset, OutputContext &) const |
| virtual const OutputContext * | inputUIContext (int n, OutputContext &) const |
| virtual Op * | default_input (int) 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::Knob * | getDopeItemKnob () 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 (OpSet &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) |
| void | setRecycling (bool recycling) |
| bool | recycling () const |
| virtual bool | inUse () const |
| virtual Executable * | executable () |
| 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 Format & | input_format () const |
| const OutputContext & | uiContext () 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. | |
| OpTreeHandler * | getTreeHandler () const |
| Returns the treeHandler for a given Op. | |
| bool | hasError () const |
| bool | opOrChildHasError () const |
| const Op * | getErroredOp () 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. | |
| OpMessageHandler & | getMsgHandler () |
| const OpMessageHandler & | getMsgHandler () 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 Iop * | iop () |
| Cast to an Iop. This is much cheaper and safer than using dynamic_cast. | |
| virtual const Iop * | iop () const |
| virtual ParticleOp * | particleOp () |
| Cast to a ParticleOp. This is much cheaper and safer than using dynamic_cast. | |
| virtual const ParticleOp * | particleOp () const |
| virtual DeepOnlyOp * | deepOnlyOp () |
| Cast to a DeepOnlyOp. This is much cheaper and safer than using dynamic_cast. | |
| virtual const DeepOnlyOp * | deepOnlyOp () const |
| virtual AxisOp * | axisOp () |
| Cast to an AxisOp. This is much cheaper and safer than using dynamic_cast. | |
| virtual const AxisOp * | axisOp () const |
| virtual AxisSceneOp * | axisSceneOp () |
| Cast to an AxisSceneOp. This is much cheaper and safer than using dynamic_cast. | |
| virtual const AxisSceneOp * | axisSceneOp () const |
| virtual CameraOp * | cameraOp () |
| Cast to an CameraOp. This is much cheaper and safer than using dynamic_cast. | |
| virtual const CameraOp * | cameraOp () const |
| virtual CameraSceneOp * | cameraSceneOp () |
| Cast to an AxisSceneOp. This is much cheaper and safer than using dynamic_cast. | |
| virtual const CameraSceneOp * | cameraSceneOp () const |
| virtual LightOp * | lightOp () |
| Cast to an LightOp. This is much cheaper and safer than using dynamic_cast. | |
| virtual const LightOp * | lightOp () const |
| virtual LightSceneOp * | lightSceneOp () |
| Cast to an LightSceneOp. This is much cheaper and safer than using dynamic_cast. | |
| virtual const LightSceneOp * | lightSceneOp () const |
| virtual SceneOpI * | sceneOpI () |
| Cast to a SceneOpI, if Op has that interface. | |
| virtual const SceneOpI * | sceneOpI () const |
| virtual GeometryProviderI * | geometryProvider () |
| Cast to a GeometryProviderI, if Op has that interface. | |
| virtual const GeometryProviderI * | geometryProvider () const |
| virtual GeoOp * | geoOp () |
| Cast to a GeoOp. This is much cheaper and safer than using dynamic_cast. | |
| virtual const GeoOp * | geoOp () const |
| virtual GeomOp * | geomOp () |
| Cast to a GeomOp. This is much cheaper and safer than using dynamic_cast. | |
| virtual const GeomOp * | geomOp () 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 bool | resolveKnobAsset (Knob *knob, const std::string &assetPath, std::string &resolvedAssetPath) |
| 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) |
| Op * | get (const Description *description) |
| Public Member Functions inherited from DD::Image::LookAt | |
| LookAt (int defaultLookAxis=kAxisZPlus) | |
| virtual Op * | lookat_input () const =0 |
| The lookat input op. | |
| void | knobs (Knob_Callback f) |
| Adds the 'Look' tab and knobs for all the look at options. | |
| int | knobChanged (Op *parent, Knob *k) |
| disables the look at input is not present | |
| void | lookAt (Matrix4 &matrix) |
| performs the look at on the incoming matrix | |
| void | lookMatrixAt (const OutputContext &oc, Matrix4 &concatMatrix) |
| performs the look at on the incoming matrix for a given context | |
Static Public Member Functions | |
| static ndk::XformComponents | GetTransformComponentsAt (const AxisOp *axisOp, const OutputContext &context) |
| Calculate the transform components of axisOp at a specific OutputContext. | |
| static fdk::Mat4d | GetInputParentTransformAt (const AxisOp *axisOp, const OutputContext &context) |
| Calculate the input parent transform of axisOp at a specific OutputContext. | |
| static fdk::Mat4d | GetLocalParentAxisTransformAt (const AxisOp *axisOp, const OutputContext &context) |
| Calculate the local parent axis transform of axisOp at a specific OutputContext. | |
| static fdk::Mat4d | GetLocalAxisTransformAt (const AxisOp *axisOp, const OutputContext &context) |
| Calculate the local axis transform of axisOp at a specific OutputContext. | |
| static fdk::Mat4d | GetWorldTransformAt (const AxisOp *axisOp, const OutputContext &context) |
| Calculate the world transform of axisOp at a specific OutputContext. | |
| Static Public Member Functions inherited from DD::Image::Op | |
| static int | treeVersion () |
| static bool | nukeBusy () |
| is nuke processing something on a parallel thread? | |
| static Op * | create (Node *node, const char *name, Op *p_op) |
| static Op * | create (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 Op * | BuildOpAt (Op *baseOp, const OutputContext &context, GenerateType type=EXECUTABLE_SKIP) |
| static Op * | retrieveOp (const char *node_path, GenerateType generate_op_type, const OutputContext *generate_op_context=nullptr) |
| static Op * | retrieveOp (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 Op * | error_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 Description * | find_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) |
Public Attributes | |
| Matrix4 & | const |
| bool | _xformInversionValid |
| Is _xformParams.w2l valid? | |
| bool | selectable_ |
| GUI selectable checkmark - deprecate or translate to new system? | |
| bool | _selectable |
| Public Attributes inherited from DD::Image::Op | |
| const MetaData::Bundle * | metaCache |
| Hash | metaCacheHash |
| Op * | op |
| Op int | input |
| Op int int | offset |
Protected Member Functions | |
| mFnDeprecatedLegacy3DSystemInNuke14 ("axis_knob has been deprecated") Axis_KnobI *axis_knob | |
| virtual ndk::XformComponents | _getTransformComponentsAt (const OutputContext &context) const |
| virtual fdk::Mat4d | _getInputParentTransformAt (const OutputContext &context) const |
| virtual fdk::Mat4d | _getLocalParentAxisTransformAt (const OutputContext &context) const |
| virtual fdk::Mat4d | _getLocalAxisTransformAt (const OutputContext &context) const |
| virtual fdk::Mat4d | _getWorldTransformAt (const OutputContext &context) const |
| mFnDeprecatedLegacy3DSystemInNuke14 ("localtransform_ has been deprecated, use Mat4d AxisSceneOp::_localAxisMatrix instead.") Matrix4 localtransform_ | |
| Local 'axis' matrix that Axis_Knob fills in - deprecated. | |
| mFnDeprecatedLegacy3DSystemInNuke14 ("local_ has been deprecated, use Mat4d _xformParams.local instead.") Matrix4 local_ | |
| Local matrix after look at performed - deprecated. | |
| mFnDeprecatedLegacy3DSystemInNuke14 ("matrix_ has been deprecated, use Mat4d _xformParams.l2w instead.") Matrix4 matrix_ | |
| Object matrix - local&parent - deprecated. | |
| mFnDeprecatedLegacy3DSystemInNuke14 ("imatrix_ has been deprecated, use Mat4d _xformParams.w2l instead.") Matrix4 imatrix_ | |
| Inverse object matrix - deprecated. | |
| 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 | _setInput (int32_t input, const OpGraphLocation &connection, int32_t base, int32_t offset) |
| The subclass-specific portion of setInput(). See that method for more info. | |
| virtual void | _knobStorePrep (const OutputContext &opStoreContext) |
| The subclass-specific portion of knobStorePrep(). See that method for more info. | |
| virtual void | _knobStorePost (const OutputContext &opStoreContext, Hash &newOpHash, Hash &newOpEditVersionHash) |
| 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 () |
| Op * | create (Node *node, const char *name) |
| Op * | create (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 void | _setRecycling (bool recycling) |
| virtual PrevalidateResult | doPreValidate (ViewerContext *ctx=nullptr, PreValidateContext *=nullptr) |
| Protected Member Functions inherited from DD::Image::LookAt | |
| void | perform_lookat (Matrix4 &concatMatrix, const Matrix4 &axisMatrix) |
Protected Attributes | |
| ndk::XformParameters | _xformParams |
| Axis xform params. | |
| union { | |
| bool _xformInversionValid | |
| Is _xformParams.w2l valid? | |
| }; | |
| int | display3d_ |
| GUI display setting - deprecate or translate to new system? | |
| union { | |
| bool selectable_ | |
| GUI selectable checkmark - deprecate or translate to new system? | |
| bool _selectable | |
| }; | |
| bool | _editable |
| Can the user change the knobs? (i.e. knobs not disabled) | |
| WorldMatrixProvider * | _worldMatrixProvider |
| 'world_matrix' output knob | |
| 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 | _editVersionHash |
| Op's current edit version state, usually the combination of input Op & knob edit version states. | |
| Protected Attributes inherited from DD::Image::LookAt | |
| Matrix4 | lookat_matrix_ |
| Matrix for rotating to look at the look input. | |
| Matrix4 | my_local |
| For the Axis_Knob to store into. | |
| bool | my_transform_normals |
| int | my_lookat_axis |
| bool | my_rotate_x |
| bool | my_rotate_y |
| bool | my_rotate_z |
| bool | my_lookat_use_quat |
| double | my_lookat_strength |
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. | |
| using | InputList = std::vector< Input > |
| using | InputConnectionContext = std::pair< Input, OutputContext > |
| Combination of Op input and the OutputContext it is being referenced at. | |
| using | InputConnectionContextList = std::vector< InputConnectionContext > |
| using | Output = std::pair< int, DD::Image::Op * > |
| Combination of input number and pointer to downstream Op input is on. | |
| using | OutputSet = std::set< Output > |
| 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. | |
| 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 Types inherited from DD::Image::LookAt | |
| enum | { kAxisZPlus , kAxisZMinus , kAxisYPlus , kAxisYMinus , kAxisXPlus , kAxisXMinus } |
| Static Protected Attributes inherited from DD::Image::LookAt | |
| static const char *const | ms_lookat_axis_choices [] |
AxisOp is the base class for all the 3D 'scene' objects like locators, cameras and lights.
AxisOp contains a world transform matrix sampled at the Op's OutputContext and nothing more. This base class is intentionally kept simple and without transform Knobs or input connections to allow AxisOp subclasses to be filled in via other OutputContext sampling methods such as direct conversion from USD prims. The CameraOp and LightOp base classes have been similarily simplified for the same reason.
AxisSceneOp is the Op class that now contains all the transform Knobs and parenting/lookat input connections to other SceneOp nodes like CameraSceneOps and LightSceneOps. See those classes for more info.
|
inlineoverridevirtual |
Cast this Op to an AxisOp. This is much cheaper and safer than using dynamic_cast.
Reimplemented from DD::Image::Op.
Referenced by getAxisOpAt(), GetInputParentTransformAt(), GetLocalAxisTransformAt(), GetLocalParentAxisTransformAt(), GetTransformComponentsAt(), and GetWorldTransformAt().
|
inlineoverridevirtual |
Reimplemented from DD::Image::Op.
|
inlineoverridevirtual |
Reimplemented from DD::Image::Op.
|
overridevirtual |
Draw node as a circular shape.
Reimplemented from DD::Image::Op.
|
overridevirtual |
Reimplemented from DD::Image::Op.
Reimplemented in DD::Image::LightOp.
|
virtual |
Return the node input to use for the parent axis source, or -1 if no parent input. Default returns input 0.
Reimplemented in DD::Image::AxisSceneOp, DD::Image::CameraSceneOp, and DD::Image::LightSceneOp.
Referenced by DD::Image::SceneOpI::_getSceneOpInputParentTransformAt(), and parentInputOp().
|
virtual |
Return the node input to use for the constrain source, or -1 if no constrain input. Default returns -1, no constraint input. See AxisSceneOp for the subclass version that supports input connections.
Reimplemented in DD::Image::AxisSceneOp, DD::Image::CameraSceneOp, and DD::Image::LightSceneOp.
Referenced by constrainInputOp().
|
overridevirtual |
Default is 2: axis and scene(optional)
Reimplemented from DD::Image::Op.
Reimplemented in DD::Image::AxisSceneOp, DD::Image::CameraSceneOp, and DD::Image::LightSceneOp.
|
overridevirtual |
Default is 3: axis, constraint and scene.
Reimplemented from DD::Image::Op.
Reimplemented in DD::Image::AxisSceneOp, DD::Image::CameraSceneOp, and DD::Image::LightSceneOp.
|
overridevirtual |
Optional input index.
Reimplemented from DD::Image::Op.
Reimplemented in DD::Image::AxisSceneOp, DD::Image::CameraSceneOp, and DD::Image::LightSceneOp.
References DD::Image::Op::optional_input().
|
overridevirtual |
AxisOp and null works on 0, GeomOp or null on input 1 and AxisOp or null on input 2.
Reimplemented from DD::Image::Op.
Reimplemented in DD::Image::AxisSceneOp, DD::Image::CameraSceneOp, and DD::Image::LightSceneOp.
|
overridevirtual |
Returns null for all inputs. Override this so Op::test_input() doesn't produce warnings.
Reimplemented from DD::Image::Op.
Reimplemented in DD::Image::AxisSceneOp, DD::Image::CameraSceneOp, and DD::Image::LightSceneOp.
|
overridevirtual |
Reimplemented from DD::Image::Op.
| DD::Image::AxisOp::mFnDeprecatedLegacy3DSystemInNuke14 | ( | "isLegacyAxisOp() has been | deprecated, |
| port AxisOp sublass to AxisSceneOp." | |||
| ) | const |
*** Nuke14 only *** virtual method is used to indicate that the AxisOp subclass is a legacy one or not.
The new GeomOp-based AxisOp plugins return false, changing the behavior of the AxisOp base class methods like knobs(), _validate(), test_input(), minimum_inputs(), maximum_inputs(), etc so old plugins building against AxisOp get the same behavior.
Existing AxisOp subclass plugins like 'Axis2', 'Axis3', 'Camera2', 'Camera3', 'Light2', 'Light3', etc will retain their current behaviors through Nuke17, but those plugins will be removed in Nuke18, and existing scripts using them will no longer work.
|
overridevirtual |
Reimplemented from DD::Image::Op.
Reimplemented in DD::Image::CameraOp, DD::Image::CameraSceneOp, DD::Image::LightOp, and DD::Image::LightSceneOp.
|
overridevirtual |
Reimplemented from DD::Image::Op.
|
overridevirtual |
Validate the parent axis first, if any, then concatenate the local transform with that. If the resulting matrix has changed, update the inversion flag.
Reimplemented from DD::Image::Op.
Reimplemented in DD::Image::ComplexLightOp.
References DD::Image::Op::_validate(), _xformInversionValid, _xformParams, localAxisTransform(), localTransform(), DD::Image::LookAt::lookAt(), DD::Image::LookAt::lookat_input(), DD::Image::Op::nodeName(), DD::Image::Op::parent(), parentInputOp(), and DD::Image::Op::validate().
|
inlinevirtual |
Does the local parent transform animate? This is only an indicator that the transform -MAY- vary in time, not that its value actually does. A subclass can determine this from any of its knobs animation state and any input Ops which may affect the local parent transform. Default implementation returns false.
Reimplemented in DD::Image::AxisSceneOp, DD::Image::CameraSceneOp, and DD::Image::LightSceneOp.
|
inlinevirtual |
Does the local transform animate? This is only an indicator that the transform -MAY- vary in time, not that its value actually does. A subclass can determine this from any of its knobs animation state and any input Ops which may affect the local transform. Default implementation returns false.
Reimplemented in DD::Image::AxisSceneOp, DD::Image::CameraSceneOp, and DD::Image::LightSceneOp.
|
virtual |
Transform components. Default implementation returns an empty XformComponents struct.
|
virtual |
Input parent transform, if any, otherwise the identity. Default implementation returns an identity matrix.
|
virtual |
Set the input parent transform matrix. Note that depending on the subclass implementation this may only persists until the next knobs()/validate() pass. Default implementation does nothing.
|
virtual |
Local parent axis transform, if any, otherwise the identity. Default implementation returns an identity matrix.
Reimplemented in DD::Image::AxisSceneOp, DD::Image::CameraSceneOp, and DD::Image::LightSceneOp.
|
virtual |
Set the local parent axis transform matrix. Note that depending on the subclass implementation this may only persists until the next knobs()/validate() pass. Default implementation does nothing.
Reimplemented in DD::Image::AxisSceneOp, DD::Image::CameraSceneOp, and DD::Image::LightSceneOp.
|
virtual |
Local 'axis' transform, if any, otherwise the identity. Typically this is the TRS Axis_Knob results separate from additional constraints or stereo offsets. Default implementation returns an identity matrix.
Reimplemented in DD::Image::AxisSceneOp, DD::Image::CameraSceneOp, and DD::Image::LightSceneOp.
Referenced by _validate().
|
virtual |
Set the local axis transform matrix. Note that depending on the subclass implementation this may only persists until the next knobs()/validate() pass. Default implementation does nothing.
Reimplemented in DD::Image::AxisSceneOp, DD::Image::CameraSceneOp, and DD::Image::LightSceneOp.
References _xformInversionValid.
|
inline |
Parent transform, if any, otherwise the identity. Should include localParentAxisTransform() and any constraint transform applied.
| void AxisOp::setParentTransform | ( | const fdk::Mat4d & | ) |
Set the parent transform matrix. Note that depending on the subclass implementation this may only persists until the next knobs()/validate() pass.
References _xformInversionValid, and _xformParams.
|
inline |
Local object transform, if any, otherwise the identity. Should include localAxisTransform() and any constraint, stereo or any other local transform applied.
Referenced by _validate().
| void AxisOp::setLocalTransform | ( | const fdk::Mat4d & | ) |
Set the local transform matrix. Note that depending on the subclass implementation this may only persists until the next knobs()/validate() pass.
References _xformInversionValid, and _xformParams.
|
inline |
World transform containing the concatenated parent and local transforms. Calculated in _validate() and overridable via setWorldTransform().
Referenced by DD::Image::SceneOpI::_validateTransforms().
| const Mat4d & AxisOp::invWorldTransform | ( | ) |
Return the inverse world transform. If worldTransform has been marked invalid the inverse world transform will be calculated and updated now.
References _xformInversionValid, and _xformParams.
| void AxisOp::setWorldTransform | ( | const fdk::Mat4d & | ) |
Replace the output matrix derived in _validate(), also invalidating the inverse world transform. Note this only persists until the next validate() pass overwrites the derived matrices.
References _xformInversionValid, and _xformParams.
|
protectedvirtual |
Calculate the transform components of this node at a specific OutputContext. Subclass implementation of GetTransformComponentsAt(AxisOp). Base class does nothing and returns an empty XformComponents struct.
Reimplemented in DD::Image::AxisSceneOp, DD::Image::CameraSceneOp, and DD::Image::LightSceneOp.
Referenced by GetTransformComponentsAt().
|
protectedvirtual |
Calculate the input parent transform of this node at a specific OutputContext. Subclass implementation of GetInputParentTransformAt(AxisOp). Base class does nothing and returns inputParentTransform().
Reimplemented in DD::Image::AxisSceneOp, DD::Image::CameraSceneOp, and DD::Image::LightSceneOp.
Referenced by GetInputParentTransformAt().
|
protectedvirtual |
Calculate the local parent transform of this node at a specific OutputContext. Subclass implementation of GetLocalParentAxisTransformAt(AxisOp). Base class does nothing and returns localParentAxisTransform().
Reimplemented in DD::Image::AxisSceneOp, DD::Image::CameraSceneOp, and DD::Image::LightSceneOp.
Referenced by GetLocalParentAxisTransformAt().
|
protectedvirtual |
Calculate the local axis transform of this node at a specific OutputContext. Subclass implementation of GetLocalAxisTransformAt(AxisOp). Base class does nothing and returns localAxisTransform().
Reimplemented in DD::Image::AxisSceneOp, DD::Image::CameraSceneOp, and DD::Image::LightSceneOp.
Referenced by GetLocalAxisTransformAt().
|
protectedvirtual |
Calculate the world transform of this node at a specific OutputContext. Subclass implementation of GetWorldTransformAt(AxisOp). Base class does nothing and returns worldTransform().
Reimplemented in DD::Image::AxisSceneOp, DD::Image::CameraSceneOp, and DD::Image::LightSceneOp.
Referenced by GetWorldTransformAt().
| ©2026 The Foundry Visionmongers, Ltd. All Rights Reserved. |