MPointArray Class Reference
[OpenMaya - API module for common classes]

#include <MPointArray.h>

Detailed Description

Array of MPoint data type.

This class implements an array of MPoints. 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.

Examples:


Public Member Functions
	MPointArray ()
	MPointArray (const MPointArray &other)
	MPointArray (const MPoint points[], unsigned int count)
	NO SCRIPT SUPPORT.
	MPointArray (const double points[][4], unsigned int count)
	MPointArray (const float points[][4], unsigned int count)
	MPointArray (unsigned int initialSize, const MPoint &initialValue=MPoint::origin)
	~MPointArray ()
const MPoint &	operator[] (unsigned int index) const
MPointArray &	operator= (const MPointArray &other)
MStatus	set (const MPoint &element, unsigned int index)
MStatus	set (unsigned int index, double x, double y, double z=0, double w=1)
MStatus	set (double element[4], unsigned int index)
MStatus	set (float element[4], unsigned int index)
MStatus	setLength (unsigned int length)
unsigned int	length () const
MStatus	remove (unsigned int index)
MStatus	insert (const MPoint &element, unsigned int index)
MStatus	append (const MPoint &element)
MStatus	append (double x, double y, double z=0, double w=1)
MStatus	copy (const MPointArray &source)
MStatus	clear ()
MStatus	get (double[][4]) const
MStatus	get (float[][4]) const
void	setSizeIncrement (unsigned int newIncrement)
unsigned int	sizeIncrement () const
MPoint &	operator[] (unsigned int index)
	NO SCRIPT SUPPORT.
Friends
OPENMAYA_EXPORT std::ostream &	operator<< (std::ostream &os, const MPointArray &array)
	NO SCRIPT SUPPORT.

Constructor & Destructor Documentation

MPointArray::MPointArray ( )

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

MPointArray::MPointArray ( const MPointArray & other )

Copy constructor.

Parameters:

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

MPointArray::MPointArray	(	const MPoint	src[],
		unsigned int	count
	)

NO SCRIPT SUPPORT.

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

Parameters:

`[in]`	src	an array of MPoints
`[in]`	count	the number of elements in the src array

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

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

Parameters:

`[in]`	src	a C++ array of double arrays of length four
`[in]`	count	the number of elements in the array

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

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

Parameters:

`[in]`	src	a C++ array of double arrays of length four
`[in]`	count	the number of elements in the array

MPointArray::MPointArray	(	unsigned int	initialSize,
		const MPoint &	initialValue = `MPoint::origin`
	)

Create a new array of MPoints 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

MPointArray::~MPointArray ( )

The class destructor.

Member Function Documentation

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

Returns:: The value of the indicated element.

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

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.

Parameters:

[in] other the array being copied

Returns:: A reference to this array

MStatus MPointArray::set	(	const MPoint &	element,
		unsigned int	index
	)

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

NOTE: This method does not grow the array if the index is out of bounds. Only a valid index should be used.

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 MPointArray::set	(	unsigned int	index,
		double	x,
		double	y,
		double	z = `0`,
		double	w = `1`
	)

Sets the value of the indicated element to the indicated values. 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.

NOTE: This method does not grow the array if the index is out of bounds. Only a valid index should be used.

Parameters:

`[in]`	index	the index of the element that is to be set to the the new value
`[in]`	x	the new value for the x component
`[in]`	y	the new value for the y component
`[in]`	z	the new value for the z component,defaulted to 0
`[in]`	w	the new value for the w component,defaulted to 1

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

MStatus MPointArray::set	(	double	val[4],
		unsigned int	index
	)

Sets the value of the indicated element to the indicated value. The x component of the element is set to val[0], the y component to val[1], the z component to val[2], and the w component to val[3].

NOTE: This method does not grow the array if the index is out of bounds. Only a valid index should be used.

Parameters:

`[in]`	val	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 MPointArray::set	(	float	val[4],
		unsigned int	index
	)

Sets the value of the indicated element to the indicated value. The x component of the element is set to val[0], the y component to val[1], the z component to val[2], and the w component to val[3].

NOTE: This method does not grow the array if the index is out of bounds. Only a valid index should be used.

Parameters:

`[in]`	val	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 MPointArray::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 MPointArray::length ( ) const

Returns the number of elements in the instance.

Returns:: The number of elements in the instance

Examples:

: apiMeshShape.cpp, cvColorNode.cpp, fullLoftNode.cpp, motionTraceCmd.cpp, multiCurveNode.cpp, narrowPolyViewer.cpp, particleAttrNode.cpp, particlePathsCmd.cpp, and simpleLoftNode.cpp.

MStatus MPointArray::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 MPointArray::insert	(	const MPoint &	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

Examples:

: particlePathsCmd.cpp.

MStatus MPointArray::append ( const MPoint & 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

Examples:

: apiMeshCreator.cpp, apiMeshShape.cpp, fullLoftNode.cpp, helixCmd.cpp, helixTool.cpp, motionTraceCmd.cpp, particleIdHash.h, particleSystemInfoCmd.cpp, simpleLoftNode.cpp, surfaceCreate.cpp, and surfaceCreateCmd.cpp.

MStatus MPointArray::append	(	double	x,
		double	y,
		double	z = `0`,
		double	w = `1`
	)

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.

Parameters:

`[in]`	x	the value for the x component
`[in]`	y	the value for the y component
`[in]`	z	the value for the z component, defaulted to 0
`[in]`	w	the value for the w component, defaulted to 1

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

MStatus MPointArray::copy ( const MPointArray & 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

MStatus MPointArray::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 if the operation is successful and MS::kFailure otherwise

Examples:

: apiMeshCreator.cpp, and cvColorNode.cpp.

MStatus MPointArray::get ( double dest[][4] ) const

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

Parameters:

[out] dest the array to populate

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

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

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.

Parameters:

[out] dest the array to populate

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

void MPointArray::setSizeIncrement ( unsigned int newIncrement )

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

Parameters:

[in] newIncrement the new increment

Examples:

: apiMeshShape.cpp.

unsigned int MPointArray::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

MPoint & MPointArray::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

Friends And Related Function Documentation

OPENMAYA_EXPORT std::ostream& operator<<	(	std::ostream &	os,
		const MPointArray &	array
	)			`[friend]`

NO SCRIPT SUPPORT.

Print the contents of the given MPointArray on the given ostream. The format used is [0: [x, y, z, w], 1: [x, y, z, w], 2: [x, y, z, w], ...].

Parameters:

`[in]`	os	the ostream to print to
`[in]`	array	the MPointArray whose value is to be printed

Returns:: The ostream reference, s, provided as the first parameter.

MPointArray Class Reference [OpenMaya - API module for common classes]

Detailed Description

Public Member Functions

Friends

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

MPointArray Class Reference
[OpenMaya - API module for common classes]