DD::Image::Op::Input Struct Reference

#include <Op.h>

Inheritance diagram for DD::Image::Op::Input:

Public Member Functions
	Input (Op *)
	Input (int32_t opInputIndex, const OpGraphLocation &location)
	Input (Op *, const OpState &, Node *_node=nullptr)
	If _node is null then it will be copied from Op, if valid.
	operator bool () const
	Note that a valid input must have a non-null Op, but can have a null Node.
Input &	operator= (const OpGraphLocation &b)
	Note the copy operator leaves index unassigned.
int32_t	index () const
	Index number of the input in the Op's inputs() list.
Public Member Functions inherited from DD::Image::OpGraphLocation
	OpGraphLocation (Op *_op)
	graphState and node are copied from _op, if valid.
	OpGraphLocation (Op *_op, const OpState &_state, Node *_node=nullptr)
	If _node is null then it will be copied from _op, if valid.
bool	isNodeGraphLocation () const
	Returns true when both op and node are valid.
bool	isOrphanedOp () const
	operator bool () const
	Note that a valid OpGraphLocation must have a non-null Op, but can have a null Node.
bool	operator== (const OpGraphLocation &b) const
	Only compares the Op* and its graph state.
bool	operator!= (const OpGraphLocation &b) const
bool	operator< (const OpGraphLocation &b) const
bool	operator> (const OpGraphLocation &b) const
const Hash &	opHash () const
	Hash from graphState. Note - may be different than op->hash()!
bool	opHashAnimates () const
	Does the graphState opHash animate? Note - may be different than op->varyingOutputHash()!
bool	varyingOutputHash () const
const Hash &	editVersionHash () const
	Edit version hash from graphState. Note - may be different than op->editVersionHash()!
const Hash &	topologyHash () const
	Hash of input graph structure unaffected by knob values.
const char *	nodeName () const
std::string	nodeIdentifierName () const
void	applyTimeRemapping (const fdk::TimeValueSet &outTimes, fdk::TimeValueSet &inTimes) const
void	applyTimeRemapping (const fdk::TimeValueList &outTimes, fdk::TimeValueSet &inTimes) const
	Same but with a time list source.
Iop *	iop () const
DeepOnlyOp *	deepOnlyOp () const
ParticleOp *	particleOp () const
AxisOp *	axisOp () const
LightOp *	lightOp () const
CameraOp *	cameraOp () const
SceneOpI *	sceneOpI () const
AxisSceneOp *	axisSceneOp () const
CameraSceneOp *	cameraSceneOp () const
LightSceneOp *	lightSceneOp () const
GeometryProviderI *	geometryProvider () const
GeomOp *	geomOp () const

Protected Attributes
int32_t	_index
	Index number of the input in the Op's inputs() list.

Friends
class	Op

Additional Inherited Members
Public Attributes inherited from DD::Image::OpGraphLocation
Op *	op
	The Op at this graph point (maybe not created by 'node')
OpState	graphState
	State of op at this graph point (maybe not same as stored in 'op')
Node *	node
	The Node at this graph point, if it exists (maybe not same as the 'op' node)

Detailed Description

A single Op input containing the location of an upstream Op, the state for the Op at this Op's input connection point, and an upstream Node if one exists.

A valid Input must have a non-null op pointer, while node can be null. A null node will commonly occur when Ops are directly connected together without creator Nodes.

Note that if non-null node may not be the same Node that op was generated by since there may be additional non-OpNodes in between op's Node and this Op's Node. When this is the case graphState may be different than the one stored in op due to those additional Nodes modifying the graph info.

Constructor & Destructor Documentation

Input() [1/2]

Op::Input::Input ( Op *  _op )

explicit

Op ctor takes the graph state information from the Op. Warning - the graph topology for this Op must not contain hidden modifier Nodes, otherwise the graph state info in the Op may not be accurate. Use Op::inputConnection() to retrieve the full graph context.

Input() [2/2]

Op::Input::Input	(	int32_t	opInputIndex,
		const OpGraphLocation &	location
	)

Construct from a graph location also setting the Op input index number (note - not the Node input index number, they can be different if Op is split.)