107 lines
3.1 KiB
C++
Executable File
107 lines
3.1 KiB
C++
Executable File
|
|
#ifndef _MMessage
|
|
#define _MMessage
|
|
//
|
|
// *****************************************************************************
|
|
//
|
|
// Copyright (C) 1998-2003 Alias|Wavefront Inc.
|
|
//
|
|
// These coded instructions, statements and computer programs contain
|
|
// unpublished information proprietary to Alias|Wavefront Inc. and are
|
|
// protected by Canadian and US federal copyright laws. They may not be
|
|
// disclosed to third parties or copied or duplicated, in whole or in part,
|
|
// without prior written consent of Alias|Wavefront Inc.
|
|
//
|
|
// Unpublished-rights reserved under the Copyright Laws of the United States.
|
|
//
|
|
// *****************************************************************************
|
|
//
|
|
// CLASS: MMessage
|
|
//
|
|
// *****************************************************************************
|
|
//
|
|
// CLASS DESCRIPTION (MMessage)
|
|
//
|
|
// This is the base class for message callbacks.
|
|
//
|
|
// There are three types of messages in maya that are exposed through the
|
|
// API and they are the following:
|
|
// scene messages, dependency graph messages, and dependency node messages.
|
|
// can be registered for these messages using the addCallback
|
|
// methods of the MSceneMessage, MDGMessage, and MNodeMessage classes.
|
|
//
|
|
// When a callback is added a number or id is returned. This id is used to
|
|
// keep track of the callback and is necessary for removing it.
|
|
// A callback id with the value 'NULL' represents an invalid callback.
|
|
// Use the removeCallback member function of this class for removing a
|
|
// callback.
|
|
//
|
|
// It is the user's responsibility to keep track of the callback id's
|
|
// and remove all callbacks for a plug-in when it is unloaded.
|
|
//
|
|
// *****************************************************************************
|
|
|
|
#if defined __cplusplus
|
|
|
|
// *****************************************************************************
|
|
|
|
// INCLUDED HEADER FILES
|
|
|
|
|
|
#include <maya/MStatus.h>
|
|
|
|
// *****************************************************************************
|
|
|
|
// DECLARATIONS
|
|
|
|
typedef unsigned int MCallbackId;
|
|
|
|
// Declaration for the callback table
|
|
typedef struct MMessageNode {
|
|
void* fClientPtr;
|
|
void* fServerPtr;
|
|
void* fSubClientPtr;
|
|
MCallbackId fId;
|
|
bool isValid;
|
|
} * MMessageNodePtr;
|
|
|
|
// *****************************************************************************
|
|
|
|
// CLASS DECLARATION (MMessage)
|
|
|
|
class MIntArray;
|
|
|
|
/// Message base class
|
|
/**
|
|
*/
|
|
#ifdef _WIN32
|
|
#pragma warning(disable: 4522)
|
|
#endif // _WIN32
|
|
|
|
class OPENMAYA_EXPORT MMessage
|
|
{
|
|
public:
|
|
///
|
|
static MStatus removeCallback( MCallbackId id );
|
|
///
|
|
static MStatus removeCallbacks( MIntArray &ids );
|
|
|
|
protected:
|
|
static void addNode( MMessageNodePtr node );
|
|
static void removeNode( MMessageNodePtr node );
|
|
|
|
private:
|
|
static const char* className();
|
|
static MMessageNodePtr findNode( MCallbackId id );
|
|
|
|
};
|
|
|
|
#ifdef _WIN32
|
|
#pragma warning(default: 4522)
|
|
#endif // _WIN32
|
|
|
|
// *****************************************************************************
|
|
|
|
#endif /* __cplusplus */
|
|
#endif /* _MMessage */
|