summaryrefslogtreecommitdiff
path: root/tools/vcdblock/vcdblocktool.h
blob: f3a38d2ed3b502d04eb2a102c4cba52b56510fe1 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
//========= Copyright Valve Corporation, All rights reserved. ============//
//
// Purpose: VcdBlock tool; main UI smarts class
//
//=============================================================================

#ifndef VCDBLOCKTOOL_H
#define VCDBLOCKTOOL_H

#ifdef _WIN32
#pragma once
#endif

#include "tier0/platform.h"
#include "toolutils/basetoolsystem.h"
#include "toolutils/recentfilelist.h"
#include "toolutils/toolmenubar.h"
#include "toolutils/toolswitchmenubutton.h"
#include "toolutils/tooleditmenubutton.h"
#include "toolutils/toolfilemenubutton.h"
#include "toolutils/toolmenubutton.h"
#include "datamodel/dmelement.h"
#include "dmevmfentity.h"
#include "toolframework/ienginetool.h"
#include "toolutils/enginetools_int.h"
#include "toolutils/savewindowpositions.h"
#include "toolutils/toolwindowfactory.h"


//-----------------------------------------------------------------------------
// Forward declarations
//-----------------------------------------------------------------------------
class CDmElement;
class CVcdBlockDoc;
class CInfoTargetPropertiesPanel;
class CInfoTargetBrowserPanel;

namespace vgui
{
	class Panel;
}


//-----------------------------------------------------------------------------
// Allows the doc to call back into the VcdBlock editor tool
//-----------------------------------------------------------------------------
abstract_class IVcdBlockDocCallback
{
public:
	// Called by the doc when the data changes
	virtual void OnDocChanged( const char *pReason, int nNotifySource, int nNotifyFlags ) = 0;
};


//-----------------------------------------------------------------------------
// Global methods of the VCD Blocking tool
//-----------------------------------------------------------------------------
abstract_class IVcdBlockTool
{
public:
	// Gets at the rool panel (for modal dialogs)
	virtual vgui::Panel *GetRootPanel() = 0;

	// Gets the registry name (for saving settings)
	virtual const char *GetRegistryName() = 0;

	// Shows a particular entity in the entity properties dialog
	virtual void ShowEntityInEntityProperties( CDmeVMFEntity *pEntity ) = 0;
};

//-----------------------------------------------------------------------------
// Implementation of the VcdBlock tool
//-----------------------------------------------------------------------------
class CVcdBlockTool : public CBaseToolSystem, public IFileMenuCallbacks, public IVcdBlockDocCallback, public IVcdBlockTool
{
	DECLARE_CLASS_SIMPLE( CVcdBlockTool, CBaseToolSystem );

public:
	CVcdBlockTool();

	// Inherited from IToolSystem
	virtual const char *GetToolName() { return "VCD Blocking Tool"; }
	virtual bool	Init( );
	virtual void	Shutdown();
	virtual bool	CanQuit();
	virtual void	OnToolActivate();
	virtual void	OnToolDeactivate();
	virtual void	ServerLevelInitPostEntity();
	virtual void	DrawEntitiesInEngine( bool bDrawInEngine );
	virtual void	ClientLevelInitPostEntity();
	virtual void	ClientLevelShutdownPreEntity();
	virtual bool	TrapKey( ButtonCode_t key, bool down );
 	virtual void	ClientPreRender();

	// Inherited from IFileMenuCallbacks
	virtual int		GetFileMenuItemsEnabled( );
	virtual void	AddRecentFilesToMenu( vgui::Menu *menu );
	virtual bool	GetPerforceFileName( char *pFileName, int nMaxLen );

	// Inherited from IVcdBlockDocCallback
	virtual void	OnDocChanged( const char *pReason, int nNotifySource, int nNotifyFlags );
	virtual vgui::Panel *GetRootPanel() { return this; }
	virtual void ShowEntityInEntityProperties( CDmeVMFEntity *pEntity );

	// Inherited from CBaseToolSystem
	virtual vgui::HScheme GetToolScheme();
	virtual vgui::Menu *CreateActionMenu( vgui::Panel *pParent );
	virtual void OnCommand( const char *cmd );
	virtual const char *GetRegistryName() { return "VcdBlockTool"; }
	virtual const char *GetBindingsContextFile() { return "cfg/VcdBlock.kb"; }
	virtual vgui::MenuBar *CreateMenuBar( CBaseToolSystem *pParent );

	MESSAGE_FUNC( Save, "OnSave" );
	void SaveAndTest();
	void RestartMap();

	// Enter mode where we preview dropping nodes
	void EnterTargetDropMode();
	void LeaveTargetDropMode();

	bool IsMiniViewportCursor( int x, int y, Vector &org, Vector &forward );

	// Save/Load game state
	void SetRememberPlayerPosition( bool state = true ) { m_bRememberPlayerPosition = state; };
	bool GetRememberPlayerPosition( void ) { return m_bRememberPlayerPosition; };
	void QuickLoad();
	void QuickSave();
	
