#include <GeomOp.h>

Inheritance diagram for DD::Image::GeomOp:

Public Member Functions
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)

Static Public Member Functions
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)

Protected Member Functions
	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)

Static Protected Member Functions
template<class Engine >
static GeomOpEngine::Builder	BuildEngine ()
	A helper function you can use as the engineBuilder argument to the GeomOp constructor to reduce clutter.

Protected Attributes
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.

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.

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

Hash	metaCacheHash

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

Detailed Description

Base class for an Op that processes a usg::Stage containing scenegraph and 3D geometry data.

This Op subclass acts somewhat different from other Nuke Ops as it actively avoids processing in a time/view sampled mode. Since stage scenegraph prims and attributes contain their own time sampled values and don't support Nuke's concept of 'views', Nuke's default behavior of splitting Ops into explicit time/view instances means there is no obvious 'primary' or principal GeomOp to process the scenegraph with. For example if a TimeWarp node asks Nuke for five split input GeomOps at different times Nuke will create those GeomOps and sample their Knobs at each unique time. Normally each of those GeomOps are not aware of each other and would need to individually process the scenegraph to produce their output, possibly doing 4x more work than neccessary.

To avoid this all GeomOps Nuke creates from the same Node share a single GeomOpEngine subclass which is what does the actual scenegraph processing. If any of the GeomOps are asked to build a stage the same GeomOpEngine instance is used, the same stage object processes, and the results cached so the next GeomOp will produce the same result.

The scene data is created by calling the static GeomOp::buildStage() method with the set of GeomOps constituting the 'request set' which is typically the set of input GeomOps feeding into the consumer node - ie. a viewer, renderer, etc. Combining the OutputContexts of all GeomOps in the set defines the frames & views that the stage should be explicitly evaluated for in the GeomOpEngines, however the GeomOpEngine is not restricted to only processing those times & views. For example if a renderer intends to output a single linear motionblur step it would request two GeomOps, one at shutter-open and one at shutter-close, but each GeomOpEngine is free to create no requested samples, all the requested samples, more samples than was requested, etc.

The primary advantage of this 'timeless' scheme is that Prims passing through the GeomOpEngines are not stripped of their existing time samples or restricted to just the requested set. So if an animated mesh is imported and then transformed, the GeomOpEngine applying the transform does not automatically strip the imported Prims of their animation data which is then made available to the downstream consumer regardless of the explicitly requested time samples.

Constructor & Destructor Documentation

◆ GeomOp()

GeomOp::GeomOp	(	Node *	node,
		GeomOpEngine::Builder	engineBuilder
	)

protected

Base class constructor requires a GeomOpEngine builder method, only subclasses can create an instance. The Engine builder method is usually declared in a GeomOp subclass like so:

class MyGeomOp : public GeomOp { class MyEngine : public Engine { MyEngine(Op* parent) : Engine(parent) {}

void processScenegraph(usg::GeomSceneContext& context) override { do something cool } }; static Engine* engineBuilder(Op* parent) { return new MyEngine(parent); }

MyGeomOp(Node* node) : GeomOp(node, engineBuilder) {} };

References _engineNode.

Member Function Documentation

◆ opHints()

OpHints GeomOp::opHints ( ) const

overrideprotectedvirtual

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

Reimplemented from DD::Image::Op.

References DD::Image::eIgnore, and DD::Image::eIgnoreInputs.

◆ geomOp() [1/2]

const GeomOp * DD::Image::GeomOp::geomOp ( ) const

inlineoverridevirtual

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

Reimplemented from DD::Image::Op.

Referenced by buildXformHandles().

◆ geomOp() [2/2]

GeomOp * DD::Image::GeomOp::geomOp ( )

inlineoverridevirtual

Reimplemented from DD::Image::Op.

◆ node_shape()

const char * GeomOp::node_shape ( ) const

overridevirtual

Draw a round sided box.

