#ifndef _MConditionMessage #define _MConditionMessage // //- // ========================================================================== // 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: MConditionMessage // // ***************************************************************************** // // CLASS DESCRIPTION (MConditionMessage) // // This class is used to register callbacks for changes to specific // conditions and/or to determine the current state of a condition. // // The addConditionCallback method allows callbacks to be registered // for the following messages: // Condition Changed // // The first parameter passed to the add callback method is the // name of the condition that will trigger the callback. The names of // available conditions can be retrieved with the getConditionNames // method. // // Callbacks that are registered for conditions will be passed an // bool parameter that is the state of the condition. // // 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. // // The getConditionState method is used to return the current status // of the specified condition. // // ***************************************************************************** #if defined __cplusplus // ***************************************************************************** // INCLUDED HEADER FILES #include #include #include // ***************************************************************************** // DECLARATIONS // ***************************************************************************** // CLASS DECLARATION (MConditionMessage) /// Condition change messages. (OpenMaya) (OpenMaya.py) /** */ #ifdef _WIN32 #pragma warning(disable: 4522) #endif // _WIN32 class OPENMAYA_EXPORT MConditionMessage : public MMessage { public: /// static MCallbackId addConditionCallback( const MString& conditionName, MMessage::MStateFunction func, void * clientData = NULL, MStatus * ReturnStatus = NULL ); /// static MStatus getConditionNames( MStringArray & names ); /// static bool getConditionState( const MString& name, MStatus * ReturnStatus = NULL ); private: static const char* className(); }; #ifdef _WIN32 #pragma warning(default: 4522) #endif // _WIN32 // ***************************************************************************** #endif /* __cplusplus */ #endif /* _MConditionMessage */