tge/lib/mayasdk6/include/maya/MAnimCurveChange.h
2025-02-17 23:17:30 -06:00

101 lines
3.0 KiB
C++
Executable File

#ifndef _MAnimCurveChange
#define _MAnimCurveChange
//
//-
// ==========================================================================
// Copyright (C) Alias Systems, a division of Silicon Graphics Limited.
// All rights reserved. These coded instructions, statements and computer
// programs contain unpublished information proprietary to Alias Systems,
// a division of Silicon Graphics Limited, which is protected by the
// Canadian and US federal copyright law and may not be disclosed to third
// parties or copied or duplicated, in whole or in part, without prior
// written consent of Alias Systems, a division of Silicon Graphics Limited
// ==========================================================================
//+
//
// CLASS: MAnimCurveChange
//
// *****************************************************************************
//
// CLASS DESCRIPTION (MAnimCurveChange)
//
// Anim Curve Change caches are used as persistent storage for information
// concerning changes to Anim Curve Nodes.
//
// When invoked with a valid Anim Curve change parameter, the remove keyframe
// and add keyframe methods of the Anim Curve Function Set
// (MFnAnimCurve::remove() and MFnAnimCurve::addKeyframe(), respectively)
// cache the change information in the Anim Curve Change cache so that the
// caller can undo and redo the changes as required.
//
// Caching of the undo and redo information in a Anim Curve Change cache is
// required primarily to support interactive editing of Anim Curves in the UI.
//
// Use Anim Curve Change caches in conjunction with the Anim Curve Function
// Set (MFnAnimCurve) to perform undoable and redoable edits on Anim Curves.
//
// *****************************************************************************
#if defined __cplusplus
// *****************************************************************************
// INCLUDED HEADER FILES
#include <maya/MStatus.h>
#include <maya/MTypes.h>
// *****************************************************************************
// DECLARATIONS
// *****************************************************************************
// CLASS DECLARATION (MAnimCurveChange)
/// Anim Curve Change Cache (OpenMayaAnim)
/**
Create Anim Curve change caches.
Undo Anim Curve changes which have been cached.
Redo Anim Curve changes which were previously undone.
*/
#ifdef _WIN32
#pragma warning(disable: 4522)
#endif // _WIN32
class OPENMAYAANIM_EXPORT MAnimCurveChange
{
public:
///
MAnimCurveChange( MStatus * ReturnStatus = NULL );
///
~MAnimCurveChange();
///
MStatus undoIt();
///
MStatus redoIt();
protected:
// No protected members
private:
static const char* className();
void* data;
};
#ifdef _WIN32
#pragma warning(default: 4522)
#endif // _WIN32
// *****************************************************************************
#endif /* __cplusplus */
#endif /* _MAnimCurveChange */