MColorManagementNodes Class Reference

Introduced in 2019.0 More...

#include <MColorManagementNodes.h>

Static Public Member Functions
static const char *	className ()
	Returns the name of this class. More...
static bool	isColorManageable (const MObject &object)
	Returns whether the object is color manageable or not. More...
static bool	isColorManaged (const MObject &object)
	Returns whether the object is color managed or not. More...
static MStatus	colorManage (MObject &object, const MString &filename, MDGModifier &dgModifier)
	Color manage one specific input node. More...
static MStatus	colorManageAllNodes (MDGModifier &dgModifier)
	Color manage all input nodes. More...

Detailed Description

Introduced in 2019.0

2019.0:

Introduced in this version.

Utilities for manipulating color manageable nodes.

Member Function Documentation

const char * className ( )

static

Returns the name of this class.

Returns

The name of this class.

OPENMAYA_MAJOR_NAMESPACE_OPEN bool isColorManageable ( const MObject &  object )

static

Returns whether the object is color manageable or not.

Parameters

[in]

object

The input object to test

Returns

true if object is color manageable

bool isColorManaged ( const MObject &  object )

static

Returns whether the object is color managed or not.

Parameters

[in]

object

The input object to test

Returns

true if object is color managed

MStatus colorManage ( MObject &  object, const MString &  filename, MDGModifier &  dgModifier  )

static

Color manage one specific input node.

This function will connect the input node to the global color management properties through these 4 plugs: "colorManagementEnabled" (whether color management is being used or not), "colorManagementConfigFileEnabled" (whether OCIO configuration file is being used or not), "configFilePath" (the OCIO config file path being used), "workingSpace" (target working space used for color management). It is the users' responsibility to ensure that these plugs are exist beforehand. If not, this function will return as failed. This function is safe to be called if certain plug(s) is(are) already connected.

In the case, plug "colorSpace" (the color space used for color management) is available in the input object, this function will apply the color management rule to it.

Parameters

[in]	object	The input object to be connected to global node
[in]	filename	The texture filename used by the input object
[in,out]	dgModifier	The DG modifier to be used

Returns

Status code

Status Codes:

• MStatus::kSuccess The operation executed successfully.
• MStatus::kInvalidParameter The node is not color manageable.
• MStatus::kFailure The operation failed.

MStatus colorManageAllNodes ( MDGModifier &  dgModifier )

static

Color manage all input nodes.

This function will color manage all input nodes.

Note

Be careful that this call could have a huge performance impact as it iterates on all nodes from the scene.

Parameters

[in,out]

dgModifier

The DG mdofier to be used

Returns

Status code

Status Codes:

• MStatus::kSuccess The operation executed successfully.
• MStatus::kFailure The operation failed.

---

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

• MColorManagementNodes.h
• MColorManagementNodes.cpp