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

#include <MTrimBoundaryArray.h>

List of all members.


Detailed Description

An array class for trim boundaries.

This class implements an array of MObjectArray objects. Each MObjectArray is a collection of curves (edges, in fact) that represent a trim boundary.

This class owns all of the MObjectArrays in the class. It doesn't hold a reference to any other MObjectArray.

Public Member Functions

 MTrimBoundaryArray ()
 MTrimBoundaryArray (const MTrimBoundaryArray &other)
 ~MTrimBoundaryArray ()
MStatus reserve (unsigned int length)
unsigned int length () const
unsigned int size () const
const MObjectArrayoperator[] (unsigned int index) const
const MObjectArrayget (unsigned int index) const
MStatus set (const MObjectArray &boundary, unsigned int index)
MStatus insert (const MObjectArray &boundary, unsigned int index)
MStatus append (const MObjectArray &boundary)
MStatus remove (unsigned int index)
MStatus clear ()
MObject getMergedBoundary (unsigned int index, MStatus *status=NULL) const


Constructor & Destructor Documentation

MTrimBoundaryArray::MTrimBoundaryArray (  ) 

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

MTrimBoundaryArray::MTrimBoundaryArray ( const MTrimBoundaryArray other  ) 

Copy Constructor.

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

MTrimBoundaryArray::~MTrimBoundaryArray (  ) 

Class destructor


Member Function Documentation

MStatus MTrimBoundaryArray::reserve ( unsigned int  reserveLength  ) 

This method is used to reserve the capacity of the array.

Parameters:
[in] reserveLength the number of items to reserve
Returns:
MS::kSuccess if the reserve worked and MS::kFailure otherwise

unsigned int MTrimBoundaryArray::length (  )  const

This method returns the length of the trim boundary array.

unsigned int MTrimBoundaryArray::size (  )  const

This method returns the size of the trim boundary array. The size and the length are the same.

const MObjectArray & MTrimBoundaryArray::operator[] ( unsigned int  index  )  const

The index operator. NOTE: no bounds are checked by this method.

Parameters:
[in] index value indicating which array to return
Returns:
The MObjectArray requested

const MObjectArray & MTrimBoundaryArray::get ( unsigned int  index  )  const

The method returns the MObjectArray specified by the index. NOTE: no bounds are checked by this method.

Parameters:
[in] index value indicating which array to return
Returns:
The MObjectArray requested

MStatus MTrimBoundaryArray::set ( const MObjectArray boundary,
unsigned int  index 
)

This method is used to replace an existing boundary array.

Parameters:
[in] boundary the boundary object array to set
[in] index the index to place the boundary array at
Returns:
MS::kSuccess if the set worked and MS::kFailure otherwise

MStatus MTrimBoundaryArray::insert ( const MObjectArray boundary,
unsigned int  index 
)

This method adds a new boundary into the "index" position.

Parameters:
[in] boundary the object array to add
[in] index the index to add the boundary array at
Returns:

MStatus MTrimBoundaryArray::append ( const MObjectArray boundary  ) 

Add a new boundary array at the end of the list.

Parameters:
[in] boundary the boundary array to append
Returns:

MStatus MTrimBoundaryArray::remove ( unsigned int  index  ) 

This method removes an existing boundary from the list.

Parameters:
[in] index the index of the array to remove
Returns:

MStatus MTrimBoundaryArray::clear (  ) 

This method clears the trim boundary array.

Returns:

MObject MTrimBoundaryArray::getMergedBoundary ( unsigned int  index,
MStatus status = NULL 
) const

This function create a curve that represent all curves of the boundary. The original boundary edges are not changed. Note that the resulting curve is not added to the current model but is owned by an MObject which is of type kNurbsCurveData.

Parameters:
[in] index the index to the boundary array that should be used to create the curve
[out] status return status of the method
Returns:


Autodesk® Maya® 2009 © 1997-2008 Autodesk, Inc. All rights reserved. Generated with doxygen 1.5.6