#include
<MFnPartition.h>
List of all
members.
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.
Constructor & Destructor Documentation
MFnPartition::MFnPartition |
( |
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:
-
MFnPartition::MFnPartition |
( |
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:
-
Member Function Documentation
MFn::Type
MFnPartition::type |
( |
|
) |
const [virtual] |
const char * MFnPartition::className |
( |
|
) |
const [protected, virtual] |
Class name.
Return the class name : "MFnPartition"
Reimplemented from MFnDependencyNode.
MObject MFnPartition::create |
( |
bool |
isRenderPartition =
false , |
|
|
MStatus * |
ReturnStatus =
NULL |
|
|
) |
|
|
|
Creates a new partition dependency node and puts it in the
dependency graph.
- Parameters:
-
[in] |
isRenderPartition |
determines whether this partition is a render partition |
[out] |
ReturnStatus |
return status |
- Returns:
- A handle for the new partition object
- Status Codes:
-
bool MFnPartition::isRenderPartition |
( |
MStatus * |
ReturnStatus =
NULL |
) |
const |
Returns true if this partition is a render partition.
- Parameters:
-
[out] |
ReturnStatus |
return status |
- Returns:
- A boolean value indicating whether the object is a member
- Status Codes:
-
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] |
set |
new set to be added to this partiton. |
- Returns:
- Return status
- Status Codes:
-
Remove a set from this partition.
- Parameters:
-
[in] |
set |
old set to be removed from this partiton. |
- Returns:
- Return status
- Status Codes:
-