gzWindow Class Reference

#include <gzWindow.h>

Inheritance diagram for gzWindow:

List of all members.

Public Member Functions
	GZ_DECLARE_TYPE_INTERFACE_EXPORT (1)
	gzWindow (const gzString &name="Gizmo3D", gzWindowHandle parent=NULL, gzGraphicsFormat *format=NULL, gzBool activateWindow=TRUE)
	Gizmo3D STD window.
	gzWindow (const gzString &name, gzWindowContext parent, gzDeviceContext dc, gzGraphicsFormat *format=NULL, gzBool activateWindow=TRUE)
	subwindow creation
virtual	~gzWindow ()
gzWindowHandle	getHandle ()
	Get the HWND on Win32 systems or Widget on X11 systems.
gzWindowContext	getWinContext ()
	Get the HWND on Win32 systems or Window on X11 systems.
gzBool	hasActiveContext ()
gzULongXY	getSize ()
gzULongXY	getPosition ()
gzLongXY	getMousePosition ()
gzLongXY	getCenterMousePosition ()
const gzGraphicsFormat *	getFormat ()
gzVoid	setSize (gzULong width, gzULong height)
gzVoid	setPosition (gzULong x, gzULong y)
gzVoid	show ()
gzVoid	hide ()
gzVoid	doQuitOnClose (gzBool quit)
gzVoid	useInputProvider (gzBool on)
gzVoid	deleteContext ()
virtual gzBool	refreshWindow ()
gzVoid	setRefreshRate (gzFloat rate)
gzVoid	setSwapInterval (gzInt interval)
gzVoid	setCaptureMouse (gzBool on)
gzVoid	setHideMouse (gzBool on)
gzVoid	setEnableSwap (gzBool on)
gzVoid	showDynamicLoadProgress (gzBool on)
	GZ_PROPERTY_EXPORT (gzBool, IncludeSwapInDraw, 1)
	True if swap time is included in draw time.
virtual gzVoid	onCommand (int wmId, int wmEvent)
virtual gzBool	onKey (gzKeyValue key, gzKeyState keystate, gzLong mouse_x, gzLong mouse_y)
virtual gzVoid	onMouseMove (gzLong mouse_x, gzLong mouse_y)
virtual gzVoid	onMouseWheel (gzLong delta, gzLong mouse_x, gzLong mouse_y)
virtual gzVoid	onShow ()
virtual gzVoid	onHide ()
virtual gzVoid	onSize (gzULong width, gzULong height)
virtual gzVoid	onPosition (gzULong width, gzULong height)
gzVoid	setFocus ()
virtual gzVoid	onFocus ()
virtual gzVoid	onLostFocus ()
virtual gzVoid	onClose ()
virtual gzBool	onMouseCursor ()
virtual gzBool	quitOnClose ()
virtual gzVoid	onNotify (gzNotifyManager *master, gzRefPointer< gzNotifyMessage > &data, gzULong senderClass)
gzVoid	setExternalSwapEvent (gzEvent *swapEvent)
gzVoid	setExternalRenderEvent (gzEvent *renderEvent)
gzRefPointer< gzEvent >	getExternalSwapEvent ()
gzRefPointer< gzEvent >	getExternalRenderEvent ()
gzVoid	setMaxSwapWaitTime (gzDouble seconds)
gzVoid	setMaxRenderWaitTime (gzDouble seconds)
gzWindowContext	getWindowContext ()
gzRenderContext	getRenderContext ()
gzDeviceContext	getDeviceContext ()
Static Public Member Functions
static gzWindow *	getWindow (gzWindowHandle handle=0, gzWindowContext=0)
static gzWindow *	getWindow (const gzString &name)
static gzWindow *	createDefaultWindow (const gzString &name="Gizmo3D", gzWindowHandle parent=NULL, gzGraphicsFormat *format=NULL, gzBool activateWindow=TRUE)
static gzWindowCreator	setDefaultWindowCreator (gzWindowCreator creator)
Protected Attributes
gzLongXY	m_mouse
gzULong	m_hasCapture
gzULong	m_hideMouse
gzTimerHandle	m_timer
gzWindowHandle	m_handle
gzWindowHandle	m_parent
gzInt	m_swapInterval
gzWindowContext	m_winContext
gzRenderContext	m_renderContext
gzDeviceContext	m_deviceContext
gzULong	m_screen_width
gzULongXY	m_size
gzULongXY	m_position
gzRefPointer< gzGraphicsFormat >	m_format
gzBool	m_doOutput:1
gzBool	m_doQuitOnClose:1
gzBool	m_enableSwap:1
gzBool	m_createdParentHandle:1
gzBool	m_createdHandle:1
gzBool	m_createdWinContext:1
gzBool	m_isInputProvider:1
gzBool	m_showDynamicLoadProgress:1
gzBool	m_inRefresh:1
gzRefPointer< gzEvent >	m_externalRenderEvent
gzRefPointer< gzEvent >	m_externalSwapEvent
gzDouble	m_maxRenderWaitTime
gzDouble	m_maxSwapWaitTime
Static Protected Attributes
static gzList< gzWindow >	s_windowList
static gzWindowCreator	s_defaultCreator
Friends
class	gzImageRender

