Python API 2.0 Reference: OpenMaya.MFnGeometryData Class Reference

OpenMaya.MFnGeometryData Class Reference
+ Inheritance diagram for OpenMaya.MFnGeometryData:

Public Member Functions

__init__ ()
 
addComponentTag ()
 
addObjectGroup ()
 
addObjectGroupComponent ()
 
changeObjectGroupId ()
 
componentTagContents ()
 
componentTagExpressionSubsetState ()
 
componentTagType ()
 
componentTags ()
 
copyObjectGroups ()
 
hasComponentTag ()
 
hasObjectGroup ()
 
objectGroup ()
 
objectGroupComponent ()
 
objectGroupSubsetState ()
 
objectGroupType ()
 
removeComponentTag ()
 
removeObjectGroup ()
 
removeObjectGroupComponent ()
 
renameComponentTag ()
 
resolveComponentTagExpression ()
 
setComponentTagContents ()
 
setObjectGroupComponent ()
 
- Public Member Functions inherited from OpenMaya.MFnData
__init__ ()
 
- Public Member Functions inherited from OpenMaya.MFnBase
__init__ ()
 
hasObj ()
 
object ()
 
setObject ()
 
type ()
 

Static Public Attributes

int kAuto = 0
 
int kCompleteGroup = 2
 
int kEdges = 3
 
int kEmptyGroup = 1
 
int kFaces = 4
 
int kInvalidGroup = 0
 
int kNull = 1
 
int kPartialGroup = 3
 
int kUnsupported = 5
 
int kVerts = 2
 
- Static Public Attributes inherited from OpenMaya.MFnData
int kAny = 24
 
int kFalloffFunction = 25
 
int kFloatArray = 8
 
int kMatrixArray = 12
 
int kComponentList = 13
 
int kDoubleArray = 7
 
int kDynArrayAttrs = 19
 
int kDynSweptGeometry = 20
 
int kIntArray = 9
 
int kInvalid = 0
 
int kLast = 26
 
int kLattice = 15
 
int kMatrix = 5
 
int kMesh = 14
 
int kNId = 23
 
int kNObject = 22
 
int kNumeric = 1
 
int kNurbsCurve = 16
 
int kNurbsSurface = 17
 
int kPlugin = 2
 
int kPluginGeometry = 3
 
int kPointArray = 10
 
int kSphere = 18
 
int kString = 4
 
int kStringArray = 6
 
int kSubdSurface = 21
 
int kVectorArray = 11
 

Properties

 isIdentity
 
 isNotIdentity
 
 matrix
 
 objectGroupCount
 

Detailed Description

This class is the function set for geometry data.

Geometry data adds matrix and grouping (set) information to regular
data and is used to pass geometry types such as mesh, lattice, and
NURBS shape data through DG connections.

__init__()
Initializes a new, empty MFnGeometryData object

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

Method resolution order:
-   MFnGeometryData
-   MFnData
-   MFnBase
-   __builtin__.object

Base Class

MFnData

Constructors

Signature Parameters Description
MFnGeometryData()  

Default constructor. Returns a new, empty MFnGeometryData object.

MFnGeometryData(obj) obj - MObject

Returns a new MFnGeometryData function set, attached to the specified object.

str() Support

Default.

repr() Support

Default.

 


Constructor & Destructor Documentation

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

Member Function Documentation

OpenMaya.MFnGeometryData.addComponentTag ( )
addComponentTag(key) -> self

Adds a componentTag with the given key to the object.
OpenMaya.MFnGeometryData.addObjectGroup ( )
addObjectGroup(id) -> self

Adds an object group with the given id to the object.
Signature: addObjectGroup(id)
Parameters:
NameTypeDescription
id int group id
Returns: Reference to self
Description: Adds an object group with the given id to the object.
OpenMaya.MFnGeometryData.addObjectGroupComponent ( )
addObjectGroupComponent(id, MObject component) -> self

Adds the members of the given component to the object group
with the given id.
Signature: addObjectGroupComponent(id, component)
Parameters:
NameTypeDescription
id int group id
component MObject Component to be added to specified object group. The component should be an MObject created from any function set derived from MFnComponent (ie. MFnSingleIndexedComponent, MFnDoubleIndexedComponent, MFnTripleIndexedComponent)
Returns: Reference to self
Description: Adds the members of the given component to the object group with the given id.
OpenMaya.MFnGeometryData.changeObjectGroupId ( )
changeObjectGroupId(sourceId, destId) -> self

Changes the id of the object group with the given id to the new id.
Signature: changeObjectGroupId(sourceId, destId)
Parameters:
NameTypeDescription
sourceId int id to change
destId int new id to set
Returns: Reference to self
Description: Changes the id of the object group with the given id to the new id.
OpenMaya.MFnGeometryData.componentTagContents ( )
componentTagContents(key) -> MObject

Returns a component which contains the members of the componentTag
with the given key.
OpenMaya.MFnGeometryData.componentTagExpressionSubsetState ( )
componentTagExpressionSubsetState(expr,ctg) -> MFnGeometryData::SubsetState type constant

Returns the state of the contents of the resolved componentTag expression.
OpenMaya.MFnGeometryData.componentTags ( )
componentTags() -> MObject

