RmUndo.h

//=============================================================================
// filename: RmUndo.h                                                          
//                                                                             
//           ATI Research, Inc.                                                
//           3D Application Research Group                                     
//                                                                             
// Description: RenderMonkey's Undo Definition                                 
//                                                                             
//=============================================================================
//   (C) 2004 ATI Research, Inc.  All rights reserved.                         
//=============================================================================

#ifndef _RM_CORE_UNDO_H_
#define _RM_CORE_UNDO_H_

#include <Core/RmTypes.h>
#include <Core/RmDefines.h>
#include <Core/RmEffect.h>


//=============================================================================
//
// Type def's
//
//=============================================================================

class RmUndoOp;

typedef RmLinkedList<RmUndoOp*>          RmUndoOpList;
typedef RmUndoOpList::iterator           RmUndoOpListIterator;
typedef RmUndoOpList::const_iterator     RmUndoOpListConstIterator;

//=============================================================================
//=============================================================================
class RM_API RmUndoOp
{
public :
   //--------------------------------------------------------------------------
   //--------------------------------------------------------------------------
   RmUndoOp( const RM_TCHAR *strOpName );

   //--------------------------------------------------------------------------
   //--------------------------------------------------------------------------
   virtual ~RmUndoOp();
   
   //--------------------------------------------------------------------------
   //--------------------------------------------------------------------------
   RmStringT  GetOpName() const { return m_strOpName; };

   //--------------------------------------------------------------------------
   //--------------------------------------------------------------------------
   virtual void ExecuteUndo();

   //--------------------------------------------------------------------------
   //--------------------------------------------------------------------------
   virtual void ExecuteRedo();

   bool IsUndone() const { return m_isUndone; };

   //--------------------------------------------------------------------------
   //--------------------------------------------------------------------------
   void AddChild( RmUndoOp *pUndoOp );

   //--------------------------------------------------------------------------
   //--------------------------------------------------------------------------
   void RemoveChild( RmUndoOp *pUndoOp );

   //--------------------------------------------------------------------------
   //--------------------------------------------------------------------------
   void RemoveAllChildren();

   //--------------------------------------------------------------------------
   //--------------------------------------------------------------------------
   RmUndoOpListIterator      BeginChild() { return m_childList.begin(); };

   //--------------------------------------------------------------------------
   //--------------------------------------------------------------------------
   RmUndoOpListConstIterator BeginChild() const { return m_childList.begin(); };

   //--------------------------------------------------------------------------
   //--------------------------------------------------------------------------
   RmUndoOpListIterator      EndChild() { return m_childList.end(); };

   //--------------------------------------------------------------------------
   //--------------------------------------------------------------------------
   RmUndoOpListConstIterator EndChild() const { return m_childList.end(); };

   //--------------------------------------------------------------------------
   //--------------------------------------------------------------------------
   int GetNumChildren() const { return m_childList.size(); };

protected :
   //--------------------------------------------------------------------------
   //--------------------------------------------------------------------------
   virtual void Undo();

   //--------------------------------------------------------------------------
   //--------------------------------------------------------------------------
   virtual void Redo();

   //--------------------------------------------------------------------------
   //--------------------------------------------------------------------------
   void UndoChildren();

   //--------------------------------------------------------------------------
   //--------------------------------------------------------------------------
   void RedoChildren();

protected:
   RmUndoOpList  m_childList; 
   bool          m_isUndone;  
   RmStringT     m_strOpName; 
}; // End of RmUndoOp



//=============================================================================
//=============================================================================
class RM_API RmDeleteNodeUndoOp : public RmUndoOp
{
public :
   //--------------------------------------------------------------------------
   //--------------------------------------------------------------------------
   RmDeleteNodeUndoOp( RmNode *pNode, RmNode* pNextSibling );

   //--------------------------------------------------------------------------
   //--------------------------------------------------------------------------
   RmDeleteNodeUndoOp( RmNode *pNode, RmNode* pNextSibling, const RM_TCHAR* strOpName );

   //--------------------------------------------------------------------------
   //--------------------------------------------------------------------------
   virtual ~RmDeleteNodeUndoOp();

protected :
   //--------------------------------------------------------------------------
   //--------------------------------------------------------------------------
   virtual void Undo();

   //--------------------------------------------------------------------------
   //--------------------------------------------------------------------------
   virtual void Redo();

private :
   RmNodeID  m_parentID;        
   RmNodeID  m_nodeID;          
   RmNodeID  m_nextSiblingID;   
   RmNode   *m_pClonedNode;     
}; // End of RmDeleteNodeUndoOp


//=============================================================================
//=============================================================================
class RM_API RmAddNodeUndoOp : public RmUndoOp
{
public :
   //--------------------------------------------------------------------------
   //--------------------------------------------------------------------------
   RmAddNodeUndoOp( RmNode *pNode, RmNode *pNextSibling = NULL );

   //--------------------------------------------------------------------------
   //--------------------------------------------------------------------------
   RmAddNodeUndoOp( RmNode *pNode, const RM_TCHAR* strOpName, RmNode *pNextSibling = NULL);

