#include <OutputContext.h>

Inheritance diagram for DD::Image::OutputContext:

Public Types
enum	LineReadPreference { eScanlineAlways , ePreferScanline , ePreferAllLines }

enum class	ContextType { eNone , eFallbackUi }

Public Types inherited from DD::Image::ProxyContext
enum	ProxySetting { PROXY_OFF , PROXY_NEVER , PROXY_SCALE_DOWN , PROXY_NEAREST , PROXY_ALWAYS }

Public Member Functions
	OutputContext ()
	Default ctor sets frame=0.0, view=0, lineReadPreference=ePreferScanline and creates an empty GraphScope.

	OutputContext (const OutputContext &src, double frame, int view=-1)
	Copy ctor with frame/view variant options. Replaces the frame and optionally the view if not -1.

	OutputContext (const OutputContext &src, int view)
	Copy ctor with view variant assignment. Convenient for changing the view without affecting frame or GraphScope.

	mFnDeprecatedInNuke17 ("OutputContext(double frame, int view) has been deprecated, use OutputContext(double frame, int view, GraphScopePtr scope) or copy construct from an existing OutputContext instead.") OutputContext(double frame

	OutputContext (double frame, int view, const GraphScopePtr graphScope)

double	frame () const

void	setFrame (double v)

int	view () const

void	setView (int view)
	Assigned view values <= 0 are clamped to view index 1 (default).

	mFnDeprecatedInNuke14 ("view has been deprecated, use setView instead.") void view(int v)

void	setGraphScope (const GraphScopePtr scope)
	Sets a GraphScope to the OutputContext.

GraphScopePtr	graphScope () const

const GraphScopeId &	graphScopeId () const

void	setLineReadPreference (LineReadPreference linePreference)

LineReadPreference	lineReadPreference () const

void	append (Hash &) const

bool	operator== (const OutputContext &b) const

bool	operator!= (const OutputContext &b) const

bool	operator< (const OutputContext &b) const

bool	operator> (const OutputContext &b) const

const std::string &	viewname () const

const Format *	to_proxy_rel (const Format &from, Format &to, const OutputContext &rel) const

bool	sameProxy (const DD::Image::OutputContext &b) const

ContextType	type () const

void	setType (const ContextType value)

Public Member Functions inherited from DD::Image::ProxyContext
ProxySetting	proxy () const

void	setProxy (ProxySetting v)

float	scale_x () const

float	scale_y () const

float	translate_x () const

float	translate_y () const

void	set (ProxySetting v, float sx, float sy, float tx, float ty)
	Set all proxy parameters.

void	setProxyscale (float scale)

void	setProxyscale (float sx, float sy)

void	setProxyscale (const Format &fullsize, const Format &proxysize)

void	setProxyscale (const Matrix4 &)

void	scale (float scale)

void	scale (float sx, float sy)

void	translate (float x, float y)

bool	isIdentity () const

void	to_proxy (Matrix4 &) const

void	to_proxy_wh (double &w, double &h) const

void	to_proxy_wh (float &w, float &h) const

double	to_proxy_w (double w) const

double	to_proxy_h (double w) const

void	to_proxy_xy (double &x, double &y) const

void	to_proxy_xy (float &x, float &y) const

double	to_proxy_x (double w) const

double	to_proxy_y (double w) const

double	from_proxy_x (double x) const

double	from_proxy_y (double y) const

void	to_proxy_box (DD::Image::Box &box) const

void	to_proxy_area (double &w, double &h) const

double	to_proxy_area (double area) const

void	to_proxy (const Format &from, Format &to) const

const Format *	to_proxy_rel (const Format &from, Format &to, const ProxyContext &) const

double	to_proxy_pixel_aspect (double pa) const

void	from_proxy (Matrix4 &) const

void	from_proxy_xy (double &x, double &y) const

void	from_proxy_wh (double &w, double &h) const

void	from_proxy_xy (float &x, float &y) const

void	from_proxy_wh (float &w, float &h) const

double	from_proxy_area (double area) const

double	from_proxy_pixel_aspect (double pa) const

void	appendProxy (Hash &hash) const
	Append the values affecting proxy scaling to the hash (i.e. not frame or view)

Static Public Member Functions
static const OutputContext &	defaultContext ()

static GraphScopePtr	graphScope (const GraphScopeId &graphScopeId)

static const std::string &	viewname (int v)

static const std::string &	viewshort (int v)

static int	viewcount ()

static bool	MultiView ()

static int	lookup_view (const std::string &viewname)

static void	set_viewnames (const std::string &s)

Public Attributes
int	view

Static Public Attributes
static void(*	create_view )(const std::string &s)

static GraphScopeRepositoryPtr(*	graphScopeRepository )()
	Returns the GraphScopeRepository in use by Nuke.

static int(*	viewIndex )(const std::string &viewName, Op *op)

static void(*	createView )(const std::string &viewName, const std::string &color, Op *op)

static const std::string &(*	viewName )(int index, Op *op)

static std::string(*	viewShortName )(int index, Op *op)

static void(*	setViewNames )(const std::vector< std::string > &viewNames, Op *op)
	Sets the op's root node to have view's named viewNames.

static int(*	viewCount )(Op *op)
	Returns the number of views on the op's root node.

static bool(*	hasMultipleViews )(Op *op)
	Returns true if op's root node has more than one view.

Friends
std::ostream &	operator<< (std::ostream &, const OutputContext &)

Additional Inherited Members
Protected Member Functions inherited from DD::Image::ProxyContext
	ProxyContext ()

bool	isEqualTo (const ProxyContext &other) const

bool	isLessThan (const ProxyContext &other) const

Detailed Description

This is a block of data that is passed up the Op tree. The context modifies the values that are stored by knobs. An Op can further use information from it (such as the frame number) to modify it's behavior, by implementing Op::setOutputContext(). And an Op can modify the context that is used by each input, by implementing Op::inputContext().

Member Enumeration Documentation

◆ LineReadPreference

enum DD::Image::OutputContext::LineReadPreference

Preferences which can be used to influence how files are read by Readers. eScanlineAlways - upstream Reader should always read frames line by line. ePreferScanline - prefer line-by-line reads, but allow other nodes upstream to override this preference. ePreferAllLines - prefer to read the whole of the requested area at once, but allow other nodes upstream to override this preference.

Member Function Documentation

◆ graphScope() [1/2]

GraphScopePtr OutputContext::graphScope ( ) const

Returns the GraphScope held by the OutputContext. The GraphScopePtr can be an empty shared pointer, which means that the GraphScope is nonexisting.

References graphScope().

Referenced by graphScope().

◆ graphScopeId()

const GraphScopeId & OutputContext::graphScopeId ( ) const

Returns the unique ID for the scope held by the OutputContext. Same as calling graphScope()->id().

Referenced by DD::Image::MaterialOpI::buildAssetPath(), and graphScope().

◆ graphScope() [2/2]

GraphScopePtr OutputContext::graphScope ( const GraphScopeId & graphScopeId )

static

Retrieves a GraphScope from the repository. This is equivalent to: OutputContext::graphScopeRepository()->get(graphScopeId).

References graphScopeId(), and graphScopeRepository.

◆ setLineReadPreference()

void OutputContext::setLineReadPreference ( LineReadPreference linePreference )

By default readers read frames line by line (ePreferScanline). Some formats support reading the entire frame in one go. Setting the lineReadPreference can be used to switch between the two modes for these formats.

Referenced by DD::Image::Write::inputContext().

◆ append()

void OutputContext::append ( Hash & hash ) const

Add the contents of this to the hash, thus producing a different hash for any different setting of OutputContext.

◆ viewcount()

int OutputContext::viewcount ( )

static

how many views exist. View 0 is always an extra view called 'default'. If there is one view, this is will be view 1.

Referenced by MultiView().

◆ MultiView()

bool OutputContext::MultiView ( )

static

whether or not there are more than one actual view (not counting the hidden 'default' view)

References viewcount().

Member Data Documentation

◆ viewIndex

int(* OutputContext::viewIndex)(const std::string &viewName, Op *op)

static

If a view exists with name viewName on op's root node then that view's index is returned, otherwise -1 is returned.

◆ createView

void(* OutputContext::createView)(const std::string &viewName, const std::string &color, Op *op)

static

Creates a new view with name viewName and color on op's root node.

◆ viewName

const std::string &(* OutputContext::viewName)(int index, Op *op)

static

If a view exists at index on op's root node then that view's name is returned, otherwise an empty string is returned.

◆ viewShortName

std::string(* OutputContext::viewShortName)(int index, Op *op)

static

If a view exists at index on op's root node then that view's short name is returned, otherwise an empty string is returned.

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Friends

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ LineReadPreference

Member Function Documentation

◆ graphScope() [1/2]

◆ graphScopeId()

◆ graphScope() [2/2]

◆ setLineReadPreference()

◆ append()

◆ viewcount()

◆ MultiView()

Member Data Documentation

◆ viewIndex

◆ createView

◆ viewName

◆ viewShortName