Nuke binary plugins 16.1.1
 
Loading...
Searching...
No Matches
DD::Image::CameraOp Class Reference

#include <CameraOp.h>

Inheritance diagram for DD::Image::CameraOp:
DD::Image::AxisOp DD::Image::Op DD::Image::LookAt DD::Image::CameraSceneOp DD::Image::LightOp DD::Image::ComplexLightOp DD::Image::LightSceneOp

Public Types

typedef void() LensFunc(Scene *, CameraOp *, MatrixArray *transforms, const VArray &v, Vector4 &out, void *data)
 
typedef void() LensNFunc(Scene *, CameraOp *, MatrixArray *transforms, VArray *vert_array, int n, void *data)
 
- 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.
 

Public Member Functions

 CameraOp (Node *node)
 
const CameraOpcameraOp () const override
 Cast to a CameraOp. This is much cheaper and safer than using dynamic_cast.
 
CameraOpcameraOp () override
 
CameraOpgetCameraOpAt (const OutputContext &context)
 Retrieve a version of this CameraOp at a specific OutputContext.
 
OpHints opHints () const override
 Return hints to control when and how this op will be evaluated by the top-down system.
 
unsigned node_color () const override
 
void _validate (bool for_real) override
 
void knobs (Knob_Callback) override
 
int knob_changed (Knob *) override
 
virtual KnobprojectionSelectorKnob () const
 
virtual ProjectionFuncprojectionPlugin () const
 The currently-assigned projection plugin.
 
ndk::LensProjection projectionMode () const override
 
bool setProjection (const char *projectionClassName)
 
void setProjectionMode (ndk::LensProjection mode)
 
virtual const char * projectionFuncClassName (Knob *selectorKnob=nullptr) const
 
bool isBaseProjectionLinear () const override
 
virtual fdk::Mat4d projectionModeMatrix (ndk::LensProjection mode) const
 
virtual fdk::Mat4d projectionModeMatrixAt (ndk::LensProjection mode, const OutputContext &context) const
 Same as projectionMatrix() except it evaluates the matrix at an arbitrary OutputContext.
 
HandlesMode doAnyHandles (ViewerContext *ctx) override
 
void build_handles (ViewerContext *) override
 
void draw_handle (ViewerContext *) override
 Draws a lovely camera, I think it is a Mitchell.
 
