MDGMessage Class Reference
この参照ページは、次の概要トピックと関連付けられています。#include <MDGMessage.h>
Class Description
Dependency graph messages.
This class is used to register callbacks for dependency graph messages.
There are 4 add callback methods which will add callbacks for the following messages
\li <b>Time change</b> \li <b>Node Added</b> \li <b>Node Removed</b> \li <b>Connection made or broken</b>
A filter can be specified for node added/removed messages. The default node type is "dependNode" which matches all nodes. Each method returns an id which is used to remove the callback.
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.
Inheritance diagram for MDGMessage:
Static Public Member Functions | |
| static MCallbackId | addTimeChangeCallback (MMessage::MTimeFunction func, void *clientData=NULL, MStatus *ReturnStatus=NULL) |
| This method registers a callback that is called whenever the time changes in the dependency graph. More... | |
| static MCallbackId | addDelayedTimeChangeCallback (MMessage::MTimeFunction func, void *clientData=NULL, MStatus *ReturnStatus=NULL) |
| This method registers a callback that is called whenever the time changes in the dependency graph, but after the time changed callback. More... | |
| static MCallbackId | addDelayedTimeChangeRunupCallback (MMessage::MTimeFunction func, void *clientData=NULL, MStatus *ReturnStatus=NULL) |
| This method registers a callback that is called whenever the time changes in the dependency graph, but after the other time changed callbacks which can be used to invoke a dynamics solve or runup if needed. More... | |
| static MCallbackId | addForceUpdateCallback (MMessage::MTimeFunction func, void *clientData=NULL, MStatus *ReturnStatus=NULL) |
| This method registers a callback that is called after the time changes and after all nodes have been evaluated in the dependency graph. More... | |
| static MCallbackId | addNodeAddedCallback (MMessage::MNodeFunction func, const MString &nodeType=kDefaultNodeType, void *clientData=NULL, MStatus *ReturnStatus=NULL) |
| This method registers a callback that is called whenever a new node is added to the dependency graph. More... | |
| static MCallbackId | addNodeRemovedCallback (MMessage::MNodeFunction func, const MString &nodeType=kDefaultNodeType, void *clientData=NULL, MStatus *ReturnStatus=NULL) |
| This method registers a callback that is called whenever a new node is removed from the dependency graph. More... | |
| static MCallbackId | addConnectionCallback (MMessage::MPlugFunction func, void *clientData=NULL, MStatus *ReturnStatus=NULL) |
| This method registers a callback that is called whenever a connection is made or broken in the dependency graph. More... | |
| static MCallbackId | addPreConnectionCallback (MMessage::MPlugFunction func, void *clientData=NULL, MStatus *ReturnStatus=NULL) |
| This method registers a callback that is called whenever any connection is made or broken in the dependency graph. More... | |
| Static Public Member Functions inherited from MMessage | |
Additional Inherited Members | |
| Public Types inherited from MMessage |
Member Function Documentation
|
static |
This method registers a callback that is called whenever the time changes in the dependency graph.
- Parameters
-
[in] func the callback function \li <b>time</b> the new time \li <b>clientData</b> User defined data passed to the callback function[in] clientData User defined data passed to the callback function [out] ReturnStatus status code
- Returns
- Identifier used for removing the callback.
- Status Codes:
- MS::kSuccess Operation succeeded
- MS::kInsufficientMemory No memory available
- MS::kFailure Error adding callback
- Examples:
|
static |
This method registers a callback that is called whenever the time changes in the dependency graph, but after the time changed callback.
- Parameters
-
[in] func the callback function - time the new time
- clientData User defined data passed to the callback function
[in] clientData User defined data passed to the callback function [out] ReturnStatus status code
- Returns
- Identifier used for removing the callback.
- Status Codes:
- MS::kSuccess Operation succeeded
- MS::kInsufficientMemory No memory available
- MS::kFailure Error adding callback
|
static |
This method registers a callback that is called whenever the time changes in the dependency graph, but after the other time changed callbacks which can be used to invoke a dynamics solve or runup if needed.
- Parameters
-
[in] func the callback function - time the new time
- clientData User defined data passed to the callback function
[in] clientData User defined data passed to the callback function [out] ReturnStatus status code
- Returns
- Identifier used for removing the callback.
- Status Codes:
- MS::kSuccess Operation succeeded
- MS::kInsufficientMemory No memory available
- MS::kFailure Error adding callback
|
static |
This method registers a callback that is called after the time changes and after all nodes have been evaluated in the dependency graph.
- Parameters
-
[in] func the callback function \li <b>time</b> the new time \li <b>clientData</b> User defined data passed to the callback function[in] clientData User defined data passed to the callback function [out] ReturnStatus status code
- Returns
- Identifier used for removing the callback.
- Status Codes:
- MS::kSuccess Operation succeeded
- MS::kInsufficientMemory No memory available
- MS::kFailure Error adding callback
|
static |
This method registers a callback that is called whenever a new node is added to the dependency graph.
The nodeType argument allows you to specify the type of nodes that will trigger the callback. The default node type is "dependNode" which matches all nodes.
- Parameters
-
[in] func the callback function \li <b>node</b> the new node \li <b>clientData</b> User defined data passed to the callback function[in] nodeType Type of node that will trigger the callback [in] clientData User defined data passed to the callback function [out] ReturnStatus status code
- Returns
- Identifier used for removing the callback.
- Status Codes:
- MS::kSuccess Operation succeeded
- MS::kInvalidParameter An invalid nodeType was specified
- MS::kInsufficientMemory No memory available
- MS::kFailure Error adding callback
- Examples:
|
static |
This method registers a callback that is called whenever a new node is removed from the dependency graph.
The nodeType argument allows you to specify the type of nodes that will trigger the callback. The default node type is "dependNode" which matches all nodes.
- Parameters
-
[in] func the callback function \li <b>node</b> the node being removed \li <b>clientData</b> User defined data passed to the callback function[in] nodeType Type of node that will trigger the callback [in] clientData User defined data passed to the callback function [out] ReturnStatus status code
- Returns
- Identifier used for removing the callback.
- Status Codes:
- MS::kSuccess Operation succeeded
- MS::kInsufficientMemory No memory available
- MS::kFailure Error adding callback
- Examples:
|
static |
This method registers a callback that is called whenever a connection is made or broken in the dependency graph.
This callback is triggered after the given connection has been made or broken, unlike the addPreConnectionCallback which is triggered before the operation.
- Parameters
-
[in] func the callback function \li <b>srcPlug</b> Source plug of the connection \li <b>destPlug</b> Destination plug of the connection \li <b>made</b> true if a new connection was made, false if broken. \li <b>clientData</b> User defined data passed to the callback function[in] clientData User defined data passed to the callback function [out] ReturnStatus status code
- Returns
- Identifier used for removing the callback.
- Status Codes:
- MS::kSuccess Operation succeeded
- MS::kInsufficientMemory No memory available
- MS::kFailure Error adding callback
|
static |
This method registers a callback that is called whenever any connection is made or broken in the dependency graph.
This callback is triggered before the given connection has been made or broken, unlike the addConnectionCallback which is triggered after the operation.
- Parameters
-
[in] func the callback function \li <b>srcPlug</b> Source plug of the connection \li <b>destPlug</b> Destination plug of the connection \li <b>made</b> true if a new connection will be made, false if it will be broken. \li <b>clientData</b> User defined data passed to the callback function[in] clientData User defined data passed to the callback function [out] ReturnStatus status code
- Returns
- Identifier used for removing the callback.
- Status Codes:
- MS::kSuccess Operation succeeded
- MS::kInsufficientMemory No memory available
- MS::kFailure Error adding callback
The documentation for this class was generated from the following files:
- MDGMessage.h
- MDGMessage.cpp