Python API 2.0 Reference
OpenMaya.MFnSet Class Reference
+ Inheritance diagram for OpenMaya.MFnSet:

Public Member Functions

def __init__ ()
 
def addMember ()
 
def addMembers ()
 
def annotation ()
 
def clear ()
 
def create ()
 
def getIntersection ()
 
def getMemberPaths ()
 
def getMembers ()
 
def getUnion ()
 
def hasRestrictions ()
 
def intersectsWith ()
 
def isMember ()
 
def removeMember ()
 
def removeMembers ()
 
def restriction ()
 
def setAnnotation ()
 
- Public Member Functions inherited from OpenMaya.MFnDependencyNode
def __init__ ()
 
def absoluteName ()
 
def addAttribute ()
 
def addExternalContentForFileAttr ()
 
def affectsAnimation ()
 
def attribute ()
 
def attributeClass ()
 
def attributeCount ()
 
def canBeWritten ()
 
def create ()
 
def dgCallbackIds ()
 
def dgCallbacks ()
 
def dgTimer ()
 
def dgTimerOff ()
 
def dgTimerOn ()
 
def dgTimerQueryState ()
 
def dgTimerReset ()
 
def findAlias ()
 
def findPlug ()
 
def getAffectedAttributes ()
 
def getAffectingAttributes ()
 
def getAliasAttr ()
 
def getAliasList ()
 
def getConnections ()
 
def getExternalContent ()
 
def hasAttribute ()
 
def hasUniqueName ()
 
def isFlagSet ()
 
def isNewAttribute ()
 
def isTrackingEdits ()
 
def name ()
 
def plugsAlias ()
 
def removeAttribute ()
 
def reorderedAttribute ()
 
def setAffectsAnimation ()
 
def setAlias ()
 
def setDoNotWrite ()
 
def setExternalContent ()
 
def setExternalContentForFileAttr ()
 
def setFlag ()
 
def setName ()
 
def setUuid ()
 
def uniqueName ()
 
def userNode ()
 
def uuid ()
 
- Public Member Functions inherited from OpenMaya.MFnBase
def __init__ ()
 
def hasObj ()
 
def object ()
 
def setObject ()
 
def type ()
 

Static Public Member Functions

def __new__ ()
 
- Static Public Member Functions inherited from OpenMaya.MFnDependencyNode
def __new__ ()
 
def allocateFlag ()
 
def classification ()
 
def deallocateAllFlags ()
 
def deallocateFlag ()
 
- Static Public Member Functions inherited from OpenMaya.MFnBase
def __new__ ()
 

Static Public Attributes

int kEdgesOnly = 2
 
int kEditPointsOnly = 4
 
int kFacetsOnly = 3
 
int kNone = 0
 
int kRenderableOnly = 5
 
int kVerticesOnly = 1
 
- Static Public Attributes inherited from OpenMaya.MFnDependencyNode
int kTimerMetrics = 9
 
int kTimerTypes = 3
 
int kExtensionAttr = 3
 
int kInvalidAttr = 4
 
int kLocalDynamicAttr = 1
 
int kNormalAttr = 2
 
int kTimerInvalidState = 3
 
int kTimerOff = 0
 
int kTimerOn = 1
 
int kTimerUninitialized = 2
 
int kTimerMetric_callback = 0
 
int kTimerMetric_callbackNotViaAPI = 6
 
int kTimerMetric_callbackViaAPI = 5
 
int kTimerMetric_compute = 1
 
int kTimerMetric_computeDuringCallback = 7
 
int kTimerMetric_computeNotDuringCallback = 8
 
int kTimerMetric_dirty = 2
 
int kTimerMetric_draw = 3
 
int kTimerMetric_fetch = 4
 
int kTimerType_count = 2
 
int kTimerType_inclusive = 1
 
int kTimerType_self = 0
 

Additional Inherited Members