enum mFnDeprecatedLegacy3DSystemInNuke14 ("Enumeration deprecated, use enum class ndk::LensProjection instead.")
 
 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 ("projection_knobs() has been deprecated, use CameraSceneOp::addProjectionKnobs() instead.") virtual void projection_knobs(Knob_Callback f)
 
 mFnDeprecatedLegacy3DSystemInNuke14 ("lens_knobs() has been deprecated, use CameraSceneOp::addDistortionKnobs() instead.") virtual void lens_knobs(Knob_Callback f)
 
 mFnDeprecatedLegacy3DSystemInNuke14 ("projection() has been deprecated, use projectionMatrix() instead") const Matrix4 &projection() const
 
 mFnDeprecatedLegacy3DSystemInNuke14 ("hfov(double) has been deprecated, use setHorizontalFov() instead") void hfov(double v)
 
 mFnDeprecatedLegacy3DSystemInNuke14 ("film_width() has been deprecated, use horizontalAperture() instead") double film_width() const
 
 mFnDeprecatedLegacy3DSystemInNuke14 ("film_height() has been deprecated, use verticalAperture() instead") double film_height() const
 
 mFnDeprecatedLegacy3DSystemInNuke14 ("focal_length() has been deprecated, use focalLength() instead") double focal_length() const
 
 mFnDeprecatedLegacy3DSystemInNuke14 ("Near() has been deprecated, use nearPlaneDistance() instead") double Near() const
 
 mFnDeprecatedLegacy3DSystemInNuke14 ("Far() has been deprecated, use farPlaneDistance() instead") double Far() const
 
 mFnDeprecatedLegacy3DSystemInNuke14 ("focal_point() has been deprecated, use focusDistance() instead") double focal_point() const
 
 mFnDeprecatedLegacy3DSystemInNuke14 ("fstop() has been deprecated, use fStop() instead") double fstop() const
 
 mFnDeprecatedLegacy3DSystemInNuke14 ("film_width(double) has been deprecated, use setHorizontalAperture() instead") void film_width(double v)
 
 mFnDeprecatedLegacy3DSystemInNuke14 ("film_height(double) has been deprecated, use setVerticalAperture() instead") void film_height(double v)
 
 mFnDeprecatedLegacy3DSystemInNuke14 ("focal_length(double) has been deprecated, use setFocalLength() instead") void focal_length(double v)
 
 mFnDeprecatedLegacy3DSystemInNuke14 ("Near(double) has been deprecated, use setNearPlaneDistance() instead") void Near(double v)
 
 mFnDeprecatedLegacy3DSystemInNuke14 ("Far(double) has been deprecated, use setFarPlaneDistance() instead") void Far(double v)
 
 mFnDeprecatedLegacy3DSystemInNuke14 ("focal_point(double) has been deprecated, use setFocusDistance() instead") void focal_point(double v)
 
 mFnDeprecatedLegacy3DSystemInNuke14 ("fstop(double) has been deprecated, use setfStop() instead") void fstop(double v)
 
 mFnDeprecatedLegacy3DSystemInNuke14 ("win_translate() has been deprecated, use windowTranslate() instead") const Vector2 &win_translate() const
 
 mFnDeprecatedLegacy3DSystemInNuke14 ("win_scale() has been deprecated, use windowScale() instead") const Vector2 &win_scale() const
 
 mFnDeprecatedLegacy3DSystemInNuke14 ("win_roll() has been deprecated, use windowRotateZ() instead") double win_roll() const
 
 mFnDeprecatedLegacy3DSystemInNuke14 ("projection_mode() has been deprecated, use projectionMode() instead") int projection_mode() const
 
 mFnDeprecatedLegacy3DSystemInNuke14 ("projection_mode(int) has been deprecated, use setProjectionMode() instead") void projection_mode(int i)
 
 mFnDeprecatedLegacy3DSystemInNuke14 ("projection_is_linear(int) has been deprecated, use isProjectionModeLinear(ndk::LensProjection) instead") virtual bool projection_is_linear(int mode) const
 
 mFnDeprecatedLegacy3DSystemInNuke14 ("projection(int) has been deprecated, use projectionModeMatrix(ndk::LensProjection) instead") virtual Matrix4 projection(int mode) const
 
 mFnDeprecatedLegacy3DSystemInNuke14 ("projectionAt(OutputContext) has been deprecated, use projectionModeMatrixAt(ndk::LensProjection, OutputContext) instead") virtual Matrix4 projectionAt(const OutputContext &)
 
 mFnDeprecatedLegacy3DSystemInNuke14 ("lens_distort_a() has been deprecated, use distortA() instead") double lens_distort_a() const
 
 mFnDeprecatedLegacy3DSystemInNuke14 ("lens_distort_b() has been deprecated, use distortB() instead") double lens_distort_b() const
 
 mFnDeprecatedLegacy3DSystemInNuke14 ("lens_distort_c() has been deprecated, use distortC() instead") double lens_distort_c() const
 
 mFnDeprecatedLegacy3DSystemInNuke14 ("lens_distort_D() has been deprecated") double lens_distort_D() const
 
 mFnDeprecatedLegacy3DSystemInNuke14 ("lens_distortion() has been deprecated") double lens_distortion() const
 
 mFnDeprecatedLegacy3DSystemInNuke14 ("lens_power() has been deprecated") double lens_power() const
 
 mFnDeprecatedLegacy3DSystemInNuke14 ("lens_distort_enabled() has been deprecated") bool lens_distort_enabled() const
 
 mFnDeprecatedLegacy3DSystemInNuke14 ("lens_function(int mode) has been deprecated.") virtual LensFunc *lens_function(int mode) const
 
 mFnDeprecatedLegacy3DSystemInNuke14 ("lensNfunction(int mode) has been deprecated.") virtual LensNFunc *lensNfunction(int mode) const
 
 mFnDeprecatedLegacy3DSystemInNuke14 ("to_format has been deprecated, use ToFormat instead.") static void to_format(Matrix4 &
 
const FormatmFnDeprecatedLegacy3DSystemInNuke14 ("from_format has been deprecated, use FromFormat instead.") static void from_format(Matrix4 &
 
const Format const FormatmFnDeprecatedLegacy3DSystemInNuke14 ("toTormat has been deprecated, use ToFormat instead.") static void toFormat(fdk
 
 mFnDeprecatedLegacy3DSystemInNuke14 ("fromFormat has been deprecated, use FromFormat instead.") static void fromFormat(fdk
 
- Public Member Functions inherited from DD::Image::AxisOp
 AxisOp (Node *node, int defaultLookAtAxis=LookAt::kAxisZPlus)
 
const AxisOpaxisOp () const override
 Cast this Op to an AxisOp. This is much cheaper and safer than using dynamic_cast.
 
AxisOpaxisOp () override
 
AxisOpgetAxisOpAt (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 AxisOpparentInputOp () const
 Convenience that casts parent input 0 to an AxisOp.
 
virtual int32_t parentInput () const
 
virtual AxisOpconstrainInputOp () 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.
 
Opdefault_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)
 
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
 
virtual bool can_link () const
 returns whether or not an op can be linked in the dag
 
const Hashhash () 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::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)
 
virtual const char * nodeClass () const
 
virtual const char * nodeName () const
 
virtual std::string nodeFullPath (char separator='.') const
 
Hash nodeTopologyHash () const
 
Hash nodeEditVersionHash () 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 &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 ()
 
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
 
OpGraphLocation nodeInputConnection (int32_t nodeInput, GenerateType type=OUTPUT_OP) const
 
OpGraphLocation nodeInputConnection (int32_t nodeInput, GenerateType type, const OutputContext *context) const
 
Opnode_input (int, GenerateType=OUTPUT_OP) const
 
Opnode_input (int, GenerateType, const OutputContext *context) const
 
Opinput_op (int n=0) const
 
virtual void inputs (int n)
 
Opinput (int) const
 
OpinputAt (int input, const OutputContext &context, GenerateType type=EXECUTABLE_INPUT) 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 InputinputConnection (int32_t input) const
 
const InputinputConnection (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 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
 
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 (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 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 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 AxisSceneOpaxisSceneOp ()
 Cast to an AxisSceneOp. This is much cheaper and safer than using dynamic_cast.
 
virtual const AxisSceneOpaxisSceneOp () const
 
virtual CameraOpcameraOp ()
 Cast to an CameraOp. This is much cheaper and safer than using dynamic_cast.
 
virtual const CameraOpcameraOp () const
 
virtual CameraSceneOpcameraSceneOp ()
 Cast to an AxisSceneOp. This is much cheaper and safer than using dynamic_cast.
 
virtual const CameraSceneOpcameraSceneOp () const
 
virtual LightOplightOp ()
 Cast to an LightOp. This is much cheaper and safer than using dynamic_cast.
 
virtual const LightOplightOp () const
 
virtual LightSceneOplightSceneOp ()
 Cast to an LightSceneOp. This is much cheaper and safer than using dynamic_cast.
 
virtual const LightSceneOplightSceneOp () const
 
virtual SceneOpIsceneOpI ()
 Cast to a SceneOpI, if Op has that interface.
 
virtual const SceneOpIsceneOpI () const
 
virtual GeometryProviderIgeometryProvider ()
 Cast to a GeometryProviderI, if Op has that interface.
 
virtual const GeometryProviderIgeometryProvider () 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 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)
 
Opget (const Description *description)
 
- Public Member Functions inherited from DD::Image::LookAt
 LookAt (int defaultLookAxis=kAxisZPlus)
 
virtual Oplookat_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 CameraOpdefault_camera ()
 
static void ToFormat (fdk::Mat4f &, const Format *)
 
static void FromFormat (fdk::Mat4f &, const Format *)
 
- Static Public Member Functions inherited from DD::Image::AxisOp
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 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 OpBuildOpAt (Op *baseOp, const OutputContext &context, GenerateType type=EXECUTABLE_SKIP)
 
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)
 

Static Public Attributes

static const char * projection_modes []
 
static const char * projection_modes_renderer []
 
- 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 Member Functions

 mFnDeprecatedLegacy3DSystemInNuke14 ("focal_length_ has been deprecated, use _params.optics.focalLength instead.") double focal_length_
 Deprecated, use _params.optics.focalLength instead.
 
 mFnDeprecatedLegacy3DSystemInNuke14 ("haperture_ has been deprecated, use _params.sensor.apertureSize.x instead.") double haperture_
 Deprecated, use _params.sensor.apertureSize.x instead.
 
 mFnDeprecatedLegacy3DSystemInNuke14 ("vaperture_ has been deprecated, use _params.sensor.apertureSize.y instead.") double vaperture_
 Deprecated, use _params.sensor.apertureSize.y instead.
 
 mFnDeprecatedLegacy3DSystemInNuke14 ("fstop_ has been deprecated, use _params.lensAperture.fStop instead.") double fstop_
 Deprecated, use _params.lensAperture.fStop instead.
 
 mFnDeprecatedLegacy3DSystemInNuke14 ("near_ has been deprecated, use _params.lensAperture.clipNearDistance instead.") double near_
 Deprecated, use _params.lensAperture.clipNearDistance instead.
 
 mFnDeprecatedLegacy3DSystemInNuke14 ("far_ has been deprecated, use _params.lensAperture.clipFarDistance instead.") double far_
 Deprecated, use _params.lensAperture.clipFarDistance instead.
 
 mFnDeprecatedLegacy3DSystemInNuke14 ("projection_mode_ has been deprecated, use projectionMode() instead.") int projection_mode_
 Deprecated, use MultiProjectionCamera::projectionMode() instead.
 
 mFnDeprecatedLegacy3DSystemInNuke14 ("focal_point_ has been deprecated, use _params.optics.focusDistance instead.") double focal_point_
 Deprecated, use _params.optics.focusDistance instead.
 
 mFnDeprecatedLegacy3DSystemInNuke14 ("win_translate_ has been deprecated, use _params.sensor.apertureTranslate instead.") Vector2 win_translate_
 Deprecated, use _params.sensor.apertureTranslate instead.
 
 mFnDeprecatedLegacy3DSystemInNuke14 ("win_scale_ has been deprecated, use _params.sensor.apertureScale instead.") Vector2 win_scale_
 Deprecated, use _params.sensor.apertureScale instead.
 
 mFnDeprecatedLegacy3DSystemInNuke14 ("win_roll_ has been deprecated, use _params.sensor.apertureRotate instead.") double win_roll_
 Deprecated, use _params.sensor.apertureRotate instead.
 
 mFnDeprecatedLegacy3DSystemInNuke14 ("lens_distort_a_, use _params.optics.opticalDistortionA instead.") double lens_distort_a_
 Deprecated, use, use _params.optics.opticalDistortionA instead.
 
 mFnDeprecatedLegacy3DSystemInNuke14 ("lens_distort_b_, use _params.optics.opticalDistortionB instead.") double lens_distort_b_
 Deprecated, use, use _params.optics.opticalDistortionB instead.
 
 mFnDeprecatedLegacy3DSystemInNuke14 ("lens_distort_c_, use _params.optics.opticalDistortionC instead.") double lens_distort_c_
 Deprecated, use, use _params.optics.opticalDistortionC instead.
 
 mFnDeprecatedLegacy3DSystemInNuke14 ("lens_distort_D_ has been deprecated") double lens_distort_D_
 Deprecated.
 
 mFnDeprecatedLegacy3DSystemInNuke14 ("lens_distortion_ has been deprecated") double lens_distortion_
 Deprecated.
 
 mFnDeprecatedLegacy3DSystemInNuke14 ("lens_power_ has been deprecated") double lens_power_
 Deprecated.
 
 mFnDeprecatedLegacy3DSystemInNuke14 ("lens_distort_enabled_ has been deprecated") bool lens_distort_enabled_
 
 mFnDeprecatedLegacy3DSystemInNuke14 ("use_vertical_lock_ has been deprecated") bool use_vertical_lock_
 Deprecated.
 
 mFnDeprecatedLegacy3DSystemInNuke14 ("projection_ has been deprecated, use Mat4d _projectionMatrix instead.") Matrix4 projection_
 Camera's projection matrix - deprecated.
 
void _validateCamera () override
 
bool _setProjectionFuncPlugin (const char *projectionClassName)
 Sets _newProjectionPlugin. _projectionPlugin gets updated in _validate().
 
- Protected Member Functions inherited from DD::Image::AxisOp
 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 ()
 
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 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

int32_t _projectionSelection
 Projection menu knob index.
 
ShutterControls _shutter
 Shutter controls which may be referenced by a renderer.
 
double _shutterBias
 Weights the shutter samples towards shutter close with a power function.
 
bool _glWorldSizeIcon
 Always draw the camera icon at the 'real' world size (defined by worldToLens factor)
 
bool _glSolidFrustum
 Draw the camera frustum as solid.
 
bool _glInsideFrustum
 Indicated whether to draw the frustum as an inside or outside box.
 
double _worldToMeters
 Is converted to sensor.sceneToCameraFactor.
 
ProjectionFunc_newProjectionPlugin
 New projection plugin selected, non-null if changed.
 
ProjectionFunc_projectionPlugin
 Projection func plugin to use, if applicable.
 
- Protected Attributes inherited from DD::Image::AxisOp
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 Attributes inherited from DD::Image::AxisOp
Matrix4const
 
- Public Attributes inherited from DD::Image::Op
const MetaData::BundlemetaCache
 
Hash metaCacheHash
 
Opop
 
Op int input
 
Op int int offset
 
- 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 []
 

Detailed Description

Op that defines a 3D camera.

Member Function Documentation

◆ cameraOp() [1/2]

const CameraOp * DD::Image::CameraOp::cameraOp ( ) const
inlineoverridevirtual

Cast to a CameraOp. This is much cheaper and safer than using dynamic_cast.

Reimplemented from DD::Image::Op.

Referenced by getCameraOpAt().

◆ cameraOp() [2/2]

CameraOp * DD::Image::CameraOp::cameraOp ( )
inlineoverridevirtual

Reimplemented from DD::Image::Op.

◆ default_camera()

CameraOp * CameraOp::default_camera ( )
static

Return a default camera that can be used when there is no camera attached to your renderer. This camera is at the origin, looking along -Z, with a perspective projection set to a lens ratio (focal-length / film-width) of 1.

Referenced by DD::Image::Render::_validate(), DD::Image::ViewerContext::addCamera(), DD::Image::RenderScene::build_handles(), and DD::Image::RenderScene::render_camera().

◆ opHints()

OpHints CameraOp::opHints ( ) const
overridevirtual

Return hints to control when and how this op will be evaluated by the top-down system.

Reimplemented from DD::Image::Op.

References DD::Image::eChainable.

◆ node_color()

unsigned DD::Image::CameraOp::node_color ( ) const
inlineoverridevirtual

Reimplemented from DD::Image::AxisOp.

Reimplemented in DD::Image::LightOp.

◆ _validate()

void CameraOp::_validate ( bool  for_real)
overridevirtual

Reimplemented from DD::Image::AxisOp.

Reimplemented in DD::Image::ComplexLightOp.

◆ knobs()

void CameraOp::knobs ( Knob_Callback  f)
overridevirtual

Default knobs puts the transform controls on the front tab, and the projection, shutter, and lens controls on tab 'Projection'.

Reimplemented from DD::Image::AxisOp.

Reimplemented in DD::Image::CameraSceneOp, DD::Image::LightOp, and DD::Image::LightSceneOp.

References DD::Image::Tab_knob().

◆ knob_changed()

int CameraOp::knob_changed ( Knob k)
overridevirtual

Reimplemented from DD::Image::AxisOp.

◆ projectionSelectorKnob()

virtual Knob * DD::Image::CameraOp::projectionSelectorKnob ( ) const
inlinevirtual

Return the knob which provides projection selection, if there is one. Base returns null.

Reimplemented in DD::Image::CameraSceneOp.

◆ projectionMode()

ndk::LensProjection CameraOp::projectionMode ( ) const
override

Currently-assigned projection mode enum value. May be one of the pre-defined modes or a custom enum. Note - do not assume this value is within the hardcoded LensProjection set as a subclass may extend or completely replace the enum set!

References _projectionSelection.

◆ setProjection()

bool CameraOp::setProjection ( const char *  projectionClassName)

Set the projection mode via a ProjectionFunc class name. If a matching ProjectionFunc plugin exists it will be loaded and an instance created for this camera (retrievable via projectionFunc() after _validate() occurs) and true is returned.

Important note - setting the projection mode via this method does not update _projectionFunc immediately, it is updated during the next _validate() cycle called on this CameraOp. This is to avoid lens shaders from disappearing from renderer visibility until the next Op update cycle.

If any error occurs the default 'Perspective' ProjectionFunc will be used as a fallback and false returned.

References _setProjectionFuncPlugin().

Referenced by setProjectionMode().

◆ setProjectionMode()

void CameraOp::setProjectionMode ( ndk::LensProjection  mode)

Same but takes LensProjection enum which is converted to the matching ProjectionFunc class name.

References setProjection().

◆ projectionFuncClassName()

const char * CameraOp::projectionFuncClassName ( Knob selectorKnob = nullptr) const
virtual

Return the class name of the selected lens projection which is used to find the matching ProjectionFunc plugin. Note that this class name is NOT the plugin name and will have a prefix and suffix added. See ProjectionFunc for more info. selectorKnob is optional to override the default retrieval of the selector Knob from projectionSelectorKnob(). Default implementation returns an empty string.

Reimplemented in DD::Image::CameraSceneOp.

◆ isBaseProjectionLinear()

bool CameraOp::isBaseProjectionLinear ( ) const
override

Returns true if current camera projection can be described linearly with a 4x4 matrix, based on the camera's current settings. This is usually only true for perspective and orthographic modes if no lens distortion is being done.

A subclass should override this method if it's implementing custom projection calculations in projectionModeMatrix().

Default implementation returns projectionFunc()->isLinear().

Referenced by DD::Image::CameraSceneOp::draw_handle().

◆ projectionModeMatrix()

Mat4d CameraOp::projectionModeMatrix ( ndk::LensProjection  mode) const
virtual

Return a linear camera projection matrix for the projection mode arg using the CameraOp's current lens values (ie its focal_length, horizontal_aperture, etc.)

Only the predefined LensProjection enums are implemented in the base class implementation, but a subclass can override this method to implement custom projection calculations.

This method should be used in conjunction with isBaseLinearProjection() to determine how to use the returned matrix, as not all projection modes can be supported by a linear matrix. For example uv and spherical, plus perspective/ortho projections become non linear if lens distortion is enabled.

In non-linear cases the matrix returned is normally considered the 'base' projection for the camera based on its current lens settings. In other words although the projection mode may be 'perspective' and the matrix returned is a valid perspective projection, if lens distortion is enabled then the final projection is a combination of both the projection matrix and the distortion.

References DD::Image::Op::nodeName().

Referenced by DD::Image::CameraSceneOp::draw_handle().

◆ ToFormat()

void CameraOp::ToFormat ( fdk::Mat4f &  matrix,
const Format format 
)
static

Multiply the passed matrix by the necessary transformation to put x=-1 at the left edge of the format, +1 at the right, and to center it vertically, and compensate for any pixel aspect. The output z and w are left unchanged.

Most Iops will need to do this using their output format to get the actual transformation from input space to output space. You would do this first, then multiply by the projection*local*parent.

References DD::Image::Format::pixel_aspect(), DD::Image::Box::r(), DD::Image::Box::t(), DD::Image::Box::w(), DD::Image::Box::x(), and DD::Image::Box::y().

◆ FromFormat()

void CameraOp::FromFormat ( fdk::Mat4f &  matrix,
const Format format 
)
static

Opposite transformation of to_format(). Multiplies the passed matrix by a transformation that scales the input format to go from x = -1 to x = 1 and to center it vertically around y = 0, and to remove any pixel aspect ratio. You multiply by this matrix last.

The 3DCard iop scales further so the image covers a range so that if the camera lens and "taking lens" are equal the image fills the field of view.

References DD::Image::Format::pixel_aspect(), DD::Image::Box::r(), DD::Image::Box::t(), DD::Image::Box::w(), DD::Image::Box::x(), and DD::Image::Box::y().

◆ doAnyHandles()

Op::HandlesMode CameraOp::doAnyHandles ( ViewerContext ctx)
overridevirtual

Reimplemented from DD::Image::Op.

◆ build_handles()

void CameraOp::build_handles ( ViewerContext ctx)
overridevirtual

Reimplemented from DD::Image::Op.

◆ draw_handle()

◆ mFnDeprecatedLegacy3DSystemInNuke14()

enum DD::Image::CameraOp::mFnDeprecatedLegacy3DSystemInNuke14 ( "Enumeration  deprecated,
use enum class ndk::LensProjection instead."   
)
inline

< Standard perspective projection

< Standard orthographic projection

< Replace screen XY with UV coordinate

< 360x180 world spherically projected around camera

< Renderer uses this option

< Camera user projection

◆ _validateCamera()

void CameraOp::_validateCamera ( )
overrideprotected

Subclass implemention of validateCamera() to perform any custom configuration of the camera, called whenever the function has been changed.

References DD::Image::AxisOp::_xformParams, and DD::Image::Op::outputContext().



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