#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.
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 |
( |
|
) |
|
MAttributeIndex::~MAttributeIndex |
( |
|
) |
|
Copy constructor.
- Parameters:
-
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
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.
bool MAttributeIndex::hasUpperBound |
( |
|
) |
const |
Return true if if there is an upper bound specified.
- Returns:
- Boolean to indicate if there is an upper bound.
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:
-
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:
-
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:
-
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:
-
Assignment operator.
- Parameters:
-
[in] |
other |
object to copy or reference |
- Returns:
- A reference to the copied MAttributeIndex
object.
Equality operator.
- Parameters:
-
[in] |
other |
object to compare with. |
- Returns:
- Boolean indicating whether the objects are same.
Inequality operator.
- Parameters:
-
[in] |
other |
object to compare with. |
- Returns:
- Boolean indicating whether the objects are same.