---

Detailed Description

Examples:

billboard.cpp, cube.cpp, dbviewer.cpp, lod.cpp, materialDemo.cpp, mirror.cpp, node.cpp, shaders.cpp, showWindow.cpp, skybox.cpp, and tree.cpp.

Definition at line 62 of file gzWindow.h.

---

Constructor & Destructor Documentation

gzWindow::gzWindow (  const gzString &  name = "Gizmo3D", gzWindowHandle  parent = NULL, gzGraphicsFormat *  format = NULL, gzBool  activateWindow = TRUE )

Gizmo3D STD window. Examples: mirror.cpp, and skybox.cpp.

gzWindow::gzWindow (  const gzString &  name, gzWindowContext  parent, gzDeviceContext  dc, gzGraphicsFormat *  format = NULL, gzBool  activateWindow = TRUE )

subwindow creation

virtual gzWindow::~gzWindow (   )  [virtual]

---

Member Function Documentation

static gzWindow* gzWindow::createDefaultWindow (  const gzString &  name = "Gizmo3D", gzWindowHandle  parent = NULL, gzGraphicsFormat *  format = NULL, gzBool  activateWindow = TRUE )  [static]

gzVoid gzWindow::deleteContext (   )

gzVoid gzWindow::doQuitOnClose (  gzBool  quit  )

gzLongXY gzWindow::getCenterMousePosition (   )

gzDeviceContext gzWindow::getDeviceContext (   )

gzRefPointer<gzEvent> gzWindow::getExternalRenderEvent (   )

gzRefPointer<gzEvent> gzWindow::getExternalSwapEvent (   )

const gzGraphicsFormat* gzWindow::getFormat (   )

gzWindowHandle gzWindow::getHandle (   )  [inline]

Get the HWND on Win32 systems or Widget on X11 systems. Definition at line 76 of file gzWindow.h. References m_handle.

gzLongXY gzWindow::getMousePosition (   )

gzULongXY gzWindow::getPosition (   )

gzRenderContext gzWindow::getRenderContext (   )

gzULongXY gzWindow::getSize (   )

gzWindowContext gzWindow::getWinContext (   )  [inline]

Get the HWND on Win32 systems or Window on X11 systems. Definition at line 79 of file gzWindow.h. References m_winContext.

static gzWindow* gzWindow::getWindow (  const gzString &  name  )  [static]

static gzWindow* gzWindow::getWindow (  gzWindowHandle  handle = 0, gzWindowContext  = 0 )  [static]

gzWindowContext gzWindow::getWindowContext (   )

gzWindow::GZ_DECLARE_TYPE_INTERFACE_EXPORT (  1   )

Reimplemented from gzRenderBase.

gzWindow::GZ_PROPERTY_EXPORT (  gzBool  , IncludeSwapInDraw  , 1  )

True if swap time is included in draw time.

gzBool gzWindow::hasActiveContext (   )

gzVoid gzWindow::hide (   )

virtual gzVoid gzWindow::onClose (   )  [inline, virtual]

Definition at line 141 of file gzWindow.h.

virtual gzVoid gzWindow::onCommand (  int  wmId, int  wmEvent )  [inline, virtual]

Definition at line 128 of file gzWindow.h.

virtual gzVoid gzWindow::onFocus (   )  [inline, virtual]

Definition at line 139 of file gzWindow.h.

virtual gzVoid gzWindow::onHide (   )  [inline, virtual]

Definition at line 134 of file gzWindow.h.

virtual gzBool gzWindow::onKey (  gzKeyValue  key, gzKeyState  keystate, gzLong  mouse_x, gzLong  mouse_y )  [virtual]

Examples: dbviewer.cpp, mirror.cpp, shaders.cpp, skybox.cpp, and tree.cpp.

virtual gzVoid gzWindow::onLostFocus (   )  [inline, virtual]

Definition at line 140 of file gzWindow.h.

virtual gzBool gzWindow::onMouseCursor (   )  [virtual]

virtual gzVoid gzWindow::onMouseMove (  gzLong  mouse_x, gzLong  mouse_y )  [virtual]

virtual gzVoid gzWindow::onMouseWheel (  gzLong  delta, gzLong  mouse_x, gzLong  mouse_y )  [virtual]

virtual gzVoid gzWindow::onNotify (  gzNotifyManager *  master, gzRefPointer< gzNotifyMessage > &  data, gzULong  senderClass )  [inline, virtual]

Implements gzNotifySlave< gzNotifyManager, gzNotifyInterface, gzRefPointer< gzNotifyMessage > >. Definition at line 147 of file gzWindow.h.

virtual gzVoid gzWindow::onPosition (  gzULong  width, gzULong  height )  [inline, virtual]

Definition at line 136 of file gzWindow.h.

virtual gzVoid gzWindow::onShow (   )  [inline, virtual]

Definition at line 133 of file gzWindow.h.

virtual gzVoid gzWindow::onSize (  gzULong  width, gzULong  height )  [inline, virtual]