Returns the componentTag keys contained in the object.
OpenMaya.MFnGeometryData.componentTagType ( )
componentTagType(key) -> MFn Type constant

Returns the type of the component that the componentTag with the
given key contains.
OpenMaya.MFnGeometryData.copyObjectGroups ( )
copyObjectGroups(MObject inGeom) -> self

Copies the object groups from the given geometry data object.
Signature: copyObjectGroups(inGeom)
Parameters:
NameTypeDescription
inGeom MObject The geometry data to be copied
Returns: Reference to self
Description: Copies the object groups from the given geometry data object.
OpenMaya.MFnGeometryData.hasComponentTag ( )
hasComponentTag(key) -> bool

Returns True if a componentTag with the given key exists.
OpenMaya.MFnGeometryData.hasObjectGroup ( )
hasObjectGroup(id) -> self

Returns True if an object group with the given id is
contained in the data.
Signature: hasObjectGroup(id)
Parameters:
NameTypeDescription
id int group id
Returns: bool
Description: Returns True if an object group with the given id is contained in the data.
OpenMaya.MFnGeometryData.objectGroup ( )
objectGroup(index) -> int

Returns the id of the index'th object group contained by the object.
Signature: objectGroup(index)
Parameters:
NameTypeDescription
index int index in the group array
Returns: int group id
Description: Returns the id of the index'th object group contained by the object.
OpenMaya.MFnGeometryData.objectGroupComponent ( )
objectGroupComponent(id) -> MObject

Returns a component which contains the members of the object group
with the given id.
Signature: objectGroupComponent(id)
Parameters:
NameTypeDescription
id int group id
Returns: MObject
Description: Returns a component which contains the members of the object group with the given id.
OpenMaya.MFnGeometryData.objectGroupSubsetState ( )
objectGroupSubsetState(id) -> MFnGeometryData::SubsetState type constant

Returns the state of the group contents of the object group with the
given id.
OpenMaya.MFnGeometryData.objectGroupType ( )
objectGroupType(id) -> MFn Type constant

Returns the type of the component that the object group with the
given id contains.
Signature: objectGroupType(id)
Parameters:
NameTypeDescription
id int group id
Returns: MFn Type constant.
Description: Returns the type of the component that the object group with the given id contains.
OpenMaya.MFnGeometryData.removeComponentTag ( )
removeComponentTag(key) -> self

Removes a componentTag with the given key from the object.
OpenMaya.MFnGeometryData.removeObjectGroup ( )
removeObjectGroup(id) -> self

Removes an object group with the given id from the object.
Signature: removeObjectGroup(id)
Parameters:
NameTypeDescription
id int group id
Returns: Reference to self
Description: Removes an object group with the given id from the object.
OpenMaya.MFnGeometryData.removeObjectGroupComponent ( )
removeObjectGroupComponent(id, MObject component) -> self

Removes the members of the given component from the object group
with the given id.
Signature: removeObjectGroupComponent(id, component)
Parameters:
NameTypeDescription
id int group id
component MObject Component specifying the members to be removed. The component should be an MObject created from any function set derived from MFnComponent (ie. MFnSingleIndexedComponent, MFnDoubleIndexedComponent, MFnTripleIndexedComponent)
Returns: Reference to self
Description: Removes the members of the given component from the object group with the given id.
OpenMaya.MFnGeometryData.renameComponentTag ( )
renameComponentTag(key, newKey) -> self

Renames a componentag with the given key the object.
OpenMaya.MFnGeometryData.resolveComponentTagExpression ( )
resolveComponentTagExpression(key, ctg) -> MObject

Returns a component which is the result of the resolved componentTag expression
with the given key.
OpenMaya.MFnGeometryData.setComponentTagContents ( )
setComponentTagContents(key, MObject component) -> self

Sets the members of the componentTag with the given key
to be those in the given component.
OpenMaya.MFnGeometryData.setObjectGroupComponent ( )
setObjectGroupComponent(id, MObject component) -> self

Sets the members of the object group with the given id
to be only those in the given component.
Signature: setObjectGroupComponent(id, component)
Parameters:
NameTypeDescription
id int group id
component MObject New component for specified object group. The component should be an MObject created from any function set derived from MFnComponent (ie. MFnSingleIndexedComponent, MFnDoubleIndexedComponent, MFnTripleIndexedComponent)
Returns: Reference to self
Description: Sets the members of the object group with the given id to be only those in the given component.

Property Documentation

OpenMaya.MFnGeometryData.isIdentity
static
 True if the matrix for the geometry is the identity.
Name: isIdentity
Type: bool
Access: R
Description: True if the matrix for the geometry is the identity.
OpenMaya.MFnGeometryData.isNotIdentity
static
 True if the matrix for the geometry is not the identity.
Name: isNotIdentity
Type: bool
Access: R
Description: True if the matrix for the geometry is not the identity.
OpenMaya.MFnGeometryData.matrix
static
 MMatrix used to convert the object into local space.
Name: matrix
Type: MMatrix
Access: RW
Description: Used to convert the object into local space.
OpenMaya.MFnGeometryData.objectGroupCount
static
 The number of object groups contained by the object.
Name: objectGroupCount
Type: int
Access: R
Description: The number of object groups contained by the object.