Public Member Functions | Protected Member Functions

MFnPartition Class Reference

Search for all occurrences

Detailed Description

Function set for partitions of objects.

MFnPartition is the function set that is used for manipulating partitions of objects.

A partition is a list of dependency nodes and dag nodes. Partitions are useful for keeping track of lists of objects for many purposes such as selection or applying common rendering parameters. Partitions in Maya are also dependency nodes, so it is possible for one partition to contain others.

#include <MFnPartition.h>

Inheritance diagram for MFnPartition:
Inheritance graph
[legend]

List of all members.

Public Member Functions

virtual MFn::Type type () const
 Function set type.
virtual ~MFnPartition ()
 Destructor.
 MFnPartition ()
 Default constructor.
 MFnPartition (MObject &object, MStatus *ReturnStatus=NULL)
 Constructor.
MObject create (bool isRenderPartition=false, MStatus *ReturnStatus=NULL)
 Creates a new partition dependency node and puts it in the dependency graph.
bool isRenderPartition (MStatus *ReturnStatus=NULL) const
 Returns true if this partition is a render partition.
MStatus addMember (const MObject &set)
 Add a set to this partition.
MStatus removeMember (const MObject &set)
 Remove a set from this partition.
 MFnPartition (const MObject &object, MStatus *ReturnStatus=NULL)
 Constructor.

Protected Member Functions

virtual const char * className () const
 Class name.

Constructor & Destructor Documentation

MFnPartition ( 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:
MFnPartition ( 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::kPartition.

Reimplemented from MFnDependencyNode.

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

Class name.

Return the class name : "MFnPartition".

Reimplemented from MFnDependencyNode.

MObject create ( bool  isRenderPartition = false,
MStatus ReturnStatus = NULL 
)

Creates a new partition dependency node and puts it in the dependency graph.

Parameters:
[in]isRenderPartitiondetermines whether this partition is a render partition
[out]ReturnStatusreturn status
Returns:
A handle for the new partition object
Status Codes:
bool isRenderPartition ( MStatus ReturnStatus = NULL) const

Returns true if this partition is a render partition.

Parameters:
[out]ReturnStatusreturn status
Returns:
A boolean value indicating whether the object is a member
Status Codes:
MStatus addMember ( const MObject set)

Add a set to this partition.

To be added to a partition, a set must be mutually exclusive with all of the other sets in the partition. If there are any conflicting elements, then the add will fail.

Parameters:
[in]setnew set to be added to this partiton.
Returns:
Return status
Status Codes:
MStatus removeMember ( const MObject set)

Remove a set from this partition.

Parameters:
[in]setold set to be removed from this partiton.
Returns:
Return status
Status Codes:

MFnPartition MFnPartition MFnPartition MFnPartition MFnPartition MFnPartition MFnPartition MFnPartition MFnPartition MFnPartition
MFnPartition MFnPartition MFnPartition MFnPartition MFnPartition MFnPartition MFnPartition MFnPartition MFnPartition MFnPartition