C++ API Reference
|
Graph Editor state information with manipulation capabilities. More...
#include <MGraphEditorInfo.h>
Public Types | |
enum | AnimCurveQuery { kAnimCurveOutlinerOnly = 0, kAnimCurveHighlighted, kAnimCurveSelected, kAnimCurveAllKnown } |
Defines the query criteria for animation curves specifically with respect to the attached Graph Editor's own viewport. More... | |
Public Member Functions | |
MGraphEditorInfo (MStatus *ReturnStatus=NULL) | |
Constructor. More... | |
MGraphEditorInfo (const MString &graphEditorName, MStatus *ReturnStatus=NULL) | |
Constructor. More... | |
~MGraphEditorInfo () override | |
Destructor. | |
MStatus | getAnimCurveNodes (MObjectArray &animCurveNodeArray, AnimCurveQuery animCurveQuery) const |
Returns an array of animCurve nodes, based on the attached Graph Editor's state information, which captures: More... | |
bool | isStackedViewportMode () const |
Returns whether or not the Graph Editor is in Stacked view mode. More... | |
bool | isNormalizedViewportMode () const |
Returns whether or not the Graph Editor is in Normalized view mode. More... | |
Public Member Functions inherited from MPanelCanvasInfo | |
MPanelCanvasInfo (const MString &editorName, MStatus *stat=NULL) | |
The constructor. More... | |
virtual | ~MPanelCanvasInfo () |
Destructor. | |
MStatus | getViewportBounds (double &left, double &right, double &bottom, double &top) const |
Return the viewport bounds. More... | |
MStatus | getViewportBounds (MDoubleArray &boundsArray) const |
Get the attached Graph Editor's viewport bounds, using the currently defined animation time units. More... | |
MStatus | getViewportSize (int &width, int &height) const |
Return the viewport size. More... | |
MStatus | setViewportBounds (double left, double right, double bottom, double top) const |
Set the viewport bounds. More... | |
MStatus | setViewportBounds (const MDoubleArray &boundsArray) const |
Set the attached Graph Editor's viewport bounds to those that are supplied using the currently defined animation time units as seen in the viewport. More... | |
bool | supportsUIDrawing () |
Returns whether the attached panel control supports drawing primitives in screen space. More... | |
void | reset () |
Resets all stored state information to be empty, thereby detaching from the currently attached Graph Editor (if any) | |
MString | name () const |
Return the name of the currently attached panel. More... | |
Static Public Member Functions | |
static const char * | className () |
Returns the name of this class. More... | |
Static Public Member Functions inherited from MPanelCanvasInfo | |
static const char * | className () |
Returns the name of this class. More... | |
Graph Editor state information with manipulation capabilities.
This class provides methods to obtain UI related information from a specific Graph Editor. Support is included for obtaining/setting viewport bounds and obtaining animation curve nodes.
Note: the following are built-in GraphEditor-specific event callback names:
Python 1.0 Example: (getting the names of the curves selected in the default Graph Editor)
Python 1.0 Example: (getting the default Graph Editor's viewport bounds when it encounters a refresh event)
Python 1.0 Example: (setting the default Graph Editor's viewport bounds)
enum AnimCurveQuery |
Defines the query criteria for animation curves specifically with respect to the attached Graph Editor's own viewport.
OPENMAYA_MAJOR_NAMESPACE_OPEN MGraphEditorInfo | ( | MStatus * | ReturnStatus = NULL | ) |
Constructor.
Attaches to the default Graph Editor object - graphEditor1GraphEd
[out] | ReturnStatus | the return status |
MGraphEditorInfo | ( | const MString & | graphEditorName, |
MStatus * | ReturnStatus = NULL |
||
) |
Constructor.
Attaches to the Graph Editor corresponding the supplied name.
[in] | graphEditorName | the name of the Graph Editor (i.e. graphEditor1GraphEd) |
[out] | ReturnStatus | the return status |
MStatus getAnimCurveNodes | ( | MObjectArray & | animCurveNodeArray, |
AnimCurveQuery | animCurveQuery | ||
) | const |
Returns an array of animCurve nodes, based on the attached Graph Editor's state information, which captures:
1) animCurve nodes present in the Outliner, but not visible in the viewport 2) animCurve nodes highlighted in the Outliner and visible in the viewport 3) animCurve nodes selected (via keys/tangent handles) in the viewport 4) animCurve nodes known to exist (independent of any Outliner filtering)
[out] | animCurveNodeArray | an array to store the found anim curves |
[in] | animCurveQuery | the anim curves to enumerate (by display state) |
bool isStackedViewportMode | ( | ) | const |
Returns whether or not the Graph Editor is in Stacked view mode.
return true if the Graph Editor is in Stacked view mode; false otherwise
bool isNormalizedViewportMode | ( | ) | const |
Returns whether or not the Graph Editor is in Normalized view mode.
return true if the Graph Editor is in a Normalized view mode. NOTE: Stacked mode also uses Normalized mode. So this method returns true in Stacked mode, as well; false if not in Stacked -nor- Normalized modes.
|
static |
Returns the name of this class.