AxisOp is the base class for all the 3D 'scene' objects like locators (usg::XformPrim), cameras (usg::CameraPrim) and lights (usg::tbd). More...

#include <AxisOp.h>

Inheritance diagram for DD::Image::AxisOp:

Public Member Functions
	AxisOp (Node *node, GeomOpEngine::Builder engine_ctor, int defaultLookAtAxis=LookAt::kAxisZPlus)

	AxisOp (Node *node, int defaultLookAtAxis=LookAt::kAxisZPlus)
	Backwards-compatible ctor.

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 *	parentInputOp () const
	Convenience that casts parent input 0 to an AxisOp.

GeomOp *	sceneInputOp () const
	Convenience that casts input sceneImporterInput() to a GeomOp.

int32_t	parentInput () const
	Return the node input to use for the parent axis source. Always defaults to input 0.

virtual int32_t	sceneImporterInput () const
	Return the node input to use for the scene importer. Default returns optional_input().

const char *	node_shape () const override
	Draw a circular node shape.

unsigned	node_color () const override

int	minimum_inputs () const override
	Default is 2: axis and scene(optional)

int	maximum_inputs () const override
	Default is 2: axis and scene(optional)

int	optional_input () const override
	Optional input index is the scene-importer input. This returns (maximum_inputs()-1).

bool	test_input (int node_input, Op *op) const override
	AxisOp and null works on 0, and GeomOp or null on input 1.

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

	mFnDeprecatedInNuke14 ("isLegacyAxisOp() has been deprecated, port AxisOp sublass to new Nuke 14 api.") bool isLegacyAxisOp() const

const std::string &	primName () const
	Return the name of the prim created by this node. Stored in AxisEngine.

const usg::Path &	primFullPath () const
	Return the full path of this prim and all its parents. Stored in AxisEngine.

int	updateScenePrim (bool force=false)

virtual int	importScenePrim (const usg::StageRef &stage, const std::string &prim_path)

template<typename T >
size_t	getAttribValuesTimeWarped (const usg::Attribute &attr, double attr_fps, fdk::TimeValueList &times, std::vector< T > &values) const

template<typename T >
bool	copyAttribToKnobTimeWarped (const usg::Attribute &attr, double attr_fps, Knob *knob, bool force_keys, int32_t channel_start_offset, int32_t view) const

fdk::TimeValueList	getOutputSampleTimes (const fdk::TimeValueList &input_times, double input_fps=0.0) const

void	knobs (Knob_Callback f) override

void	createAxisOpKnobs (Knob_Callback f, const std::string &filters="")
	create the Axis Op Knobs and set a custom filter to use on the popup

void	setOutputContext (const OutputContext &context) override
	Called by Nuke immediately AFTER Op::knobs(). We use this to update the importer values.

int	knob_changed (Knob *k) override

void	appendGeomState (DD::Image::Hash &op_hash) override
	Adds the node name to the node hash for invalidation on changes.

virtual void	addDisplayOptionsKnobs (Knob_Callback f)
	Adds the OpenGL display option controls.

virtual void	addFileImportKnobs (Knob_Callback f)
	Add the file path and import enable knobs.

virtual void	addCreateOptionsKnobs (Knob_Callback f, const std::string &filters="")
	Adds the create/import, prim path, etc knobs.

virtual void	addScenePrimImporterKnobs (Knob_Callback f, bool group_open, bool add_time_options, bool add_xform_options)

virtual void	addLocalParentingKnobs (Knob_Callback f, bool add_sync_options=true)

virtual void	addLocalXformKnobs (Knob_Callback f, bool add_sync_options=true)

virtual void	addTransformKnobs (Knob_Callback f, bool add_sync_options=true)

Axis_KnobI *	getAxis ()
	Return internal 'transform' Axis_Knob for set/get internal transformation.

virtual void	addExtraFrontPanelKnobs (Knob_Callback f)
	Adds addl front-panel knobs. Called after addTransformKnobs(). Base class adds nothing.

void	enableAxisKnobs (bool on)

void	enableKnobs (const std::vector< std::string > &knobNames, bool on)

virtual void	enableScenePrimImporterKnobs (bool scene_import_enabled)
	Enable/disable knobs filled in by the scene importer.

virtual void	enableScenePrimImporterExtraKnobs (bool scene_import_enabled)

virtual void	enableXformExtractKnobs (bool xform_extract_enabled)

void	_validate (bool for_real) override

const fdk::Mat4d &	inputParentTransform () const

const fdk::Mat4d &	localParentTransform () const
	Result of the local-parent TRS knobs, if enabled. Calculated in _validate().

const fdk::Mat4d &	localAxisTransform () const
	Result of the local-axis TRS Axis_Knob (without lookat rotations.) Calculated in knobs().

const fdk::Mat4d &	parentTransform () const
	Parent transform containing the input-parent and local-parent. Calculated in _validate().

const fdk::Mat4d &	localTransform () const
	Local object transform containing the local-axis TRS Axis_Knob with lookat rotations. Calculated in _validate().

const fdk::Mat4d &	worldTransform () const
	World transform containing the input-parent, local-parent, local-axis, and lookat. Calculated in _validate().

const fdk::Mat4d &	invWorldTransform ()

virtual fdk::Mat4d	worldTransformAt (const OutputContext &context) const

void	setWorldTransform (const fdk::Mat4d &)

int	display3d () const

int	display3d ()

void	setDisplay3d (int mode)

bool	selectable () const override

void	setSelectable (bool v)

bool	editable () const

void	setEditable (bool v)

virtual bool	isGuiInteractive (Axis_KnobI::Transformation knob) const
	Return true if a particular knob transformation is modifiable by user interaction in gui.

HandlesMode	doAnyHandles (ViewerContext *) override

void	build_handles (ViewerContext *) override

void	draw_handle (ViewerContext *) override

	mFnDeprecatedInNuke14 ("Class() has been deprecated, implement on subclass plugin instead.") const char *Class() const override

	mFnDeprecatedInNuke14 ("node_help() has been deprecated, implement on subclass plugin instead.") const char *node_help() const override

	mFnDeprecatedInNuke14 ("selectable(bool mode) has been deprecated, use setSelectable() instead.") void selectable(bool v)

	mFnDeprecatedInNuke14 ("display3d(int mode) has been deprecated, use setDisplay3d() instead.") void display3d(int mode)

	mFnDeprecatedInNuke14 ("input0() has been deprecated, use parentInput() instead.") AxisOp *input0() const

	mFnDeprecatedInNuke14 ("lookAtEnabled() has been deprecated") virtual bool lookAtEnabled() const

	mFnDeprecatedInNuke14 ("lookat_input() has been deprecated") Op *lookat_input() const override

	mFnDeprecatedInNuke14 ("matrix(const Matrix4&) has been deprecated, use setWorldTransform() instead.") void matrix(const Matrix4 &)

	mFnDeprecatedInNuke14 ("local() has been deprecated, use localTransform() instead.") const Matrix4 &local() const

	mFnDeprecatedInNuke14 ("matrix() has been deprecated, use worldTransform() instead.") const Matrix4 &matrix() const

	mFnDeprecatedInNuke14 ("imatrix() has been deprecated, use invWorldTransform() instead.") const Matrix4 &imatrix()

	mFnDeprecatedInNuke14 ("matrixAt() has been deprecated, use worldTransformAt() instead.") virtual void matrixAt(const OutputContext &

Public Member Functions inherited from DD::Image::GeomOp
const GeneralInfo &	generalInfo () const override

const GeomOp *	geomOp () const override
	Cast to a GeomOp. This is much cheaper and safer than using dynamic_cast.

GeomOp *	geomOp () override

GeomOpEngine *	engineNode () const

const char *	node_shape () const override
	Draw a round sided box.

unsigned	node_color () const override

int	minimum_inputs () const override
	Minimum number of Node inputs for this class - GeomOp base class has only one input.

int	maximum_inputs () const override
	Maximum number of Node inputs for this class.

Op *	default_input (int node_input) const override
	Return a default NullGeomOp op for Node input0.

bool	test_input (int node_input, Op *op) const override
	Allows only GeomOp inputs by default.

virtual void	AppendKnobToTarget (const Knob_Closure &f, const usg::Token &target_id)

virtual void	AppendKnobToTarget (const char *knob_name, const usg::Token &target_id)

void	KnobDefinesGeometry (const Knob_Closure &f)

void	KnobModifiesAttribValues (const Knob_Closure &f)

void	KnobEditsLayer (const Knob_Closure &f)

void	KnobEditStage (const Knob_Closure &f)

template<typename T >
T	getKnobValue (const char *knob_name, const OutputContext &context, const T &default_value) const

template<typename T >
bool	setKnobValue (const char *knob_name, const T &value, double time, int32_t element_offset=0, int32_t view=-1)

template<typename T >
bool	setKnobValues (const char *knob_name, bool clear_keys, const std::vector< T > &values, const std::vector< double > &times, int32_t element_offset=0, int32_t view=-1)

const OutputContext &	inputContext (int node_input, int offset, OutputContext &scratch_ctx) const override

const OutputContext *	inputUIContext (int node_input, OutputContext &scratch_ctx) const override

GeomOp *	input (int op_input) const

GeomOp *	input0 () const

GeomOp *	input1 () const

virtual bool	selectable () const

virtual bool	selection3DChanged (ViewerContext *ctx)

virtual bool	selection3DCleared ()

virtual bool	selection3DMouseDown (ViewerContext *ctx)

virtual bool	selection3DMouseUp (ViewerContext *ctx)

virtual bool	selection3DMouseDrag (ViewerContext *ctx)

void	build_handles (ViewerContext *ctx) override

virtual void	buildXformHandles (ViewerContext *ctx, const fdk::Mat4d &localMatrix)

const usg::GeomState &	inputVersions () const

const usg::GeomState &	localVersions () const

const usg::GeomState &	outputVersions () const

const usg::GeomState &	inputGeomState () const

const usg::GeomState &	localGeomState () const

const usg::GeomState &	outputGeomState () const

void	resetGeomState ()

void	buildGeomState (DD::Image::Hash &op_hash)

void	appendToTarget (const usg::Token &target_id, const fdk::Hash &hash, const fdk::Hash &version, bool is_animating_source=false)

void	appendToTarget (const usg::Token &target_id, const Hash &hash, const Hash &version, bool is_animating_source=false)

void	appendToTarget (const usg::Token &target_id, Op *op)
	Variant that appends op->hash() and uses op->varyingOutputHash() for 'is hash animating' state.

void	appendToDefineGeometryTarget (const fdk::Hash &hash, const fdk::Hash &version, bool is_animating_source=false)

void	appendToDefineGeometryTarget (const Hash &hash, const Hash &version, bool is_animating_source=false)

void	appendToDefineGeometryTarget (Op *op)

void	appendToModifyValuesTarget (const fdk::Hash &hash, const fdk::Hash &version, bool is_animating_source=false)

void	appendToModifyValuesTarget (const Hash &hash, const Hash &version, bool is_animating_source=false)

void	appendToModifyValuesTarget (Op *op)

void	appendToEditStageTarget (const fdk::Hash &hash, const fdk::Hash &version, bool is_animating_source=false)

void	appendToEditStageTarget (const Hash &hash, const Hash &version, bool is_animating_source=false)

void	appendToEditStageTarget (Op *op)

const usg::GeomStateTargetArray &	localTargets () const
	The set of knob-change targets, copied from the shared GeomOpEngine.

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

bool	haveHash () const
	return true if the hash() value is meaningful and globally unique

bool	varyingOutputHash () const

void	setVaryingOutputHash (bool varyingHashes)
	Set the varyingOutputHash indicator to a specific state.

void	enableVaryingOutputHash ()
	Enable the varyingOutputHash indicator.

virtual Hash	editState () const

virtual void	setEditState (const Hash &h)

virtual std::vector< DD::Image::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)

