class MFnTripleIndexedComponent

Jump to documentation

Inheritance:

MFnTripleIndexedComponent < MFnComponent < MFnBase

public members:

	MFnTripleIndexedComponent ()
	MFnTripleIndexedComponent ( MObject & object, MStatus * ReturnStatus = NULL )
virtual	~MFnTripleIndexedComponent ()
virtual MFn::Type	type () const
MObject	create ( MFn::Type compType, MStatus * ReturnStatus = NULL )
MStatus	addElement ( int sIndex, int tIndex, int uIndex )
MStatus	addElements ( const MIntArray & sIndexArray, const MIntArray & tIndexArray, const MIntArray & uIndexArray )
MStatus	getElement ( int index, int & sIndex, int & tIndex, int & uIndex ) const
MStatus	getElements ( MIntArray & sIndexArray, MIntArray & tIndexArray, MIntArray & uIndexArray ) const
MStatus	setCompleteData ( int maxS, int maxT, int maxU )
MStatus	getCompleteData ( int & maxS, int & maxT, int & maxU ) const
	MFnTripleIndexedComponent ( 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 triple indexed components. Triple indexed components store 3 dimensional index values.

Functions

MFnTripleIndexedComponent:: MFnTripleIndexedComponent ()

Description

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

MFnTripleIndexedComponent:: MFnTripleIndexedComponent ( 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

MFnTripleIndexedComponent:: MFnTripleIndexedComponent ( 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

MFnTripleIndexedComponent:: ~MFnTripleIndexedComponent ()

Description

The class destructor.

MFn::Type MFnTripleIndexedComponent:: type () const

Description

Return the type of this function set.

Return Value

• the constant MFn::kTripleIndexedComponent

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

Description

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

MFn::kLatticeComponent

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 MFnTripleIndexedComponent:: addElement ( int sIndex, int tIndex, int uIndex )

Description

Add the specified element to the component.

Arguments

• sIndex the s index to add
• tIndex the t index to add
• vIndex the u index to add

Return Value

• status code

Status Codes

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

MStatus MFnTripleIndexedComponent:: addElements ( const MIntArray & sIndices, const MIntArray & tIndices, const MIntArray & uIndices )

Description

Add the specified elements to the component.

Arguments

• sIndices the array of s indices to be added
• tIndices the array of t indices to be added
• uIndices the array of u indices to be added

Return Value

• status code

Status Codes

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

MStatus MFnTripleIndexedComponent:: getElement ( int index, int & sIndex, int & tIndex, int & uIndex ) const

Description

Get the specified element from the component.

Arguments

• index the index of the element to retrieve
• sIndex the s index of the component
• tIndex the t index of the component
• uIndex the u index of the component

Return Value

• status code

Status Codes

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

MStatus MFnTripleIndexedComponent:: getElements ( MIntArray & sIndices, MIntArray & tIndices, MIntArray & uIndices ) const

Description

Get all of the element indices from the component.

Arguments

• sIndices storage for the array of s indices
• tIndices storage for the array of t indices
• uIndices storage for the array of u indices

Return Value

• status code

Status Codes

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

MStatus MFnTripleIndexedComponent:: setCompleteData ( int maxS, int maxT, int maxU )

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

• maxS the maximum number of S elements
• maxT the maximum number of T elements
• maxU the maximum number of U elements

Return Value

• status code

Status Codes

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

MStatus MFnTripleIndexedComponent:: getCompleteData ( int & maxS, int & maxT, int & maxU ) const

Description

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

Arguments

• maxS storage for the maximum number of S elements
• maxT storage for the maximum number of T elements
• maxU storage for the maximum number of U 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.