MEvaluationGraph Class Reference

Evaluation graph object. More...

#include <MEvaluationGraph.h>

Public Member Functions
virtual	~MEvaluationGraph ()
	Destructor.
MDGContext	context (MStatus *ReturnStatus) const
	Provides evaluation context. More...
bool	partialEvaluation () const
	Test if graph is partially invalidated. More...
MEvaluationNode	rootNode () const
	Introduced in 2019.0 More...
bool	manipulationActive () const
	Introduced in 2024.0 More...

Static Public Member Functions
static MEvaluationGraph	ownerGraph (const MEvaluationNode &evalNode)
	Introduced in 2019.0 More...
static MEvaluationGraph	contextGraph (const MDGContext &context)
	Introduced in 2024.0 More...
static const char *	className ()
	Returns the name of this class. More...

Detailed Description

Evaluation graph object.

The evaluation graph holds information about what in the scene is considered to be live (or time dependent). It is constructed out of dirty messages, and has full knowledge of dependencies between live nodes. This is why it can be used to replace regular Maya evaluation with dirty propagation.

The evaluation graph is linked to DG context and graph construction. This context is fully respected during evaluation.

Evaluation with the evaluation graph can be done in different modes and depending on settings, a different executor is used to traverse the graph and do complete or partial graph computation. Unlike the DG, the evaluation with evaluation graph is using forward evaluation model. Graph topology is defined by directional connections between evaluation nodes.

Examples:

simpleEvaluator/simpleEvaluator.cpp, and testMTopologyEvaluator/testMTopologyEvaluator.cpp.

Member Function Documentation

OPENMAYA_MAJOR_NAMESPACE_OPEN MDGContext context

(

MStatus *

ReturnStatus

)

const

Provides evaluation context.

Parameters

[in]

ReturnStatus

Status object

Returns

Current evaluation context

Status Codes:

• MS::kSuccess operation successful
• MS::kFailure operation failed (graph does not exist)

bool partialEvaluation

(

)

const

Test if graph is partially invalidated.

Returns

True if scene evaluation was partially invalidated

MEvaluationNode rootNode

(

)

const

Introduced in 2019.0

Get evaluation graph root node.

2019.0:

Introduced in this version.

Every evaluation node in evaluation graph is reachable from root node.

Returns

Root evaluation node.

Examples:

testMTopologyEvaluator/testMTopologyEvaluator.cpp.

bool manipulationActive

(

)

const

Introduced in 2024.0

Return the status of manipulation with the graph.

2024.0:

Introduced in this version.

Returns

true if manipulation is active

MEvaluationGraph ownerGraph ( const MEvaluationNode &  evalNode )

static

Introduced in 2019.0

Access evaluation graph owning given evaluation node.

2019.0:

Introduced in this version.

Parameters

[in]

evalNode

Evaluation node to return owning graph

Returns

Evaluation graph

Examples:

testMTopologyEvaluator/testMTopologyEvaluator.cpp.

MEvaluationGraph contextGraph ( const MDGContext &  context )

static

Introduced in 2024.0

Access evaluation graph for given context.

2024.0:

Introduced in this version.

Parameters

[in]

context

MDGContext to return graph

Returns

Evaluation graph

const char * className ( )

static

Returns the name of this class.

Returns

The name of this class.

---

The documentation for this class was generated from the following files:

• MEvaluationGraph.h
• MEvaluationGraph.cpp