Public Types | Public Member Functions | Protected Member Functions

MFnContainerNode Class Reference

Search for all occurrences

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 defines the primary interface to those nodes. This class allows you to query information about container nodes in the Maya scene.

#include <MFnContainerNode.h>

Inheritance diagram for MFnContainerNode:
Inheritance graph
[legend]

List of all members.

Public Types

enum  MPublishNodeType { kParentAnchor, kChildAnchor, kGeneric }
 

Specify which type of published node.

More...

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
 Return two arrays: the first contains the plugs that have been published on this container.
MStatus getPublishedNames (MStringArray &publishedNames, bool unboundOnly) const
 Return a list of published names on the container.
MStatus getMembers (MObjectArray &members) const
 Return an array of the nodes included in this container.
MStatus getSubcontainers (MObjectArray &members) const
 Return an array of the container nodes included in this container.
MStatus getParentContainer (MObject &parent) const
 Return the parent container, if there is one.
MStatus getRootTransform (MObject &root) const
 Return the root transform, if there is one.
MStatus getPublishedNodes (MPublishNodeType type, MStringArray &publishedNames, MObjectArray &nodes) const
 Return a list of the published nodes of a given type.
 MFnContainerNode (const MObject &object, MStatus *ReturnStatus=NULL)
 Constructor.

Protected Member Functions

virtual const char * className () const
 Class name.

Member Enumeration Documentation

Specify which type of published node.

Enumerator:
kParentAnchor 

published as parent anchor

kChildAnchor 

published as child anchor

kGeneric 

published as node (non-anchor)


Constructor & Destructor Documentation

MFnContainerNode ( MObject object,
MStatus ReturnStatus = NULL 
)

Constructor.

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

Parameters:
[in]objectThe MObject to attach the function set to
[out]ReturnStatusthe return status
Status Codes:
MFnContainerNode ( const MObject object,
MStatus ReturnStatus = NULL 
)

Constructor.

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

Parameters:
[in]objectThe MObject to attach the function set to
[out]ReturnStatusthe return status
Status Codes:

Member Function Documentation

MFn::Type type ( ) const [virtual]

Function set type.

Return the class type : MFn::kContainerBase.

Reimplemented from MFnDependencyNode.

const char * className ( ) const [protected, virtual]

Class name.

Return the class name : "MFnContainerNode".

Reimplemented from MFnDependencyNode.

MStatus 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:
[out]publishedPlugsarray to store the result plugs
[out]publishedNamesarray to store the result names
Returns:
Return status
Status Codes:
MStatus getPublishedNames ( MStringArray publishedNames,
bool  unboundOnly 
) const

Return a list of published names on the container.

Depending on the arguments, either all published names or only unbound published names will be returned.

Parameters:
[out]publishedNamesarray to store the result names
[in]unboundOnlyif true, only return names that are not associated with a plug
Returns:
Return status
Status Codes:
MStatus getMembers ( MObjectArray members) const

Return an array of the nodes included in this container.

Parameters:
[in]membersarray to store the result nodes
Returns:
Return status
Status Codes:
MStatus getSubcontainers ( MObjectArray subcontainers) const

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

Parameters:
[out]subcontainersarray to store the result nodes
Returns:
Return status
Status Codes:
MStatus getParentContainer ( MObject parent) const

Return the parent container, if there is one.

Otherwise return an empty MObject

Parameters:
[out]parentparent container, if found
Returns:
Return status
Status Codes:
MStatus getRootTransform ( MObject root) const

Return the root transform, if there is one.

Otherwise return an empty MObject.

Parameters:
[out]rootroot transform, if found
Returns:
Return status
Status Codes:
MStatus getPublishedNodes ( MPublishNodeType  type,
MStringArray publishedNames,
MObjectArray nodes 
) const

Return a list of the published nodes of a given type.

For any names that have assigned nodes, return the node at the corresponding array index. For any names that do not have assigned nodes, a NULL MObject will be at the corresponding array index.

Parameters:
[in]typepublished node type of interest
[out]publishedNamespublished names of the specified type
[out]nodescorresponding published node or a NULL MObject
Returns:
Return status
Status Codes:

MFnContainerNode MFnContainerNode MFnContainerNode MFnContainerNode MFnContainerNode MFnContainerNode MFnContainerNode MFnContainerNode MFnContainerNode MFnContainerNode
MFnContainerNode MFnContainerNode MFnContainerNode MFnContainerNode MFnContainerNode MFnContainerNode MFnContainerNode MFnContainerNode MFnContainerNode MFnContainerNode