   //--------------------------------------------------------------------------
   //--------------------------------------------------------------------------
   virtual ~RmAddNodeUndoOp();

protected :
   //--------------------------------------------------------------------------
   //--------------------------------------------------------------------------
   virtual void Undo();

   //--------------------------------------------------------------------------
   //--------------------------------------------------------------------------
   virtual void Redo();

private :
   RmNodeID  m_parentID;        
   RmNodeID  m_nodeID;          
   RmNodeID  m_nextSiblingID;   
   RmNodeID  m_activeEffectID;  
   RmNode     *m_pClonedNode;   
}; // End of RmAddNodeUndoOp


//=============================================================================
//=============================================================================
class RM_API RmRenameNodeUndoOp : public RmUndoOp
{
public :
   //--------------------------------------------------------------------------
   //--------------------------------------------------------------------------
   RmRenameNodeUndoOp( RmNode *pNode, const RM_TCHAR *strNewName );
   
   //--------------------------------------------------------------------------
   //--------------------------------------------------------------------------
   RmRenameNodeUndoOp( RmNode *pNode, const RM_TCHAR *strNewName, const RM_TCHAR *strOpName );

   //--------------------------------------------------------------------------
   //--------------------------------------------------------------------------
   virtual ~RmRenameNodeUndoOp();

protected :
   //--------------------------------------------------------------------------
   //--------------------------------------------------------------------------
   virtual void Undo();

   //--------------------------------------------------------------------------
   //--------------------------------------------------------------------------
   virtual void Redo();

private :
   RmNodeID    m_nodeID;     
   RmStringT   m_strOldName; 
   RmStringT   m_strNewName; 
}; // End of RmRenameNodeUndoOp


//=============================================================================
//=============================================================================
class RM_API RmSemanticChangeUndoOp : public RmUndoOp
{
public :
   //--------------------------------------------------------------------------
   //--------------------------------------------------------------------------
   RmSemanticChangeUndoOp( RmVariable *pRmVariable, const RM_TCHAR *strNewSemantic );
   
   //--------------------------------------------------------------------------
   //--------------------------------------------------------------------------
   RmSemanticChangeUndoOp( RmVariable *pRmVariable, const RM_TCHAR *strNewSemantic, const RM_TCHAR *strOpName );

   //--------------------------------------------------------------------------
   //--------------------------------------------------------------------------
   virtual ~RmSemanticChangeUndoOp();

protected :
   //--------------------------------------------------------------------------
   //--------------------------------------------------------------------------
   virtual void Undo();

   //--------------------------------------------------------------------------
   //--------------------------------------------------------------------------
   virtual void Redo();

private :
   RmNodeID    m_nodeID;         
   RmStringT   m_strOldSemantic; 
   RmStringT   m_strNewSemantic; 
   
}; // End of RmSemanticChangeUndoOp

//=============================================================================
//=============================================================================
class RM_API RmModelOrientationChangeUndoOp : public RmUndoOp
{
public :
   //--------------------------------------------------------------------------
   //--------------------------------------------------------------------------
   RmModelOrientationChangeUndoOp(  RmModelData *pRmModelData,
                                    const RmModelOrientation newModelOrientation );
   
   //--------------------------------------------------------------------------
   //--------------------------------------------------------------------------
   RmModelOrientationChangeUndoOp(  RmModelData *pRmModelData,
                                    const RmModelOrientation newModelOrientation,
                                    const RM_TCHAR *strOpName );

   //--------------------------------------------------------------------------
   //--------------------------------------------------------------------------
   virtual ~RmModelOrientationChangeUndoOp();

protected :
   //--------------------------------------------------------------------------
   //--------------------------------------------------------------------------
   virtual void Undo();

   //--------------------------------------------------------------------------
   //--------------------------------------------------------------------------
   virtual void Redo();

private :
   RmNodeID             m_nodeID;               
   RmModelOrientation   m_oldModelOrientation;  
   RmModelOrientation   m_newModelOrientation;  
   
}; // End of RmModelOrientationChangeUndoOp


//=============================================================================
//=============================================================================
class RM_API RmTextureOriginChangeUndoOp : public RmUndoOp
{
public :
   //--------------------------------------------------------------------------
   //--------------------------------------------------------------------------
   RmTextureOriginChangeUndoOp(  RmTextureVariable *pRmTextureVariable,
                                 const RmTextureOrigin newTextureOrigin );
   
   //--------------------------------------------------------------------------
   //--------------------------------------------------------------------------
   RmTextureOriginChangeUndoOp(  RmTextureVariable *pRmTextureVariable,
                                 const RmTextureOrigin newTextureOrigin,
                                 const RM_TCHAR *strOpName );

   //--------------------------------------------------------------------------
   //--------------------------------------------------------------------------
   virtual ~RmTextureOriginChangeUndoOp();

protected :
   //--------------------------------------------------------------------------
   //--------------------------------------------------------------------------
   virtual void Undo();