	bool IsInNodeDrag( void ) { return m_bInNodeDragMode; };

public:
	MESSAGE_FUNC( OnRestartLevel, "RestartLevel" );
	MESSAGE_FUNC( OnNew, "OnNew" );
	MESSAGE_FUNC( OnOpen, "OnOpen" );
	MESSAGE_FUNC( OnSaveAs, "OnSaveAs" );
	MESSAGE_FUNC( OnClose, "OnClose" );
	MESSAGE_FUNC( OnCloseNoSave, "OnCloseNoSave" );
	MESSAGE_FUNC( OnMarkNotDirty, "OnMarkNotDirty" );
	MESSAGE_FUNC( OnExit, "OnExit" );

	// Commands related to the edit menu
	void		OnDescribeUndo();

	// Methods related to the VcdBlock menu
	MESSAGE_FUNC( OnAddNewNodes, "AddNewNodes" );
	MESSAGE_FUNC( OnCopyEditsToVMF, "CopyEditsToVMF" );
	MESSAGE_FUNC( OnRememberPosition, "RememberPosition" );

	// Methods related to the view menu
	MESSAGE_FUNC( OnToggleProperties, "OnToggleProperties" );
	MESSAGE_FUNC( OnToggleEntityReport, "OnToggleEntityReport" );
	MESSAGE_FUNC( OnDefaultLayout, "OnDefaultLayout" );

	// Keybindings
	KEYBINDING_FUNC( undo, KEY_Z, vgui::MODIFIER_CONTROL, OnUndo, "#undo_help", 0 );
	KEYBINDING_FUNC( redo, KEY_Z, vgui::MODIFIER_CONTROL | vgui::MODIFIER_SHIFT, OnRedo, "#redo_help", 0 );
	KEYBINDING_FUNC_NODECLARE( VcdBlockAddNewNodes, KEY_A, vgui::MODIFIER_CONTROL, OnAddNewNodes, "#VcdBlockAddNewNodesHelp", 0 );

	void		OpenFileFromHistory( int slot );
	void		OpenSpecificFile( const char *pFileName );
	virtual void SetupFileOpenDialog( vgui::FileOpenDialog *pDialog, bool bOpenFile, const char *pFileFormat, KeyValues *pContextKeyValues );
	virtual bool OnReadFileFromDisk( const char *pFileName, const char *pFileFormat, KeyValues *pContextKeyValues );
	virtual bool OnWriteFileToDisk( const char *pFileName, const char *pFileFormat, KeyValues *pContextKeyValues );
	virtual void OnFileOperationCompleted( const char *pFileType, bool bWroteFile, vgui::FileOpenStateMachine::CompletionState_t state, KeyValues *pContextKeyValues );

	void AttachAllEngineEntities();

	// returns the document
	CVcdBlockDoc *GetDocument();

	// Gets at tool windows
	CInfoTargetPropertiesPanel *GetProperties();
	CInfoTargetBrowserPanel *GetInfoTargetBrowser();

	CDmeHandle< CDmeVMFEntity > GetCurrentEntity( void ) { return m_hCurrentEntity; }

private:
	// Loads up a new document
	bool LoadDocument( const char *pDocName );

	// Updates the menu bar based on the current file
	void UpdateMenuBar( );

	// Shows element properties
	void ShowElementProperties( );

	virtual const char *GetLogoTextureName();

	// Creates, destroys tools
	void CreateTools( CVcdBlockDoc *doc );
	void DestroyTools();

	// Initializes the tools
	void InitTools();

	// Shows, toggles tool windows
	void ToggleToolWindow( Panel *tool, char const *toolName );
	void ShowToolWindow( Panel *tool, char const *toolName, bool visible );

	// Kills all tool windows
	void DestroyToolContainers();

	// Gets the position of the preview object
	void GetPlacementInfo( Vector &vecOrigin, QAngle &angles );
	
private:
	// Document
	CVcdBlockDoc *m_pDoc;

	// The menu bar
	CToolFileMenuBar *m_pMenuBar;

	// Element properties for editing material
	vgui::DHANDLE< CInfoTargetPropertiesPanel >	m_hProperties;

	// The entity report
	vgui::DHANDLE< CInfoTargetBrowserPanel > m_hInfoTargetBrowser;

	// The currently viewed entity
	CDmeHandle< CDmeVMFEntity > m_hCurrentEntity;

	// Separate undo context for the act busy tool
	bool m_bInNodeDropMode;
	bool m_bInNodeDragMode;
	int m_iDragX;
	int m_iDragY;
	CDmeHandle< CDmeVMFEntity > m_hPreviewTarget;
	CToolWindowFactory< ToolWindow > m_ToolWindowFactory;

	// remembered player position
	bool m_bRememberPlayerPosition;
	bool m_bHasPlayerPosition;
	Vector m_vecPlayerOrigin;
	QAngle m_vecPlayerAngles;
};

extern CVcdBlockTool *g_pVcdBlockTool;

#endif // VCDBLOCKTOOL_H