tge/lib/mayasdk6/include/maya/MAnimMessage.h
2017-04-17 06:17:10 -06:00

116 lines
3.8 KiB
C++
Executable File

#ifndef _MAnimMessage
#define _MAnimMessage
//
//-
// ==========================================================================
// Copyright (C) 1995 - 2005 Alias Systems Corp. 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 Alias Systems Corp. ("Alias") and/or its
// licensors, which is protected by Canadian and US 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
// Alias.
//
// THE DATA IS PROVIDED "AS IS". ALIAS HEREBY DISCLAIMS ALL WARRANTIES RELATING
// TO THE DATA, INCLUDING, WITHOUT LIMITATION, ANY AND ALL EXPRESS OR IMPLIED
// WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY AND/OR FITNESS FOR A
// PARTICULAR PURPOSE. IN NO EVENT SHALL ALIAS BE LIABLE FOR ANY DAMAGES
// WHATSOEVER, WHETHER DIRECT, INDIRECT, SPECIAL, OR PUNITIVE, WHETHER IN AN
// ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, OR IN EQUITY,
// ARISING OUT OF ACCESS TO, USE OF, OR RELIANCE UPON THE DATA.
// ==========================================================================
//+
//
// CLASS: MAnimMessage
//
// *****************************************************************************
//
// CLASS DESCRIPTION (MAnimMessage)
//
// This class is used to register callbacks for animation messages.
// There is 3 add callback methods which will add callbacks for the
// following message
// Anim curve edited
// Anim curve keyframe edited.
//
// 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.
//
// *****************************************************************************
#if defined __cplusplus
// *****************************************************************************
// INCLUDED HEADER FILES
#include <maya/MMessage.h>
#include <maya/MString.h>
// *****************************************************************************
// DECLARATIONS
class MObjectArray;
// *****************************************************************************
// CLASS DECLARATION (MAnimMessage)
/// Animation messages (OpenMayaAnim)
/**
*/
#ifdef _WIN32
#pragma warning(disable: 4522)
#endif // _WIN32
class OPENMAYAANIM_EXPORT MAnimMessage : public MMessage
{
public:
/// AnimCurve edited callback
static MCallbackId addAnimCurveEditedCallback (
void (*func)(MObjectArray &editedCurves,
void *clientData),
void * clientData = NULL,
MStatus * ReturnStatus = NULL);
/// AnimCurve keyframe edited callback.
static MCallbackId addAnimKeyframeEditedCallback (
void (*func)(MObjectArray &editedKeys,
void *clientData),
void * clientData = NULL,
MStatus * ReturnStatus = NULL );
/// AnimCurve keyframe edited callback.
static MCallbackId addAnimKeyframeEditedCallback (
MObject &animNode,
void (*func)(MObject &animNode,
MObjectArray &editedKeys,
void *clientData),
void *clientData = NULL,
MStatus * ReturnStatus = NULL );
/// AnimCurve keyframe edited callback flush.
static void flushAnimKeyframeEditedCallbacks();
private:
static const char* className();
};
#ifdef _WIN32
#pragma warning(default: 4522)
#endif // _WIN32
// *****************************************************************************
#endif /* __cplusplus */
#endif /* _MAnimMessage */