   //--------------------------------------------------------------------------
   //--------------------------------------------------------------------------
   virtual void Redo();

private :
   RmNodeID          m_nodeID;            
   RmTextureOrigin   m_oldTextureOrigin;  
   RmTextureOrigin   m_newTextureOrigin;  
   
}; // End of RmTextureOriginChangeUndoOp


//=============================================================================
//=============================================================================
class RM_API RmUpdateNodeUndoOp : public RmUndoOp
{
public :
   //--------------------------------------------------------------------------
   //--------------------------------------------------------------------------
   RmUpdateNodeUndoOp( RmNode *pNode );

   //--------------------------------------------------------------------------
   //--------------------------------------------------------------------------
   RmUpdateNodeUndoOp( RmNode *pNode, const RM_TCHAR* strOpName );

   //--------------------------------------------------------------------------
   //--------------------------------------------------------------------------
   virtual ~RmUpdateNodeUndoOp();

protected :
   //--------------------------------------------------------------------------
   //--------------------------------------------------------------------------
   virtual void Undo();

   //--------------------------------------------------------------------------
   //--------------------------------------------------------------------------
   virtual void Redo();

private :
   RmNodeID    m_nodeID;         

   RmStringT   m_strOpName;      

   RmNode     *m_pClonedOldNode; 
   RmNode     *m_pClonedNewNode; 
}; // End of RmUpdateNodeUndoOp

//=============================================================================
//=============================================================================
class RM_API RmNodeValueChangeUndoOp : public RmUndoOp
{
public :
   //--------------------------------------------------------------------------
   //--------------------------------------------------------------------------
   RmNodeValueChangeUndoOp( RmNode *pNode );

   //--------------------------------------------------------------------------
   //--------------------------------------------------------------------------
   RmNodeValueChangeUndoOp( RmNode *pNode, const RM_TCHAR* strOpName );

   //--------------------------------------------------------------------------
   //--------------------------------------------------------------------------
   virtual ~RmNodeValueChangeUndoOp();

protected :
   //--------------------------------------------------------------------------
   //--------------------------------------------------------------------------
   virtual void Undo();

   //--------------------------------------------------------------------------
   //--------------------------------------------------------------------------
   virtual void Redo();

private :
   RmNodeID    m_nodeID;         

   RmStringT   m_strOpName;      

   RmNode     *m_pClonedOldNode; 
   RmNode     *m_pClonedNewNode; 
   
}; // End of RmNodeValueChangeUndoOp


//=============================================================================
//=============================================================================
class RM_API RmChangeActiveEffectUndoOp : public RmUndoOp
{
public :
   //--------------------------------------------------------------------------
   //--------------------------------------------------------------------------
   RmChangeActiveEffectUndoOp( RmEffect *pOldActiveEffect,
                               RmEffect *pNewActiveEffect );

   //--------------------------------------------------------------------------
   //--------------------------------------------------------------------------
   virtual ~RmChangeActiveEffectUndoOp();

protected :
   //--------------------------------------------------------------------------
   //--------------------------------------------------------------------------
   virtual void Undo();

   //--------------------------------------------------------------------------
   //--------------------------------------------------------------------------
   virtual void Redo();

private :
   bool      m_bSetOld;            
   bool      m_bSetNew;            
   RmNodeID  m_oldActiveEffectID;  
   RmNodeID  m_newActiveEffectID;  
}; // End of RmChangeActiveEffectUndoOp

//=============================================================================
//=============================================================================
class RM_API RmBeginMessageBlockUndoOp : public RmUndoOp
{
public :
   //--------------------------------------------------------------------------
   //--------------------------------------------------------------------------
   RmBeginMessageBlockUndoOp() : RmUndoOp( _T( "Begin Message Block Undo Op" ) ) {}

   //--------------------------------------------------------------------------
   //--------------------------------------------------------------------------
   virtual ~RmBeginMessageBlockUndoOp() {}

protected :
   //--------------------------------------------------------------------------
   //--------------------------------------------------------------------------
   virtual void Undo() { getRmApp()->EndMessageBlock(); }

   //--------------------------------------------------------------------------
   //--------------------------------------------------------------------------
   virtual void Redo() { getRmApp()->BeginMessageBlock(); }

}; // End of RmBeginMessageBlockUndoOp

//=============================================================================
//=============================================================================
class RM_API RmEndMessageBlockUndoOp : public RmUndoOp
{
public :
   //--------------------------------------------------------------------------
   //--------------------------------------------------------------------------
   RmEndMessageBlockUndoOp() : RmUndoOp( _T( "End Message Block Undo Op" ) ) {}

   //--------------------------------------------------------------------------
   //--------------------------------------------------------------------------
   virtual ~RmEndMessageBlockUndoOp() {}

protected :
   //--------------------------------------------------------------------------
   //--------------------------------------------------------------------------
   virtual void Undo() { getRmApp()->BeginMessageBlock(); }

   //--------------------------------------------------------------------------
   //--------------------------------------------------------------------------
   virtual void Redo() { getRmApp()->EndMessageBlock(); }

}; // End of RmEndMessageBlockUndoOp

#endif

---