Python API 2.0 Reference: OpenMaya.MFnComponent Class Reference

+ Inheritance diagram for OpenMaya.MFnComponent:

Public Member Functions

__init__ ()
 
isEqual ()
 
weight ()
 
- Public Member Functions inherited from OpenMaya.MFnBase
__init__ ()
 
hasObj ()
 
object ()
 
setObject ()
 
type ()
 

Properties

 componentType
 
 elementCount
 
 hasWeights
 
 isComplete
 
 isEmpty
 

Detailed Description

This is the base class for all function sets which deal with
component objects.

__init__()
Initializes a new, empty MFnComponent object
__init__(MObject component)
Initializes a new MFnComponent function set, attached to the specified component.

Method resolution order:
-   MFnComponent
-   MFnBase
-   __builtin__.object

Base Class

MFnBase

Constructors

Signature Parameters Description
MFnComponent()  

Default constructor. Returns a new, empty MFnComponent object.

MFnComponent(component) component - MObject

Returns a new MFnComponent function set, attached to the specified component.

 


Constructor & Destructor Documentation

OpenMaya.MFnComponent.__init__ ( )
x.__init__(...) initializes x; see x.__class__.__doc__ for signature

Member Function Documentation

OpenMaya.MFnComponent.isEqual ( )
isEqual(MObject other) -> bool

Returns True if other refers to the same component as the
one to which the function set is currently attached.
Signature: isEqual(other)
Parameters: other - MObject
Returns: bool
Description: Returns true if other refers to the same component as the one to which the function set is currently attached.
OpenMaya.MFnComponent.weight ( )
weight(index) -> MWeight

Returns the weight associated with the specified element,
where index can range from 0 to elementCount-1.
Signature: weight(index)
Parameters: index - int
Returns: MWeight
Description: Returns the weight associated with the specified element, where index can range from 0 to elementCount-1.

Property Documentation

OpenMaya.MFnComponent.componentType
static
 Type of the component. (MFn Type constant)
Name: componentType
Type: MFn Type constant
Access: R
Description: Type of the component.
OpenMaya.MFnComponent.elementCount
static
 Number of elements in the component.
Name: elementCount
Type: int
Access: R
Description: Number of elements in the component.
OpenMaya.MFnComponent.hasWeights
static
 True if the component has weights associated with its elements.
Name: hasWeights
Type: bool
Access: R
Description: True if the component has weights associated with its elements.
OpenMaya.MFnComponent.isComplete
static
 Marking a component as complete means that it represents a full set
 of indices from 0 to elementCount-1
Name: isComplete
Type: bool
Access: RW
Description: Marking a component as complete means that it represents a full set of indices from 0 to numElements()-1
OpenMaya.MFnComponent.isEmpty
static
 True if the component contains no elements.
Name: isEmpty
Type: bool
Access: R
Description: True if the component contains no elements.