#include <SourceGeomOp.h>

Inheritance diagram for DD::Image::SourceGeomOp:

Classes
class	SourceEngine
	The type for missing parent prims we create. More...

Public Member Functions
	SourceGeomOp (Node *node, GeomOpEngine::Builder engine_ctor)
	Constructs a SourceGeomOp with a single texture input.

const char *	Class () const override

const char *	node_help () const override

int	mergeInput () const
	Returns the node input to use for the merge geometry source. Always defaults to input 0.

virtual int	materialInput () const

int	minimum_inputs () const override
	Do not use this class if the subclass will not support merge input 0!

int	maximum_inputs () const override
	Do not use this class if the subclass will not support merge input 0!

int	optional_input () const override
	Do not use this class if the subclass will not support merge input 0!

bool	test_input (int node_input, Op *op) const override

Op *	default_input (int node_input) const override

const char *	input_label (int node_input, char *buffer) const override
	'img' for input eMaterialInput.

void	build_handles (ViewerContext *ctx) override

void	updateGeneralInfo () override

void	knobs (Knob_Callback) override

void	knobs (Knob_Callback f, bool addPathKnob)
	Overload of knobs() which allows the primPath to be not created.

virtual void	addSourceKnobs (Knob_Callback f)

int	knob_changed (Knob *k) override

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

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

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

GeomOp *	geomOp () override

GeomOpEngine *	engineNode () const

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

unsigned	node_color () const override

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

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

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

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

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

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

void	KnobDefinesGeometry (const Knob_Closure &f)

void	KnobModifiesAttribValues (const Knob_Closure &f)

void	KnobEditsLayer (const Knob_Closure &f)

void	KnobEditStage (const Knob_Closure &f)

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

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

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

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

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

GeomOp *	input (int op_input) const

GeomOp *	input0 () const

GeomOp *	input1 () const

virtual bool	selectable () const

virtual bool	selection3DChanged (ViewerContext *ctx)

virtual bool	selection3DCleared ()

virtual bool	selection3DMouseDown (ViewerContext *ctx)

virtual bool	selection3DMouseUp (ViewerContext *ctx)

virtual bool	selection3DMouseDrag (ViewerContext *ctx)

void	build_handles (ViewerContext *ctx) override

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

const usg::GeomState &	inputVersions () const

const usg::GeomState &	localVersions () const

const usg::GeomState &	outputVersions () const

const usg::GeomState &	inputGeomState () const

const usg::GeomState &	localGeomState () const

const usg::GeomState &	outputGeomState () const

void	resetGeomState ()

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

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

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

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

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

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

void	appendToDefineGeometryTarget (Op *op)

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

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

void	appendToModifyValuesTarget (Op *op)

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

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

void	appendToEditStageTarget (Op *op)

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

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

Op *	rootOp () const

bool	preValidateAborted (int treeStartingVersion, PrevalidateResult &result) const

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

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

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

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

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

bool	varyingOutputHash () const

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

void	enableVaryingOutputHash ()
	Enable the varyingOutputHash indicator.

virtual Hash	editState () const

virtual void	setEditState (const Hash &h)

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

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

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

Node *	node () const

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

void	node (Node *v)

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

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

Hash	nodeTopologyHash () const

Op *	firstOp () const

void	firstOp (Op *v)

Op *	parent () const

void	parent (Op *lpOp)

virtual void	detach ()
	node has been deleted in DAG

virtual void	attach ()
	node has been created in DAG

virtual void	pre_write_knobs ()

void	knobStorePrep (const OutputContext &storeContext)

virtual void	knobs (Knob_Callback)

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

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

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

void	set_unlicensed ()

Knob *	knob (const char *name) const

Knob *	knob (int) const

bool	pushed () const

bool	panel_visible () const

bool	node_disabled () const

bool	node_selected () const

unsigned	node_gl_color () const

void *	field (const char *name)

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

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

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

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

void	endHandle (ViewerContext *ctx)

virtual int	knob_changed (Knob *)

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

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

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

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

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

virtual int	inputArrows (int nodeInputs) const

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

bool	script_expand (const char *str) const

HandlesMode	anyHandles (ViewerContext *ctx)

