class MAttributeIndex

Jump to documentation

The index information for an attribute specification. (OpenMaya) (OpenMaya.py)

public members:

enum MIndexType
kInteger
kFloat
MAttributeIndex ()
~MAttributeIndex ()
MAttributeIndex ( const MAttributeIndex & other )
MAttributeIndex ( int value )
MAttributeIndex ( double value )
MIndexType type () const
bool hasRange () const
bool hasValidRange () const
bool hasLowerBound () const
bool hasUpperBound () const
MStatus getLower ( int & value ) const
MStatus getLower ( double & value ) const
MStatus getUpper ( int & value ) const
MStatus getUpper ( double & value ) const
bool isBounded () const
MStatus getValue ( int & value ) const
MStatus getValue ( double & value ) const
MStatus setType ( MIndexType type )
MStatus setValue ( int value )
MStatus setValue ( double value )
MStatus setLower ( int value )
MStatus setLower ( double value )
MStatus setUpper ( int value )
MStatus setUpper ( double value )
MAttributeIndex & operator= ( const MAttributeIndex & other )
bool operator== ( const MAttributeIndex & other ) const
bool operator!= ( const MAttributeIndex & other ) const

Documentation

The index information for an attribute specification. (OpenMaya) (OpenMaya.py)
Description

Class that provides access to the index part of an attribute specification (MAttributeSpec).

See MAttributeSpec for more information.

Functions

MAttributeIndex:: MAttributeIndex ()

Description

Constructor.

MAttributeIndex:: ~MAttributeIndex ()

Description

Destructor.

MAttributeIndex:: MAttributeIndex ( const MAttributeIndex & other )

Description

Copy constructor.

Arguments

  • other value to copy

MAttributeIndex:: MAttributeIndex ( int value )

Description

Constructor.

Arguments

  • value index value to set

MAttributeIndex:: MAttributeIndex ( double value )

Description

Constructor.

Arguments

  • value index value to set

MAttributeIndex::MIndexType MAttributeIndex:: type () const

Description

Returns the type of attribute index.

Valid index types are kInteger and kFloat.

Return Value

  • the index type

bool MAttributeIndex:: hasRange () const

Description

Return true if a range was specified.

Note: false will be returned for an unbounded range which can be tested using the hasBound method.

Return Value

  • boolean indicating whether the range exists or not.

bool MAttributeIndex:: hasValidRange () const

Description

Return true if upper value is greater than lower value.

Return Value

  • boolean indicating whether the range is valid or not.

bool MAttributeIndex:: hasLowerBound () const

Description

Return true if if there is a lower bound specified.

Return Value

  • boolean to indicate if there is a lower bound.

bool MAttributeIndex:: hasUpperBound () const

Description

Return true if if there is an upper bound specified.

Return Value

  • boolean to indicate if there is an upper bound.

MStatus MAttributeIndex:: getLower ( int & value ) const

Description

Return the lower bound for this object or false if 1) the type does not match the argument type or 2) there is no lower bound. (both of which can be tested for using other methods on this class).

Arguments

  • value lower bound value is returned through this parameter.

Return Value

  • MS::kSuccess the call was successful.
  • MS::kFailure method failed.

MStatus MAttributeIndex:: getLower ( double & value ) const

Description

Return the lower bound for this object or false if 1) the type does not match the argument type or 2) there is no lower bound. (both of which can be tested for using other methods on this class).

Arguments

  • value lower bound value is returned through this parameter.

Return Value

  • MS::kSuccess the call was successful.
  • MS::kFailure method failed.

MStatus MAttributeIndex:: getUpper ( int & value ) const

Description

Return the upper bound for this object or false if 1) the type does not match the argument type or 2) there is no upper bound. (both of which can be tested for using other methods on this class).

Arguments

  • value upper bound value is returned through this parameter.

Return Value

  • MS::kSuccess the call was successful.
  • MS::kFailure method failed.

MStatus MAttributeIndex:: getUpper ( double & value ) const

Description

Return the upper bound for this object or false if 1) the type does not match the argument type or 2) there is no upper bound. (both of which can be tested for using other methods on this class).

Arguments

  • value upper bound value is returned through this parameter.

Return Value

  • MS::kSuccess the call was successful.
  • MS::kFailure method failed.

bool MAttributeIndex:: isBounded () const

Description

Returns true if this object is bounded.

Return Value

  • boolean indicating if the object is bounded.

MStatus MAttributeIndex:: getValue ( int & value ) const

Description

Return the current value of the index or false if 1) the type does not match the argument type or 2) the index is a range or 3) the index is unbounded.

Arguments

  • value value of the index is returned through this parameter.

Return Value

  • MS::kSuccess the call was successful.
  • MS::kFailure method failed.

MStatus MAttributeIndex:: getValue ( double & value ) const

Description

Return the current value of the index or false if 1) the type does not match the argument type or 2) the index is a range or 3) the index is unbounded.

Arguments

  • value value of the index is returned through this parameter.

Return Value

  • MS::kSuccess the call was successful.
  • MS::kFailure method failed.

MStatus MAttributeIndex:: setType ( MAttributeIndex::MIndexType type )

Description

Sets the type of attribute index.

Valid index types are kInteger and kFloat.

Arguments

  • type the index type to set

Return Value

  • MS::kSuccess the index type was set
  • MS::kFailure invalid index type specified

MStatus MAttributeIndex:: setValue ( int value )

Description

Sets the index value of this object.

Arguments

  • value the value to set

Return Value

  • MS::kSuccess the value was set
  • MS::kFailure error setting value

MStatus MAttributeIndex:: setValue ( double value )

Description

Sets the index value of this object.

Arguments

  • value the value to set

Return Value

  • MS::kSuccess the value was set
  • MS::kFailure error setting value

MStatus MAttributeIndex:: setLower ( int value )

Description

Sets the lower bounds of this object.

Arguments

  • value the value to set

Return Value

  • MS::kSuccess the value was set
  • MS::kFailure error setting value

MStatus MAttributeIndex:: setLower ( double value )

Description

Sets the lower bounds of this object.

Arguments

  • value the value to set

Return Value

  • MS::kSuccess the value was set
  • MS::kFailure error setting value

MStatus MAttributeIndex:: setUpper ( int value )

Description

Sets the upper bounds of this object.

Arguments

  • value the value to set

Return Value

  • MS::kSuccess the value was set
  • MS::kFailure error setting value

MStatus MAttributeIndex:: setUpper ( double value )

Description

Sets the upper bounds of this object.

Arguments

  • value the value to set

Return Value

  • MS::kSuccess the value was set
  • MS::kFailure error setting value

MAttributeIndex & MAttributeIndex:: operator= ( const MAttributeIndex & other )

Description

Assignment operator.

Arguments

  • other object to copy or reference

Return Value

  • A reference to the copied MAttributeIndex object.

bool MAttributeIndex:: operator== ( const MAttributeIndex & other ) const

Description

Equality operator.

Arguments

  • other object to compare with.

Return Value

  • boolean indicating whether the objects are same.

bool MAttributeIndex:: operator!= ( const MAttributeIndex & other ) const

Description

Inequality operator.

Arguments

  • other object to compare with.

Return Value

  • boolean indicating whether the objects are same.

This class has no child classes.

Autodesk® Maya® 2008 © 1997-2007 Autodesk, Inc. All rights reserved. doc++ Copyright