#include
<MFnVectorArrayData.h>
List of all
members.
Detailed Description
int array function set for dependency node data.
MFnVectorArrayData
allows the creation and manipulation of MVectorArray data objects for
use in the dependency graph.
If a user written dependency node either accepts or produces
MVectorArrays, then this class is used to extract or create the
data that comes from or goes to other dependency graph nodes. The
MDataHandle::type
method will return kVectorArray when data of this type is present.
To access it, the MDataHandle::data
method is used to get an MObject for the data and this should then
be used to initialize an instance of MFnVectorArrayData.
Constructor & Destructor Documentation
MFnVectorArrayData::MFnVectorArrayData |
( |
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:
-
MFnVectorArrayData::MFnVectorArrayData |
( |
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:
-
Member Function Documentation
MFn::Type
MFnVectorArrayData::type |
( |
|
) |
const [virtual] |
const char * MFnVectorArrayData::className |
( |
|
) |
const [protected, virtual] |
Class name.
Return the class name : "MFnVectorArrayData"
Reimplemented from MFnData.
unsigned int MFnVectorArrayData::length |
( |
MStatus * |
ReturnStatus =
NULL |
) |
const |
Return the number of vectors in the instance.
- Parameters:
-
[out] |
ReturnStatus |
kFailure if the instance is not attached to an MObject, and kSuccess
otherwise. |
- Returns:
- The number of vectors in the instance
MStatus MFnVectorArrayData::set |
( |
MVector & |
element, |
|
|
unsigned int |
index |
|
|
) |
|
|
|
Set the element at the specified index.
No checking is done by this class to ensure that the index is
valid - use the length method to determine the size of the
array.
- Parameters:
-
[in] |
element |
the element |
[in] |
index |
the index of the vector to set |
- Returns:
-
- kSuccess operation successful
- kFailure instance is not attached to an MObject
Copy all the vectors in the instance into the given MVectorArray.
- Parameters:
-
- Returns:
-
- kSuccess operation successful
- kFailure instance is not attached to an MObject
Set the instance to contain the vectors defined in the given
MVectorArray.
- Parameters:
-
[in] |
array |
the MVectorArray containing the data
to set into this instance |
- Returns:
-
- kSuccess operation successful
- kFailure instance is not attached to an MObject
Return an MVectorArray containing the
vector array currently operated upon by the function set. The
MVectorArray returned by this
method is editable, so any changes to the return instance also
affects the MObject
operated upon by this function set.
- Parameters:
-
[out] |
ReturnStatus |
kFailure if the instance is not attached to an MObject, and kSuccess
otherwise. |
- Returns:
- A copy of the MVectorArray held in this
instance
Create a new MObject, attach it to this instance, and
initialize it to be empty.
- Parameters:
-
[out] |
ReturnStatus |
kSuccess |
- Returns:
- The newly created MObject
Create a new MObject, attach it to this instance, and
initialize it to contain the data from the given MVectorArray.
- Parameters:
-
[in] |
arr |
the data to use when initializing this instance |
[out] |
ReturnStatus |
kSuccess |
- Returns:
- The newly created MObject
const MVector &
MFnVectorArrayData::operator[] |
( |
unsigned int |
index |
) |
const |
NO SCRIPT SUPPORT.
Extract the indicated int from the const instance. No checking
is done by this class to ensure that the index is valid - use the
length method to determine the size of the array. If the instance
is not attached to an MObject, this method will return an empty
vector.
- Parameters:
-
[in] |
index |
the index of the vector to extract |
- Returns:
- The indicated vector
MVector &
MFnVectorArrayData::operator[] |
( |
unsigned int |
index |
) |
|
NO SCRIPT SUPPORT.
Extract the indicated vector from the instance. by the function
set. The vector returned by this method is editable, so any changes
to the returned instance also affects the MObject operated upon by this function
set.
No checking is done by this class to ensure that the index is
valid - use the length method to determine the size of the array.
If the instance is not attached to an MObject, this method will return a zero
vector.
- Parameters:
-
[in] |
index |
the index of the vector to extract |
- Returns:
- The indicated vector