Public Member Functions | Static Public Member Functions

MAttributeSpecArray Class Reference

Search for all occurrences

Detailed Description

An attribute specification array.

Array class for MAttributeSpec.

See MAttributeSpec for more information.

Examples:

apiMeshShape.cpp, and apiMeshShape.h.

#include <MAttributeSpecArray.h>

List of all members.

Public Member Functions

 MAttributeSpecArray ()
 Default constructor.
 MAttributeSpecArray (const MAttributeSpecArray &other)
 Copy Constructor.
 MAttributeSpecArray (unsigned int initializeSize, const MAttributeSpec &initialValue)
 Create a new array of MAttributeSpecs of a specified size and initialize all the elements with the given initial value.
 ~MAttributeSpecArray ()
 Class Destructor.
MAttributeSpec operator[] (unsigned int index) const
 Index operator.
MAttributeSpecArrayoperator= (const MAttributeSpecArray &other)
 Assignment operator.
MStatus set (const MAttributeSpec &element, unsigned int index)
 Sets the value of the specified element to the given attribute spec.
MStatus setLength (unsigned int length)
 Set the length of the array.
unsigned int length () const
 Returns the number of elements in the array.
MStatus remove (unsigned int index)
 Removes the element in the array at the given index.
MStatus insert (const MAttributeSpec &element, unsigned int index)
 Inserts a new value into the array at the given index.
MStatus append (const MAttributeSpec &element)
 Adds a new element to the end of the array.
MStatus copy (const MAttributeSpecArray &source)
 Copy the contents of the source array to this array.
MStatus clear ()
 Clear the contents of the array.
void setSizeIncrement (unsigned int newIncrement)
 Set the size by which the array will be expanded whenever expansion is necessary.
unsigned int sizeIncrement () const
 Return the size by which the array will be expanded whenever expansion is necessary.

Static Public Member Functions

static const char * className ()
 Returns the name of this class.

Constructor & Destructor Documentation

Default constructor.

The array is set to contain no elements.

Copy Constructor.

Parameters:
[in]otherthe array with which to initialize this array
MAttributeSpecArray ( unsigned int  initialSize,
const MAttributeSpec initialValue 
)

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

Parameters:
[in]initialSizethe initial size of the array
[in]initialValuethe initial value of each element

Member Function Documentation

MAttributeSpec operator[] ( unsigned int  index) const

Index operator.

Returns the value of the element at the given index. Valid indices are 0 to length()-1.

Parameters:
[in]indexthe index of the element to return
Returns:
A reference to the specified element
MAttributeSpecArray & operator= ( const MAttributeSpecArray other)

Assignment operator.

Parameters:
[in]otherThe source object to assign from.
Returns:
A reference to the copied MAttributeSpecArray object.
MStatus set ( const MAttributeSpec element,
unsigned int  index 
)

Sets the value of the specified element to the given attribute spec.

Parameters:
[in]elementthe new value for the specified element
[in]indexthe index of the element to be set
Returns:
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]lengththe new size of the array
Returns:
unsigned int length ( ) const

Returns the number of elements in the array.

Returns:
The number of elements in the array
Examples:
apiMeshShape.cpp.
MStatus remove ( unsigned int  index)

Removes the element in the array at the given index.

Parameters:
[in]indexthe index of the element to removed
Returns:
MStatus insert ( const MAttributeSpec 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.

Parameters:
[in]elementthe new value to insert into the array
[in]indexthe index of the element to set
Returns:
MStatus append ( const MAttributeSpec element)

Adds a new element to the end of the array.

Parameters:
[in]elementthe value for the new last element
Returns:
MStatus copy ( const MAttributeSpecArray source)

Copy the contents of the source array to this array.

Parameters:
[in]sourcearray to copy from
Returns:
MS::kSuccess if the copy 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:
void setSizeIncrement ( unsigned int  newIncrement)

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

Parameters:
[in]newIncrementthe new increment
unsigned int sizeIncrement ( ) const

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

Returns:
The size increment.
const char * className ( ) [static]

Returns the name of this class.

Returns:
The name of this class.

MAttributeSpecArray MAttributeSpecArray MAttributeSpecArray MAttributeSpecArray MAttributeSpecArray MAttributeSpecArray MAttributeSpecArray MAttributeSpecArray MAttributeSpecArray MAttributeSpecArray
MAttributeSpecArray MAttributeSpecArray MAttributeSpecArray MAttributeSpecArray MAttributeSpecArray MAttributeSpecArray MAttributeSpecArray MAttributeSpecArray MAttributeSpecArray MAttributeSpecArray