const char *	nodeName () const
	Return NodeI::name() which is the Node's local name with no parent path.

std::string	nodeFullPath (char separator='.') const

Hash	nodeTopologyHash () const

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 &storeContext)

virtual void	knobs (Knob_Callback)

void	knobStorePost (const OutputContext &storeContext, Hash &hash)

int	replace_knobs (Knob afterthis, int n, void(f)(void , Knob_Callback), void , const char *fileExt=nullptr)

int	add_knobs (void(f)(void , Knob_Callback), void *, Knob_Callback)

void	set_unlicensed ()

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

Op *	node_input (int, GenerateType=OUTPUT_OP) const

Op *	node_input (int, GenerateType, const DD::Image::OutputContext *outputContext) const

Op *	input_op (int n=0) const

virtual void	inputs (int n)

Op *	input (int) 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 std::vector< Op * > &	getInputs () const

const std::vector< Op * > &	getChildren () const

virtual void	set_input (int i, Op *op, int input, int offset)

void	set_input0 (Op *op)

void	set_input (int i, Op *op)

void	set_input (int i, Op &op)

void	set_input (int input, int offset, Op *op)

const 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

const Hash &	hash () 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 (std::set< Op * > &forgotten)

virtual const char *	node_shape () const

DD::Image::Hash	curveHash () const

bool	opCurrent () const

virtual unsigned	node_color () const

virtual const char *	node_help () const =0

virtual const char *	input_label (int, char *) const

virtual std::string	input_longlabel (int) const

void	node_redraw ()

void	print_name (std::ostream &o) const

NodeContext	nodeContext () const

std::string	node_name () const
	Returns the same string as printed by print_name(ostream).

void	invalidateSameHash ()

bool	invalidate ()

bool	invalidate (const Hash &hash)

bool	update (const Box *=nullptr)

void	asapUpdate ()

void	asapUpdate (const Box &box, int direction=0)

void	validate (bool for_real=true)

virtual void	force_validate (bool for_real=true)

void	update_handles () const

bool	valid () const
	Returns true if it has been validated - including if there was an error.

bool	real_valid () const
	Returns true if it has been real-validated - including if there was an error.

bool	inErrorState () const

bool	inInvalidState () const

bool	opened () const

void	open ()

void	unopen ()

bool	running () const

void	running (bool v)

bool	not_closed () const

void	close ()

void	callCloseAfter (double seconds)

void	copyState (Op *input)

bool	cached () const

void	cached (bool b)

virtual bool	inUse () const

virtual 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 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 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 CameraOp *	cameraOp ()
	Cast to an CameraOp. This is much cheaper and safer than using dynamic_cast.

virtual const CameraOp *	cameraOp () const

virtual LightOp *	lightOp ()
	Cast to an LightOp. This is much cheaper and safer than using dynamic_cast.

virtual const LightOp *	lightOp () const

virtual std::string	getLibraryName () const
	Return a label and version string to display library version info for the Node.

virtual VersionInfo	getLibraryVersion () const

virtual OpHints	opHints () const
	Return hints to control when and how this op will be evaluated by the top-down system.

virtual std::string	resolveKnobAsset (Knob *knob, const std::string &assetPath)

virtual bool	updateKnobsFromAsset (Knob *knob)

virtual void	_updateKnobsFromAsset (Knob *assetKnob, const ndk::asset::AssetData &assetData)

virtual const char *	Class () const =0

const std::string	libraryDisplayName () const

virtual const char *	displayName () const

virtual std::string	docsPath () const

virtual bool	onAction (const ViewerContext c, const DD::Image::Flags f, void d)

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

Public Attributes
Matrix4 &	const

bool	_xformInversionValid
	Is _invWorldTransform valid?

Axis_KnobI *	_axisKnob
	Reference to the node Axis_Knob.

Public Attributes inherited from DD::Image::Op
const MetaData::Bundle *	metaCache

Hash	metaCacheHash

Protected Member Functions
	mFnDeprecatedInNuke14 ("isLegacyAxisOp() has been deprecated, port AxisOp sublass to new Nuke 14 api.") virtual bool _isLegacyAxisOp() const

	mFnDeprecatedInNuke14 ("localtransform_ has been deprecated, use Mat4d _localTransform instead.") Matrix4 localtransform_
	Local 'axis' matrix that Axis_Knob fills in - deprecated.

	mFnDeprecatedInNuke14 ("local_ has been deprecated, use Mat4d _localAxisMatrix instead.") Matrix4 local_
	Local matrix after look at performed - deprecated.

	mFnDeprecatedInNuke14 ("matrix_ has been deprecated, use Mat4d _worldTransform instead.") Matrix4 matrix_
	Object matrix - local&parent - deprecated.

	mFnDeprecatedInNuke14 ("imatrix_ has been deprecated, use Mat4d _invWorldTransform instead.") Matrix4 imatrix_
	Inverse object matrix - deprecated.

Protected Member Functions inherited from DD::Image::GeomOp
	GeomOp (Node *node, GeomOpEngine::Builder engineBuilder)

	GeomOp (Node *)
	Ctor for MultiTypeNode support only! Do not implement for Engine-using subclasses.

OpHints	opHints () const override
	Return hints to control when and how this op will be evaluated by the top-down system.

void	setOutputContext (const OutputContext &context) override
	Called by Nuke immediately AFTER Op::knobs().

int	knob_changed (Knob *k) override

virtual void	appendGeomState (DD::Image::Hash &op_hash)

void	_validate (bool for_real) override

virtual void	updateGeneralInfo ()
	Default implemenation copies the GeneralInfo from input0.

virtual fdk::Mat4d	handlesParentTransform (DD::Image::ViewerContext *ctx)

virtual void	buildXformHandles (ViewerContext ctx, const fdk::Mat4d localMatrix)

Protected Member Functions inherited from DD::Image::Op
	Op (Node *node)
	The constructor is protected so only subclasses can create the base class.

virtual void	_knobStorePrep (const OutputContext &storeContext)
	The subclass-specific portion of knobStorePrep(). See that method for more info.

virtual void	_knobStorePost (const OutputContext &storeContext, Hash &hash)
	The subclass-specific portion of knobStorePost(). See that method for more info.

virtual void	_invalidate ()

virtual void	_validate (bool for_real)

virtual void	_open ()

virtual void	_close ()

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 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
std::string	_primPath
	Path + name for the output prim to create (if needed)

int32_t	_parentPrimType
	The type for missing parent prims we create.

bool	_importEnabled
	If true this node imports prim attributes from scene input or file source.

bool	_passthroughEnabled
	If true this node does not create or change any input scene prims.

bool	_mergeEnabled
	If true any input scenegraph is merged into the output scenegraph.

struct DD::Image::AxisOp::ScenePrimImport	_importer
	Scene prim importer controls & state.

bool	_importerChanged
	If true any knobs set by the importer need to be re-stored.

fdk::Vec3d	_localParentTranslate
	Local-parent translation knob value.

fdk::Vec3d	_localParentRotate
	Local-parent rotate knob value.

fdk::Vec3d	_localParentScale
	Local-parent scale knob value.

fdk::Mat4d	_localParentMatrix
	Parent transform derived from local parent TRS knobs.

fdk::Mat4d	_localAxisMatrix
	Local matrix that Axis_Knob fills in (no lookat rotations)

fdk::Mat4d	_parentTransform
	Input-parent & local-parent transform.

fdk::Mat4d	_localTransform
	Local object transform - axis_matrix & lookat rotations.

fdk::Mat4d	_worldTransform
	World transform - _parentTransform & _localTransform.

fdk::Mat4d	_invWorldTransform
	Inverse world transform.

DD::Image::Hash	_parentHash
	Does parent path or transform need to be updated?

union {
bool _xformInversionValid
	Is _invWorldTransform valid?

};

union {
Axis_KnobI * _axisKnob
	Reference to the node Axis_Knob.

};

WorldMatrixProvider *	_worldMatrixProvider
	'world_matrix' output knob

Knob *	_localParentTranslateKnob
	If not null apply parent_translate.

Knob *	_localParentRotateKnob
	If not null apply parent_rotate.

Knob *	_localParentScaleKnob
	If not null apply parent_scale.

int	display3d_
	GUI display setting - deprecate?

bool	selectable_
	GUI selectable checkmark - deprecate?

bool	_editable
	Can the user change the knobs? (i.e. knobs not disabled)

Protected Attributes inherited from DD::Image::GeomOp
GeomOpEngine *	_engineNode
	GeomEngine graph processor shared between all Op instances of this GeomOp subclass.

GeneralInfo	info_
	Global intended frame range (must remain 'info_' for MultiTypeNode support!)

