OpenMaya.MAttributeIndex Class Reference

OpenMaya.MAttributeIndex Class Reference

Class Description

The index information for an attribute specification.
+ Inheritance diagram for OpenMaya.MAttributeIndex:

Public Member Functions

__eq__ ()
 
__ge__ ()
 
__gt__ ()
 
__init__ ()
 
__le__ ()
 
__lt__ ()
 
__ne__ ()
 
copy ()
 
getLower ()
 
getUpper ()
 
getValue ()
 
hasLowerBound ()
 
hasRange ()
 
hasUpperBound ()
 
hasValidRange ()
 
isBounded ()
 
setLower ()
 
setType ()
 
setUpper ()
 
setValue ()
 
type ()
 

Static Public Attributes

int kFloat = 1
 
int kInteger = 0
 

Constructor & Destructor Documentation

OpenMaya.MAttributeIndex.__init__ ( )
x.__init__(...) initializes x; see help(type(x)) for signature

Member Function Documentation

OpenMaya.MAttributeIndex.__eq__ ( )
x.__eq__(y) <==> x==y
OpenMaya.MAttributeIndex.__ge__ ( )
x.__ge__(y) <==> x>=y
OpenMaya.MAttributeIndex.__gt__ ( )
x.__gt__(y) <==> x>y
OpenMaya.MAttributeIndex.__le__ ( )
x.__le__(y) <==> x<=y
OpenMaya.MAttributeIndex.__lt__ ( )
x.__lt__(y) <==> x<y
OpenMaya.MAttributeIndex.__ne__ ( )
x.__ne__(y) <==> x!=y
OpenMaya.MAttributeIndex.copy ( )
copy(source) -> self

Copy data from source index.

* source (MAttributeIndex) - The source index to copy from
OpenMaya.MAttributeIndex.getLower ( )
getLower() -> int/float

Returns the lower bound of the index.
OpenMaya.MAttributeIndex.getUpper ( )
getUpper() -> int/float

Returns the upper bound of the index.
OpenMaya.MAttributeIndex.getValue ( )
getValue() -> int/float

Returns the current value of the index.
Raises an exception if the index is a range.
OpenMaya.MAttributeIndex.hasLowerBound ( )
hasLowerBound() -> bool

Returns True if a lower bound is specified.
OpenMaya.MAttributeIndex.hasRange ( )
hasRange() -> bool

Returns True if a range was specified.
OpenMaya.MAttributeIndex.hasUpperBound ( )
hasUpperBound() -> bool

Returns True if an upper bound is specified.
OpenMaya.MAttributeIndex.hasValidRange ( )
hasValidRange() -> bool

Returns True if upper bound is greater than lower bound.
OpenMaya.MAttributeIndex.isBounded ( )
isBounded() -> bool

Returns True if the index is bounded.
OpenMaya.MAttributeIndex.setLower ( )
setLower(value) -> self

Sets the lower bound of the index.
OpenMaya.MAttributeIndex.setType ( )
setType(type) -> self

Sets the type of attribute index.
See type() for a list of valid index types.

* type (int) - the index type to set
OpenMaya.MAttributeIndex.setUpper ( )
setUpper(value) -> self

Sets the upper bound of the index.
OpenMaya.MAttributeIndex.setValue ( )
setValue(value) -> self

Sets the value of the index.

Remark: calling this method with an integer value will change its type to kInteger, and subsequently calling with a float value will change it to kFloat.
OpenMaya.MAttributeIndex.type ( )
type() -> int

Returns the type of attribute index.

Valid index types:
  kInteger      Integer index (e.g. mesh.cp[5])
  kFloat                Floating-poing index (e.g. curve.u[1.3])