virtual void	build_handles (ViewerContext *)

void	add_draw_handle (ViewerContext *)

virtual void	draw_handle (ViewerContext *)

virtual void	add_input_handle (int input, ViewerContext *)

void	add_op_handle (ViewerContext *ctx)

void	add_knob_handle (Knob , ViewerContext )

virtual int	getViewableModes () const

virtual int	optional_input () const

virtual int	minimum_inputs () const

virtual int	maximum_inputs () const

virtual bool	test_input (int, Op *) const

int	inputs () const

int	node_inputs () const

Op *	node_input (int, GenerateType=OUTPUT_OP) const

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

Op *	input_op (int n=0) const

virtual void	inputs (int n)

Op *	input (int) const

int	inputNumber (int input, int offset) const

Op *	input (int input, int offset) const

Op *	input0 () const
	return the primary input

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

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

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

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

void	set_input0 (Op *op)

void	set_input (int i, Op *op)

void	set_input (int i, Op &op)

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

const OutputContext &	outputContext () const

virtual void	setOutputContext (const OutputContext &c)

virtual void	append (Hash &)

virtual float	uses_input (int) const

virtual void	build_splits ()

virtual int	split_input (int) const

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

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

virtual Op *	default_input (int) const

const Hash &	hash () const

virtual bool	frameTransformImplemented () const

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

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

virtual DopeItemFlags::Mask	getDopeItemFlags () const

virtual bool	shouldHideInDopeSheet (Knob *knob) const

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

virtual ViewSet	viewsProduced () const

virtual ViewSet	viewsWantOn (int i) const

virtual ViewSet	splitForViews () const

bool	requested () const

void	setRequested ()

void	forgetRequestShallow ()

void	forget_request ()

void	forget_request (std::set< Op * > &forgotten)

virtual const char *	node_shape () const

DD::Image::Hash	curveHash () const

bool	opCurrent () const

virtual unsigned	node_color () const

virtual const char *	node_help () const =0

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

virtual std::string	input_longlabel (int) const

void	node_redraw ()

void	print_name (std::ostream &o) const

NodeContext	nodeContext () const

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

void	invalidateSameHash ()

bool	invalidate ()

bool	invalidate (const Hash &hash)

bool	update (const Box *=nullptr)

void	asapUpdate ()

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

void	validate (bool for_real=true)

virtual void	force_validate (bool for_real=true)

void	update_handles () const

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

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

bool	inErrorState () const

bool	inInvalidState () const

bool	opened () const

void	open ()

void	unopen ()

bool	running () const

void	running (bool v)

bool	not_closed () const

void	close ()

void	callCloseAfter (double seconds)

void	copyState (Op *input)

bool	cached () const

void	cached (bool b)

virtual bool	inUse () const

virtual Executable *	executable ()

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

void	gotoContext (const OutputContext &, bool update)

void	progressFraction (double fraction, StatusFlags flags=StatusNone)

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

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

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

void	progressDismiss ()

int	slowness () const

void	slowness (int newval)

virtual bool	firstEngineRendersWholeRequest () const

virtual bool	updateUI (const OutputContext &context)

const Format &	input_format () const

const OutputContext &	uiContext () const

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

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

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

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

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

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

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

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

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

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

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

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

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

bool	hasError () const

bool	opOrChildHasError () const

const Op *	getErroredOp () const

void	setPopUpScheme (PopUpScheme lScheme)

PopUpScheme	getPopUpScheme () const

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

OpMessageHandler &	getMsgHandler ()

const OpMessageHandler &	getMsgHandler () const

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

std::string	getDetailedDebugInfo () const

bool	tryValidate (bool for_real=true)

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

virtual const Iop *	iop () const

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

virtual const GeoOp *	geoOp () const

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

virtual const GeomOp *	geomOp () const

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

virtual const ParticleOp *	particleOp () const

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

virtual const DeepOnlyOp *	deepOnlyOp () const

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

virtual const AxisOp *	axisOp () const

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

virtual const CameraOp *	cameraOp () const

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

virtual const LightOp *	lightOp () const

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

virtual VersionInfo	getLibraryVersion () const

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

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

virtual bool	updateKnobsFromAsset (Knob *knob)

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

