#include
<MTimeArray.h>
List of all
members.
Detailed Description
Array of
MTime
data type.
This class implements an array of MTimes. Common convenience
functions are available, and the implementation is compatible with
the internal Maya implementation so that it can be passed
efficiently between plugins and internal maya data structures.
Constructor & Destructor Documentation
MTimeArray::MTimeArray |
( |
|
) |
|
Default Constructor. The instance is set to contain no
elements.
MTimeArray::MTimeArray |
( |
const MTimeArray & |
other |
) |
|
Copy Constructor.
- Parameters:
-
[in] |
other |
the array with which to initialize this instance |
MTimeArray::MTimeArray |
( |
const MTime |
src[], |
|
|
unsigned int |
count |
|
|
) |
|
|
|
NO SCRIPT SUPPORT.
Create a new array of MTimes and initialize it with the given
MTime
elements.
- Parameters:
-
[in] |
src |
an array of MTimes |
[in] |
count |
the number of elements in the src array |
MTimeArray::MTimeArray |
( |
unsigned int |
initialSize, |
|
|
const MTime & |
initialValue |
|
|
) |
|
|
|
Create a new array of times of a specified size and initialize
all the elements with the given initial value.
- Parameters:
-
[in] |
initialSize |
the initial size of the array |
[in] |
initialValue |
the initial value of each element |
MTimeArray::~MTimeArray |
( |
|
) |
|
Member Function Documentation
const MTime & MTimeArray::operator[] |
( |
unsigned int |
index |
) |
const |
Index operator. Returns the value of the element at the given
index. No range checking is done - valid indices are 0 to length()-1.
- Parameters:
-
[in] |
index |
the index of the desired element |
- Returns:
- A reference to the indicated element
MStatus MTimeArray::set |
( |
const MTime & |
element, |
|
|
unsigned int |
index |
|
|
) |
|
|
|
Sets the value of the indicated element to the indicated
MTime
value.
- Parameters:
-
[in] |
element |
the new value for the indicated element |
[in] |
index |
the index of the element that is to be set to the the new
value |
- Returns:
- MS::kSuccess if the value
was set successfully and MS::kFailure otherwise
MStatus MTimeArray::setLength |
( |
unsigned int |
length |
) |
|
Set the length of the array. This will grow and shrink the array
as desired. Elements that are grown have uninitialized values,
while those which are shrunk will lose the data contained in the
deleted elements (ie. it will release the memory).
- Parameters:
-
[in] |
length |
the new size of the array |
unsigned int MTimeArray::length |
( |
|
) |
const |
Returns the number of elements in the instance.
- Returns:
- The number of elements in the instance
MStatus MTimeArray::remove |
( |
unsigned int |
index |
) |
|
Remove the array element at the given index. All array elements
following the removed element are shifted toward the first
element.
- Parameters:
-
[in] |
index |
index of the element to be removed |
- Returns:
- MS::kSuccess if the
remove was successful and MS::kFailure otherwise
MStatus MTimeArray::insert |
( |
const MTime & |
element, |
|
|
unsigned int |
index |
|
|
) |
|
|
|
Inserts a new value into the array at the given index. The
initial element at that index, and all following elements, are
shifted towards the last. If the array cannot be expanded in size
by 1 element, then the insert will fail and the existing array will
remain unchanged.
- Parameters:
-
[in] |
element |
the new value to insert into the array |
[in] |
index |
the index of the element to set to the the new value |
- Returns:
- MS::kSuccess if the
insert was successful and MS::kFailure otherwise
Adds a new element to the end of the array. If the array cannot
be expanded in size by 1 element, then the append will fail and the
existing array will remain unchanged.
- Parameters:
-
[in] |
element |
the value for the new last element |
- Returns:
- MS::kSuccess if the
append was successful and MS::kFailure otherwise
Clear the contents of the array. After this operation the length
method will return 0. This does not change the amount of memory
allocated to the array, only the number of valid elements in
it.
- Returns:
- MS::kSuccess the
operation is successful and MS::kFailure otherwise
void MTimeArray::setSizeIncrement |
( |
unsigned int |
newIncrement |
) |
|
Set the size by which the array will be expanded whenever
expansion is necessary.
- Parameters:
-
[in] |
newIncrement |
the new increment |
unsigned int MTimeArray::sizeIncrement |
( |
|
) |
const |
Return the size by which the array will be expanded whenever
expansion is necessary.
- Returns:
- true if the array argument is a non-zero pointer and false
otherwise
MTime & MTimeArray::operator[] |
( |
unsigned int |
index |
) |
|
NO SCRIPT SUPPORT.
Index operator allowing assignment to an element of the array.
Returns a reference to the element at the given index. No range
checking is done - valid indices are 0 to length()-1.
- Parameters:
-
[in] |
index |
the index of the desired element |
- Returns:
- A reference to the indicated element
NO SCRIPT SUPPORT.
Copy the elements of the array into the given array of MTimes.
No checking is done to ensure that the destination array of MTimes
is large enough to hold all the elements of the instance.
- Parameters:
-
[out] |
array |
the array to populate |
- Returns:
- MS::kSuccess if the array
argument is a non-zero pointer and MS::kFailure otherwise
Friends And Related Function Documentation
OPENMAYA_EXPORT std::ostream&
operator<< |
( |
std::ostream & |
os, |
|
|
const MTimeArray & |
array |
|
|
) |
|
|
[friend] |
NO SCRIPT SUPPORT.
Print the contents of the given MTimeArray on the given ostream.
The format used is [time, time, time, ... time].
- Parameters:
-
[in] |
os |
the ostream to print to |
[in] |
array |
the MTimeArray whose value is to be
printed |
- Returns:
- The ostream reference, s, provided as the first
parameter.