#include <MFnSingleIndexedComponent.h>

Class Description

Single indexed component function set.

This function set allows you to create, edit, and query single indexed components. Single indexed components store 1 dimensional index values.

Examples:: AbcExport/MayaMeshWriter.cpp, AbcImport/CreateSceneHelper.cpp, apiMeshShape/apiMeshData.cpp, apiMeshShape/apiMeshGeometryOverride.cpp, apiMeshShape/apiMeshShape.cpp, apiMeshShape/apiMeshShapeUI.cpp, apiMeshShape/apiMeshSubSceneOverride.cpp, gpuCache/CacheWriter.cpp, grabUVMain.cpp, listRichSelectionCmd/listRichSelectionCmd.cpp, meshOpCmd/meshOpCmd.cpp, meshOpCmd/meshOpNode.cpp, OpenGLViewportRenderer/OpenGLViewportRenderer.cpp, paintCallback/paintCallback.cpp, splitUVCmd/splitUVCmd.cpp, and splitUVCmd/splitUVNode.cpp.

Inheritance diagram for MFnSingleIndexedComponent:

Public Member Functions
virtual MFn::Type	type () const
	Function set type. More...

virtual	~MFnSingleIndexedComponent ()
	Destructor.

	MFnSingleIndexedComponent ()
	Default constructor.

	MFnSingleIndexedComponent (MObject &object, MStatus *ReturnStatus=NULL)
	Constructor. More...

MObject	create (MFn::Type compType, MStatus *ReturnStatus=NULL)
	Create a single indexed component of the given type. More...

MStatus	addElement (int element)
	Add the specified element to the component. More...

MStatus	addElements (MIntArray &elements)
	Add the specified elements to the component. More...

int	elementMax (MStatus *ReturnStatus=NULL) const
	Returns the biggest element, plus 1, from the component. More...

int	element (int index, MStatus *ReturnStatus=NULL) const
	Returns the specified element from the component. More...

MStatus	getElements (MIntArray &elements) const
	Get all of the element indices from the component. More...

MStatus	setCompleteData (int numElements)
	Marks the component as complete (meaning all items are selected) and uses the argument to identify the total number of elements selected. More...

MStatus	getCompleteData (int &numElements) const
	Returns the number of elements for the complete component. More...

	MFnSingleIndexedComponent (const MObject &object, MStatus *ReturnStatus=NULL)
	Constructor. More...

Public Member Functions inherited from MFnComponent
virtual	~MFnComponent ()
	Destructor.

	MFnComponent (MObject &object, MStatus *ReturnStatus=NULL)
	Constructor. More...

	MFnComponent ()
	Default class constructor.

int	elementCount (MStatus *ReturnStatus=NULL) const
	Returns the number of elements that this component contains. More...

MFn::Type	componentType (MStatus *ReturnStatus=NULL) const
	Returns the MFn type of the component. More...

bool	isEmpty (MStatus *ReturnStatus=NULL) const
	Determines if this component is empty, i.e. More...

bool	isEqual (MObject &, MStatus *ReturnStatus=NULL) const
	Compares this component with the given component. More...

bool	isComplete (MStatus *ReturnStatus=NULL) const
	Returns the complete state of the component. More...

MStatus	setComplete (bool)
	Sets the complete state of the component. More...

bool	hasWeights () const
	Query this component for the existance of attached weight data. More...

MWeight	weight (int index, MStatus *ReturnStatus=NULL) const
	Return the weight data for a given element within this component. More...

MStatus	setWeight (int index, const MWeight &weight)
	Set the weight data for a given element within this component. More...

MStatus	setWeights (const MWeight &weight)
	Set the weight data for all elements within this component. More...

	MFnComponent (const MObject &object, MStatus *ReturnStatus=NULL)
	Constructor. More...

MFn::Type	type (MStatus *ReturnStatus=NULL)
	Obsolete & no script support. More...

Public Member Functions inherited from MFnBase
virtual	~MFnBase ()
	Class Destructor. More...

bool	hasObj (MFn::Type) const
	Determines whether or not the Function Set is compatible with the specified Maya Object within the API RTTI system. More...

bool	hasObj (const MObject &) const
	Determines whether or not the Function Set is compatible with the specified Maya Object within the API RTTI system. More...

MObject	object (MStatus *ReturnStatus=NULL) const
	Returns the MObject that is attached to the Function Set. More...

virtual MStatus	setObject (MObject &object)
	Attaches the Function Set to the specified Maya Object. More...

virtual MStatus	setObject (const MObject &object)
	NO SCRIPT SUPPORT. More...

Protected Member Functions
virtual const char *	className () const
	Class name. More...

Additional Inherited Members
Static Public Member Functions inherited from MFnBase
static const char *	className ()
	Returns the name of this class. More...

Constructor & Destructor Documentation

MFnSingleIndexedComponent	(	MObject &	object,
		MStatus *	ReturnStatus = `NULL`
	)

Constructor.

Class constructor that initializes the function set to the given MObject.

Parameters

[in]	object	The MObject to attach the function set to
[out]	ReturnStatus	the return status