Protected Attributes inherited from DD::Image::Op
bool	_haveHash
	whether the _hash actually has been set by a call to invalidate(Hash) ever.

bool	_varyingOutputHash
	whether the hash value will animate over time

Hash	_editState
	Op's current edit state, usually the combination of input & knob edit states.

Protected Attributes inherited from DD::Image::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.

typedef std::pair< int, DD::Image::Op * >	Output
	Combination of input number and pointer to Op.

typedef std::set< Output >	OutputSet
	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 Member Functions inherited from DD::Image::GeomOp
static void	buildStage (usg::StageRef &stage, const usg::ArgSet &request_args, GeomOp geop0, GeomOp geop1=nullptr, const fdk::TimeValueSet *addl_process_times=nullptr)

static void	buildStage (usg::StageRef &stage, const usg::ArgSet &request_args, const GeomOpSet &geops, const fdk::TimeValueSet *addl_process_times=nullptr)
	Same as buildStage(GeomOp*) but for a set of GeomOps.

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 *	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)

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 Member Functions inherited from DD::Image::GeomOp
template<class Engine >
static GeomOpEngine::Builder	BuildEngine ()
	A helper function you can use as the engineBuilder argument to the GeomOp constructor to reduce clutter.

Static Protected Attributes inherited from DD::Image::LookAt
static const char *const	ms_lookat_axis_choices []

Detailed Description

AxisOp is the base class for all the 3D 'scene' objects like locators (usg::XformPrim), cameras (usg::CameraPrim) and lights (usg::tbd).

It contains a local transform matrix and an optional local-parent transform matrix. The local-parent enables an arbitrary parenting hierarchy to be decomposed and contained within the AxisOp allowing the node to be disconnected or disassociated from a parenting network or scenegraph. The node is effectively localized and can be copied, pasted into other scripts, etc.

Member Function Documentation

◆ axisOp() [1/2]

const AxisOp * DD::Image::AxisOp::axisOp ( ) const

inlineoverridevirtual

Cast this Op to an AxisOp. This is much cheaper and safer than using dynamic_cast.

Reimplemented from DD::Image::Op.

Referenced by worldTransformAt().

◆ axisOp() [2/2]

AxisOp * DD::Image::AxisOp::axisOp ( )

inlineoverridevirtual

Reimplemented from DD::Image::Op.

◆ node_shape()

const char * AxisOp::node_shape ( ) const

overridevirtual

Draw a circular node shape.

Reimplemented from DD::Image::Op.

◆ node_color()

unsigned AxisOp::node_color ( ) const

overridevirtual

Reimplemented from DD::Image::Op.

◆ minimum_inputs()

int AxisOp::minimum_inputs ( ) const

overridevirtual

Default is 2: axis and scene(optional)

Reimplemented from DD::Image::Op.

◆ maximum_inputs()

int AxisOp::maximum_inputs ( ) const

overridevirtual

Default is 2: axis and scene(optional)

Reimplemented from DD::Image::Op.

Referenced by optional_input().

◆ optional_input()

int AxisOp::optional_input ( ) const

overridevirtual

Optional input index is the scene-importer input. This returns (maximum_inputs()-1).

Scene import input is the last input index, which is (maximum_inputs() - 1), and draws as a stub arrow on the right side of the node. Note - the minimum and maximum input counts must include this optional input in their totals, otherwise the arrow will not appear on the node.

Reimplemented from DD::Image::Op.

References maximum_inputs(), and DD::Image::Op::optional_input().

◆ test_input()

bool AxisOp::test_input	(	int	node_input,
		Op *	op
	)		const

overridevirtual

AxisOp and null works on 0, and GeomOp or null on input 1.

Reimplemented from DD::Image::Op.

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

◆ default_input()

Op * AxisOp::default_input ( int node_input ) const

overridevirtual

Returns null for all inputs. Override this so Op::test_input() doesn't produce warnings.

Reimplemented from DD::Image::Op.

◆ input_label()

const char * AxisOp::input_label	(	int	node_input,
		char *	buffer
	)		const

overridevirtual

Reimplemented from DD::Image::Op.

◆ mFnDeprecatedInNuke14() [1/2]

DD::Image::AxisOp::mFnDeprecatedInNuke14	(	"isLegacyAxisOp() has been	deprecated,
		port AxisOp sublass to new Nuke 14 api."
	)		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 Nuke14, but those plugins will be removed in Nuke15, and existing scripts using them will no longer work.

◆ updateScenePrim()

int AxisOp::updateScenePrim ( bool force = false )

Check if the imported prim needs to be loaded or reloaded. If the prim needs reloading then importScenePrim() is called with the correct stage and prim path.

If force is true then the prim will always be reloaded.

Return codes: -1 - no prim data was loaded and no error (i.e. no change) 0 - prim data was loaded with no error 1 - there was an error and no prim data was loaded

If error was returned (1) check the error state and message in ScenePrimImport.

This should be called from an implemented Op::setOutputContext() method which get called immediately after Op::knobs() so that we can import and change knob contents BEFORE validate() is called.

This method will cause the scene prim to be loaded on initial script load, if knob values that affect the load state change, or if the input scene connection GeomState changes.

If force is true then importScenePrim() is always called, assuming there's a valid input stage.

