C++ API Reference
|
Animation messages. More...
#include <MAnimMessage.h>
Static Public Member Functions | |
static MCallbackId | addAnimCurveEditedCallback (MMessage::MObjArray func, void *clientData=NULL, MStatus *ReturnStatus=NULL) |
AnimCurve edited callback. More... | |
static MCallbackId | addAnimKeyframeEditedCallback (MMessage::MObjArray func, void *clientData=NULL, MStatus *ReturnStatus=NULL) |
AnimCurve keyframe edited callback. More... | |
static MCallbackId | addNodeAnimKeyframeEditedCallback (MObject &animNode, MMessage::MNodeObjArray func, void *clientData=NULL, MStatus *ReturnStatus=NULL) |
AnimCurve keyframe edited callback. More... | |
static MCallbackId | addAnimKeyframeEditCheckCallback (MMessage::MCheckPlugFunction func, void *clientData=NULL, MStatus *ReturnStatus=NULL) |
AnimCurve keyframe edit check callback. More... | |
static MCallbackId | addPreBakeResultsCallback (MMessage::MPlugsDGModFunction func, void *clientData=NULL, MStatus *ReturnStatus=NULL) |
Pre Bake Simulation callback. More... | |
static MCallbackId | addPostBakeResultsCallback (MMessage::MPlugsDGModFunction func, void *clientData=NULL, MStatus *ReturnStatus=NULL) |
Post Bake Simulation callback. More... | |
static MCallbackId | addDisableImplicitControlCallback (MMessage::MPlugsDGModFunction func, void *clientData=NULL, MStatus *ReturnStatus=NULL) |
Disable Implicit Control callback. More... | |
static MCallbackId | addAnimKeyframeEditedCallback (MObject &animNode, MMessage::MNodeObjArray func, void *clientData=NULL, MStatus *ReturnStatus=NULL) |
This method is obsolete. More... | |
static void | flushAnimKeyframeEditedCallbacks () |
AnimCurve keyframe edited callback flush. More... | |
static const char * | className () |
Returns the name of this class. More... | |
Additional Inherited Members | |
Callback result action codes. More... |
Animation messages.
This class is used to register callbacks for animation messages.
To remove a callback use MMessage::removeCallback. All callbacks that are registered by a plug-in must be removed by that plug-in when it is unloaded. Failure to do so will result in a fatal error.
|
static |
AnimCurve edited callback.
This method registers a callback that is called whenever an AnimCurve is edited.
[in] | func | The callback function. |
[in] | clientData | User defined data passed to the callback function. |
[out] | ReturnStatus | Status code. |
|
static |
AnimCurve keyframe edited callback.
This method registers a callback that is called whenever an a group of keys are modified.
The callback is invoked once per atomic change to single or group of keyframes. For example, if a user selects a group 5 of keys and moves them 5 units in the value axis, then a single callback event will be invoked with a MObject for each of the 5 keyframes. The MObjects can then be used in the MFnKeyframeDelta function set. Refer to MFnKeyframeDelta function set documentation for more info.
[in] | func | the callback function |
[in] | clientData | User defined data. |
[out] | ReturnStatus | status code |
|
static |
AnimCurve keyframe edited callback.
This method registers a callback that is called whenever an a group of keys are modified.
The callback is invoked once per atomic change to single or group of keyframes on the specified animation curve node. For example, if a user selects a group 5 of keys and moves them 5 units in the value axis, then a single callback event will be invoked with a MObject for each of the 5 keyframes. The MObjects can then be used in the MFnKeyframeDelta function set. Refer to MFnKeyframeDelta function set documentation for more info.
[in] | animNode | the param curve node you want to watch. |
[in] | func | the callback function |
[in] | clientData | User defined data. |
[out] | ReturnStatus | status code |
|
static |
AnimCurve keyframe edit check callback.
This method registers a callback that is used by the setKeyframe command to allow a user to consider the set keyframe request and cancel it if needed.
The callback method should return false to abort the keyframe setting.
[in] | func | the callback function
|
[in] | clientData | User defined data. |
[out] | ReturnStatus | status code |
This example callback will reject any changes to plugs including 'translate' in their name.
|
static |
Pre Bake Simulation callback.
This method registers a callback that is called from bakeResults command before the simulation.
One example usage is handle the runup to the first frame in a dynamic system. If plugArray is set to zero length in the callback, the baking will be aborted.
[in] | func | the callback function
|
[in] | clientData | User defined data. |
[out] | ReturnStatus | status code |
|
static |
Post Bake Simulation callback.
This method registers a callback that is called from bakeResults command after the simulation.
If the plugArray is replaced, then the anim curves created from baking will be connected to the new plugs.
[in] | func | the callback function
|
[in] | clientData | User defined data. |
[out] | ReturnStatus | status code |
|
static |
Disable Implicit Control callback.
This method registers a callback that is called from bakeResults command after baking operation is completed, if disableImplicitControl is enabled.
One example usage of this callback is to create the anim curve that is used to drive Maya rigidbody's bakeSimulationIndex, which defines if the rigid body should take its input from anim curve or rigid body simulation.
[in] | func | the callback function
|
[in] | clientData | User defined data. |
[out] | ReturnStatus | status code |
|
static |
This method is obsolete.
This method is not available in Python.
[from before Maya 2016]
[in] | animNode | the param curve node you want to watch. |
[in] | func | The callback function. |
[in] | clientData | User defined data. |
[out] | ReturnStatus | Status code. |
|
static |
AnimCurve keyframe edited callback flush.
Animation keyframe edited callbacks are queued to only be issued on an idle event.
There may be times when it is desired to issue the callback at a specific time. This method provides this functionality. It will flush all animation keyframe edited callbacks and force them to issue their callbacks with the data contained within.
|
static |
Returns the name of this class.