class MFnDoubleIndexedComponent

Jump to documentation

Inheritance:

MFnDoubleIndexedComponent < MFnComponent < MFnBase

public members:

	MFnDoubleIndexedComponent ()
	MFnDoubleIndexedComponent ( MObject & object, MStatus * ReturnStatus = NULL )
virtual	~MFnDoubleIndexedComponent ()
virtual MFn::Type	type () const
MObject	create ( MFn::Type compType, MStatus * ReturnStatus = NULL )
MStatus	addElement ( int uIndex, int vIndex )
MStatus	addElements ( const MIntArray & uIndexArray, const MIntArray & vIndexArray )
MStatus	getElement ( int index, int & uIndex, int & vIndex ) const
MStatus	getElements ( MIntArray & uIndexArray, MIntArray & vIndexArray ) const
MStatus	setCompleteData ( int maxU, int maxV )
MStatus	getCompleteData ( int & maxU, int & maxV ) const
	public NO SCRIPT SUPPORT
	MFnDoubleIndexedComponent ( const MObject & object, MStatus * ReturnStatus = NULL )

Inherited from MFnComponent:

public members:

int	elementCount ( MStatus * ReturnStatus = NULL )
MFn::Type	componentType ( MStatus * ReturnStatus = NULL )
bool	isEmpty ( MStatus * ReturnStatus = NULL ) const
bool	isEqual ( MObject &, MStatus * ReturnStatus = NULL ) const
bool	isComplete ( MStatus * ReturnStatus = NULL ) const
MStatus	setComplete ( bool )
MFn::Type	type ( MStatus * ReturnStatus = NULL )

Inherited from MFnBase:

public members:

virtual MFn::Type	type () const
bool	hasObj ( MFn::Type ) const
bool	hasObj ( const MObject & ) const
MObject	object ( MStatus * ReturnStatus = NULL ) const
virtual MStatus	setObject ( MObject & object )
virtual MStatus	setObject ( const MObject & object )

Documentation

Description

This function set allows you to create, edit, and query double indexed components. Double indexed components store 2 dimensional index values.

Functions

MFnDoubleIndexedComponent:: MFnDoubleIndexedComponent ()

Description

Default class constructor. The function set is not attached to an MObject.

MFnDoubleIndexedComponent:: MFnDoubleIndexedComponent ( MObject & object, MStatus * ReturnStatus )

Description

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

Arguments

• object the MObject to attach the function set to
• ReturnStatus the return status
  • 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

MFnDoubleIndexedComponent:: MFnDoubleIndexedComponent ( const MObject & object, MStatus * ReturnStatus )

Description

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

Arguments

• object the const MObject to attach the function set to
• ReturnStatus the return status
  • 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

MFnDoubleIndexedComponent:: ~MFnDoubleIndexedComponent ()

Description

The class destructor.

MFn::Type MFnDoubleIndexedComponent:: type () const

Description

Return the type of this function set.

Return Value

• the constant MFn::kDoubleIndexedComponent

MObject MFnDoubleIndexedComponent:: create ( MFn::Type compType, MStatus * ReturnStatus )

Description

Create a double indexed component of the given type. Allowable types are

MFn::kSurfaceCVComponent MFn::kSurfaceEPComponent MFn::kSurfaceKnotComponent MFn::kMeshVtxFaceComponent

Arguments

• compType the type of component to create
• ReturnStatus status code

Return Value

• the new component

Status Codes

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

MStatus MFnDoubleIndexedComponent:: addElement ( int uIndex, int vIndex )

Description

Add the specified element to the component.

Arguments

• uIndex the u index to add
• vIndex the v index to add

Return Value

• status code

Status Codes

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

MStatus MFnDoubleIndexedComponent:: addElements ( const MIntArray & uIndices, const MIntArray & vIndices )

Description

Add the specified elements to the component.

Arguments

• uIndices the array of u indices to be added
• vIndices the array of v indices to be added

Return Value

• status code

Status Codes

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

MStatus MFnDoubleIndexedComponent:: getElement ( int index, int & uIndex, int & vIndex ) const

Description

Get the specified element from the component.

Arguments

• index the index of the element to retrieve
• uIndex the u index of the component
• vIndex the v index of the component

Return Value

• status code

Status Codes

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

MStatus MFnDoubleIndexedComponent:: getElements ( MIntArray & uIndices, MIntArray & vIndices ) const

Description

Get all of the element indices from the component.

Arguments

• uIndices storage for the array of u indices
• vIndices storage for the array of v indices

Return Value

• status code

Status Codes

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

MStatus MFnDoubleIndexedComponent:: setCompleteData ( int maxU, int maxV )

Description

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)).

Arguments

• maxU the maximum number of U elements
• maxV the maximum number of V elements

Return Value

• status code

Status Codes

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

MStatus MFnDoubleIndexedComponent:: getCompleteData ( int & maxU, int & maxV ) const

Description

Returns the number of elements for the complete component. A complete component means that all elements are selected.

Arguments

• maxU storage for the maximum number of U elements
• maxV storage for the maximum number of V elements

Return Value

• status code

Status Codes

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

This class has no child classes.