References _importEnabled, _importer, DD::Image::GeomOp::buildStage(), DD::Image::Op::error(), importScenePrim(), DD::Image::Op::nodeName(), sceneInputOp(), and DD::Image::Op::validate().

Referenced by setOutputContext().

◆ importScenePrim()

int AxisOp::importScenePrim	(	const usg::StageRef &	stage,
		const std::string &	prim_path
	)

virtual

Try to import prim data from the provided stage. Will return 1(error) if stage is invalid. If prim_path is empty then -1 will be returned indicating no change has occured, otherwise if prim_path is invalid or not present in stage then 1(error) will be returned.

Return codes: -1 - no prim data was loaded and no error, usually due to empty prim path 0 - prim data was loaded with no error 1 - there was an error and no prim data was loaded

Reimplemented in DD::Image::CameraOp.

References _importer, _localParentRotateKnob, _localParentScaleKnob, _localParentTranslateKnob, DD::Image::AxisVals::applyEulerFilter(), DD::Image::ValueStuffI::clear_animated(), DD::Image::Op::debug(), DD::Image::AxisVals::enableParentXformVals(), DD::Image::AxisVals::extractFromMatrix(), DD::Image::Op::knob(), DD::Image::Op::nodeName(), DD::Image::Knob::set(), and DD::Image::ValueStuffI::set_value().

Referenced by DD::Image::CameraOp::importScenePrim(), and updateScenePrim().

◆ getAttribValuesTimeWarped()

template<typename T >

size_t DD::Image::AxisOp::getAttribValuesTimeWarped	(	const usg::Attribute &	attr,
		double	attr_fps,
		fdk::TimeValueList &	times,
		std::vector< T > &	values
	)		const

inline

Retrieve the attribute values at times possibly modified by the importer time options. If there are no time samples in the attribute then only a single default-time value is returned, unaffected by the time options. If the output time of the samples have been affected the times array reflects the output time and not the time the attribute was sampled at.

If the importer is set to frame lock then only a single value is set, sampled at the lock time, regardless of the animation status of the attribute.

This method will always set at least one time and value if the attrib is valid. Returns the number of value/times set, or 0 if there was a problem.

Referenced by DD::Image::CameraOp::importScenePrim().

◆ copyAttribToKnobTimeWarped()

template<typename T >

bool DD::Image::AxisOp::copyAttribToKnobTimeWarped	(	const usg::Attribute &	attr,
		double	attr_fps,
		Knob *	knob,
		bool	force_keys,
		int32_t	channel_start_offset,
		int32_t	view
	)		const

inline

Retrieve the attribute values at times possibly modified by the importer time options and save them into the target Knob. If force_keys is true then the Knob will have a keyframe set even if the sample attribute only has a default value (i.e. no time sample.) This likely only works for ArrayKnobs since they support animation. See Knob::set() for explanation of channel_start_offset and view options. Returns true on success.

References DD::Image::Knob::set().

◆ getOutputSampleTimes()

TimeValueList AxisOp::getOutputSampleTimes	(	const fdk::TimeValueList &	input_times,
		double	input_fps = `0.0`
	)		const

Generate output time values from an input time list using the current importer settings to possibly time warp / offset them. If no time change needed the returned times will be the input times. input_fps is only needed if this is changing the frame rate of the input samples. If left at the 0.0 default then no time warping is applied.

References _importer.

◆ knobs()

void AxisOp::knobs ( Knob_Callback f )

overridevirtual

Reimplemented from DD::Image::Op.

Reimplemented in DD::Image::CameraOp.

◆ setOutputContext()

void AxisOp::setOutputContext ( const OutputContext & context )

overridevirtual

Called by Nuke immediately AFTER Op::knobs(). We use this to update the importer values.

We use setOutputContext() to update the imported state right after knobs() has been called, but before append() or _validate().

At this point all the knob values will be stored at the OutputContext passed to this method and we can decide what to do with their stored values.

If we end up loading a scene prim successfully there's a bunch of knobs who's contents will likely get changed, affecting the Op's local variables such as _localAxisMatrix. But - since knobs() has already been called and the previously knobs stored at the prior values these vars are now out of date. This is a common Nuke issue when Knobs are changed outside the expected pattern, and is often experienced as a off-by-one delay in updating values when the Viewer changes frame, since changing the frame will force the knobs to store with their new contents, causing a 'snap'.

The solution to this is to force the knobs to store after a known change has been applied, via Op::setKnobsToContext(force=true). This method will call knobs() again, storing the new values, then this method setOutputContext() again, then append() and finally invalidate() to update the Op hash. The trick here is avoiding a loop due to the second call into this method, so the variable _importerChanged is used to note whether we're in that second knobs() update cycle or not, and to avoid re-calling the importer again.

Reimplemented from DD::Image::Op.

References _importer, _importerChanged, DD::Image::Op::inputsValid(), DD::Image::Op::nodeName(), sceneImporterInput(), DD::Image::Op::setKnobsToContext(), DD::Image::GeomOp::setOutputContext(), and updateScenePrim().

◆ knob_changed()

int AxisOp::knob_changed ( Knob * k )

overridevirtual

Reimplemented from DD::Image::Op.

◆ appendGeomState()

void AxisOp::appendGeomState ( DD::Image::Hash & op_hash )

overridevirtual

Adds the node name to the node hash for invalidation on changes.

Reimplemented from DD::Image::GeomOp.

References DD::Image::GeomOp::appendGeomState(), and DD::Image::Op::nodeTopologyHash().

◆ addDisplayOptionsKnobs()

void AxisOp::addDisplayOptionsKnobs ( Knob_Callback f )

virtual

Adds the OpenGL display option controls.

Reimplemented in DD::Image::CameraOp.

References _editable, DD::Image::Bool_knob(), display3d_, DD::Image::display3d_names_source, DD::Image::Enumeration_knob(), DD::Image::Op::knobs(), selectable_, and DD::Image::Tooltip().

Referenced by DD::Image::CameraOp::addDisplayOptionsKnobs(), and createAxisOpKnobs().

◆ addScenePrimImporterKnobs()

void AxisOp::addScenePrimImporterKnobs	(	Knob_Callback	f,
		bool	group_open,
		bool	add_time_options,
		bool	add_xform_options
	)

virtual

Adds the scene import controls. If add_xform_knobs is true the knobs to control local parent extraction, matrix decomposition options, etc are added.

References _importer, DD::Image::Bool_knob(), DD::Image::ClearFlags(), DD::Image::Knob::DISABLED, DD::Image::Divider(), DD::Image::Knob::EARLY_STORE, DD::Image::Knob::ENDLINE, DD::Image::Enumeration_knob(), DD::Image::Newline(), DD::Image::Knob::NO_ANIMATION, DD::Image::Knob::NO_MULTIVIEW, DD::Image::SetFlags(), DD::Image::Knob::SLIDER, DD::Image::Knob::STARTLINE, and DD::Image::Tooltip().

Referenced by createAxisOpKnobs().

◆ addLocalParentingKnobs()

void AxisOp::addLocalParentingKnobs	(	Knob_Callback	f,
		bool	add_sync_options = `true`
	)

virtual

Add the local-parent TRS knobs. If add_sync_options is true the import-sync options are added.

References _importer, _localParentRotate, _localParentRotateKnob, _localParentScale, _localParentScaleKnob, _localParentTranslate, _localParentTranslateKnob, DD::Image::GeomOp::AppendKnobToTarget(), DD::Image::Bool_knob(), DD::Image::ClearFlags(), DD::Image::Knob::EARLY_STORE, DD::Image::Knob::ENDLINE, DD::Image::Newline(), DD::Image::Knob::NO_HANDLES, DD::Image::SetFlags(), DD::Image::Knob::STARTLINE, DD::Image::Tooltip(), and DD::Image::XYZ_knob().

Referenced by addTransformKnobs().

◆ addLocalXformKnobs()

void AxisOp::addLocalXformKnobs	(	Knob_Callback	f,
		bool	add_sync_options = `true`
	)

virtual

Adds the front panel local-axis transform knobs. If add_sync_options is true the import-sync options are added.

References _axisKnob, _importer, _localAxisMatrix, _worldMatrixProvider, DD::Image::GeomOp::AppendKnobToTarget(), DD::Image::Array_knob(), DD::Image::Axis_knob(), DD::Image::BeginClosedGroup(), DD::Image::Bool_knob(), DD::Image::ClearFlags(), DD::Image::Knob::DO_NOT_WRITE, DD::Image::Knob::EARLY_STORE, DD::Image::EndGroup(), DD::Image::Knob::ENDLINE, DD::Image::SetFlags(), DD::Image::Knob::STARTLINE, and DD::Image::Tooltip().

Referenced by addTransformKnobs().

◆ addTransformKnobs()

void AxisOp::addTransformKnobs	(	Knob_Callback	f,
		bool	add_sync_options = `true`
	)

virtual

Adds the front panel local-parent & local-axis transform knobs. If add_sync_options is true the import-sync options are added. Calls addLocalParentingKnobs() then addLocalXformKnobs(), adding dividers.

References addLocalParentingKnobs(), addLocalXformKnobs(), and DD::Image::Divider().

Referenced by createAxisOpKnobs().

◆ addExtraFrontPanelKnobs()

void AxisOp::addExtraFrontPanelKnobs ( Knob_Callback f )

virtual

Adds addl front-panel knobs. Called after addTransformKnobs(). Base class adds nothing.

Reimplemented in DD::Image::CameraOp.

Referenced by createAxisOpKnobs().

◆ enableAxisKnobs()

void AxisOp::enableAxisKnobs ( bool on )

Enable or disable axis knobs.

Parameters

on	true to enable the axis knobs ('transform')

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

◆ enableKnobs()

void AxisOp::enableKnobs	(	const std::vector< std::string > &	knobNames,
		bool	on
	)

Enable or disable knobs based on array of knobnames.

Parameters

knobNames	knob names to enable or disable
on	true to enable the knobs

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

◆ _validate()

