#include <MTimeArray.h>

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

Public Member Functions
	MTimeArray ()
	Default Constructor. More...

	MTimeArray (const MTimeArray &other)
	Copy Constructor. More...

	MTimeArray (const MTime src[], unsigned int count)
	NO SCRIPT SUPPORT. More...

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

	~MTimeArray ()
	Class Destructor.

const MTime &	operator[] (unsigned int index) const
	Index operator. More...

MStatus	set (const MTime &element, unsigned int index)
	Sets the value of the indicated element to the indicated MTime value. More...

MStatus	setLength (unsigned int length)
	Set the length of the array. More...

unsigned int	length () const
	Returns the number of elements in the instance. More...

MStatus	remove (unsigned int index)
	Remove the array element at the given index. More...

MStatus	insert (const MTime &element, unsigned int index)
	Inserts a new value into the array at the given index. More...

MStatus	append (const MTime &element)
	Adds a new element to the end of the array. More...

MStatus	clear ()
	Clear the contents of the array. More...

void	setSizeIncrement (unsigned int newIncrement)
	Set the size by which the array will be expanded whenever expansion is necessary. More...

unsigned int	sizeIncrement () const
	Return the size by which the array will be expanded whenever expansion is necessary. More...

MTime &	operator[] (unsigned int index)
	NO SCRIPT SUPPORT. More...

MStatus	get (MTime array[]) const
	NO SCRIPT SUPPORT. More...

MTimeArray &	operator= (const MTimeArray &)
	Assignment operator copies all of the elements of the other array into this one. More...

MStatus	copy (const MTimeArray &source)
	Copy the contents of the source array to this array. More...

Static Public Member Functions
static const char *	className ()
	Returns the name of this class. More...

Friends
OPENMAYA_EXPORT std::ostream &	operator<< (std::ostream &os, const MTimeArray &array)
	NO SCRIPT SUPPORT. More...

Constructor & Destructor Documentation

OPENMAYA_MAJOR_NAMESPACE_OPEN MTimeArray ( )

Default Constructor.

The instance is set to contain no elements.

MTimeArray ( const MTimeArray & other )

Copy Constructor.

Parameters

[in] other the array with which to initialize this instance

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	(	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

Member Function Documentation

const MTime & 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 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 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 length ( ) const

Returns the number of elements in the instance.

Returns: The number of elements in the instance

MStatus 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 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

MStatus append ( const MTime & element )

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

MStatus clear ( )

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 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 sizeIncrement ( ) const

Return the size by which the array will be expanded whenever expansion is necessary.

Returns: The size increment.

MTime & 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

MStatus get ( MTime array[] ) const

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

MTimeArray & operator= ( const MTimeArray & other )

Assignment operator copies all of the elements of the other array into this one.

Parameters

[in] other the array being copied

Returns: A reference to this array

MStatus copy ( const MTimeArray & source )

Copy the contents of the source array to this array.

Parameters

[in] source array to copy from

Returns: MS::kSuccess if the copy was successful and MS::kFailure otherwise

const char * className ( )

static

Returns the name of this class.

Returns: The name of this class.

Friends And Related Function Documentation

OPENMAYA_EXPORT std::ostream& operator<<	(	std::ostream &	os,
		const MTimeArray &	array
	)

friend

NO SCRIPT SUPPORT.

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.

The documentation for this class was generated from the following files:

MTimeArray.h
MTimeArray.cpp

MTimeArray Class Reference

Class Description

Public Member Functions

Static Public Member Functions

Friends

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation