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

Public Member Functions

def __init__ ()
 
def deleteComponent ()
 
def deleteComponentsFromGroups ()
 
def getMatrix ()
 
def iterator ()
 
def smartCopy ()
 
def updateCompleteVertexGroup ()
 
- Public Member Functions inherited from OpenMaya.MPxData
def __init__ ()
 
def copy ()
 
def name ()
 
def readASCII ()
 
def readBinary ()
 
def typeId ()
 
def writeASCII ()
 
def writeBinary ()
 

Static Public Member Functions

def __new__ ()
 
- Static Public Member Functions inherited from OpenMaya.MPxData
def __new__ ()
 

Properties

 matrix = property(...)
 

Additional Inherited Members

- Static Public Attributes inherited from OpenMaya.MPxData
int kData = 0
 
int kGeometryData = 1
 
int kLast = 2
 

Detailed Description

Base Class for User-defined Dependency Graph Geometry Data Types.

Method resolution order:
-   MPxGeometryData
-   MPxData
-   builtins.object

Constructor & Destructor Documentation

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

Member Function Documentation

def OpenMaya.MPxGeometryData.__new__ ( )
static
Create and return a new object.  See help(type) for accurate signature.
def OpenMaya.MPxGeometryData.deleteComponent ( )
deleteComponent(compList) -> bool

This method should be overridden if this data is to support component deletion. For user defined shapes (MPxSurfaceShape) which support components, this method must be overridden if component deletion is to be supported when the shape has history.

Returns True if the deletion was successfull, False otherwise.

* compList (MObjectArray) - a list of components that are to be deleted
def OpenMaya.MPxGeometryData.deleteComponentsFromGroups ( )
deleteComponentsFromGroups(compList, groupIdArray, groupComponentArray) -> bool

This method should be overridden to modify the groups that flows along with the geometry, as part of the data, based on the components being deleted. It should intelligently update the groups based on what gets deleted. The class MFnGeometryData can be used to access and modify grouping information for data.

Returns True if the deletion was successfull, False otherwise.

The groupIdArray and groupComponentArray should contain the updated grouping information after the deletion has occurred.

* compList (MObjectArray) - a list of components that are to be deleted
* groupIdArray [OUT] (MIntArray) - array of group id's
* groupComponentArray (MObjectArray) - array of updated components, one for each group id
def OpenMaya.MPxGeometryData.getMatrix ( )
getMatrix(matrix) -> bool

Gets the matrix associated to MPxGeometryData and retursn True if is identity

* matrix [OUT] (MMatrix) - the returned matrix that takes a point from local object space to world space.
def OpenMaya.MPxGeometryData.iterator ( )
iterator(componentList, component, useComponents, world=None) -> MPxGeometryIterator

Associates a control point based geometry iterator with this data.
This method is used in conjunction with MPxSurfaceShape and should be overridden if your shape is to support maya's deformations.

The useComponents argument specifies whether the iteration is over the given componentList or the component.

Returns an iterator for your geometry.

* componentList (MObjectArray) - a list of components that are to be iterated over.
* component (MObject) - a component to be iterator over.
* useComponents (bool) - if True then componentList is to be iterated over, otherwise the iteration is on component.
* world (bool) - specifies whether the iteration is for world space data.
def OpenMaya.MPxGeometryData.smartCopy ( )
smartCopy(srcGeom) -> self

This method is used in conjunction with MPxSurfaceShape classes which support maya's deformations.

This method is used to prvoide maya with an efficient way to copy the source data into the memory of this data with as little memory allocation as possible.

This method is not mandatory and only needs to be overridden to improve performance of deformations on shapes.

* srcGeom (MPxGeometryData) - the data to be copied
def OpenMaya.MPxGeometryData.updateCompleteVertexGroup ( )
updateCompleteVertexGroup(component) -> bool

This method is used in conjunction with MPxSurfaceShape classes which support maya's deformations.

This method should make sure that complete vertex group data is up-to-date.
If the given component is not complete (i.e. it represents all elements of your geometry) then you must mark is as complete using the methods of MFnComponent and return true if the component was updated, false if it was already complete.

This method is used by deformers when deforming the "whole" object and not just selected components.

Returns true if the component was updated, false if it was already complete.

* component (MObject) - the component to test

Property Documentation

OpenMaya.MPxGeometryData.matrix = property(...)
static
 The matrix associated to MPxGeometryData.