void AxisOp::_validate ( bool for_real )

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::GeomOp::_engineNode, _localAxisMatrix, _localParentMatrix, _localParentRotate, _localParentScale, _localParentTranslate, _localTransform, _parentHash, _parentPrimType, _parentTransform, _passthroughEnabled, _primPath, DD::Image::Op::_validate(), DD::Image::GeomOp::_validate(), _worldTransform, _xformInversionValid, DD::Image::Op::append(), DD::Image::Op::hash(), DD::Image::LookAt::lookAt(), DD::Image::LookAt::lookat_input(), DD::Image::Op::nodeName(), DD::Image::Op::nodeTopologyHash(), DD::Image::Op::parent(), parentInputOp(), primFullPath(), primName(), sceneInputOp(), and DD::Image::Op::validate().

◆ invWorldTransform()

const Mat4d & AxisOp::invWorldTransform ( )

Return the inverse world transform. If _worldTransform has been marked invalid the _invWorldTransform will be calculated and updated now.

References _invWorldTransform, _worldTransform, and _xformInversionValid.

◆ worldTransformAt()

Mat4d AxisOp::worldTransformAt ( const OutputContext & context ) const

virtual

Calculate the world-space transform of this node at a specific OutputContext. Calls Knob::store() on all the transform knobs but discards the results, so this method can be more expensive than creating an AxisOp at the OutputContext and reusing it.

References _axisKnob, _localParentRotateKnob, _localParentScaleKnob, _localParentTranslateKnob, DD::Image::Op::axisOp(), axisOp(), DD::Image::Op::EXECUTABLE_SKIP, DD::Image::Knob::get(), DD::Image::Op::node_input(), and worldTransformAt().

Referenced by worldTransformAt().

◆ setWorldTransform()

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 _worldTransform, and _xformInversionValid.

◆ selectable()

bool DD::Image::AxisOp::selectable ( ) const

inlineoverridevirtual

Reimplemented from DD::Image::GeomOp.

◆ doAnyHandles()

Op::HandlesMode AxisOp::doAnyHandles ( ViewerContext * ctx )

overridevirtual

Reimplemented from DD::Image::Op.

◆ build_handles()

void AxisOp::build_handles ( ViewerContext * ctx )

overridevirtual

This default version will always cause draw_handle() to be called when in 3D mode. Subclasses (i.e. the camera) should replace draw_handle with their own version to draw what they want.

Reimplemented from DD::Image::Op.

References _editable, _localTransform, _parentTransform, DD::Image::Op::add_draw_handle(), DD::Image::Op::build_input_handles(), DD::Image::Op::build_knob_handles(), display3d_, DD::Image::ViewerContext::expand_bbox(), DD::Image::Op::input0(), DD::Image::ViewerContext::modelmatrix, DD::Image::Op::node_disabled(), DD::Image::Op::node_selected(), parentInputOp(), DD::Image::ViewerContext::transform_mode(), DD::Image::Op::validate(), DD::Image::VIEWER_2D, and DD::Image::ViewerContext::viewer_mode().

◆ draw_handle()

void AxisOp::draw_handle ( ViewerContext * ctx )

overridevirtual

Draws any geometry attached to this axis. Note that the Axis knob will draw the 3-arrow axis control at its pivot-translate location.

Reimplemented from DD::Image::Op.

Reimplemented in DD::Image::CameraOp, DD::Image::LightOp, and DD::Image::ComplexLightOp.

References _localTransform, DD::Image::ViewerContext::display3d(), display3d_, DD::Image::ViewerContext::draw_hidden_lines(), DD::Image::ViewerContext::draw_lines(), DD::Image::ViewerContext::draw_unpickable_lines(), DD::Image::ViewerContext::fg_color(), DD::Image::gl_text(), DD::Image::glColor(), DD::Image::ViewerContext::icon_size(), DD::Image::ViewerContext::node_color(), DD::Image::Op::node_selected(), DD::Image::Op::print_name(), selectable_, and DD::Image::ViewerContext::selected_color().

◆ mFnDeprecatedInNuke14() [2/2]

DD::Image::AxisOp::mFnDeprecatedInNuke14	(	"isLegacyAxisOp() has been	deprecated,
		port AxisOp sublass to new Nuke 14 api."
	)		const

inlineprotected

*** Nuke14 only *** virtual method is used to indicate that the AxisOp subclass is a legacy one or not.

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ axisOp() [1/2]

◆ axisOp() [2/2]

◆ node_shape()

◆ node_color()

◆ minimum_inputs()

◆ maximum_inputs()

◆ optional_input()

◆ test_input()

◆ default_input()

◆ input_label()

◆ mFnDeprecatedInNuke14() [1/2]

◆ updateScenePrim()

◆ importScenePrim()

◆ getAttribValuesTimeWarped()

◆ copyAttribToKnobTimeWarped()

◆ getOutputSampleTimes()

◆ knobs()

◆ setOutputContext()

◆ knob_changed()

◆ appendGeomState()

◆ addDisplayOptionsKnobs()

◆ addScenePrimImporterKnobs()

◆ addLocalParentingKnobs()

◆ addLocalXformKnobs()

◆ addTransformKnobs()

◆ addExtraFrontPanelKnobs()

◆ enableAxisKnobs()

◆ enableKnobs()

◆ _validate()

◆ invWorldTransform()

◆ worldTransformAt()

◆ setWorldTransform()

◆ selectable()

◆ doAnyHandles()

◆ build_handles()

◆ draw_handle()

◆ mFnDeprecatedInNuke14() [2/2]