Inherits DD::Image::LightOp.

Public Member Functions
	ComplexLightOp (Node *node)

double	hfov () const
	Horizontal field of view.

int	lightType () const

bool	is_delta_light () const
	This light has a delta distribution (a cone in 3D)

void	get_L_vector (LightContext &ltx, const Vector3 &P, const Vector3 &N, Vector3 &L, float &D) const
	Calculate a normalized direction vector L and distance D to surface point P.

void	get_color (LightContext &ltx, const Vector3 &P, const Vector3 &N, const Vector3 &L, float D, Pixel &out)
	Returns the amount of light stiking the current surface point from the light.

void	shade_GL (ViewerContext *ctx, int light_num)
	This will set the OpenGL lighting settings.

void	draw_handle (ViewerContext *ctx)
	Draws the light handle.

void	_validate (bool for_real)
	This will validate the light node.

void	knobs (Knob_Callback f)

Public Member Functions inherited from DD::Image::LightOp
	LightOp (Node *node)

int	samples () const

void	set_samples (int n)

float	sample_width () const

void	set_sample_width (float width)

const Pixel &	color () const

void	color (const Pixel &v)

float	intensity () const

void	set_intensity (float v)

bool	falloff () const

void	set_falloff (bool b)

int	falloffType () const

void	set_falloffType (int b)

bool	cast_shadows () const

void	set_cast_shadows (bool b)

int	shadows_mode () const

float	alpha_threshold () const

TextureFilter *	shadow_filter ()

float	depthmap_bias () const

void	set_depthmap_bias (float v)

float	shadow_jitter_scale () const

void	set_shadow_jitter_scale (float v)

int	depthmap_width () const

void	set_depthmap_width (int n)

void	setShadowMaskChannel (Channel &channel)

Channel	getShadowMaskChannel () const

virtual float	get_shadowing (const LightContext &ltx, const VertexContext &vtx, const Vector3 &P, Pixel &out)
	Return the amount of shadowing the light creates at surface point P. and optionally copies the shadow mask to the output pixel. More...

virtual double	vfov () const

virtual double	aspect () const

void	_validate (bool for_real)

virtual void	request (ChannelMask, int count)

void	knobs (Knob_Callback)

int	knob_changed (Knob *k)

void	color_knobs (Knob_Callback)

void	attenuation_knobs (Knob_Callback)

void	shadow_knobs (Knob_Callback)

unsigned	node_color () const

void	build_handles (ViewerContext *)

void	draw_handle (ViewerContext *)

const char *	node_help () const
	This is the light node help.

const char *	displayName () const
	This is the node display name.

const char *	Class () const

Public Member Functions inherited from DD::Image::CameraOp
	CameraOp (Node *node)

virtual void	projection_knobs (Knob_Callback)

virtual void	lens_knobs (Knob_Callback)

void	hfov (double v)

double	film_width () const

void	film_width (double v)

double	film_height () const

void	film_height (double v)

double	focal_length () const

void	focal_length (double v)

double	Near () const

void	Near (double v)

double	Far () const

void	Far (double v)

double	focal_point () const

void	focal_point (double v)

double	fstop () const

void	fstop (double v)

int	projection_mode () const

void	projection_mode (int i)

virtual bool	projection_is_linear (int mode) const

virtual LensFunc *	lens_function (int mode) const

virtual LensNFunc *	lensNfunction (int mode) const

double	lens_distort_a () const

double	lens_distort_b () const

double	lens_distort_c () const

double	lens_distort_D () const

double	lens_distortion () const

double	lens_power () const

bool	lens_distort_enabled () const

const Vector2 &	win_translate () const

const Vector2 &	win_scale () const

double	win_roll () const

const Matrix4 &	projection () const

virtual Matrix4	projection (int mode) const

virtual Matrix4	projectionAt (const DD::Image::OutputContext &)

HandlesMode	doAnyHandles (ViewerContext *ctx) override

OpHints	opHints () const override

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

int	minimum_inputs () const

int	maximum_inputs () const

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

virtual Op *	lookat_input () const
	override from LookAt to add the look at pipe to input 1

virtual bool	lookAtEnabled () const
	by default all the axis look at pipe is disabled

void	enableAxisKnobs (bool on)

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

bool	test_input (int, Op *) const

AxisOp *	input0 () const

int	display3d () const

bool	selectable () const

void	display3d (int v)

void	selectable (bool v)

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

Axis_KnobI *	getAxis ()

const char *	node_shape () const

int	display3d ()

const Matrix4 &	local () const

void	matrix (const Matrix4 &m)

const Matrix4 &	matrix () const

const Matrix4 &	imatrix ()

virtual void	matrixAt (const DD::Image::OutputContext &context, DD::Image::Matrix4 &matrix) const

virtual void	print_info (std::ostream &o) const

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

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)

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

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

void	add_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

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 More...

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

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)

DD::Image::Hash	curveHash () const

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

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. More...

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

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

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 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 std::string	getLibraryName () const
	Return a label and version string to display library version info for the Node.

virtual VersionInfo	getLibraryVersion () const

const std::string	libraryDisplayName () 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)

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

