1.7.3Please send us your comment about this page
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.
#include <MAttributeIndex.h>
Public Types |
|
| enum | MIndexType { kInteger, kFloat } |
|
Data types for attribute indices. More... |
|
Public Member Functions |
|
| MAttributeIndex () | |
| Constructor. |
|
| ~MAttributeIndex () | |
| Destructor. |
|
| MAttributeIndex (const MAttributeIndex &other) | |
| Copy constructor. |
|
| MAttributeIndex (int value) | |
| Constructor. |
|
| MAttributeIndex (double value) | |
| Constructor. |
|
| MIndexType | type () const |
| Returns the type of attribute index.
|
|
| bool | hasRange () const |
| Return true if a range was specified.
|
|
| bool | hasValidRange () const |
| Return true if upper value is greater than
lower value. |
|
| bool | hasLowerBound () const |
| Return true if if there is a lower bound
specified. |
|
| bool | hasUpperBound () const |
| Return true if if there is an upper bound
specified. |
|
| MStatus | 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. |
|
| MStatus | 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. |
|
| MStatus | 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. |
|
| MStatus | 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. |
|
| bool | isBounded () const |
| Returns true if this object is bounded.
|
|
| MStatus | 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. |
|
| MStatus | 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. |
|
| MStatus | setType (MIndexType type) |
| Sets the type of attribute index. |
|
| MStatus | setValue (int value) |
| Sets the index value of this object.
|
|
| MStatus | setValue (double value) |
| Sets the index value of this object.
|
|
| MStatus | setLower (int value) |
| Sets the lower bounds of this object.
|
|
| MStatus | setLower (double value) |
| Sets the lower bounds of this object.
|
|
| MStatus | setUpper (int value) |
| Sets the upper bounds of this object.
|
|
| MStatus | setUpper (double value) |
| Sets the upper bounds of this object.
|
|
| MAttributeIndex & | operator= (const MAttributeIndex &other) |
| Assignment operator. |
|
| bool | operator== (const MAttributeIndex &other) const |
| Equality operator. |
|
| bool | operator!= (const MAttributeIndex &other) const |
| Inequality operator. |
|
Static Public Member Functions |
|
| static const char * | className () |
| Returns the name of this class. |
|
Friends |
|
| class | MAttributeSpec |
| enum MIndexType |
Data types for attribute indices.
| MAttributeIndex | ( | const MAttributeIndex & | other | ) |
Copy constructor.
| [in] | other | value to copy |
| MAttributeIndex | ( | int | value | ) |
Constructor.
| [in] | value | index value to set |
| MAttributeIndex | ( | double | value | ) |
Constructor.
| [in] | value | index value to set |
| MAttributeIndex::MIndexType type | ( | ) | const |
Returns the type of attribute index.
Valid index types are kInteger and kFloat.
| bool 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.
| bool hasValidRange | ( | ) | const |
Return true if upper value is greater than lower value.
| bool hasLowerBound | ( | ) | const |
Return true if if there is a lower bound specified.
| bool hasUpperBound | ( | ) | const |
Return true if if there is an upper bound specified.
| MStatus 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).
| [out] | value | lower bound value is returned through this parameter. |
| MStatus 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).
| [out] | value | lower bound value is returned through this parameter. |
| MStatus 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).
| [out] | value | upper bound value is returned through this parameter. |
| MStatus 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).
| [out] | value | upper bound value is returned through this parameter. |
| bool isBounded | ( | ) | const |
Returns true if this object is bounded.
| MStatus 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.
| [out] | value | value of the index is returned through this parameter. |
| MStatus 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.
| [out] | value | value of the index is returned through this parameter. |
| MStatus setType | ( | MAttributeIndex::MIndexType | type | ) |
Sets the type of attribute index.
Valid index types are kInteger and kFloat.
| [in] | type | the index type to set |
| MStatus setValue | ( | int | value | ) |
Sets the index value of this object.
| [in] | value | the value to set |
| MStatus setValue | ( | double | value | ) |
Sets the index value of this object.
| [in] | value | the value to set |
| MStatus setLower | ( | int | value | ) |
Sets the lower bounds of this object.
| [in] | value | the value to set |
| MStatus setLower | ( | double | value | ) |
Sets the lower bounds of this object.
| [in] | value | the value to set |
| MStatus setUpper | ( | int | value | ) |
Sets the upper bounds of this object.
| [in] | value | the value to set |
| MStatus setUpper | ( | double | value | ) |
Sets the upper bounds of this object.
| [in] | value | the value to set |
| MAttributeIndex & operator= | ( | const MAttributeIndex & | other | ) |
Assignment operator.
| [in] | other | object to copy or reference |
| bool operator== | ( | const MAttributeIndex & | other | ) | const |
Equality operator.
| [in] | other | object to compare with. |
| bool operator!= | ( | const MAttributeIndex & | other | ) | const |
Inequality operator.
| [in] | other | object to compare with. |
| const char * className | ( | ) | [static] |