MFnContainerNode Class Reference
[OpenMaya - API module for common classes, FunctionSet classes]

#include <MFnContainerNode.h>

Inheritance diagram for MFnContainerNode:

[legend]

Collaboration diagram for MFnContainerNode:

[legend]

List of all members.

---

Detailed Description

container function set

MFnContainerNode is the function set for creating, querying and editing containers.

Maya uses container nodes to bundle sets of related nodes together with a published attribute list that defined the primary interface to those nodes. This class allows you to query information about container nodes in the Maya scene.

Public Member Functions
virtual MFn::Type	type () const
	Function set type.
virtual	~MFnContainerNode ()
	Destructor.
	MFnContainerNode ()
	Default constructor.
	MFnContainerNode (MObject &object, MStatus *ReturnStatus=NULL)
	Constructor.
MStatus	getPublishedPlugs (MPlugArray &publishedPlugs, MStringArray &publishedNames) const
MStatus	getMembers (MObjectArray &members) const
MStatus	getSubcontainers (MObjectArray &members) const
MStatus	getParentContainer (MObject &parent) const
	MFnContainerNode (const MObject &object, MStatus *ReturnStatus=NULL)
	Constructor.
Protected Member Functions
virtual const char *	className () const
	Class name.

---

Constructor & Destructor Documentation

MFnContainerNode::MFnContainerNode	(	MObject &	object,
		MStatus *	ReturnStatus = NULL
	)

Constructor.

Class constructor that initializes the function set to the given MObject.

Parameters:

[in]	object	The MObject to attach the function set to
[out]	ReturnStatus	the return status

Status Codes:

• MS::kSuccess if the function set is successfully attached
• MS::kInvalidParameter if the MObject does not represent a valid Maya object or if the function set is not allowed to attach to this MObject

MFnContainerNode::MFnContainerNode	(	const MObject &	object,
		MStatus *	ReturnStatus = NULL
	)

Constructor.

Class constructor that initializes the function set to the given MObject.

Parameters:

[in]	object	The MObject to attach the function set to
[out]	ReturnStatus	the return status

Status Codes:

• MS::kSuccess if the function set is successfully attached
• MS::kInvalidParameter if the MObject does not represent a valid Maya object or if the function set is not allowed to attach to this MObject

---

Member Function Documentation

MFn::Type MFnContainerNode::type

(

)

const [virtual]

Function set type.

Return the class type : MFn::kContainer

Reimplemented from MFnDependencyNode.

const char * MFnContainerNode::className

(

)

const [protected, virtual]

Class name.

Return the class name : "MFnContainerNode"

Reimplemented from MFnDependencyNode.

MStatus MFnContainerNode::getPublishedPlugs	(	MPlugArray &	publishedPlugs,
		MStringArray &	publishedNames
	)			const

Return two arrays: the first contains the plugs that have been published on this container. The second contains that published names for those plugs. There is a one-to-one correspondence between the plugs in the first array and the strings in the second.

Parameters:

[in]	publishedPlugs	array to store the result plugs
[in]	publishedNames	array to store the result names

Returns:

Return status

Status Codes:

• MS::kSuccess operation successful
• MS::kFailure this function set does not have a valid container object

MStatus MFnContainerNode::getMembers

(

MObjectArray &

members

)

const

Return an array of the nodes included in this container.

Parameters:

[in]

members

array to store the result nodes

Returns:

Return status

Status Codes:

• MS::kSuccess operation successful
• MS::kFailure this function set does not have a valid container object

MStatus MFnContainerNode::getSubcontainers

(

MObjectArray &

subcontainers

)

const

Return an array of the container nodes included in this container.

Parameters:

[in]

subcontainers

array to store the result nodes

Returns:

Return status

Status Codes:

• MS::kSuccess operation successful
• MS::kFailure this function set does not have a valid container object

MStatus MFnContainerNode::getParentContainer

(

MObject &

parent

)

const

Return the parent container, if there is one. Otherwise return an empty MObject

Parameters:

[in]

parent

parent container, if found

Returns:

Return status

Status Codes:

• MS::kSuccess operation successful
• MS::kFailure this function set does not have a valid container object