Reimplemented from DD::Image::Op.

◆ node_color()

unsigned GeomOp::node_color ( ) const

overridevirtual

Reimplemented from DD::Image::Op.

◆ minimum_inputs()

int DD::Image::GeomOp::minimum_inputs ( ) const

inlineoverridevirtual

Minimum number of Node inputs for this class - GeomOp base class has only one input.

Reimplemented from DD::Image::Op.

Reimplemented in DD::Image::SourceGeomOp.

◆ maximum_inputs()

int DD::Image::GeomOp::maximum_inputs ( ) const

inlineoverridevirtual

Maximum number of Node inputs for this class.

Reimplemented from DD::Image::Op.

Reimplemented in DD::Image::SourceGeomOp.

◆ default_input()

Op * GeomOp::default_input ( int node_input ) const

overridevirtual

Return a default NullGeomOp op for Node input0.

Reimplemented from DD::Image::Op.

Reimplemented in DD::Image::SourceGeomOp.

Referenced by DD::Image::SourceGeomOp::default_input().

◆ test_input()

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

overridevirtual

Allows only GeomOp inputs by default.

Reimplemented from DD::Image::Op.

Reimplemented in DD::Image::SourceGeomOp.

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

◆ AppendKnobToTarget() [1/2]

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

virtual

Correlate a Knob value with a GeomOpEngine manipulation, specified by the GeomStateTarget target_id identifier.

This method associates the Knob with a named GeomStateTarget owned by the GeomOpEngine which then affects the engine's local GeomState. The current edit state and hash of the knob, calculated during Knob::store(), is appended to the version state and hash of the named target.

Call this in the knobs() method right after defining a knob which is intended to affect the geometry output in some way.

For example in the knobs() method of a GeomOp subclass that wants a 'scale' parameter to modify existing Prim attributes: XYZ_knob(f, &params.scale.x, "scale"); AppendKnobToTarget(f, usg::EngineTokens.target.modifyValues);

The GeomOpEngine class has built-in targets which trigger GeomState flags: 'define-geometry' (usg::EngineTokens.target.defineGeometry) 'modify-values' (usg::EngineTokens.target.modifyValues) 'edit-stage' (usg::EngineTokens.target.editStage) 'affect-stereo' (usg::EngineTokens.target.affectStereo) See usg::GeomStateTarget for more info.

You must do this after the knob to be bound's declaration, as the Knob_Callback var passed to the declaration method (Int_knob(f), XYZ_knob(f), etc) contains the results from the most recent knob store(), like the frame, view and edit state of the knob. This info is used during binding to track the animation state of the knob.

References _engineNode, and appendToTarget().

Referenced by DD::Image::AxisOp::addCreateOptionsKnobs(), DD::Image::AxisOp::addLocalParentingKnobs(), DD::Image::AxisOp::addLocalXformKnobs(), and DD::Image::SourceGeomOp::knobs().

◆ AppendKnobToTarget() [2/2]

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

virtual

Like AppendKnobToTarget() but for knobs with no current Op OutputContext (ie no frame or view.) Intended for global non-animating Node knobs like 'name' and 'tile_color'.

References _engineNode, DD::Image::Knob::append(), appendToTarget(), DD::Image::Knob::editState(), DD::Image::Knob::isAnimated(), and DD::Image::Op::knob().

◆ KnobDefinesGeometry()

void DD::Image::GeomOp::KnobDefinesGeometry ( const Knob_Closure & f )

inline

Use this method if the Knob's value will affect the 3D scenegraph topology by adding/removing Prims or Attributes, or by changing their names or paths in the scenegraph.

Convenience method that calls AppendKnobToTarget() with the 'define-geometry' target.

Important note - knob changes affecting the GeomState::defineGeometryState will cause Stage recomposition whenever the Knob's value changes. Stage recomposition can be expensive (slow) so ONLY bind this knob to GeomState::defineGeometryState when stage recomposition is absolutely required. If the knob is just changing the contents of an existing attribute rather than explicitly creating that attribute, use KnobModifiesAttribValues() instead.

