AxisSceneOp is the base class for all the 3D 'scene' objects like locators (usg::XformPrim), cameras (usg::CameraPrim) and lights which are translatable to USD prims. More...

#include <AxisSceneOp.h>

Inheritance diagram for DD::Image::AxisSceneOp:

Public Member Functions
	AxisSceneOp (Node *node)

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

AxisSceneOp *	axisSceneOp () override

int32_t	parentInput () const override
	AxisOp: Return the node input to use for the parent axis source. Defaults to input 0.

int32_t	sceneInput () const override
	SceneOpI: Return the node input to use for the scene source. Defaults to input 1.

int32_t	constrainInput () const override
	SceneOpI: Return the node input to use for the parent axis source. Defaults to input 2.

SceneOpI *	parentInputSceneOp () const override
	SceneOpI: Return the parentInput() input cast to a SceneOpI, if possible.

GeomOp *	sceneInputOp () const override
	SceneOpI: Return the sceneInput() input cast to a GeomOp, if possible.

SceneOpI *	constrainInputSceneOp () const override
	SceneOpI: Return the AxisOp::constrainInput() input cast to a SceneOpI, if possible.

const usg::Token &	primarySchemaType () const override
	SceneOpI: Return the name of the primary USD schema this node is handling.

const char *	primPathFilter () const override
	SceneOpI: Return the default filter string to apply in the prim path knob.

int	minimum_inputs () const override
	Default is 3: axis, scene and constrain.

int	maximum_inputs () const override
	Default is 3: axis, scene and constrain.

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

void	knobs (Knob_Callback) override

void	addDisplayOptionsKnobs (Knob_Callback) override

void	_knobStorePrep (const OutputContext &opStoreContext) override

void	_knobStorePost (const OutputContext &opStoreContext, Hash &newOpHash, Hash &newOpEditVersionHash) override

int	knob_changed (Knob *k) override

void	_validate (bool for_real) override

const fdk::Mat4d &	localParentAxisTransform () const override
	Local parent axis transform matrix.

void	setLocalParentAxisTransform (const fdk::Mat4d &localParent) override

const fdk::Mat4d &	localAxisTransform () const override

void	setLocalAxisTransform (const fdk::Mat4d &localAxis) override

bool	localParentTransformVaries () const override

bool	localTransformVaries () const override

HandlesMode	doAnyHandles (ViewerContext *) override

void	build_handles (ViewerContext *) override
	This default version will always cause draw_handle() to be called when in 3D mode.

void	draw_handle (ViewerContext *) override

AxisOp *	getAxisOp () override
	SceneOpI: Return the AxisOp the interface is attached to.

SceneOpI *	sceneOpI () override
	Cast to a SceneOpI.

const SceneOpI *	sceneOpI () const override

Op *	getGeometryProviderOp () override
	GeometryProviderI: Return the Op the interface is attached to.

GeometryProviderI *	geometryProvider () override
	Cast to a GeometryProviderI interface. This is much cheaper and safer than using dynamic_cast.

const GeometryProviderI *	geometryProvider () const override

usg::Path	buildBasePrimPath () const override
	SceneOpI: Prepends the parent connection if there is one.

virtual usg::Path	buildXformSchemaPrimPath () const

Public Member Functions inherited from DD::Image::AxisOp
	AxisOp (Node *node, int defaultLookAtAxis=LookAt::kAxisZPlus)

const AxisOp *	axisOp () const override
	Cast this Op to an AxisOp. This is much cheaper and safer than using dynamic_cast.

AxisOp *	axisOp () override

AxisOp *	getAxisOpAt (const OutputContext &context)
	Retrieve a version of this AxisOp at a specific OutputContext.

bool	can_link () const override

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

unsigned	node_color () const override

virtual AxisOp *	parentInputOp () const
	Convenience that casts parent input 0 to an AxisOp.

virtual int32_t	parentInput () const

virtual AxisOp *	constrainInputOp () const
	Return the constrainInput() input cast to an AxisOp, if possible.

virtual int32_t	constrainInput () const

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

int	maximum_inputs () const override
	Default is 3: axis, constraint and scene.

int	optional_input () const override
	Optional input index.

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

Op *	default_input (int node_input) const override
	Returns null for all inputs. Override this so Op::test_input() doesn't produce warnings.

const char *	input_label (int node_input, char *) const override

	mFnDeprecatedLegacy3DSystemInNuke14 ("isLegacyAxisOp() has been deprecated, port AxisOp sublass to AxisSceneOp.") bool isLegacyAxisOp() const

void	knobs (Knob_Callback f) override

int	knob_changed (Knob *k) override

void	_validate (bool for_real) override

virtual bool	localParentTransformVaries () const

virtual bool	localTransformVaries () const

virtual const ndk::XformComponents &	transformComponents () const

virtual const fdk::Mat4d &	inputParentTransform () const

virtual void	setInputParentTransform (const fdk::Mat4d &)

virtual const fdk::Mat4d &	localParentAxisTransform () const

virtual void	setLocalParentAxisTransform (const fdk::Mat4d &)

virtual const fdk::Mat4d &	localAxisTransform () const

virtual void	setLocalAxisTransform (const fdk::Mat4d &)

const fdk::Mat4d &	parentTransform () const

void	setParentTransform (const fdk::Mat4d &)

const fdk::Mat4d &	localTransform () const

void	setLocalTransform (const fdk::Mat4d &)

const fdk::Mat4d &	worldTransform () const

const fdk::Mat4d &	invWorldTransform ()

void	setWorldTransform (const fdk::Mat4d &)

int	display3d () const

int	display3d ()

void	setDisplay3d (int mode)

	mFnDeprecatedLegacy3DSystemInNuke14 ("isLegacyAxisOp() has been deprecated, port AxisOp sublass to AxisSceneOp.") virtual bool _isLegacyAxisOp() const

mFnDeprecatedLegacy3DSystemInNuke14("worldTransformAt() deprecated on AxisOp, use the static AxisOp::GetWorldTransformAt(AxisOp) " "method instead. If implementing an override of this method implement _getWorldTransformAt().") virtual fdk	mFnDeprecatedLegacy3DSystemInNuke14 ("getAxis() deprecated on AxisOp, now implemented on AxisSceneOp::getLocalAxisKnob().") Axis_KnobI *getAxis()

	mFnDeprecatedLegacy3DSystemInNuke14 ("enableAxisKnobs() deprecated on AxisOp, now implemented on AxisSceneOp.") void enableAxisKnobs(bool on)