virtual const char *	Class () const =0

const std::string	libraryDisplayName () const

virtual const char *	displayName () const

virtual std::string	docsPath () const

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

Op *	get (const Description *description)

Protected Types
enum class	ParentType { None , Scope , Xform }
	Possible types to create for missing parents.

Protected Member Functions
virtual Knob *	makeTransformKnob (Knob_Callback f)

virtual Knob *	getTransformKnob () const

fdk::Mat4d	handlesParentTransform (DD::Image::ViewerContext *ctx) override
	Return the parent transformation for the handles.

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

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

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

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

int	knob_changed (Knob *k) override

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

void	_validate (bool for_real) override

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

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

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

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

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

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

virtual void	_invalidate ()

virtual void	_validate (bool for_real)

virtual void	_open ()

virtual void	_close ()

Op *	create (Node node, const char name)

Op *	create (const char *name)

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

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

void	build_input_handles (ViewerContext *)

void	build_knob_handles (ViewerContext *)

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

virtual HandlesMode	doAnyHandles (ViewerContext *ctx)

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

Protected Attributes
std::string	_primPath
	The root path for created prims.

TransformKnobs	_transformKnobs

ParentType	_missingParentType

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

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

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

bool	_varyingOutputHash
	whether the hash value will animate over time

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

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

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

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

enum	ViewableModes { eViewableMode2D , eViewableMode3D , eViewableMode3D_2DReference }

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

enum	NodeContext { eNodeGraph , eTimeline , eOpGraph }

enum	StatusFlags { StatusNone , StatusModal , StatusUseCallback }

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

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

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

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

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

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

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

Static Public Member Functions inherited from DD::Image::GeomOp
static void	buildStage (usg::StageRef &stage, const usg::ArgSet &request_args, GeomOp geop0, GeomOp geop1=nullptr, const fdk::TimeValueSet *addl_process_times=nullptr)

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

Static Public Member Functions inherited from DD::Image::Op
static int	treeVersion ()

static bool	nukeBusy ()
	is nuke processing something on a parallel thread?

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

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

static void	resetTimers ()
	reset all the performance timers

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

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

static const char *	script_result (bool py=false)

static void	script_unlock ()

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

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

static void	all_forget_request ()

static void	new_request_pass ()

static double	callPendingClose (double seconds)

static void	clearPendingClose ()

static Op *	error_op ()

static const char *	error_message ()

static void	clearAbortAndError ()
	To be removed.

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

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

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

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

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

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

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

static bool	has_timeout (TimeoutHandler, void *=nullptr)

static void	remove_timeout (TimeoutHandler, void *=nullptr)

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

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

Detailed Description

Subclass of GeomOp that supports a ShaderOp input and local transform for ease of object setup. Connection to legacy 'Material' class is not allowed, although connection to Iops for simple textures is. Do not use this class if there is not at least 1 input for the merge source (ie input 0)! If your class does not need a merge input or material input then subclass directly from GeomOp instead.

Member Function Documentation

◆ Class()

const char * SourceGeomOp::Class ( ) const

overridevirtual

Implements DD::Image::Op.

◆ node_help()

const char * SourceGeomOp::node_help ( ) const

overridevirtual

Implements DD::Image::Op.

◆ materialInput()

virtual int DD::Image::SourceGeomOp::materialInput ( ) const

inlinevirtual

Returns the node input to use for the material binding. Default is the optional_input() which is normally the last input, or (maximum_inputs() - 1).

Referenced by default_input(), input_label(), DD::Image::SourceGeomOp::SourceEngine::processScenegraph(), test_input(), and updateGeneralInfo().

◆ minimum_inputs()

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

inlineoverridevirtual

Do not use this class if the subclass will not support merge input 0!

Default is 2: merge input and material input(optional). Subclasses that add additional inputs should keep the merge input at 0 and add inputs starting at 1, taking into account the material input will be last.

Reimplemented from DD::Image::GeomOp.

◆ maximum_inputs()

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

inlineoverridevirtual

Do not use this class if the subclass will not support merge input 0!

Default is 2: merge input and material input(optional). Subclasses that add additional inputs should keep the merge input at 0 and add inputs starting at 1, taking into account the material input will be last.

