class MTimeArray

Jump to documentation

public members:

	MTimeArray ()
	MTimeArray ( const MTimeArray & other )
	MTimeArray ( const MTime src[], unsigned int count )
	MTimeArray ( unsigned int initialSize, const MTime &initialValue )
	~MTimeArray ()
const MTime &	operator[] ( unsigned int index ) const
MTime &	operator[] ( unsigned int index )
MStatus	set ( const MTime & element, unsigned int index )
MStatus	setLength ( unsigned int length )
unsigned int	length () const
MStatus	remove ( unsigned int index )
MStatus	insert ( const MTime & element, unsigned int index )
MStatus	append ( const MTime & element )
MStatus	clear ()
MStatus	get ( MTime array[] ) const
void	setSizeIncrement ( unsigned int newIncrement )
unsigned int	sizeIncrement () const
friend ostream &	operator<< (ostream &os, const MTimeArray &array)

Documentation

Description

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.

Functions

MTimeArray:: MTimeArray ()

Description

Default Constructor. The instance is set to contain no elements.

MTimeArray:: MTimeArray ( const MTimeArray & other )

Description

Copy Constructor.

Arguments

• other the array with which to initialize this instance

MTimeArray:: MTimeArray ( const MTime src[], unsigned int count )

Description

Create a new array of MTimes and initialize it with the given MTime elements.

Arguments

• src an array of MTimes
• count the number of elements in the src array

MTimeArray:: MTimeArray ( unsigned int initialSize, const MTime &initialValue )

Description

Create a new array of times of a specified size and initialize all the elements with the given initial value.

Arguments

• initialSize the initial size of the array
• initialValue the initial value of each element

MTimeArray:: ~MTimeArray ()

Description

Class Destructor.

const MTime & MTimeArray:: operator[] ( unsigned int index ) const

Description

Index operator. Returns the value of the element at the given index. No range checking is done - valid indices are 0 to length()-1.

Arguments

• index the index of the desired element

Return Value

• a reference to the indicated element

MTime & MTimeArray:: operator[] ( unsigned int index )

Description

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.

Arguments

• index the index of the desired element

Return Value

• a reference to the indicated element

MStatus MTimeArray:: setLength ( unsigned int length )

Description

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

Arguments

• size the new size of the array

unsigned int MTimeArray:: length () const

Description

Returns the number of elements in the instance.

Return Value

• the number of elements in the instance

MStatus MTimeArray:: remove ( unsigned int index )

Description

Remove the array element at the given index. All array elements following the removed element are shifted toward the first element.

Arguments

• index index of the element to be removed

Return Value

• MS::kSuccess if the remove was successful and MS::kFailure otherwise

MStatus MTimeArray:: insert ( const MTime & element, unsigned int index )

Description

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.

Arguments

• element the new value to insert into the array
• index the index of the element to set to the the new value

Return Value

• MS::kSuccess if the insert was successful and MS::kFailure otherwise

MStatus MTimeArray:: set ( const MTime &element, unsigned int index )

Description

Sets the value of the indicated element to the indicated MTime value.

Arguments

• element the new value for the indicated element
• index the index of the element that is to be set to the the new value

Return Value

• MS::kSuccess if the value was set successfully and MS::kFailure otherwise

MStatus MTimeArray:: append ( const MTime &element )

Description

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.

Arguments

• element the value for the new last element

Return Value

• MS::kSuccess if the append was successful and MS::kFailure otherwise

MStatus MTimeArray:: clear ()

Description

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.

Return Value

• true MS::kSuccess the operation is successful and MS::kFailure otherwise

MStatus MTimeArray:: get ( MTime array[] ) const

Description

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.

Arguments

• array the array to populate

Return Value

• MS::kSuccess if the array argument is a non-zero pointer and MS::kFailure otherwise

void MTimeArray:: setSizeIncrement ( unsigned int newIncrement )

Description

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

Arguments

• newIncrement the new increment

unsigned int MTimeArray:: sizeIncrement () const

Description

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

Return Value

• true if the array argument is a non-zero pointer and false otherwise

ostream& operator<< (ostream &os, const MTimeArray &array)

Description

Print the contents of the given MTimeArray on the given ostream. The format used is [time, time, time, ... time].

Arguments

• os the ostream to print to
• array the MTimeArray whose value is to be printed

Return Value

• the ostream reference, s, provided as the first parameter.

This class has no child classes.