#ifndef _MAnimUtil #define _MAnimUtil //- // ========================================================================== // Copyright (C) 1995 - 2006 Autodesk, Inc., and/or its licensors. All // rights reserved. // // The coded instructions, statements, computer programs, and/or related // material (collectively the "Data") in these files contain unpublished // information proprietary to Autodesk, Inc. ("Autodesk") and/or its // licensors, which is protected by U.S. and Canadian federal copyright law // and by international treaties. // // The Data may not be disclosed or distributed to third parties or be // copied or duplicated, in whole or in part, without the prior written // consent of Autodesk. // // The copyright notices in the Software and this entire statement, // including the above license grant, this restriction and the following // disclaimer, must be included in all copies of the Software, in whole // or in part, and all derivative works of the Software, unless such copies // or derivative works are solely in the form of machine-executable object // code generated by a source language processor. // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND. // AUTODESK DOES NOT MAKE AND HEREBY DISCLAIMS ANY EXPRESS OR IMPLIED // WARRANTIES INCLUDING, BUT NOT LIMITED TO, THE WARRANTIES OF // NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE, // OR ARISING FROM A COURSE OF DEALING, USAGE, OR TRADE PRACTICE. IN NO // EVENT WILL AUTODESK AND/OR ITS LICENSORS BE LIABLE FOR ANY LOST // REVENUES, DATA, OR PROFITS, OR SPECIAL, DIRECT, INDIRECT, OR // CONSEQUENTIAL DAMAGES, EVEN IF AUTODESK AND/OR ITS LICENSORS HAS // BEEN ADVISED OF THE POSSIBILITY OR PROBABILITY OF SUCH DAMAGES. // ========================================================================== //+ // // CLASS: MAnimUtil // // **************************************************************************** #if defined __cplusplus // **************************************************************************** // INCLUDED HEADER FILES #include // **************************************************************************** // DECLARATIONS class MPlug; class MPlugArray; class MObjectArray; class MSelectionList; class MDagPath; // **************************************************************************** // CLASS DECLARATION (MAnimUtil) //! \ingroup OpenMayaAnim //! \brief Static class providing common animation helper methods /*! MAnimUtil is a static class which provides methods which determine if an object is being animated, which attributes are animated for a given object and which animation curves are used to animate a given attribute. Note: for purposes of this helper class, "animation" refers to attributes animated by animCurves (i.e. by setting keys). It does not include any animation through expressions or dynamics or timer node connections. Some helper methods may examine different types of objects. Depending upon how the object is represented, the same object may be examined differently. If the object is specified as an MObject, then all of its attributes are examined. If the MObject is a hierarchical object (such as a dag node) and you specify that the objects parents should be examined, then all the parents of an instanced object will be examined. If the object is specified as an MDagPath, then all of its attributes are examined. If you specify that the objects parents should be examined, then only the specified path of the instanced object will be examined. If the object is specifed as an MPlug and no attribute has been set, then the method will behave as if it was called with an MObject. Otherwise only the specified attribute will be examined. For example, a compound attribute will not have its child attributes examined (i.e. if you specify node.translate, node.translateX will not be examined). If the object is specified through an MSelectionList, it can also have multiple representations. If the object was added to the MSelectionList as an MObject, then it will be examined as an MObject. If the object was added to the MSelectionList as an MDagPath, then it will be examined as an MDagPath. If the object was added to the MSelectionList as either a component or an MPlug, it will be examined as an MPlug with additional expansion of compound attributes into their child attributes (for example, if specify node.translate is specified, node.translateX will be examined. More importantly, if you specify poly.f[4] then xValue, yValue and zValue will be examined for each vertex). Below is a summary of how the same object will be examined by MAnimUtil::isAnimated depending upon how it has been represented. If we have the following hierarchical layout: The MAnimUtil::isAnimated will respond as follows: isAnimated ( MObject(pTorus1), false ) => false isAnimated ( MObject(pTorus1), true ) => true isAnimated ( MDagPath(group2|pTorus1), false ) => false isAnimated ( MDagPath(group2|pTorus1), true ) => false isAnimated ( MPlug(pTorus1), false ) => false isAnimated ( MPlug(pTorus1), true ) => true isAnimated ( MPlug(group1.translate) ) => false isAnimated ( MPlug(group1.translateX) ) => true isAnimated ( MPlug(pTorusShape1.pnts[4]) ) => false isAnimated ( MPlug(pTorusShape1.pnts[4].xValue) ) => true The following list assumes that MAnimUtil is called with an MSelectionList named list, and shows the response depending upon how the object has been added to list: isAnimated ( list.add(MObject(pTorus1)), false ) => false isAnimated ( list.add(MObject(pTorus1)), true ) => true isAnimated ( list.add(MDagPath(group2|pTorus1)), false ) => false isAnimated ( list.add(MDagPath(group2|pTorus1)), true ) => false isAnimated ( list.add(MPlug(pTorus1)), false ) => false isAnimated ( list.add(MPlug(pTorus1)), true ) => true isAnimated ( list.add(MPlug(group1.translate)) ) => true isAnimated ( list.add(MPlug(group1.translateX) ) => true isAnimated ( list.add(MPlug(pTorusShape1.pnts[4])) ) => true isAnimated ( list.add(MPlug(pTorusShape1.pnts[4].xValue)) ) => true */ class OPENMAYAANIM_EXPORT MAnimUtil { public: static bool isAnimated( const MObject &node, bool checkParent = false, MStatus * ReturnStatus = NULL ); static bool isAnimated( const MDagPath &path, bool checkParent = false, MStatus * ReturnStatus = NULL ); static bool isAnimated( const MPlug &plug, bool checkParent = false, MStatus * ReturnStatus = NULL ); static bool isAnimated( const MSelectionList &selectionList, bool checkParent = false, MStatus * ReturnStatus = NULL ); static bool findAnimatedPlugs( const MObject &node, MPlugArray &animatedPlugs, bool checkParent = false, MStatus * ReturnStatus = NULL ); static bool findAnimatedPlugs( const MDagPath &path, MPlugArray &animatedPlugs, bool checkParent = false, MStatus * ReturnStatus = NULL ); static bool findAnimatedPlugs( const MSelectionList &selectionList, MPlugArray &animatedPlugs, bool checkParent = false, MStatus * ReturnStatus = NULL ); static bool findAnimation( const MPlug &plug, MObjectArray &animation, MStatus * ReturnStatus = NULL ); static bool findSetDrivenKeyAnimation( const MPlug &plug, MObjectArray &animation, MPlugArray &drivers, MStatus * ReturnStatus = NULL ); static bool findConstraint( const MPlug &plug, MObject &constraint, MObjectArray& targets, MStatus * ReturnStatus = NULL ); static bool findAnimatablePlugs( const MSelectionList &selectionList, MPlugArray &animatablePlugs); static bool findAnimationLayers( const MPlug &plug, MObjectArray& layers, MPlugArray &plugs, MStatus * ReturnStatus = NULL ); static const char* className(); private: ~MAnimUtil(); #ifdef __GNUC__ friend class shutUpAboutPrivateDestructors; #endif }; #endif /* __cplusplus */ #endif /* _MAnimUtil */