Definition at line 135 of file gzWindow.h.

virtual gzBool gzWindow::quitOnClose (   )  [virtual]

virtual gzBool gzWindow::refreshWindow (   )  [virtual]

gzVoid gzWindow::setCaptureMouse (  gzBool  on  )

Examples: shaders.cpp, skybox.cpp, and tree.cpp.

static gzWindowCreator gzWindow::setDefaultWindowCreator (  gzWindowCreator  creator  )  [static]

gzVoid gzWindow::setEnableSwap (  gzBool  on  )

gzVoid gzWindow::setExternalRenderEvent (  gzEvent *  renderEvent  )

gzVoid gzWindow::setExternalSwapEvent (  gzEvent *  swapEvent  )

gzVoid gzWindow::setFocus (   )

gzVoid gzWindow::setHideMouse (  gzBool  on  )

Examples: shaders.cpp, skybox.cpp, and tree.cpp.

gzVoid gzWindow::setMaxRenderWaitTime (  gzDouble  seconds  )

gzVoid gzWindow::setMaxSwapWaitTime (  gzDouble  seconds  )

gzVoid gzWindow::setPosition (  gzULong  x, gzULong  y )

gzVoid gzWindow::setRefreshRate (  gzFloat  rate  )

gzVoid gzWindow::setSize (  gzULong  width, gzULong  height )

gzVoid gzWindow::setSwapInterval (  gzInt  interval  )

gzVoid gzWindow::show (   )

Examples: shaders.cpp, skybox.cpp, and tree.cpp.

gzVoid gzWindow::showDynamicLoadProgress (  gzBool  on  )

gzVoid gzWindow::useInputProvider (  gzBool  on  )

---

Friends And Related Function Documentation

friend class gzImageRender [friend]

Definition at line 170 of file gzWindow.h.

---

Member Data Documentation

gzBool gzWindow::m_createdHandle [protected]

Definition at line 262 of file gzWindow.h.

gzBool gzWindow::m_createdParentHandle [protected]

Definition at line 261 of file gzWindow.h.

gzBool gzWindow::m_createdWinContext [protected]

Definition at line 263 of file gzWindow.h.

gzDeviceContext gzWindow::m_deviceContext [protected]

Definition at line 246 of file gzWindow.h.

gzBool gzWindow::m_doOutput [protected]

Definition at line 257 of file gzWindow.h.

gzBool gzWindow::m_doQuitOnClose [protected]

Definition at line 258 of file gzWindow.h.

gzBool gzWindow::m_enableSwap [protected]

Definition at line 259 of file gzWindow.h.

gzRefPointer<gzEvent> gzWindow::m_externalRenderEvent [protected]

Definition at line 271 of file gzWindow.h.

gzRefPointer<gzEvent> gzWindow::m_externalSwapEvent [protected]

Definition at line 273 of file gzWindow.h.

gzRefPointer<gzGraphicsFormat> gzWindow::m_format [protected]

Definition at line 255 of file gzWindow.h.

gzWindowHandle gzWindow::m_handle [protected]

Definition at line 236 of file gzWindow.h.

gzULong gzWindow::m_hasCapture [protected]

Definition at line 231 of file gzWindow.h.

gzULong gzWindow::m_hideMouse [protected]

Definition at line 232 of file gzWindow.h.

gzBool gzWindow::m_inRefresh [protected]

Definition at line 267 of file gzWindow.h.

gzBool gzWindow::m_isInputProvider [protected]

Definition at line 264 of file gzWindow.h.

gzDouble gzWindow::m_maxRenderWaitTime [protected]

Definition at line 275 of file gzWindow.h.

gzDouble gzWindow::m_maxSwapWaitTime [protected]

Definition at line 277 of file gzWindow.h.

gzLongXY gzWindow::m_mouse [protected]

Definition at line 229 of file gzWindow.h.

gzWindowHandle gzWindow::m_parent [protected]

Definition at line 238 of file gzWindow.h.

gzULongXY gzWindow::m_position [protected]

Definition at line 253 of file gzWindow.h.

gzRenderContext gzWindow::m_renderContext [protected]

Definition at line 245 of file gzWindow.h.

gzULong gzWindow::m_screen_width [protected]

Definition at line 250 of file gzWindow.h.

gzBool gzWindow::m_showDynamicLoadProgress [protected]

Definition at line 265 of file gzWindow.h.

gzULongXY gzWindow::m_size [protected]

Definition at line 252 of file gzWindow.h.

gzInt gzWindow::m_swapInterval [protected]

Definition at line 240 of file gzWindow.h.

gzTimerHandle gzWindow::m_timer [protected]

Definition at line 234 of file gzWindow.h.

gzWindowContext gzWindow::m_winContext [protected]

Definition at line 244 of file gzWindow.h.

gzWindowCreator gzWindow::s_defaultCreator [static, protected]

Definition at line 283 of file gzWindow.h.

gzList<gzWindow> gzWindow::s_windowList [static, protected]

Definition at line 281 of file gzWindow.h.

---

The documentation for this class was generated from the following file:

• gzWindow.h

---