class MColorArray

Jump to documentation

public members:

	MColorArray ()
	MColorArray ( const MColorArray & other )
	MColorArray ( const MColor src[], unsigned int count )
	MColorArray ( const float src[][4], unsigned int count )
	MColorArray ( const double src[][4], unsigned int count )
	MColorArray ( unsigned int initialSize, const MColor &initialValue )
	~MColorArray ()
const MColor &	operator[] ( unsigned int index ) const
MColor &	operator[] ( unsigned int index )
MColorArray &	operator= ( const MColorArray & other )
MStatus	set ( const MColor & element, unsigned int index )
MStatus	set ( unsigned int index, float r, float g, float b, float a=1 )
MStatus	set ( float val[4], unsigned int index)
MStatus	set ( float elements[][4], unsigned int size)
MStatus	set ( double elements[][4], unsigned int size)
MStatus	setLength ( unsigned int length )
unsigned int	length () const
MStatus	remove ( unsigned int index )
MStatus	insert ( const MColor & element, unsigned int index )
MStatus	append ( const MColor & element )
MStatus	append ( float r, float g, float b, float a=1 )
MStatus	clear ()
MStatus	get ( float dest[][4] ) const
void	setSizeIncrement ( unsigned int newIncrement )
unsigned int	sizeIncrement () const
friend ostream &	operator<< (ostream &os, const MColorArray &array)

Documentation

Description

This class implements an array of MColor's. 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

MColorArray:: MColorArray ()

Description

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

MColorArray:: MColorArray ( const MColorArray & other )

Description

Copy constructor.

Arguments

• other the array with which to initialize this instance

MColorArray:: MColorArray ( const MColor src[], unsigned int count )

Description

Create a new array of MColor's and initialize it with the given elements.

Arguments

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

MColorArray:: MColorArray ( const float src[][4], unsigned int count )

Description

Create a new array of MColor's and initialize it with the given elements.

Arguments

• src a C++ array of float arrays of length four
• count the number of elements in the array

MColorArray:: MColorArray ( const double src[][4], unsigned int count )

Description

Create a new array of MColor's and initialize it with the given elements.

Arguments

• src a C++ array of double arrays of length four
• count the number of elements in the array

MColorArray:: MColorArray ( unsigned int initialSize, const MColor &initialValue )

Description

Create a new array of MColor's 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

MColorArray:: ~MColorArray ()

Description

The class destructor.

const MColor & MColorArray:: 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 element whose value is to be returned

Return Value

• the value of the indicated element.

MColor & MColorArray:: 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

MColorArray & MColorArray:: operator= ( const MColorArray & other )

Description

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

If the other array was returned as a reference to internal data, then this array will also become a reference rather than doing a full copy.

Arguments

• other the array being copied

Return Value

• a reference to this array

MStatus MColorArray:: set ( const MColor & element, unsigned int index)

Description

Sets the value of the indicated element to the indicated 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 MColorArray:: set ( unsigned int index, float r, float g, float b, float a )

Description

Sets the value of the indicated element to the indicated values. The r component of the element is set to r, the g component to g, the b component to b, and the a component to a.

Arguments

• index the index of the element that is to be set to the the new value
• r the new value for the r component
• g the new value for the g component
• b the new value for the b component
• a the new value for the a component,defaulted to 1

Return Value

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

MStatus MColorArray:: set ( float val[4], unsigned int index)

Description

Sets the value of the indicated element to the indicated value. The r component of the element is set to val[0], the g component to val[1], the b component to val[2], and the a component to val[3].

Arguments

• val 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 MColorArray:: 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

• length the new size of the array

Return Value

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

unsigned int MColorArray:: length () const

Description

Returns the number of elements in the instance.

Return Value

• the number of elements in the instance

MStatus MColorArray:: 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 MColorArray:: insert ( const MColor & 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 MColorArray:: append ( const MColor & 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 MColorArray:: append ( float x, float y, float z, float w )

Description

Adds a new element to the end of the array. The appended element has the indicated values for its x,y,z and w components. The x component of the element is set to x, the y component to y, the z component to z, and the w component to w.

If the array cannot be expanded in size by 1 element, then the append will fail and the existing array will remain unchanged.

Arguments

• x the value for the x component
• y the value for the y component
• z the value for the z component, defaulted to 0
• w the value for the w component, defaulted to 1

Return Value

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

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

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

MStatus MColorArray:: get ( float dest[][4] ) const

Description

Copy the elements of the array into the C++ array of float arrays. No checking is done to ensure that the destination C++ array of float arrays is large enough to hold all the elements of the instance.

Arguments

• dest the array to populate

Return Value

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

void MColorArray:: 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 MColorArray:: 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 MColorArray &array)

Description

Print the contents of the given MColorArray on the given ostream. The format used is [0: [r, g, b, a], 1: [r, g, b, a], 2: [r, g, b, a], ...].

Arguments

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

Return Value

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

MStatus MColorArray:: set (float elements[][4], unsigned int size)

Description

Resets the values of the color components. The length of the passed in C++ array should be same as the length of the ColorArray to which we are setting the values.

Arguments

• elements C++ array of float arrays of length four.
• size the number of elements in the array.

Return Value

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

MStatus MColorArray:: set (double elements[][4], unsigned int size)

Description

Resets the values of the color components. The length of the passed in C++ array should be same as the length of the ColorArray to which we are setting the values.

Arguments

• elements C++ array of double arrays of length four.
• size the number of elements in the array.

Return Value

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

This class has no child classes.