Referenced by DD::Image::AxisOp::addCreateOptionsKnobs(), DD::Image::AxisOp::addFileImportKnobs(), and DD::Image::SourceGeomOp::knobs().

◆ KnobModifiesAttribValues()

void DD::Image::GeomOp::KnobModifiesAttribValues ( const Knob_Closure & f )

inline

Use this method if the Knob's value is changing the contents of an existing attribute. The most common type of geometry manipulation.

Convenience method that calls AppendKnobToTarget() with the 'modify-values' target and appendToDefineGeometryTarget() with the Knob's authoring mode.

Referenced by DD::Image::CameraOp::addProjectionKnobs(), DD::Image::CameraOp::addShutterKnobs(), and DD::Image::AxisOp::createAxisOpKnobs().

◆ KnobEditsLayer()

void DD::Image::GeomOp::KnobEditsLayer ( const Knob_Closure & f )

Use this method if the Knob's value is performing non-specific changes to the engine's editLayer().

Convenience method that calls AppendKnobToTarget() with the 'edit-layer' target.

◆ KnobEditStage()

void DD::Image::GeomOp::KnobEditStage ( const Knob_Closure & f )

inline

Use this method if the Knob's value is performing non-specific changes to the stage passing through, or generated by, the engine.

Convenience method that calls AppendKnobToTarget() with the 'edit-stage' target.

◆ getKnobValue()

template<typename T >

T DD::Image::GeomOp::getKnobValue	(	const char *	knob_name,
		const OutputContext &	context,
		const T &	default_value
	)		const

inline

Convenience to get a Knob pointer and retrieve its value in one step. See Knob::get() for more info. Same as calling: T value; Knob* k = knob("foo"); if (k) value = k->get<T>(context);

References DD::Image::Knob::get(), and DD::Image::GeomOpEngine::knob().

◆ setKnobValue()

template<typename T >

bool DD::Image::GeomOp::setKnobValue	(	const char *	knob_name,
		const T &	value,
		double	time,
		int32_t	element_offset = `0`,
		int32_t	view = `-1`
	)

inline

Convenience to get a Knob pointer and set its value in one step. See Knob::set() for more info. Same as calling: Knob* k = knob("foo"); if (k) k->set(value, time, element_offset, view); Return true on success.

References DD::Image::GeomOpEngine::knob(), and DD::Image::Knob::set().

◆ setKnobValues()

template<typename T >

bool DD::Image::GeomOp::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`
	)

inline

Convenience to get a Knob pointer and set its values in one step. See Knob::set() for more info. Same as calling: Knob* k = knob("foo"); if (k) k->set(clear_keys, values, times, element_offset, view); Return true on success.

References DD::Image::GeomOpEngine::knob(), and DD::Image::Knob::set().

◆ inputContext()

const OutputContext & GeomOp::inputContext	(	int	node_input,
		int	offset,
		OutputContext &	scratch_ctx
	)		const

overridevirtual

Reimplemented from DD::Image::Op.

◆ inputUIContext()

const OutputContext * GeomOp::inputUIContext	(	int	node_input,
		OutputContext &	scratch_ctx
	)		const

overridevirtual

Reimplemented from DD::Image::Op.

◆ selectable()

bool GeomOp::selectable ( ) const

virtual

Whether the geometry the node is managing should be selectable in the Viewer. Base class returns true.

◆ build_handles()

void GeomOp::build_handles ( ViewerContext * ctx )

overridevirtual

Reimplemented from DD::Image::Op.

Reimplemented in DD::Image::SourceGeomOp.

◆ buildXformHandles() [1/2]

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

virtual

Build_handles with the context model matrix multiplied by the (global) local matrix so nodes up the tree are displayed correctly.

References buildXformHandles().

Referenced by DD::Image::SourceGeomOp::build_handles(), and buildXformHandles().

◆ buildStage()

void GeomOp::buildStage	(	usg::StageRef &	stage,
		const usg::ArgSet &	request_args,
		GeomOp *	geop0,
		GeomOp *	geop1 = `nullptr`,
		const fdk::TimeValueSet *	addl_process_times = `nullptr`
	)

static

Build the passed-in stage by calling this GeomOp's GeomEngine.

If the GeomOp 0 is null, or either GeomOp is invalid, the stage is emptied.

These GeomOps are typically the inputs to a Viewer, renderer Iop, or an Op that wants to sample geometry.

The outputContext() of each GeomOp is used to define the requested times and views to be processed for the usg::Stage. A GeomOpEngine should fill the request times, at a minimum, but is free to add additional time samples.

If addl_process_times is provided those are added to the process times set.

References buildStage().

Referenced by buildStage(), and DD::Image::AxisOp::updateScenePrim().

◆ resetGeomState()

void GeomOp::resetGeomState ( )

Clear the GeomOp's local GeomStateTarget hashes which get built in knobs() and appendGeomState().

Warning - do not call this method unless you know exactly what you're doing otherwise unexpected behavior of the geometry system may result.

This is called by the non-virtual portion of Op::knobStorePrep().

Referenced by DD::Image::Op::knobStorePrep().

◆ buildGeomState()

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

Make changes to the GeomStateTargets registered to this GeomEngine which contribute to the dirtiness(out-of-dateness) state of the layers and stage this node affects or processes.

Warning - do not call this method unless you know exactly what you're doing otherwise unexpected behavior of the geometry system may result.

This is called by the non-virtual portion of Op::knobStorePost().

Each GeomStateTarget affects a specific aspect of the 3D scene and there are several pre-defined ones such as 'define-geometry' and 'modify-values' which in turn affect Hash values in the GeomState stored in the GeomEngine.

Knob values are typically used to build a Hash which is then appended to the GeomStateTargets the knob wants to influence, usually at the Op's current OutputContext. This should be done in the knobs() method.

For arbitrary hash contributions to GeomStateTargets, such as input hashes, subclasses should implement the virtual appendGeomState() method and append to the local GeomStateTargets via appendToTarget().

References _engineNode, appendGeomState(), DD::Image::Op::input(), DD::Image::Op::inputs(), DD::Image::Op::inputsValid(), DD::Image::Op::nodeName(), DD::Image::Op::outputContext(), and DD::Image::Op::treeVersion().

Referenced by DD::Image::Op::knobStorePost().

◆ appendToTarget()

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

Append a value state hash and edit-version state hash to GeomStateTarget target_id at the GeomOp's current OutputContext (time & view.)

If is_animating_source is true then the GeomStateTarget is marked as animating regardless of whether the hashes are actually changing over time. This is useful as a hint when creating geometry attribute time samples.

Not thread safe - assuming this is called on main thread.

References DD::Image::Op::hash(), DD::Image::Op::node(), DD::Image::Op::nodeName(), DD::Image::Op::outputContext(), and DD::Image::version().

Referenced by AppendKnobToTarget(), and appendToTarget().

◆ setOutputContext()

void GeomOp::setOutputContext ( const OutputContext & context )

overrideprotectedvirtual

Called by Nuke immediately AFTER Op::knobs().

Reimplemented from DD::Image::Op.

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

Referenced by DD::Image::AxisOp::setOutputContext().

◆ knob_changed()

int GeomOp::knob_changed ( Knob * k )

overrideprotectedvirtual

Reimplemented from DD::Image::Op.

◆ appendGeomState()

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

inlineprotectedvirtual

Append arbitrary hash contributions to this GeoOp's GeomStateTargets which affect the local GeomState. These hash contribution sources are normally from non-Knob sources like inputs or some other Op value like frame or view. op_hash is provided as a convenience to allow the GeomOp to affect the Op's output hash at the same time without needing to reimplement the hash calcs in Op::append(), which will be called soon afterwards.

This is called after GeomOp::knobs() so the targets will already include any Knob contributions. It's called from within GeomOp::buildGeomState() just prior to the construction of the GeoOp's _inputGeomState, _localGeomState, and _outputGeomState private vars.

A GeomOp subclass should affect the assigned GeomStateTargets via appendToTarget() which indirectly contribute to the _localGeomState hash when the target graph is queried for its concatenated GeomStateTarget::hash().

Default implementation does nothing.

Reimplemented in DD::Image::AxisOp.

Referenced by DD::Image::AxisOp::appendGeomState(), and buildGeomState().

◆ _validate()

void GeomOp::_validate ( bool for_real )

overrideprotectedvirtual

GeomOp subclass-dependent portion of validate(). This calls validate on the inputs and updates GeneralInfo.

Reimplemented from DD::Image::Op.

References DD::Image::Op::_validate(), and updateGeneralInfo().

Referenced by DD::Image::AxisOp::_validate().

◆ updateGeneralInfo()

void GeomOp::updateGeneralInfo ( )

protectedvirtual

Default implemenation copies the GeneralInfo from input0.

Reimplemented in DD::Image::SourceGeomOp.

References DD::Image::Op::geomOp(), info_, DD::Image::Op::input0(), and DD::Image::Op::validate().

Referenced by _validate(), and DD::Image::SourceGeomOp::updateGeneralInfo().

◆ handlesParentTransform()

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

inlineprotectedvirtual

Return the parent transformation for the handles.

This is called in build_handles() when the handles are building.

Reimplemented in DD::Image::SourceGeomOp.

Referenced by buildXformHandles().

◆ buildXformHandles() [2/2]

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

protectedvirtual

Called directly by both build_handles and buildXformHandles so can share common code.

References DD::Image::Op::add_input_handle(), DD::Image::Op::build_knob_handles(), DD::Image::CONNECTED, DD::Image::ViewerContext::connected(), geomOp(), handlesParentTransform(), DD::Image::IopInfoOwner::info(), DD::Image::Op::input(), DD::Image::Op::inputs(), DD::Image::Op::iop(), DD::Image::ViewerContext::modelmatrix, DD::Image::Op::node_disabled(), DD::Image::ViewerContext::pImpl(), DD::Image::Matrix4::scale(), DD::Image::SHOW_OBJECT, DD::Image::SHOW_PUSHED_OBJECT, DD::Image::ViewerContext::transform_mode(), DD::Image::Op::validate(), DD::Image::VIEWER_2D, and DD::Image::ViewerContext::viewer_mode().

Public Member Functions

Static Public Member Functions

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ GeomOp()

Member Function Documentation

◆ opHints()

◆ geomOp() [1/2]

◆ geomOp() [2/2]

◆ node_shape()

◆ node_color()

◆ minimum_inputs()

◆ maximum_inputs()

◆ default_input()

◆ test_input()

◆ AppendKnobToTarget() [1/2]

◆ AppendKnobToTarget() [2/2]

◆ KnobDefinesGeometry()

◆ KnobModifiesAttribValues()

◆ KnobEditsLayer()

◆ KnobEditStage()

◆ getKnobValue()

◆ setKnobValue()

◆ setKnobValues()

◆ inputContext()

◆ inputUIContext()

◆ selectable()

◆ build_handles()

◆ buildXformHandles() [1/2]

◆ buildStage()

◆ resetGeomState()

◆ buildGeomState()

◆ appendToTarget()

◆ setOutputContext()

◆ knob_changed()

◆ appendGeomState()

◆ _validate()

◆ updateGeneralInfo()

◆ handlesParentTransform()

◆ buildXformHandles() [2/2]