Reimplemented from DD::Image::GeomOp.

◆ optional_input()

int DD::Image::SourceGeomOp::optional_input ( ) const

inlineoverridevirtual

Do not use this class if the subclass will not support merge input 0!

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

Reimplemented from DD::Image::Op.

◆ test_input()

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

overridevirtual

Allow ShaderOp or Iop only for eMaterialInput. Connection to legacy 'Material' class is not allowed!

Reimplemented from DD::Image::GeomOp.

References DD::Image::Op::iop(), materialInput(), mergeInput(), and DD::Image::Op::node_input().

◆ default_input()

Op * SourceGeomOp::default_input ( int node_input ) const

overridevirtual

Disconnected eMaterialInput is assigned a black default constant ShaderOp, matching legacy behavior.

Reimplemented from DD::Image::GeomOp.

References DD::Image::GeomOp::default_input(), DD::Image::Iop::default_input(), materialInput(), DD::Image::Op::node_input(), and DD::Image::Op::outputContext().

◆ input_label()

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

overridevirtual

'img' for input eMaterialInput.

Reimplemented from DD::Image::Op.

References materialInput(), and DD::Image::Op::node_input().

◆ build_handles()

void SourceGeomOp::build_handles ( ViewerContext * ctx )

overridevirtual

build_handles calls buildXformHandles with the (global) local matrix so nodes up the tree are displayed correctly.

Reimplemented from DD::Image::GeomOp.

References DD::Image::GeomOp::buildXformHandles().

◆ updateGeneralInfo()

void SourceGeomOp::updateGeneralInfo ( )

overridevirtual

Updates the general info from the material input. Otherwise the default behaviour from GeomOp is used.

Reimplemented from DD::Image::GeomOp.

References DD::Image::Op::geomOp(), DD::Image::GeomOp::info_, DD::Image::Op::input0(), DD::Image::Op::iop(), materialInput(), DD::Image::GeomOp::updateGeneralInfo(), and DD::Image::Op::validate().

◆ knobs()

void SourceGeomOp::knobs ( Knob_Callback f )

overridevirtual

Calls the GeomOp base class with is_source_geo=true so that the display knobs are correct for a Source object, then calls addSourceKnobs() to let a subclass add it's own knobs.

Reimplemented from DD::Image::Op.

References knobs().

Referenced by knobs().

◆ addSourceKnobs()

virtual void DD::Image::SourceGeomOp::addSourceKnobs ( Knob_Callback f )

inlinevirtual

Subclass specifies knobs that creates source geometry. Base class does nothing.

Referenced by knobs().

◆ knob_changed()

int SourceGeomOp::knob_changed ( Knob * k )

overridevirtual

Reimplemented from DD::Image::GeomOp.

◆ appendGeomState()

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

overridevirtual

Reimplemented from DD::Image::GeomOp.

◆ makeTransformKnob()

Knob * SourceGeomOp::makeTransformKnob ( Knob_Callback f )

protectedvirtual

Make an Axis_Knob called "transform" which will drive the local transform. Calling this will cause a parent Xform prim containing the tranform before createPrims is called. Plugins can implement their own implementation of this to support custom transform knobs.

◆ handlesParentTransform()

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

overrideprotectedvirtual

Return the parent transformation for the handles.

The parent transformation is a part of the transformation of the target prim that in the transformation order comes before the actual transformation produced by the Axis_Knob. Depending on the value of the transformation operation order knob, when Prepend, the parent transformation is the concatenated transformation of the parents of the target prim, or when Append, it's the concatenated transformation of the parents and the local transformation of the target prim. This is called in build_handles() when the handles are building.

Reimplemented from DD::Image::GeomOp.

References _primPath, and DD::Image::ViewerContext::pImpl().

Classes

Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ Class()

◆ node_help()

◆ materialInput()

◆ minimum_inputs()

◆ maximum_inputs()

◆ optional_input()

◆ test_input()

◆ default_input()

◆ input_label()

◆ build_handles()

◆ updateGeneralInfo()

◆ knobs()

◆ addSourceKnobs()

◆ knob_changed()

◆ appendGeomState()

◆ makeTransformKnob()

◆ handlesParentTransform()