C++ API Reference: MAttributeIndex Class Reference
The index information for an attribute specification.
More...
#include <MAttributeIndex.h>
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.
Data types for attribute indices.
Enumerator kInteger
Integer index (e.g.
mesh.cp[5])
kFloat
Floating-poing index (e.g.
curve.u[1.3])
Copy constructor.
Parameters
Constructor.
Parameters
[in] value index value to set
Constructor.
Parameters
[in] value index value to set
Returns the type of attribute index.
Valid index types are kInteger and kFloat.
Returns The index type
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 hasValidRange
(
)
const
Return true if upper value is greater than lower value.
Returns Boolean indicating whether the range is valid or not.
bool hasLowerBound
(
)
const
Return true if if there is a lower bound specified.
Returns Boolean to indicate if there is a lower bound.
bool hasUpperBound
(
)
const
Return true if if there is an upper bound specified.
Returns Boolean to indicate if there is an upper bound.
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).
Parameters
[out] value lower bound value is returned through this parameter.
Returns
MS::kSuccess the call was successful.
MS::kFailure method failed.
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).
Parameters
[out] value lower bound value is returned through this parameter.
Returns
MS::kSuccess the call was successful.
MS::kFailure method failed.
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).
Parameters
[out] value upper bound value is returned through this parameter.
Returns
MS::kSuccess the call was successful.
MS::kFailure method failed.
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).
Parameters
[out] value upper bound value is returned through this parameter.
Returns
MS::kSuccess the call was successful.
MS::kFailure method failed.
Returns true if this object is bounded.
Returns
boolean indicating if the 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.
Parameters
[out] value value of the index is returned through this parameter.
Returns
MS::kSuccess the call was successful.
MS::kFailure method failed.
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.
Parameters
[out] value value of the index is returned through this parameter.
Returns
MS::kSuccess the call was successful.
MS::kFailure method failed.
Sets the type of attribute index.
Valid index types are kInteger and kFloat.
Parameters
[in] type the index type to set
Returns
MS::kSuccess the index type was set
MS::kFailure invalid index type specified
Sets the index value of this object.
Parameters
[in] value the value to set
Returns
MS::kSuccess the value was set
MS::kFailure error setting value
Sets the index value of this object.
Parameters
[in] value the value to set
Returns
MS::kSuccess the value was set
MS::kFailure error setting value
Sets the lower bounds of this object.
Parameters
[in] value the value to set
Returns
MS::kSuccess the value was set
MS::kFailure error setting value
Sets the lower bounds of this object.
Parameters
[in] value the value to set
Returns
MS::kSuccess the value was set
MS::kFailure error setting value
Sets the upper bounds of this object.
Parameters
[in] value the value to set
Returns
MS::kSuccess the value was set
MS::kFailure error setting value
Sets the upper bounds of this object.
Parameters
[in] value the value to set
Returns
MS::kSuccess the value was set
MS::kFailure error setting value
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.
const char * className
(
)
static
Returns the name of this class.
Returns The name of this class.
The documentation for this class was generated from the following files:
MAttributeIndex.h
MAttributeIndex.cpp