EvalContext

class EvalContext

Bases: pybind11_builtins.pybind11_object

This class holds the evaluation context passed to the evaluation handler during a plug evaluation.

Use this interface to query the dependency count and the dependencies value. This interface is implemented by the application.

Methods

as_Box3f(index)	Returns the n-th dependency value as a Box3f.
as_Color4f(index)	Returns the n-th dependency value as a Color4f.
as_M44f(index)	Returns the n-th dependency value as a M44f.
as_Quatf(index)	Returns the n-th dependency value as a Quatf.
as_V2f(index)	Returns the n-th dependency value as a V2f.
as_V2i(index)	Returns the n-th dependency value as a V2i.
as_V3f(index)	Returns the n-th dependency value as a V3f.
as_V3i(index)	Returns the n-th dependency value as a V3i.
as_V4f(index)	Returns the n-th dependency value as a V4f.
as_V4i(index)	Returns the n-th dependency value as a V4i.
as_bool(index)	Returns the n-th dependency value as a bool.
as_float(index)	Returns the n-th dependency value as a float.
as_int(index)	Returns the n-th dependency value as an integer.
as_string(index)	Returns the n-th dependency value as a string.
value(index)	Returns the n-th dependency value.
value_count()	Returns the number of dependencies value available.

__init__

x.__init__(…) initializes x; see help(type(x)) for signature

as_Box3f(index: int) → Imath.Box3f

Returns the n-th dependency value as a Box3f.

You must be sure this value is a Box3f or you will have an empty box.

Parameters:index (int) – index of the dependency to query Return type:Imath.Box3f

as_Color4f(index: int) → Imath.Color4f

Returns the n-th dependency value as a Color4f.

You must be sure this value is a Color4f or you will have a default value.

Parameters:index (int) – index of the dependency to query Return type:Imath.Color4f

as_M44f(index: int) → Imath.M44f

Returns the n-th dependency value as a M44f.

You must be sure this value is a M44f or you will have an identity matrix.

Parameters:index (int) – index of the dependency to query Return type:Imath.M44f

as_Quatf(index: int) → Imath.Quatf

Returns the n-th dependency value as a Quatf.

You must be sure this value is a Quatf or you will have an identity quaternion.

Parameters:index (int) – index of the dependency to query Return type:Imath.Quatf

as_V2f(index: int) → Imath.V2f

Returns the n-th dependency value as a V2f.

You must be sure this value is a V2f or you will have {0,0}.

Parameters:index (int) – index of the dependency to query Return type:Imath.V2f

as_V2i(index: int) → Imath.V2i

Returns the n-th dependency value as a V2i.

You must be sure this value is a V2i or you will have {0,0}.

Parameters:index (int) – index of the dependency to query Return type:Imath.V2i

as_V3f(index: int) → Imath.V3f

Returns the n-th dependency value as a V3f.

You must be sure this value is a V3f or you will have {0,0,0}.

Parameters:index (int) – index of the dependency to query Return type:Imath.V3f

as_V3i(index: int) → Imath.V3i

Returns the n-th dependency value as a V3i.

You must be sure this value is a V3i or you will have {0,0,0}.

Parameters:index (int) – index of the dependency to query Return type:Imath.V3i

as_V4f(index: int) → Imath.V4f

Returns the n-th dependency value as a V4f.

You must be sure this value is a V4f or you will have {0,0,0,0}.

Parameters:index (int) – index of the dependency to query Return type:Imath.V4f

as_V4i(index: int) → Imath.V4i

Returns the n-th dependency value as a V4i.

You must be sure this value is a V4i or you will have {0,0,0,0}.

Parameters:index (int) – index of the dependency to query Return type:Imath.V4i

as_bool(index: int) → bool

Returns the n-th dependency value as a bool.

You must be sure this value is an integer, a float or a boolean or you get false.

Parameters:index (int) – index of the dependency to query Return type:bool

as_float(index: int) → float

Returns the n-th dependency value as a float.

You must be sure this value is an integer, a float or a boolean or you get 0.f.

Parameters:index (int) – index of the dependency to query Return type:float

as_int(index: int) → int

Returns the n-th dependency value as an integer.

You must be sure this value is an integer, a float or a boolean or you get 0.

Parameters:index (int) – index of the dependency to query Return type:int

as_string(index: int) → unicode

Returns the n-th dependency value as a string.

You must be sure this value is a string or you will have an empty string.

Parameters:index (int) – index of the dependency to query Return type:unicode

value(index: int) → Value

Returns the n-th dependency value.

The Value pointer is null if no plug is connected to this dependency entry. If this is an internal dependency set in the Node constructor, you shall assume the Value pointer is valid.

Parameters:index (int) – index of the dependency to query Return type:Value

value_count() → int

Returns the number of dependencies value available.

Return type:int