#include
<MFnPointArrayData.h>
List of all
members.
Detailed Description
Point array function set for dependency node data.
MFnPointArrayData
allows the creation and manipulation of MPointArray data objects for use
in the dependency graph.
If a user written dependency node either accepts or produces
MPointArrays, 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 kPointArray 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 MFnPointArrayData.
Constructor & Destructor Documentation
MFnPointArrayData::MFnPointArrayData |
( |
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:
-
MFnPointArrayData::MFnPointArrayData |
( |
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
MFnPointArrayData::type |
( |
|
) |
const [virtual] |
const char * MFnPointArrayData::className |
( |
|
) |
const [protected, virtual] |
Class name.
Return the class name : "MFnPointArrayData"
Reimplemented from MFnData.
unsigned int MFnPointArrayData::length |
( |
MStatus * |
ReturnStatus =
NULL |
) |
const |
Return the number of points in the instance.
- Parameters:
-
[out] |
ReturnStatus |
kFailure if the instance is not attached to an MObject, and kSuccess
otherwise. |
- Returns:
- The number of points in the instance
MStatus MFnPointArrayData::set |
( |
MPoint & |
element, |
|
|
unsigned int |
index |
|
|
) |
|
|
|
Set the point element at the specified index.
- Parameters:
-
[in] |
element |
the element to be set |
[in] |
index |
the index of the MPoint to set |
- Returns:
-
- kSuccess operation successful
- kFailure instance is not attached to an MObject
Copy all the points in the instance into the given MPointArray. No checking is done
by this class on sizes, so it is up to the user to ensure that the
given MPointArray is large enough to
hold the number of MPoints in the instance.
- Parameters:
-
- Returns:
-
- kSuccess operation successful
- kFailure instance is not attached to an MObject
Set the instance to contain the points defined in the given
MPointArray.
- Parameters:
-
[in] |
array |
the MPointArray containing the data to
set into this instance |
- Returns:
-
- kSuccess operation successful
- kFailure instance is not attached to an MObject
Get an MPointArray containing the points
stored in this instance. The MPointArray 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 MPointArray held in this
instance
Create a new MObject, attach it to this instance, and
initialize it to contain no points.
- 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 MPointArray.
- Parameters:
-
[in] |
arr |
the data to use when initializing this instance |
[out] |
ReturnStatus |
kSuccess |
- Returns:
- The newly created MObject
MPoint &
MFnPointArrayData::operator[] |
( |
unsigned int |
index |
) |
|
NO SCRIPT SUPPORT.
Extract the indicated MPoint from the instance.
The MPoint returned by this method is
editable, so any changes to the return 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 an
MPoint containing (0.0, 0.0, 0.0,
1.0).
- Parameters:
-
[in] |
index |
the index of the MPoint to extract |
- Returns:
- The indicated MPoint
const MPoint &
MFnPointArrayData::operator[] |
( |
unsigned int |
index |
) |
const |
NO SCRIPT SUPPORT.
Extract the indicated MPoint 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
MPoint containing (0.0, 0.0, 0.0,
1.0).
- Parameters:
-
[in] |
index |
the index of the MPoint to extract |
- Returns:
- The indicated MPoint