Protected Attributes
double	_coneAngleNotClamp

double	_conePenumbraAngleNotClamp

double	_coneFalloffNotClamp

float	_coneAngle

float	_conePenumbraAngle

float	_coneFalloff

float	_coneOuterCos

float	_iconeCos

float	_coneInnerCos

int	_lightType

double	_intensityScale

Protected Attributes inherited from DD::Image::LightOp
Pixel	color_
	Color of the light (can be >3 channels!)

float	intensity_
	Global intensity.

bool	falloff_
	Whether to factor in physical falloff.

int	falloffType_
	falloff type

int	samples_
	The number of samples (for area testing)

float	sample_width_
	sample width (for shadowing)

bool	cast_shadows_
	Whether light casts shadows.

int	shadows_mode_
	Shadow casting mode.

TextureFilter	shadow_filter_
	Default filter to use in shadow texture sampling.

float	scene_epsilon_
	Scene epsilon for shadow comparison.

float	depthmap_bias_
	Offset in Z of shadow buffer.

float	depthmap_slope_bias_
	Offset in Z to be scale in proportion of the local gradient.

float	alpha_threshold_
	Alpha threshold for transparent shadow map mode.

float	shadow_jitter_scale_
	Size of shadow jitter.

int	depthmap_width_
	Size in pixels of shadow buffer.

Channel	_shadowMaskChannel
	Output the shadow mask to this channel.

Protected Attributes inherited from DD::Image::CameraOp
double	focal_length_

double	haperture_

double	vaperture_

double	near_

double	far_
	Near and far Z clipping planes.

Vector2	win_translate_
	Window coords translate XY.

Vector2	win_scale_
	Window coords scale XY.

double	win_roll_
	Window coords rotate Z.

Matrix4	projection_
	Camera's projection matrix.

int	projection_mode_
	Camera lens projection mode.

double	focal_point_
	Focal point of camera.

double	fstop_
	camera fstop

bool	use_vertical_lock_

double	lens_distort_a_

double	lens_distort_b_

double	lens_distort_c_

double	lens_distort_D_

double	lens_distortion_

double	lens_power_

bool	lens_distort_enabled_

Protected Attributes inherited from DD::Image::AxisOp
Matrix4	localtransform_
	Local matrix that Axis_Knob fills in.

Matrix4	local_

Matrix4	matrix_
	Local matrix after look at performed. More...

Matrix4	imatrix_
	Inverse object matrix.

bool	inversion_updated
	Whether imatrix_ is valid.

Axis_KnobI *	axis_knob
	reference to the transformation knob

WorldMatrixProvider *	_worldMatrixProvider

int	display3d_
	GUI display setting.

bool	selectable_
	GUI selectable checkmark.

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

Protected Attributes inherited from DD::Image::LookAt
Matrix4	lookat_matrix_
	Matrix for rotating to look at the look input.

Matrix4	my_local
	For the Axis_Knob to store into.

bool	my_transform_normals

int	my_lookat_axis

bool	my_rotate_x

bool	my_rotate_y

bool	my_rotate_z

bool	my_lookat_use_quat

double	my_lookat_strength

Additional Inherited Members
Public Types inherited from DD::Image::LightOp
enum	{ eNoFalloff, eLinearFalloff, eQuadraticFalloff, eCubicFalloff }

enum	LightType { ePointLight, eDirectionalLight, eSpotLight, eOtherLight }

enum	ShadowMode { eSolidShadow, eTransparentShadow, eSemiTransparentShadow }

Public Types inherited from DD::Image::CameraOp
enum	{ LENS_PERSPECTIVE, LENS_ORTHOGRAPHIC, LENS_UV, LENS_SPHERICAL, LENS_RENDER_CAMERA, LENS_USER_CAMERA }

typedef void(	LensFunc) (Scene , CameraOp , MatrixArray transforms, const VArray &v, Vector4 &out, void data)

typedef void(	LensNFunc) (Scene , CameraOp , MatrixArray transforms, VArray vert_array, int n, void *data)

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::CameraOp
static void	to_format (Matrix4 &, const Format *)

static void	from_format (Matrix4 &, const Format *)

static CameraOp *	default_camera ()

Static Public Member Functions inherited from DD::Image::Op
static int	treeVersion ()
	get the current tree version

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 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::LightOp
static const Description	description

Static Public Attributes inherited from DD::Image::CameraOp
static const char *	projection_modes []

static const char *	projection_modes_renderer []

static const Description	description

Static Public Attributes inherited from DD::Image::AxisOp
static const Description	description

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 constexpr int	kInvalidVersion

static constexpr VersionInfo	kUnsetVersion

Protected Types inherited from DD::Image::LookAt
enum	{ kAxisZPlus, kAxisZMinus, kAxisYPlus, kAxisYMinus, kAxisXPlus, kAxisXMinus }

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

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 More...

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

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 PrevalidateResult	doPreValidate (ViewerContext ctx=nullptr, PreValidateContext =nullptr)

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

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

Detailed Description

Light source base class that provides either a point source with falloff (as per LightOp), but also adds the options of a directional light and a spotlight

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description