dhewm3/neo/tools/materialeditor/MaterialView.h
dhewg 79ad905e05 Fix all whitespace errors
Excluding 3rd party files.
2011-12-10 15:35:54 +01:00

148 lines
4.9 KiB
C++

/*
===========================================================================
Doom 3 GPL Source Code
Copyright (C) 1999-2011 id Software LLC, a ZeniMax Media company.
This file is part of the Doom 3 GPL Source Code ("Doom 3 Source Code").
Doom 3 Source Code is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
Doom 3 Source Code is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with Doom 3 Source Code. If not, see <http://www.gnu.org/licenses/>.
In addition, the Doom 3 Source Code is also subject to certain additional terms. You should have received a copy of these additional terms immediately following the terms and conditions of the GNU General Public License which accompanied the Doom 3 Source Code. If not, please request a copy in writing from id Software at the address below.
If you have questions concerning this license or the applicable additional terms, you may contact in writing id Software LLC, c/o ZeniMax Media Inc., Suite 120, Rockville, Maryland 20850 USA.
===========================================================================
*/
#pragma once
#include "MaterialDocManager.h"
/**
* MaterialView Interface. Interface to be implemented by classes that want
* notifications of material changes. Classes that implement this interface
* must register themself with the MaterialDocManager class with the
* RegisterView method.
*/
class MaterialView {
public:
/**
* Constructor.
*/
MaterialView(void) { materialDocManager = NULL; };
/**
* Destructor.
*/
virtual ~MaterialView(void) {};
//////////////////////////////////////////////////////////////////////////
//Public Interface to be implemented by subclasses
//////////////////////////////////////////////////////////////////////////
/**
* Sets the material document manager for this view instance.
* @param docManager The material document manager for this view instance.
*/
virtual void SetMaterialDocManager(MaterialDocManager* docManager) { materialDocManager = docManager; };
/**
* Called when the selected material has changed.
* @param pMaterial The newly selected material.
*/
virtual void MV_OnMaterialSelectionChange(MaterialDoc* pMaterial) {};
/**
* Called when the material has changed but not applied.
* @param pMaterial The selected material.
*/
virtual void MV_OnMaterialChange(MaterialDoc* pMaterial) {};
/**
* Called when the material changes have been applied.
* @param pMaterial The selected material.
*/
virtual void MV_OnMaterialApply(MaterialDoc* pMaterial) {};
/**
* Called when the material changes have been saved.
* @param pMaterial The saved material.
*/
virtual void MV_OnMaterialSaved(MaterialDoc* pMaterial) {};
/**
* Called when a material file has been saved
* @param filename path of the file that was saved.
*/
virtual void MV_OnMaterialSaveFile(const char* filename) {};
/**
* Called when a material is added
* @param pMaterial The material that was added.
*/
virtual void MV_OnMaterialAdd(MaterialDoc* pMaterial) {};
/**
* Called when a material is deleted
* @param pMaterial The material that was deleted.
*/
virtual void MV_OnMaterialDelete(MaterialDoc* pMaterial) {};
/**
* Called when a stage is added
* @param pMaterial The material that was affected.
* @param stageNum The index of the stage that was added
*/
virtual void MV_OnMaterialStageAdd(MaterialDoc* pMaterial, int stageNum) {};
/**
* Called when a stage is deleted
* @param pMaterial The material that was affected.
* @param stageNum The index of the stage that was deleted
*/
virtual void MV_OnMaterialStageDelete(MaterialDoc* pMaterial, int stageNum) {};
/**
* Called when a stage is moved
* @param pMaterial The material that was deleted.
* @param from The from index
* @param to The to index
*/
virtual void MV_OnMaterialStageMove(MaterialDoc* pMaterial, int from, int to) {};
/**
* Called when an attribute is changed
* @param pMaterial The material that was deleted.
* @param stage The stage that contains the change.
* @param attribName The attribute that has changed.
*/
virtual void MV_OnMaterialAttributeChanged(MaterialDoc* pMaterial, int stage, const char* attribName) {};
/**
* Called when the material name has changed
* @param pMaterial The material that was deleted.
* @param oldName The old name of the material.
*/
virtual void MV_OnMaterialNameChanged(MaterialDoc* pMaterial, const char* oldName) {};
/**
* Called when a file has been reloaded
* @param filename The file that was reloaded.
*/
virtual void MV_OnFileReload(const char* filename) {};
protected:
MaterialDocManager* materialDocManager;
};