MAttributeIndex Class Reference
[OpenMaya - API module for common classes]

#include <MAttributeIndex.h>

List of all members.


Detailed Description

The index information for an attribute specification.

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

See MAttributeSpec for more information.

Examples:

apiMeshShape.cpp.


Public Types

enum   MIndexType { kInteger, kFloat }
  Data types for attribute indices. More...

Public Member Functions

  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

Friends

class  MAttributeSpec

Member Enumeration Documentation

Data types for attribute indices.

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

Constructor & Destructor Documentation

MAttributeIndex::MAttributeIndex (  ) 

Constructor.

MAttributeIndex::~MAttributeIndex (  ) 

Destructor.

MAttributeIndex::MAttributeIndex ( const MAttributeIndex other  ) 

Copy constructor.

Parameters:
[in]  other  value to copy

MAttributeIndex::MAttributeIndex ( int  value  ) 

Constructor.

Parameters:
[in]  value  index value to set

MAttributeIndex::MAttributeIndex ( double  value  ) 

Constructor.

Parameters:
[in]  value  index value to set

Member Function Documentation

MAttributeIndex::MIndexType MAttributeIndex::type (  )  const

Returns the type of attribute index.

Valid index types are kInteger and kFloat.

Returns:
The index type

bool MAttributeIndex::hasRange (  )  const

Return true if a range was specified.

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

Returns:
Boolean indicating whether the range exists or not.

bool MAttributeIndex::hasValidRange (  )  const

Return true if upper value is greater than lower value.

Returns:
Boolean indicating whether the range is valid or not.

bool MAttributeIndex::hasLowerBound (  )  const

Return true if if there is a lower bound specified.

Returns:
Boolean to indicate if there is a lower bound.
Examples:

bool MAttributeIndex::hasUpperBound (  )  const

Return true if if there is an upper bound specified.

Returns:
Boolean to indicate if there is an upper bound.
Examples:

MStatus MAttributeIndex::getLower ( int &  value  )  const

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).

Parameters:
[out]  value  lower bound value is returned through this parameter.
Returns:
Examples:

MStatus MAttributeIndex::getLower ( double &  value  )  const

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).

Parameters:
[out]  value  lower bound value is returned through this parameter.
Returns:

MStatus MAttributeIndex::getUpper ( int &  value  )  const

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).

Parameters:
[out]  value  upper bound value is returned through this parameter.
Returns:
Examples:

MStatus MAttributeIndex::getUpper ( double &  value  )  const

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).

Parameters:
[out]  value  upper bound value is returned through this parameter.
Returns:

bool MAttributeIndex::isBounded (  )  const

Returns true if this object is bounded.

Returns:
  • boolean indicating if the object is bounded.

MStatus MAttributeIndex::getValue ( int &  value  )  const

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.

Parameters:
[out]  value  value of the index is returned through this parameter.
Returns:

MStatus MAttributeIndex::getValue ( double &  value  )  const

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.

Parameters:
[out]  value  value of the index is returned through this parameter.
Returns:

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

Sets the type of attribute index.

Valid index types are kInteger and kFloat.

Parameters:
[in]  type  the index type to set
Returns:

MStatus MAttributeIndex::setValue ( int  value  ) 

Sets the index value of this object.

Parameters:
[in]  value  the value to set
Returns:

MStatus MAttributeIndex::setValue ( double  value  ) 

Sets the index value of this object.

Parameters:
[in]  value  the value to set
Returns:

MStatus MAttributeIndex::setLower ( int  value  ) 

Sets the lower bounds of this object.

Parameters:
[in]  value  the value to set
Returns:

MStatus MAttributeIndex::setLower ( double  value  ) 

Sets the lower bounds of this object.

Parameters:
[in]  value  the value to set
Returns:

MStatus MAttributeIndex::setUpper ( int  value  ) 

Sets the upper bounds of this object.

Parameters:
[in]  value  the value to set
Returns:

MStatus MAttributeIndex::setUpper ( double  value  ) 

Sets the upper bounds of this object.

Parameters:
[in]  value  the value to set
Returns:

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

Assignment operator.

Parameters:
[in]  other  object to copy or reference
Returns:
A reference to the copied MAttributeIndex object.

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

Equality operator.

Parameters:
[in]  other  object to compare with.
Returns:
Boolean indicating whether the objects are same.

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

Inequality operator.

Parameters:
[in]  other  object to compare with.
Returns:
Boolean indicating whether the objects are same.

Autodesk® Maya® 2011 © 1997-2010 Autodesk, Inc. All rights reserved. Generated with doxygen 1.5.6