mFnDeprecatedLegacy3DSystemInNuke14("enableKnobs() deprecated on AxisOp, now implemented on AxisSceneOp.") void enableKnobs(const std	mFnDeprecatedLegacy3DSystemInNuke14 ("doAnyHandle() deprecated on AxisOp, implement on AxisSceneOp instead.") HandlesMode doAnyHandles(ViewerContext *) override

	mFnDeprecatedLegacy3DSystemInNuke14 ("draw_handle() deprecated on AxisOp, implement on AxisSceneOp instead.") void build_handles(ViewerContext *) override

	mFnDeprecatedLegacy3DSystemInNuke14 ("draw_handle() deprecated on AxisOp, implement on AxisSceneOp instead.") void draw_handle(ViewerContext *) override

bool	selectable () const

void	setSelectable (bool v)

	mFnDeprecatedLegacy3DSystemInNuke14 ("editable() deprecated on AxisOp, implement on AxisSceneOp instead.") bool editable() const

	mFnDeprecatedLegacy3DSystemInNuke14 ("setEditable() deprecated on AxisOp, implement on AxisSceneOp instead.") void setEditable(bool v)

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

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

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

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

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

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

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

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

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

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

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

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

Public Member Functions inherited from DD::Image::Op
PrevalidateResult	preValidate (ViewerContext ctx=nullptr, PreValidateContext =nullptr)

Op *	rootOp () const

bool	preValidateAborted (int treeStartingVersion, PrevalidateResult &result) const

const OutputSet &	getOutputs () const
	return all the outputs of this node

virtual void	setInputsValid (bool nowValid)
	set whether the input ops are valid (are for the right context)

bool	inputsValid () const
	return whether the input ops are valid (are for the right context)

virtual bool	can_clone () const
	returns whether or not an op can be cloned in the dag

virtual bool	can_link () const
	returns whether or not an op can be linked in the dag

const Hash &	hash () const

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

bool	varyingOutputHash () const

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

void	enableVaryingOutputHash ()
	Enable the varyingOutputHash indicator.

virtual Hash	editVersionHash () const

virtual void	setEditVersionHash (const Hash &h)

virtual std::vector< DD::Image::OutputContext >	getPrevVersionsWanted () const

virtual const MetaData::Bundle &	_fetchMetaData (const char *keyname)

const MetaData::Bundle &	fetchMetaData (const char *keyname)

Node *	node () const

DD::Image::NodeI *	getNode () const

void	node (Node *v)

virtual const char *	nodeClass () const

virtual const char *	nodeName () const

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

Hash	nodeTopologyHash () const

Hash	nodeEditVersionHash () const

Op *	firstOp () const

void	firstOp (Op *v)

Op *	parent () const

void	parent (Op *lpOp)

virtual void	detach ()
	node has been deleted in DAG

virtual void	attach ()
	node has been created in DAG

virtual void	pre_write_knobs ()

void	knobStorePrep (const OutputContext &opStoreContext)

virtual void	knobs (Knob_Callback)

void	knobStorePost (const OutputContext &opStoreContext, Hash &newOpHash, Hash &newOpEditVersionHash)

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

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

void	set_unlicensed ()

Knob *	knob (const char *name) const

Knob *	knob (int) const

bool	pushed () const

bool	panel_visible () const

bool	node_disabled () const

bool	node_selected () const

unsigned	node_gl_color () const

void *	field (const char *name)

void *	field (const char *name, int &type)

void *	set_field (const char name, const void source, int size)

void *	get_field (const char name, void dest, int size)

void	beginHandle (HandleType command, ViewerContext ctx, EventCallback cb, int index, float x=0, float y=0, float z=0, ViewerContext::Cursor cursor=ViewerContext::kNoCursor)

void	endHandle (ViewerContext *ctx)

virtual int	knob_changed (Knob *)

virtual int	knob_change_finished (Knob *knob, bool changedByUser=true)

void	addTime (OpTimer::Category category, long long microsecondsCPU, long long microsecondsWall, bool isTopLevel=true)

void	getPerformanceInfo (OpTimer::Category category, OpTimer::PerformanceInfo &info) const
	return the amount of CPU time taken by this op

virtual bool	inputs_clockwise () const
	whether unconnected inputs on the DAG should be arranged clockwise or anticlockwise (default)

virtual std::vector< int >	input_order () const

virtual int	inputArrows (int nodeInputs) const

bool	script_command (const char *command, bool py=true, bool eval=true) const

bool	script_expand (const char *str) const

HandlesMode	anyHandles (ViewerContext *ctx)

virtual void	build_handles (ViewerContext *)

void	add_draw_handle (ViewerContext *)

virtual void	draw_handle (ViewerContext *)

virtual void	add_input_handle (int input, ViewerContext *)

void	add_op_handle (ViewerContext *ctx)

void	add_knob_handle (Knob , ViewerContext )

virtual int	getViewableModes () const

virtual int	optional_input () const

virtual int	minimum_inputs () const

virtual int	maximum_inputs () const

virtual bool	test_input (int, Op *) const

int	inputs () const

int	node_inputs () const

OpGraphLocation	nodeInputConnection (int32_t nodeInput, GenerateType type=OUTPUT_OP) const

OpGraphLocation	nodeInputConnection (int32_t nodeInput, GenerateType type, const OutputContext *context) const

Op *	node_input (int, GenerateType=OUTPUT_OP) const

Op *	node_input (int, GenerateType, const OutputContext *context) const

Op *	input_op (int n=0) const

virtual void	inputs (int n)

Op *	input (int) const

Op *	inputAt (int input, const OutputContext &context, GenerateType type=EXECUTABLE_INPUT) const

int	inputNumber (int input, int offset) const

Op *	input (int input, int offset) const

Op *	input0 () const
	return the primary input

Op *	input1 () const
	return the second input, if it exists

const Input &	inputConnection (int32_t input) const

const Input &	inputConnection (int32_t base, int32_t offset) const

	mFnDeprecatedInNuke17 ("getInputs() has been deprecated, use getInputOps() instead") const OpList &getInputs() const

OpList	getInputOps () const

const InputList &	getInputConnections () const

const OpList &	getChildren () const

	mFnDeprecatedInNuke17 ("set_input(int, Op*, int, int) has been deprecated, use setInput(int, Input) and implement _setInput() instead") virtual void set_input(int i

void	set_input0 (Op *op)

void	set_input (int i, Op *op)

void	set_input (int i, Op &op)

void	set_input (int input, int offset, Op *op)
	Same as setInput(inputNumber(n, offset), op, n, offset);.

void	setInput (int32_t input, const OpGraphLocation &connection)
	Same as setInput(input, connection, input, 0).

void	setInput (int32_t input, const OpGraphLocation &connection, int32_t base, int32_t offset)

const OutputContext &	outputContext () const

virtual void	setOutputContext (const OutputContext &c)

virtual void	append (Hash &)

virtual float	uses_input (int) const

virtual void	build_splits ()

virtual int	split_input (int) const

virtual const OutputContext &	inputContext (int n, int offset, OutputContext &) const

virtual const OutputContext *	inputUIContext (int n, OutputContext &) const

virtual Op *	default_input (int) const

virtual bool	frameTransformImplemented () const

virtual bool	frameTransformDownstream (const OutputContext &context, unsigned int input, float inFrame, float &outFrame) const

virtual bool	frameTransformUpstream (const OutputContext &context, unsigned int input, float outFrame, float &inFrame) const

virtual DopeItemFlags::Mask	getDopeItemFlags () const

virtual bool	shouldHideInDopeSheet (Knob *knob) const

virtual DD::Image::Knob *	getDopeItemKnob () const

virtual ViewSet	viewsProduced () const

virtual ViewSet	viewsWantOn (int i) const

virtual ViewSet	splitForViews () const

bool	requested () const

void	setRequested ()

void	forgetRequestShallow ()

void	forget_request ()

void	forget_request (OpSet &forgotten)

virtual const char *	node_shape () const

DD::Image::Hash	curveHash () const

bool	opCurrent () const

virtual unsigned	node_color () const

virtual const char *	node_help () const =0

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

virtual std::string	input_longlabel (int) const

void	node_redraw ()

void	print_name (std::ostream &o) const

NodeContext	nodeContext () const

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

void	invalidateSameHash ()

bool	invalidate ()

bool	invalidate (const Hash &hash)

bool	update (const Box *=nullptr)

void	asapUpdate ()

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

void	validate (bool for_real=true)

virtual void	force_validate (bool for_real=true)

void	update_handles () const

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

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

bool	inErrorState () const

bool	inInvalidState () const

bool	opened () const

void	open ()

void	unopen ()

bool	running () const

void	running (bool v)

bool	not_closed () const

void	close ()

void	callCloseAfter (double seconds)

void	copyState (Op *input)

bool	cached () const

void	cached (bool b)

void	setRecycling (bool recycling)

bool	recycling () const

virtual bool	inUse () const

virtual Executable *	executable ()

void	setKnobsToContext (const OutputContext &, bool force=false)

void	gotoContext (const OutputContext &, bool update)

void	progressFraction (double fraction, StatusFlags flags=StatusNone)

void	progressFraction (int a, int b, StatusFlags flags=StatusNone)

void	progressMessage (const char *fmt,...)

void	progressModalMessage (const char *fmt,...)

void	progressDismiss ()

int	slowness () const

void	slowness (int newval)

virtual bool	firstEngineRendersWholeRequest () const

virtual bool	updateUI (const OutputContext &context)

const Format &	input_format () const

const OutputContext &	uiContext () const

void	error (const char *fmt,...)

void	warning (const char *fmt,...)

void	critical (const char *fmt,...)

void	debug (const char *fmt,...)

void	abort () const
	Abort all trees the op is in.

bool	aborted () const
	True if one of the trees the op is in was aborted; ops should check this while processing and return quickly when true.

void	cancel () const
	Cancel all trees the op is in. Make sure you also call abort() to stop processing.

bool	cancelled () const
	True if one of the trees the op is in was cancelled (by user interaction)

bool	addToTree (OpTree *lpTree)
	Returns true if the op was added to the tree, or false if its reference count increased.

bool	removeFromTree (OpTree *lpTree)
	Returns false if the op was removed from the tree, or true if its reference count decreased.

bool	isInTree (OpTree *lpTree) const
	Checks if an op is in a particular tree, for debugging purposes.

bool	isInAnyTree () const
	Checks if an op is in any tree at all.

OpTreeHandler *	getTreeHandler () const
	Returns the treeHandler for a given Op.

bool	hasError () const

bool	opOrChildHasError () const

const Op *	getErroredOp () const

void	setPopUpScheme (PopUpScheme lScheme)

PopUpScheme	getPopUpScheme () const

bool	arePopUpsEnabled ()
	Returns whether a pop-up should be enabled for the next message, modifying internal data when necessary.

OpMessageHandler &	getMsgHandler ()

const OpMessageHandler &	getMsgHandler () const

std::string	getDebugInfo () const
	Returns a string of debug information about the op. For internal use.

std::string	getDetailedDebugInfo () const

bool	tryValidate (bool for_real=true)

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

virtual const Iop *	iop () const

virtual ParticleOp *	particleOp ()
	Cast to a ParticleOp. This is much cheaper and safer than using dynamic_cast.

virtual const ParticleOp *	particleOp () const

virtual DeepOnlyOp *	deepOnlyOp ()
	Cast to a DeepOnlyOp. This is much cheaper and safer than using dynamic_cast.

virtual const DeepOnlyOp *	deepOnlyOp () const

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

virtual const AxisOp *	axisOp () const

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

virtual const AxisSceneOp *	axisSceneOp () const

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

virtual const CameraOp *	cameraOp () const

virtual CameraSceneOp *	cameraSceneOp ()
	Cast to an AxisSceneOp. This is much cheaper and safer than using dynamic_cast.

virtual const CameraSceneOp *	cameraSceneOp () const

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

virtual const LightOp *	lightOp () const

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

virtual const LightSceneOp *	lightSceneOp () const

virtual SceneOpI *	sceneOpI ()
	Cast to a SceneOpI, if Op has that interface.

virtual const SceneOpI *	sceneOpI () const

virtual GeometryProviderI *	geometryProvider ()
	Cast to a GeometryProviderI, if Op has that interface.

virtual const GeometryProviderI *	geometryProvider () const

virtual GeoOp *	geoOp ()
	Cast to a GeoOp. This is much cheaper and safer than using dynamic_cast.

virtual const GeoOp *	geoOp () const

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

virtual const GeomOp *	geomOp () const

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

virtual VersionInfo	getLibraryVersion () const

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

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

virtual bool	updateKnobsFromAsset (Knob *knob)

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

virtual const char *	Class () const =0

const std::string	libraryDisplayName () const

virtual const char *	displayName () const

virtual std::string	docsPath () const

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

Op *	get (const Description *description)

Public Member Functions inherited from DD::Image::LookAt
	LookAt (int defaultLookAxis=kAxisZPlus)

virtual Op *	lookat_input () const =0
	The lookat input op.

void	knobs (Knob_Callback f)
	Adds the 'Look' tab and knobs for all the look at options.

int	knobChanged (Op parent, Knob k)
	disables the look at input is not present

void	lookAt (Matrix4 &matrix)
	performs the look at on the incoming matrix

void	lookMatrixAt (const OutputContext &oc, Matrix4 &concatMatrix)
	performs the look at on the incoming matrix for a given context

Public Member Functions inherited from DD::Image::SceneOpI
	SceneOpI (fdk::AxisDirection defaultOrientAxis=fdk::AxisDirection::Z_PLUS)

virtual AxisOp *	getAxisOp ()=0

AxisSceneOp *	asAxisSceneOp ()
	Convenience to cast this interface's Op to an AxisSceneOp.

CameraSceneOp *	asCameraSceneOp ()
	Convenience to cast this interface's Op to a CameraSceneOp.

LightSceneOp *	asLightSceneOp ()
	Convenience to cast this interface's Op to a LightSceneOp.

virtual int32_t	sceneInput () const

virtual GeomOp *	sceneInputOp () const
	Return the sceneInput() input cast to a GeomOp, if possible. Default returns null.

virtual SceneOpI *	parentInputSceneOp () const
	Return the AxisOp::parentInput() input cast to a SceneOpI, if possible. Default returns null.

virtual SceneOpI *	constrainInputSceneOp () const
	Return the AxisOp::constrainInput() input cast to a SceneOpI, if possible. Default returns null.

SceneOpNodeI *	sceneOpNode () const
	Return the custom node owner.

virtual const usg::Token &	primarySchemaType () const =0

virtual usg::TokenArray	getAppliedApiSchemaTypes () const

virtual const usg::Path &	primPath () const
	Prim path to create/edit.

virtual const usg::Token &	parentPrimCreateType () const

virtual usg::Path	buildBasePrimPath () const

virtual const char *	primPathFilter () const

bool	readFromSceneEnabled () const
	Is the read from scene mode enabled?

bool	sourcePrimEnabled () const
	Returns true if there's a valid scene input prim to extract data from.

const usg::Path &	sourcePrimPath () const
	Prim path in source scene to read.

const SceneOpNodeI::ConfigParams &	params () const
	Returns the shared node configuration params.

const SceneOpNodeI::SceneData &	sceneData () const
	Returns the shared node scene data.

const usg::StageRef &	sourceStage () const
	Stage the prim data will be extracted from, if valid.

const usg::Prim &	sourcePrim () const
	Prim that data will be extracted from, if valid.

const AxisValsSet *	transformCache () const

const SceneOpNodeI::SharedData &	sharedData () const
	Returns the shared node data.

void	SetAuthoringProvider (Knob_Callback f, uint64_t componentId)
	Assigns the AuthoringProvider to the last created or stored knob.

void	SetAuthoringProvider (Knob_Callback f, Knob *knob, uint64_t componentId)
	Same, but with a knob specifier for a compound knob to supply, if needed.

void	SetAxisKnobAuthoringProvider (Knob_Callback f)

void	addAuthoringProvider (Knob k, AuthoringProvider provider)
	Add a value provider to the node shared list, which takes ownership of allocation.

AuthoringProvider *	getAuthoringProvider (Knob *k) const
	Retrieve an authoring provider by Knob.

const AuthoringProviderKnobMap &	getAuthoringProviderKnobMap () const

Knob *	opKnob (const char *name) const

virtual void	addImportOptionKnobs (Knob_Callback f)

virtual void	addXformExtractOptionKnobs (Knob_Callback f)

virtual void	addExportOptionKnobs (Knob_Callback f)

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

virtual void	addLocalParentXformKnobs (Knob_Callback f, bool addSyncOptions=true)

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

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

virtual void	addConstrainOptionsKnobs (Knob_Callback f)
	Adds the constrain option knobs.

virtual void	addExtraFrontPanelKnobs (Knob_Callback f)

const char *	localParentTranslateKnobName () const

const char *	localParentRotateKnobName () const

const char *	localParentScaleKnobName () const

const char *	localAxisKnobName () const

const char *	worldMatrixKnobName () const

Knob *	getLocalParentTranslateKnob () const
	Return the internal 'local_parent_translate' XYZ knob.

Knob *	getLocalParentRotateKnob () const
	Return the internal 'local_parent_rotate' XYZ knob.

Knob *	getLocalParentScaleKnob () const
	Return the internal 'local_parent_scale' XYZ knob.

Axis_KnobI *	getLocalAxisKnob () const
	Return internal 'transform' Axis_Knob for set/get internal local transformation.

ArrayKnobI *	getWorldMatrixKnob () const
	Return internal 'world_matrix' Array_Knob.

virtual void	setReadOnlyLocalParent (bool readOnly)
	Make read only the knobs the translate/rotate/scale knobs for the local parent xform.

virtual void	setReadOnlyLocalXform (bool readOnly)
	Make read only the knobs in the local xform section.

void	KnobDefinesGeometry (const Knob_Closure &f)

void	KnobModifiesAttribValues (const Knob_Closure &f)

GeometryProviderI *	asGeometryProvider () override
	GeometryProviderI: Allow subclasses to gain access to sibling functions.

fdk::Hash	geometryComposeState () override
	GeometryProviderI: Returns the compose state of the exportLayer.

fdk::Hash	geometryEditVersionState () override
	GeometryProviderI: Returns the edit state of the exportLayer.

bool	geometryStateVaries () override

bool	canProvideGeometryStage () const override
	GeometryProviderI: Provides a fully constructed usg::Stage via buildGeometryStage().

bool	canProvideGeometryFor (const usg::Token &purpose) const override

void	buildGeometryStage (usg::StageRef &stage, const usg::ArgSet &requestArgs={}, const fdk::TimeValueSet &sampleTimes=fdk::TimeValueSet()) override

void	writeScenePrimsToLayer (usg::LayerRef &layer, bool appendTo, const fdk::FrameValueSet &times)

Public Member Functions inherited from DD::Image::GeometryProviderI
virtual GeometryProviderI *	asGeometryProvider ()=0

virtual Op *	getGeometryProviderOp ()=0

Op *	getGeometryProviderOp () const
	Same as getGeometryProviderOp() but const.

virtual fdk::Hash	geometryComposeState ()=0

virtual fdk::Hash	geometryEditVersionState ()=0

virtual bool	geometryStateVaries ()=0

virtual usg::LayerRef	buildGeometryLayer (bool appendTo=false, const fdk::TimeValueSet &sampleTimes=fdk::TimeValueSet())=0

virtual usg::LayerRef	getGeometryLayer (const fdk::TimeValueSet &sampleTimes=fdk::TimeValueSet())

virtual bool	canProvideGeometryStage () const

virtual bool	canProvideGeometryFor (const usg::Token &purpose) const

virtual void	buildGeometryStage (usg::StageRef &stage, const usg::ArgSet &requestArgs, const fdk::TimeValueSet &sampleTimes=fdk::TimeValueSet())

virtual usg::StageRef	getGeometryStage (const fdk::TimeValueSet &sampleTimes=fdk::TimeValueSet())

Public Member Functions inherited from DD::Image::ConstrainOpI
	ConstrainOpI (fdk::FrameValue referenceFrame, fdk::AxisDirection defaultLookAxis=fdk::AxisDirection::Z_PLUS)

	ConstrainOpI (DD::Image::Op *op, fdk::AxisDirection defaultLookAxis=fdk::AxisDirection::Z_PLUS)

void	knobs (Knob_Callback f, Op *op)

int	knob_changed (Knob k, Op op)

const char *	input_label (char *buffer) const
	Returns the input label for the current constrain mode.

const char *	constraintKnobName () const

const char *	orientAxisKnobName () const

const char *	rotateXKnobName () const

const char *	rotateYKnobName () const

const char *	rotateZKnobName () const

const char *	strengthKnobName () const

const char *	applyTranslateKnobName () const

const char *	applyRotateKnobName () const

const char *	applyScaleKnobName () const

const char *	maintainOffsetFrameKnobName () const

const char *	maintainOffsetKnobName () const

const char *	setMaintainOffsetFrameToCurrentKnobName () const

ndk::ConstraintMatrixParams	getConstraintParametersFromKnobs (const OutputContext *context=nullptr) const

fdk::TimeValueSet	getNeededInputTimes (const fdk::TimeValueSet &requestedTimes) const
	Returns the times we need from inputs given the times that have been requested.

ndk::ConstraintMode	getConstraintType () const
	Gets the constraint type from the constraint knob.

bool	constraintMaintainOffset () const

Protected Member Functions
ndk::XformComponents	_getTransformComponentsAt (const OutputContext &context) const override

fdk::Mat4d	_getInputParentTransformAt (const OutputContext &context) const override

fdk::Mat4d	_getLocalParentAxisTransformAt (const OutputContext &context) const override

fdk::Mat4d	_getLocalAxisTransformAt (const OutputContext &context) const override

fdk::Mat4d	_getWorldTransformAt (const OutputContext &context) const override

void	_writeScenePrims (usg::LayerRef &layer, bool appendTo, const fdk::TimeValueSet &times=fdk::TimeValueSet()) override
	SceneOpI: Subclass portion of writeScenePrims().

bool	_isLegacyAxisOp () const override

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

Op *	create (Node node, const char name)

Op *	create (const char *name)

HandlesMode	anyInputHandles (ViewerContext *)
	return if any of the inputs (recursively) wish to draw handles

HandlesMode	anyKnobHandles (ViewerContext *)
	return if any of the knobs on this node wish to draw handles

void	build_input_handles (ViewerContext *)

void	build_knob_handles (ViewerContext *)

void	disallowNoTrees ()
	Call this to tell the op that it should always have op trees for normal behaviour (for internal use)

virtual HandlesMode	doAnyHandles (ViewerContext *ctx)

virtual void	_setRecycling (bool recycling)

virtual PrevalidateResult	doPreValidate (ViewerContext ctx=nullptr, PreValidateContext =nullptr)

Protected Member Functions inherited from DD::Image::LookAt
void	perform_lookat (Matrix4 &concatMatrix, const Matrix4 &axisMatrix)

Protected Member Functions inherited from DD::Image::SceneOpI
virtual AuthoringProvider *	_createAuthoringProvider (Knob *k, uint64_t componentId)

virtual fdk::Hash	buildSourceSceneState (const fdk::Hash &hash)

virtual void	getExtractKeyRange (SceneOpNodeI::SharedData &data, fdk::TimeValue &firstKey, fdk::TimeValue &lastKey)

virtual bool	extractSceneData (SceneOpNodeI::SharedData &data, const fdk::TimeValueSet &addlSampleTimes=fdk::TimeValueSet())

virtual void	extractSceneXformData (SceneOpNodeI::SharedData &data, AxisValsArray &axisValsSamples, bool &isDefaultXforms, const fdk::TimeValueSet &addlSampleTimes=fdk::TimeValueSet()) const

virtual AxisVals	getXformDataAt (SceneOpNodeI::SharedData &data, const OutputContext &context) const

virtual void	_validateTransforms (bool for_real, ndk::XformParameters &outputXformParams)

virtual void	_buildLocalTransforms (const ndk::XformComponents &xformComponents, fdk::Mat4d &preConstraintXform, const ndk::ConstraintMatrixParams &constraintParams, ndk::XformParameters &finalLocalXforms) const

virtual bool	_buildConstraintParams (AxisOp *constrainSourceOp, const ndk::XformComponents &xformComponents, fdk::Mat4d &preConstraintXform, ndk::ConstraintMatrixParams &constraintParams) const

virtual bool	_getLocalParentTransformAnimation (fdk::TimeValueSet keyTimes=nullptr, int32_t nAnimatedExpressions=nullptr, int32_t view=-1) const

virtual bool	_getLocalTransformAnimation (fdk::TimeValueSet keyTimes=nullptr, int32_t nAnimatedExpressions=nullptr, int32_t view=-1) const

virtual const ndk::XformComponents &	_getSceneOpTransformComponents () const
	Return the transform components built _validateTransforms().

virtual ndk::XformComponents	_getSceneOpTransformComponentsAt (const OutputContext &context) const
	Calculate the transform components at a specific OutputContext.

virtual const fdk::Mat4d &	_getSceneOpInputParentTransform () const
	Return the input parent transform built in _validateTransforms().

virtual fdk::Mat4d	_getSceneOpInputParentTransformAt (const OutputContext &context) const
	Calculate the input parent transform at a specific OutputContext.

virtual const fdk::Mat4d &	_getSceneOpLocalParentAxisTransform () const
	Return the local parent axis transform built in _validateTransforms().

virtual fdk::Mat4d	_getSceneOpLocalParentAxisTransformAt (const OutputContext &context) const
	Calculate the local parent axis transform at a specific OutputContext.

virtual const fdk::Mat4d &	_getSceneOpParentTransform () const
	Return the total local parent transform built in _validateTransforms().

virtual const fdk::Mat4d &	_getSceneOpLocalAxisTransform () const
	Return the local axis transform built in _validateTransforms().

virtual fdk::Mat4d	_getSceneOpLocalAxisTransformAt (const OutputContext &context) const
	Calculate the local axis transform at a specific OutputContext.

virtual const fdk::Mat4d &	_getSceneOpLocalTransform () const
	Return the total local transform built in _validateTransforms().

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

void	_sceneOpResetTargetState ()

void	_sceneOpUpdateScenePrimState (const DD::Image::Hash &newOpEditVersionHash)

void	_appendKnobToDefineGeometryTarget (Knob *k)

void	_appendKnobToModifyValuesTarget (Knob *k)

virtual int	_sceneOpKnobChanged (Knob *k, int32_t callAgain)

usg::LayerRef	buildGeometryLayer (bool appendTo, const fdk::TimeValueSet &sampleTimes) override

virtual void	_createParentPrims (usg::LayerRef &layer, const usg::Path &basePrimPath)

virtual void	_writeScenePrims (usg::LayerRef &layer, bool appendTo, const fdk::TimeValueSet &times=fdk::TimeValueSet())=0

virtual void	_writeTransformOps (usg::LayerRef &layer, usg::XformablePrim &xformable, bool appendTo, const fdk::FrameValueSet &times=fdk::FrameValueSet())

bool	writeKnob (const char *knobName, const fdk::FrameValueSet &times, usg::Prim &outputPrim, const usg::Token &targetPropertyName, usg::Value::Type targetPropertyTypeHint) const

bool	writeKnob (const char *knobName, bool ignoreDefaultTest, const fdk::FrameValueSet &times, usg::Prim &outputPrim, const usg::Token &targetPropertyName, usg::Value::Type targetPropertyTypeHint) const

bool	writeKnob (Knob *knob, bool ignoreDefaultTest, const fdk::FrameValueSet &times, usg::Prim &outputPrim, const usg::Token &targetPropertyName, usg::Value::Type targetPropertyTypeHint) const
	Same but with a Knob*.

bool	writeKnob (const ArrayKnobRefList &knobRefs, bool ignoreDefaultTest, const fdk::FrameValueSet &times, usg::Prim &outputPrim, const usg::Token &targetPropertyName, usg::Value::Type targetPropertyType) const

bool	writeInputOpAsAssetPath (int32_t input, const fdk::FrameValueSet &times, usg::Prim &outputPrim, const usg::Token &targetPropertyName) const
	Write an input Op connection as an AssetPath, typically for texture sources.

Additional Inherited Members
Public Types inherited from DD::Image::Op
enum	HandlesMode { eNoHandles , eHandlesUncooked , eHandlesCooked , eHandlesMax }

enum	PrevalidateResult { eFinished , eCancelled , eAbandoned }
	This is a tribool return value. Do not extend.

enum	HandleType { eNone , eMouseLeftClick , eMouseRightClick , eMouseMove , eMouseDrag , eMouseRelease , eSelectionChanged , eSelectionChangeFinished , eHandleDragTranslate , eHandleDragRotate , eHandleDragScale , eHandleDragPivot , eAllHandles }

enum	ViewableModes { eViewableMode2D , eViewableMode3D , eViewableMode3D_2DReference }

enum	GenerateType { OUTPUT_OP , ANY_CONTEXT , INPUT_OP , INPUT_OP_PEEK , EXECUTABLE , EXECUTABLE_SKIP , EXECUTABLE_INPUT , UICONTEXT_ONLY }

enum	NodeContext { eNodeGraph , eTimeline , eOpGraph }

enum	StatusFlags { StatusNone , StatusModal , StatusUseCallback }

enum	PopUpScheme { ePU_Never , ePU_Done , ePU_Once , ePU_Default , ePU_Always }
	Pop-up schemes determine when pop-up messages are displayed for op errors. More...

enum	VersionComponents { eMajor , eMinor , ePoint , eRevision }
	Enum to help get the desired version component from the VersionInfo tuple.

using	InputList = std::vector< Input >

using	InputConnectionContext = std::pair< Input, OutputContext >
	Combination of Op input and the OutputContext it is being referenced at.

using	InputConnectionContextList = std::vector< InputConnectionContext >

using	Output = std::pair< int, DD::Image::Op * >
	Combination of input number and pointer to downstream Op input is on.

using	OutputSet = std::set< Output >
	Set of all outputs from this Op.

typedef std::map< Hash, std::vector< unsigned int > >	ItemSelectionList

typedef bool()	EventCallback(Op *op, EventContext eventCtx)

using	VersionInfo = std::tuple< int, int, int, int >
	Contains version components with each index defined by the VersionComponents enum.

Public Types inherited from DD::Image::SceneOpI
enum	{ TIME , PARENT_T , PARENT_R , PARENT_S , XFORM_ORDER , ROT_ORDER , TRANSLATE , ROTATE , SCALE , UNIFORM_SCALE , SKEW , PIVOT_T , PIVOT_R , LAST_XFORM_PARAM }
	Which component of an AxisVals to provide.

enum	{ PARENT_XFORM , PARENT_SCOPE , PARENT_NONE }
	Parent prim creation modes.

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 Op *	create (Node node, const char name, Op *p_op)

static Op *	create (const char name, Op p_op)

static void	resetTimers ()
	reset all the performance timers

static void	setTimingEnabled (bool enabled)
	turn performance timing on or off

static bool	isTimingEnabled ()
	return whether performance timing is on or not

static const char *	script_result (bool py=false)

static void	script_unlock ()

static Op *	BuildOpAt (Op *baseOp, const OutputContext &context, GenerateType type=EXECUTABLE_SKIP)

static Op *	retrieveOp (const char node_path, GenerateType generate_op_type, const OutputContext generate_op_context=nullptr)

static Op *	retrieveOp (const char *node_path, const Hash &op_hash, int tree_version)

static void	all_forget_request ()

static void	new_request_pass ()

static double	callPendingClose (double seconds)

static void	clearPendingClose ()

static Op *	error_op ()

static const char *	error_message ()

static void	clearAbortAndError ()
	To be removed.

static void	SetDefaultPopUpEnable (bool lEnable)
	This is used by Nuke to indicate when ops using the default pop-up scheme should show pop-ups. Not recommended for customisation.

static std::string	getVersionInfoStr (const VersionInfo &versionInfo)
	Helper function to convert a VersionInfo tuple into a string.

static const Description *	find_description (const char name, const Op op_)

static int	message_f (char t, const char *,...)

static int	message_vf (char t, const char *, va_list)

static void	add_timeout (float t, TimeoutHandler, void *v=nullptr)

static void	repeat_timeout (float t, TimeoutHandler, void *=nullptr)

static bool	has_timeout (TimeoutHandler, void *=nullptr)

static void	remove_timeout (TimeoutHandler, void *=nullptr)

Static Public Member Functions inherited from DD::Image::SceneOpI
static std::string	localAxisXformOpName (const Op *op)
	Returns the name of the local axis xformOp for the xform given by Op.

static std::string	localParentXformOpName (const Op *op)
	Returns the name of the local parent xformOp for the xform given by Op.

Static Public Member Functions inherited from DD::Image::GeometryProviderI
static void	BuildStage (usg::StageRef &stage, const usg::ArgSet &requestArgs, const OpGraphLocation &geometryProviderOp, const fdk::TimeValueSet &sampleTimes)

static void	BuildStage (usg::StageRef &stage, const OpGraphLocation &geometryProviderOp, const fdk::TimeValueSet &sampleTimes)
	Same as buildStage(OpSet) but with no request args.

static void	BuildStage (usg::StageRef &stage, const OpGraphLocation &geometryProviderOp, const fdk::TimeValue &sampleTime)
	Same as buildStage(OpSet) but with only one sample time.

Static Public Member Functions inherited from DD::Image::ConstrainOpI
static fdk::AxisDirection	GetLookAxis (int lookAxisIndex)

Public Attributes inherited from DD::Image::AxisOp
Matrix4 &	const

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

Hash	metaCacheHash

Op *	op

Op int	input

Op int int	offset

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::SceneOpI
static bool	BuildConstraintParamsAt (const SceneOpI *sceneOp, const OutputContext &context, const ndk::XformComponents &xformComponents, fdk::Mat4d &preConstraintXform, ndk::ConstraintMatrixParams &constraintParams)

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

Protected Attributes inherited from DD::Image::SceneOpI
ndk::XformComponents	_xformComponents
	Transform components.

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

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

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

SnapKnobs	_snapKnobs
	Snap menu options.

bool	_applyConstraintToParent
	Snap/constraint is applied to the local parent, not the local axis.

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

DD::Image::Hash	_constrainHash
	The hash for the constrain input set in validate().

WorldMatrixProvider *	_worldXformProvider
	'world_matrix' output knob - valid ONLY on firstOp()!

SceneOpNodeI *	_sceneOpNode
	Node owner, set by SceneOpNode.

Protected Attributes inherited from DD::Image::ConstrainOpI
Knob *	_constraintKnob

Knob *	_lookAxisKnob

Knob *	_strengthKnob

Knob *	_rotateXKnob

Knob *	_rotateYKnob

Knob *	_rotateZKnob

Knob *	_applyTranslateKnob

Knob *	_applyRotateKnob

Knob *	_applyScaleKnob

Knob *	_maintainOffsetFrameKnob

Knob *	_maintainOffsetKnob

Knob *	_setMaintainOffsetFrameToCurrentKnob

int	_constraint

fdk::AxisDirection	_lookAxis

bool	_rotateX

bool	_rotateY

bool	_rotateZ

double	_strength

bool	_applyTranslate

bool	_applyRotate

bool	_applyScale

bool	_maintainOffset

float	_maintainOffsetFrame

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

Detailed Description

AxisSceneOp is the base class for all the 3D 'scene' objects like locators (usg::XformPrim), cameras (usg::CameraPrim) and lights which are translatable to USD prims.

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

◆ axisSceneOp() [1/2]

const AxisSceneOp * DD::Image::AxisSceneOp::axisSceneOp ( ) const

inlineoverridevirtual

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

Reimplemented from DD::Image::Op.

◆ axisSceneOp() [2/2]

AxisSceneOp * DD::Image::AxisSceneOp::axisSceneOp ( )

inlineoverridevirtual

Reimplemented from DD::Image::Op.

◆ parentInput()

int32_t DD::Image::AxisSceneOp::parentInput ( ) const

inlineoverridevirtual

AxisOp: Return the node input to use for the parent axis source. Defaults to input 0.

Reimplemented from DD::Image::AxisOp.

Referenced by parentInputSceneOp().

◆ sceneInput()

int32_t DD::Image::AxisSceneOp::sceneInput ( ) const

inlineoverridevirtual

SceneOpI: Return the node input to use for the scene source. Defaults to input 1.

Reimplemented from DD::Image::SceneOpI.

Referenced by sceneInputOp().

◆ constrainInput()

int32_t DD::Image::AxisSceneOp::constrainInput ( ) const

inlineoverridevirtual

SceneOpI: Return the node input to use for the parent axis source. Defaults to input 2.

Reimplemented from DD::Image::AxisOp.

Referenced by constrainInputSceneOp().

◆ parentInputSceneOp()

SceneOpI * AxisSceneOp::parentInputSceneOp ( ) const

overridevirtual

SceneOpI: Return the parentInput() input cast to a SceneOpI, if possible.

Reimplemented from DD::Image::SceneOpI.

References parentInput().

Referenced by _writeScenePrims().

◆ sceneInputOp()

GeomOp * AxisSceneOp::sceneInputOp ( ) const

overridevirtual

SceneOpI: Return the sceneInput() input cast to a GeomOp, if possible.

Reimplemented from DD::Image::SceneOpI.

References sceneInput().

◆ constrainInputSceneOp()

SceneOpI * AxisSceneOp::constrainInputSceneOp ( ) const

overridevirtual

SceneOpI: Return the AxisOp::constrainInput() input cast to a SceneOpI, if possible.

Reimplemented from DD::Image::SceneOpI.

References constrainInput().

◆ primarySchemaType()

const usg::Token & DD::Image::AxisSceneOp::primarySchemaType ( ) const

inlineoverridevirtual

SceneOpI: Return the name of the primary USD schema this node is handling.

Implements DD::Image::SceneOpI.

◆ primPathFilter()

const char * DD::Image::AxisSceneOp::primPathFilter ( ) const

inlineoverridevirtual

SceneOpI: Return the default filter string to apply in the prim path knob.

Reimplemented from DD::Image::SceneOpI.

◆ minimum_inputs()

int AxisSceneOp::minimum_inputs ( ) const

overridevirtual

Default is 3: axis, scene and constrain.

Reimplemented from DD::Image::AxisOp.

◆ maximum_inputs()

int AxisSceneOp::maximum_inputs ( ) const

overridevirtual

Default is 3: axis, scene and constrain.

Reimplemented from DD::Image::AxisOp.

◆ optional_input()

int AxisSceneOp::optional_input ( ) const

overridevirtual

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

Reimplemented from DD::Image::AxisOp.

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

◆ test_input()

bool AxisSceneOp::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::AxisOp.

◆ default_input()

Op * AxisSceneOp::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::AxisOp.

◆ input_label()

const char * AxisSceneOp::input_label	(	int	node_input,
		char *	buf
	)		const

overridevirtual

Reimplemented from DD::Image::AxisOp.

◆ knobs()

void AxisSceneOp::knobs ( Knob_Callback f )

overridevirtual

Reimplemented from DD::Image::AxisOp.

◆ addDisplayOptionsKnobs()

void AxisSceneOp::addDisplayOptionsKnobs ( Knob_Callback f )

overridevirtual

Reimplemented from DD::Image::SceneOpI.

◆ _knobStorePrep()

void AxisSceneOp::_knobStorePrep ( const OutputContext & opStoreContext )

overridevirtual

Called by Nuke just BEFORE Op::knobs(EARLY_STORE). This is used to update the scene importer and exporter states.

We use _knobStorePrep() to reset the exporter local GeomStateTargets that are built from Knobs during the store pass.

Reimplemented from DD::Image::Op.

References DD::Image::Op::_knobStorePrep(), and DD::Image::SceneOpI::_sceneOpResetTargetState().

◆ _knobStorePost()

void AxisSceneOp::_knobStorePost	(	const OutputContext &	opStoreContext,
		Hash &	newOpHash,
		Hash &	newOpEditVersionHash
	)

overridevirtual

Called by Nuke immediately AFTER Op::knobs(). This is used to update the scene importer and exporter states.

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

Reimplemented from DD::Image::Op.

References DD::Image::Op::_knobStorePost(), and DD::Image::SceneOpI::_sceneOpUpdateScenePrimState().

◆ knob_changed()

int AxisSceneOp::knob_changed ( Knob * k )

overridevirtual

Reimplemented from DD::Image::AxisOp.

◆ _validate()

void AxisSceneOp::_validate ( bool for_real )

overridevirtual

Reimplemented from DD::Image::AxisOp.

◆ localParentAxisTransform()

const fdk::Mat4d & DD::Image::AxisSceneOp::localParentAxisTransform ( ) const

inlineoverridevirtual

Local parent axis transform matrix.

Reimplemented from DD::Image::AxisOp.

◆ setLocalParentAxisTransform()

void DD::Image::AxisSceneOp::setLocalParentAxisTransform ( const fdk::Mat4d & localParent )

inlineoverridevirtual

Set the local parent axis transform matrix. Note this only persists until the next knobs()/validate() pass.

Reimplemented from DD::Image::AxisOp.

◆ localAxisTransform()

const fdk::Mat4d & DD::Image::AxisSceneOp::localAxisTransform ( ) const

inlineoverridevirtual

Result of the local-axis TRS Axis_Knob (without lookat rotations.) Calculated in _validateTransforms().

Reimplemented from DD::Image::AxisOp.

◆ setLocalAxisTransform()

void DD::Image::AxisSceneOp::setLocalAxisTransform ( const fdk::Mat4d & localAxis )

inlineoverridevirtual

Set the local axis transform matrix. Note this only persists until the next knobs()/validate() pass.

Reimplemented from DD::Image::AxisOp.

◆ localParentTransformVaries()

bool DD::Image::AxisSceneOp::localParentTransformVaries ( ) const

inlineoverridevirtual

Does the local parent transform animate? This is only an indicator that the transform -MAY- vary in time, not that its value actually does.

Reimplemented from DD::Image::AxisOp.

◆ localTransformVaries()

bool DD::Image::AxisSceneOp::localTransformVaries ( ) const

inlineoverridevirtual

Does the local transform animate? This is only an indicator that the transform -MAY- vary in time, not that its value actually does.

Reimplemented from DD::Image::AxisOp.

◆ doAnyHandles()

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

overridevirtual

Reimplemented from DD::Image::Op.

◆ build_handles()

void AxisSceneOp::build_handles ( ViewerContext * ctx )

overridevirtual

This default version will always cause draw_handle() to be called when in 3D mode.

Reimplemented from DD::Image::Op.

References DD::Image::AxisOp::_editable, DD::Image::SceneOpI::_xformComponents, DD::Image::AxisOp::_xformParams, DD::Image::Op::add_draw_handle(), DD::Image::Op::build_input_handles(), DD::Image::Op::build_knob_handles(), DD::Image::ViewerContext::expand_bbox(), DD::Image::ViewerContext::modelmatrix, DD::Image::Op::node_disabled(), DD::Image::Op::node_selected(), DD::Image::Op::nodeName(), DD::Image::ViewerContext::transform_mode(), DD::Image::Op::validate(), DD::Image::VIEWER_2D, and DD::Image::ViewerContext::viewer_mode().

◆ draw_handle()

void AxisSceneOp::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.

References DD::Image::AxisOp::_xformParams, DD::Image::ViewerContext::display3d(), DD::Image::ViewerContext::draw_hidden_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(), and DD::Image::ViewerContext::selected_color().

◆ getAxisOp()

AxisOp * DD::Image::AxisSceneOp::getAxisOp ( )

inlineoverridevirtual

SceneOpI: Return the AxisOp the interface is attached to.

Implements DD::Image::SceneOpI.

◆ sceneOpI() [1/2]

SceneOpI * DD::Image::AxisSceneOp::sceneOpI ( )

inlineoverridevirtual

Cast to a SceneOpI.

Reimplemented from DD::Image::Op.

◆ sceneOpI() [2/2]

const SceneOpI * DD::Image::AxisSceneOp::sceneOpI ( ) const

inlineoverridevirtual

Reimplemented from DD::Image::Op.

◆ getGeometryProviderOp()

Op * DD::Image::AxisSceneOp::getGeometryProviderOp ( )

inlineoverridevirtual

GeometryProviderI: Return the Op the interface is attached to.

Implements DD::Image::GeometryProviderI.

◆ geometryProvider() [1/2]

GeometryProviderI * DD::Image::AxisSceneOp::geometryProvider ( )

inlineoverridevirtual

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

Reimplemented from DD::Image::Op.

◆ geometryProvider() [2/2]

const GeometryProviderI * DD::Image::AxisSceneOp::geometryProvider ( ) const

inlineoverridevirtual

Reimplemented from DD::Image::Op.

◆ buildBasePrimPath()

usg::Path AxisSceneOp::buildBasePrimPath ( ) const

overridevirtual

SceneOpI: Prepends the parent connection if there is one.

Reimplemented from DD::Image::SceneOpI.

References buildXformSchemaPrimPath().

Referenced by _writeScenePrims().

◆ buildXformSchemaPrimPath()

usg::Path AxisSceneOp::buildXformSchemaPrimPath ( ) const

virtual

Builds a path from buildBasePrimPath(), appending the Node displayName() to use as the Xform schema's prim name.

For example if the Node class name is 'MyCustomXform_v4' we want it to show up in the scenegraph as 'MyCustomXform', while the custom schema name may be 'ProjectionXform'.

References DD::Image::SceneOpI::buildBasePrimPath().

Referenced by buildBasePrimPath().

◆ _getTransformComponentsAt()

ndk::XformComponents AxisSceneOp::_getTransformComponentsAt ( const OutputContext & context ) const

overrideprotectedvirtual

Calculate the transform components of this node at a specific OutputContext. Subclass implementation of GetTransformComponentsAt(AxisOp), redirects to SceneOpI::_getSceneOpTransformComponentsAt().

Reimplemented from DD::Image::AxisOp.

References DD::Image::SceneOpI::_getSceneOpTransformComponentsAt().

◆ _getInputParentTransformAt()

Mat4d AxisSceneOp::_getInputParentTransformAt ( const OutputContext & context ) const

overrideprotectedvirtual

Calculate the input parent transform of this node at a specific OutputContext. Subclass implementation of GetInputParentTransformAt(AxisOp), redirects to SceneOpI::_getSceneOpInputParentTransformAt().

Reimplemented from DD::Image::AxisOp.

References DD::Image::SceneOpI::_getSceneOpInputParentTransformAt().

◆ _getLocalParentAxisTransformAt()

Mat4d AxisSceneOp::_getLocalParentAxisTransformAt ( const OutputContext & context ) const

overrideprotectedvirtual

Calculate the local parent transform of this node at a specific OutputContext. Subclass implementation of GetLocalParentAxisTransformAt(AxisOp), redirects to SceneOpI::_getSceneOpLocalParentAxisTransformAt().

Reimplemented from DD::Image::AxisOp.

References DD::Image::SceneOpI::_getSceneOpLocalParentAxisTransformAt().

◆ _getLocalAxisTransformAt()

Mat4d AxisSceneOp::_getLocalAxisTransformAt ( const OutputContext & context ) const

overrideprotectedvirtual

Calculate the local axis transform of this node at a specific OutputContext. Subclass implementation of GetLocalAxisTransformAt(AxisOp), redirects to SceneOpI::_getSceneOpLocalAxisTransformAt().

Reimplemented from DD::Image::AxisOp.

References DD::Image::SceneOpI::_getSceneOpLocalAxisTransformAt().

◆ _getWorldTransformAt()

Mat4d AxisSceneOp::_getWorldTransformAt ( const OutputContext & context ) const

overrideprotectedvirtual

Calculate the world transform of this node at a specific OutputContext. Subclass implementation of GetWorldTransformAt(AxisOp), redirects to SceneOpI::_getSceneOpWorldTransformAt().

Reimplemented from DD::Image::AxisOp.

References DD::Image::SceneOpI::_getSceneOpWorldTransformAt().

◆ _writeScenePrims()

void AxisSceneOp::_writeScenePrims	(	usg::LayerRef &	layer,
		bool	appendTo,
		const fdk::TimeValueSet &	times = `fdk::TimeValueSet()`
	)

overrideprotectedvirtual

SceneOpI: Subclass portion of writeScenePrims().

Implements DD::Image::SceneOpI.

References DD::Image::SceneOpI::_createParentPrims(), DD::Image::SceneOpI::_sceneOpNode, DD::Image::SceneOpI::_writeTransformOps(), buildBasePrimPath(), DD::Image::Op::nodeName(), DD::Image::Op::parent(), and parentInputSceneOp().

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ axisSceneOp() [1/2]

◆ axisSceneOp() [2/2]

◆ parentInput()

◆ sceneInput()

◆ constrainInput()

◆ parentInputSceneOp()

◆ sceneInputOp()

◆ constrainInputSceneOp()

◆ primarySchemaType()

◆ primPathFilter()

◆ minimum_inputs()

◆ maximum_inputs()

◆ optional_input()

◆ test_input()

◆ default_input()

◆ input_label()

◆ knobs()

◆ addDisplayOptionsKnobs()

◆ _knobStorePrep()

◆ _knobStorePost()

◆ knob_changed()

◆ _validate()

◆ localParentAxisTransform()

◆ setLocalParentAxisTransform()

◆ localAxisTransform()

◆ setLocalAxisTransform()

◆ localParentTransformVaries()

◆ localTransformVaries()

◆ doAnyHandles()

◆ build_handles()

◆ draw_handle()

◆ getAxisOp()

◆ sceneOpI() [1/2]

◆ sceneOpI() [2/2]

◆ getGeometryProviderOp()

◆ geometryProvider() [1/2]

◆ geometryProvider() [2/2]

◆ buildBasePrimPath()

◆ buildXformSchemaPrimPath()

◆ _getTransformComponentsAt()

◆ _getInputParentTransformAt()

◆ _getLocalParentAxisTransformAt()

◆ _getLocalAxisTransformAt()

◆ _getWorldTransformAt()

◆ _writeScenePrims()