- Properties inherited from OpenMaya.MFnDependencyNode
 isDefaultNode = property(...)
 
 isFromReferencedFile = property(...)
 
 isLocked = property(...)
 
 isShared = property(...)
 
 namespace = property(...)
 
 pluginName = property(...)
 
 typeId = property(...)
 
 typeName = property(...)
 

Detailed Description

Function set for sets.

Method resolution order:
-   MFnSet
-   MFnDependencyNode
-   MFnBase
-   builtins.object

Constructor & Destructor Documentation

def OpenMaya.MFnSet.__init__ ( )
Initialize self.  See help(type(self)) for accurate signature.

Member Function Documentation

def OpenMaya.MFnSet.__new__ ( )
static
Create and return a new object.  See help(type) for accurate signature.
def OpenMaya.MFnSet.addMember ( )
addMember( object ) -> self

Add a new object to the set.

The added object may be an MObject, an (MDagPath, MObject) tuple, or an MPlug.
def OpenMaya.MFnSet.addMembers ( )
addMembers( MSelectionList ) -> self

Add a list of new objects to the set.
def OpenMaya.MFnSet.annotation ( )
annotation() -> string

Returns the annotation string for this set.  This allows a description of the set to be stored with it.
def OpenMaya.MFnSet.clear ( )
clear() -> self

Removes all elements from this set.
def OpenMaya.MFnSet.create ( )
create(members, restriction=kNone) -> MObject

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

* members (MSelectionList) - list of members for new set
* restriction (MFnSet.Restriction) - restriction applied to members
def OpenMaya.MFnSet.getIntersection ( )
getIntersection( otherSet ) -> MSelectionList

This method calculates the intersection of two sets.  The result will be the intersection of this set and the set passed into the method.

* otherSet (MObject or MObjectArray or list of sets) - set(s) to find union of with this set
def OpenMaya.MFnSet.getMemberPaths ( )
getMemberPaths( shading ) -> MDagPathArray

Get the members of this set as an array of dagPaths.

This will usually return the same dagPaths as will be contained in the getMembersmethod. If the shading flag is set to true, the list will consist only of dagPathsthat are affected by this set for the purposes of material assignments.

* shading (bool) -  whether the list should only contain members of this set used for shading purposes.
def OpenMaya.MFnSet.getMembers ( )
getMembers( flatten ) -> MSelectionList

Get the members of this set as a selection list.  This information is providedas a selection list so that all of the path information is retained forDAG nodes.

It is possible to ask for the returned list to be flattened.  This means thatall sets that exist inside this set will be expanded into a list of theircontents.

* flatten (bool) - whether to flatten the returned list
def OpenMaya.MFnSet.getUnion ( )
getUnion( otherSet ) -> MSelectionList

This method calculates the union of two sets.  The result will be the union of this set and the set passed into the method.

* otherSet (MObject or MObjectArray or list of sets) - set(s) to find union of with this set
def OpenMaya.MFnSet.hasRestrictions ( )
hasRestrictions() -> bool

Returns true if this function set has restrictions on the type of objects that it may contain.
def OpenMaya.MFnSet.intersectsWith ( )
intersectsWith( otherSet ) -> self

Returns true if this set intersects with the given set.  An intersection occurs if there are any common members between the two sets.
def OpenMaya.MFnSet.isMember ( )
isMember( object ) -> bool

Returns true if the given object is a member of this set.

The object may be an MObject, an (MDagPath, MObject) tuple, or an MPlug.
def OpenMaya.MFnSet.removeMember ( )
removeMember( object ) -> self

Remove an object from the set.

The removed object may be an MObject, an (MDagPath, MObject) tuple, or an MPlug.
def OpenMaya.MFnSet.removeMembers ( )
removeMembers( MSelectionList ) -> self

Remove items of the selection list from the set.
def OpenMaya.MFnSet.restriction ( )
restriction() -> MFnSet.Restriction

Returns the type of membership restriction that this set has.
def OpenMaya.MFnSet.setAnnotation ( )
setAnnotation( annotation ) -> self

Sets the annotation string for this set.  This allows a description of the set to be stored with it.