Status Codes:

MS::kSuccess if the function set is successfully attached
MS::kInvalidParameter if the MObject does not represent a valid Maya object or if the function set is not allowed to attach to this MObject

MFnSingleIndexedComponent	(	const MObject &	object,
		MStatus *	ReturnStatus = `NULL`
	)

Constructor.

Class constructor that initializes the function set to the given MObject.

Parameters

[in]	object	The MObject to attach the function set to
[out]	ReturnStatus	the return status

Status Codes:

MS::kSuccess if the function set is successfully attached
MS::kInvalidParameter if the MObject does not represent a valid Maya object or if the function set is not allowed to attach to this MObject

Member Function Documentation

MFn::Type type ( ) const

virtual

Function set type.

Return the class type : MFn::kSingleIndexedComponent.

Reimplemented from MFnComponent.

OPENMAYA_MAJOR_NAMESPACE_OPEN const char * className ( ) const

protectedvirtual

Class name.

Return the class name : "MFnSingleIndexedComponent".

Reimplemented from MFnComponent.

MObject create	(	MFn::Type	compType,
		MStatus *	ReturnStatus = `NULL`
	)

Create a single indexed component of the given type.

Allowable types are

MFn::kCurveCVComponent MFn::kCurveEPComponent MFn::kCurveKnotComponent MFn::kMeshEdgeComponent MFn::kMeshPolygonComponent MFn::kMeshVertComponent MFn::kMeshMapComponent

Parameters

[in]	compType	the type of component to create
[out]	ReturnStatus	status code

Returns: The new component

Status Codes:

MS::kSuccess the method was successful.
MS::kInvalidParameter invalid component type

Examples:: AbcImport/CreateSceneHelper.cpp, apiMeshShape/apiMeshShape.cpp, apiMeshShape/apiMeshShapeUI.cpp, gpuCache/CacheWriter.cpp, OpenGLViewportRenderer/OpenGLViewportRenderer.cpp, and splitUVCmd/splitUVCmd.cpp.

MStatus addElement ( int element )

Add the specified element to the component.

Parameters

[in] element the element index to be added

Returns: Status code

Status Codes:

MS::kSuccess the method was successful
MS::kFailure an object error has occurred

Examples:: apiMeshShape/apiMeshShape.cpp, apiMeshShape/apiMeshShapeUI.cpp, and OpenGLViewportRenderer/OpenGLViewportRenderer.cpp.

MStatus addElements ( MIntArray & elements )

Add the specified elements to the component.

Parameters

[in] elements the array of element indices to be added

Returns: Status code

Status Codes:

MS::kSuccess the method was successful
MS::kFailure an object error has occurred

Examples:: AbcImport/CreateSceneHelper.cpp, and splitUVCmd/splitUVCmd.cpp.

int elementMax ( MStatus * ReturnStatus = NULL ) const

Returns the biggest element, plus 1, from the component.

Parameters

[out] ReturnStatus status code

Returns: The biggest index plus 1 of the specified component

Status Codes:

MS::kSuccess the method was successful
MS::kFailure an object error has occurred

int element	(	int	index,
		MStatus *	ReturnStatus = `NULL`
	)		const

Returns the specified element from the component.

Parameters

[in]	index	the index of the element to retrieve
[out]	ReturnStatus	status code

Returns: The index of the specified component

Status Codes:

MS::kSuccess the method was successful
MS::kFailure an object error has occurred

Examples:: apiMeshShape/apiMeshShape.cpp, and paintCallback/paintCallback.cpp.

MStatus getElements ( MIntArray & elements ) const

Get all of the element indices from the component.

Parameters

[out] elements storage for the array of indices

Returns: Status code

Status Codes:

MS::kSuccess the method was successful
MS::kFailure an object error has occurred

Examples:: AbcExport/MayaMeshWriter.cpp, and apiMeshShape/apiMeshSubSceneOverride.cpp.

MStatus setCompleteData ( int numElements )

Marks the component as complete (meaning all items are selected) and uses the argument to identify the total number of elements selected.

If the component should contain N element indices, then the range would be [0,N-1].

Also sets the complete state of the component to 'true' (i.e. setComplete(true)).

Parameters

[in] numElements the maximum number of elements in the component

Returns: Status code

Status Codes:

MS::kSuccess the method was successful
MS::kFailure an object error has occurred

Examples:: AbcImport/CreateSceneHelper.cpp, apiMeshShape/apiMeshShape.cpp, and gpuCache/CacheWriter.cpp.

MStatus getCompleteData ( int & numElements ) const

Returns the number of elements for the complete component.

A complete component means that all elements are selected.

Parameters

[out] numElements storage for the maximum number of elements

Returns: Status code

Status Codes:

MS::kSuccess the method was successful
MS::kFailure an object error has occurred

The documentation for this class was generated from the following files:

MFnSingleIndexedComponent.h
MFnSingleIndexedComponent.cpp

MFnSingleIndexedComponent Class Reference

Class Description

Public Member Functions

Protected Member Functions

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation