Ogre::ConfigDialog Class Reference
Core » General

Defines the behaviour of an automatic renderer configuration dialog. More...

`#include <OgreConfigDialogImp.h>`

Inheritance diagram for Ogre::ConfigDialog:
[legend]

## Public Member Functions

| ConfigDialog ()
| ConfigDialog ()
| ConfigDialog ()
| ConfigDialog ()
| ConfigDialog ()
| ConfigDialog ()
| ConfigDialog ()
| ConfigDialog ()
| ConfigDialog ()
| ~ConfigDialog ()
| ~ConfigDialog ()
| ~ConfigDialog ()
| ~ConfigDialog ()
| ~ConfigDialog ()
| ~ConfigDialog ()
void | cancel ()
void | cancel ()
void | cancel ()
bool | display ()
bool | display ()
bool | display ()
bool | display ()
| Displays the dialog. More...
bool | display ()
| Displays the dialog. More...
bool | display ()
| Displays the dialog. More...
bool | display ()
| Displays the dialog. More...
bool | display ()
| Displays the dialog. More...
bool | display ()
void | initialise ()
void | initialise ()
void | initialise ()
void | initialise ()
void | operator delete (void *ptr)
void | operator delete (void *ptr, void *)
void | operator delete (void *ptr, const char *, int, const char *)
void | operator delete[] (void *ptr)
void | operator delete[] (void *ptr, const char *, int, const char *)
void * | operator new (size_t sz, const char *file, int line, const char *func)
| operator new, with debug line info More...
void * | operator new (size_t sz)
void * | operator new (size_t sz, void *ptr)
| placement operator new More...
void * | operator new[] (size_t sz, const char *file, int line, const char *func)
| array operator new, with debug line info More...
void * | operator new[] (size_t sz)
void | run ()
void | run ()
void | run ()

## Protected Member Functions

bool | createWindow ()
| Create the gtk+ dialog window. More...
void | setupRendererParams ()
| Get parameters from selected renderer and fill the dialog. More...

## Static Protected Member Functions

static BOOL CALLBACK | DlgProc (HWND hDlg, UINT iMsg, WPARAM wParam, LPARAM lParam)
| Callback to process window events. More...
static void | optionChanged (GtkComboBox *widget, gpointer data)
| Callback function to change a renderer option. More...
static gboolean | refreshParams (gpointer data)
| Idle function to refresh renderer parameters. More...
static void | rendererChanged (GtkComboBox *widget, gpointer data)
| Callback function for renderer select combobox. More...

## Protected Attributes

bool | iDisplayStatus
RenderSystem * | iSelectedRenderSystem
GtkWidget * | mDialog
| The dialog window. More...
HINSTANCE | mHInstance
GtkWidget * | mOKButton
| The button used to accept the dialog. More...
GtkWidget * | mParamTable
| The table with renderer parameters. More...
RenderSystem * | mSelectedRenderSystem
| The rendersystem selected by user. More...

## Detailed Description

Defines the behaviour of an automatic renderer configuration dialog.

Remarks
  OGRE comes with it's own renderer configuration dialog, which applications can use to easily allow the user to configure the settings appropriate to their machine. This class defines the interface to this standard dialog. Because dialogs are inherently tied to a particular platform's windowing system, there will be a different subclass for each platform.

Author
  Steven J. Streeting

Remarks
  OGRE comes with it's own renderer configuration dialog, which applications can use to easily allow the user to configure the settings appropriate to their machine. This class defines the interface to this standard dialog. Because dialogs are inherently tied to a particular platform's windowing system, there will be a different subclass for each platform.

Author
  Andrew Zabolotny zap@h.nosp@m.omel.nosp@m.ink.r.nosp@m.u

Definition at line 38 of file Android/OgreConfigDialogImp.h.

## Constructor & Destructor Documentation

## ConfigDialog() [1/9]

Ogre::ConfigDialog::ConfigDialog | ( |  | ) |

## ~ConfigDialog() [1/6]

Ogre::ConfigDialog::~ConfigDialog | ( |  | ) |

## ConfigDialog() [2/9]

Ogre::ConfigDialog::ConfigDialog | ( |  | ) |

## ~ConfigDialog() [2/6]

Ogre::ConfigDialog::~ConfigDialog | ( |  | ) |

## ConfigDialog() [3/9]

Ogre::ConfigDialog::ConfigDialog | ( |  | ) |

## ConfigDialog() [4/9]

Ogre::ConfigDialog::ConfigDialog | ( |  | ) |

## ConfigDialog() [5/9]

Ogre::ConfigDialog::ConfigDialog | ( |  | ) |

## ~ConfigDialog() [3/6]

Ogre::ConfigDialog::~ConfigDialog | ( |  | ) |

## ConfigDialog() [6/9]

Ogre::ConfigDialog::ConfigDialog | ( |  | ) |

## ConfigDialog() [7/9]

Ogre::ConfigDialog::ConfigDialog | ( |  | ) |

## ~ConfigDialog() [4/6]

Ogre::ConfigDialog::~ConfigDialog | ( |  | ) |

## ConfigDialog() [8/9]

Ogre::ConfigDialog::ConfigDialog | ( |  | ) |

## ~ConfigDialog() [5/6]

Ogre::ConfigDialog::~ConfigDialog | ( |  | ) |

## ConfigDialog() [9/9]

Ogre::ConfigDialog::ConfigDialog | ( |  | ) |

## ~ConfigDialog() [6/6]

Ogre::ConfigDialog::~ConfigDialog | ( |  | ) |

## Member Function Documentation

## cancel() [1/3]

void Ogre::ConfigDialog::cancel | ( |  | ) |

## cancel() [2/3]

void Ogre::ConfigDialog::cancel | ( |  | ) |

## cancel() [3/3]

void Ogre::ConfigDialog::cancel | ( |  | ) |

## createWindow()

bool Ogre::ConfigDialog::createWindow | ( |  | ) |

protected

Create the gtk+ dialog window.

## display() [1/9]

bool Ogre::ConfigDialog::display | ( |  | ) |

## display() [2/9]

bool Ogre::ConfigDialog::display | ( |  | ) |

## display() [3/9]

bool Ogre::ConfigDialog::display | ( |  | ) |

## display() [4/9]

bool Ogre::ConfigDialog::display | ( |  | ) |

Displays the dialog.

Remarks
  This method displays the dialog and from then on the dialog interacts with the user independently. The dialog will be calling the relevant OGRE rendering systems to query them for options and to set the options the user selects. The method returns when the user closes the dialog.

Returns
  If the user accepted the dialog, true is returned.

  If the user cancelled the dialog (indicating the application should probably terminate), false is returned.

See also
  RenderSystem

## display() [5/9]

bool Ogre::ConfigDialog::display | ( |  | ) |

Displays the dialog.

Remarks
  This method displays the dialog and from then on the dialog interacts with the user independently. The dialog will be calling the relevant OGRE rendering systems to query them for options and to set the options the user selects. The method returns when the user closes the dialog.

Returns
  If the user accepted the dialog, true is returned.

  If the user cancelled the dialog (indicating the application should probably terminate), false is returned.

See also
  RenderSystem

## display() [6/9]

bool Ogre::ConfigDialog::display | ( |  | ) |

Displays the dialog.

Remarks
  This method displays the dialog and from then on the dialog interacts with the user independently. The dialog will be calling the relevant OGRE rendering systems to query them for options and to set the options the user selects. The method returns when the user closes the dialog.

Returns
  If the user accepted the dialog, true is returned.

  If the user cancelled the dialog (indicating the application should probably terminate), false is returned.

See also
  RenderSystem

## display() [7/9]

bool Ogre::ConfigDialog::display | ( |  | ) |

Displays the dialog.

Remarks
  This method displays the dialog and from then on the dialog interacts with the user independently. The dialog will be calling the relevant OGRE rendering systems to query them for options and to set the options the user selects. The method returns when the user closes the dialog.

Returns
  If the user accepted the dialog, true is returned.

  If the user cancelled the dialog (indicating the application should probably terminate), false is returned.

See also
  RenderSystem

## display() [8/9]

bool Ogre::ConfigDialog::display | ( |  | ) |

Displays the dialog.

Remarks
  This method displays the dialog and from then on the dialog interacts with the user independently. The dialog will be calling the relevant OGRE rendering systems to query them for options and to set the options the user selects. The method returns when the user closes the dialog.

Returns
  If the user accepted the dialog, true is returned.

  If the user cancelled the dialog (indicating the application should probably terminate), false is returned.

See also
  RenderSystem

## display() [9/9]

bool Ogre::ConfigDialog::display | ( |  | ) |

## DlgProc()

static BOOL CALLBACK Ogre::ConfigDialog::DlgProc | ( | HWND | hDlg,
|  | UINT | iMsg,
|  | WPARAM | wParam,
|  | LPARAM | lParam
| ) |  |

static protected

Callback to process window events.

## initialise() [1/4]

void Ogre::ConfigDialog::initialise | ( |  | ) |

## initialise() [2/4]

void Ogre::ConfigDialog::initialise | ( |  | ) |

## initialise() [3/4]

void Ogre::ConfigDialog::initialise | ( |  | ) |

## initialise() [4/4]

void Ogre::ConfigDialog::initialise | ( |  | ) |

## operator delete() [1/3]

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete | ( | void * | ptr | ) |

inherited

Definition at line 96 of file OgreMemoryAllocatedObject.h.

## operator delete() [2/3]

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete | ( | void * | ptr,
|  | void * |
| ) |  |

inherited

Definition at line 102 of file OgreMemoryAllocatedObject.h.

## operator delete() [3/3]

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete | ( | void * | ptr,
|  | const char * | ,
|  | int | ,
|  | const char * |
| ) |  |

inherited

Definition at line 108 of file OgreMemoryAllocatedObject.h.

## operator delete[]() [1/2]

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete[] | ( | void * | ptr | ) |

inherited

Definition at line 113 of file OgreMemoryAllocatedObject.h.

## operator delete[]() [2/2]

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete[] | ( | void * | ptr,
|  | const char * | ,
|  | int | ,
|  | const char * |
| ) |  |

inherited

Definition at line 119 of file OgreMemoryAllocatedObject.h.

## operator new() [1/3]

template<class Alloc >

void* Ogre::AllocatedObject< Alloc >::operator new | ( | size_t | sz,
|  | const char * | file,
|  | int | line,
|  | const char * | func
| ) |  |

inherited

operator new, with debug line info

Definition at line 68 of file OgreMemoryAllocatedObject.h.

## operator new() [2/3]

template<class Alloc >

void* Ogre::AllocatedObject< Alloc >::operator new | ( | size_t | sz | ) |

inherited

Definition at line 73 of file OgreMemoryAllocatedObject.h.

## operator new() [3/3]

template<class Alloc >

void* Ogre::AllocatedObject< Alloc >::operator new | ( | size_t | sz,
|  | void * | ptr
| ) |  |

inherited

placement operator new

Definition at line 79 of file OgreMemoryAllocatedObject.h.

## operator new[]() [1/2]

template<class Alloc >

void* Ogre::AllocatedObject< Alloc >::operator new[] | ( | size_t | sz,
|  | const char * | file,
|  | int | line,
|  | const char * | func
| ) |  |

inherited

array operator new, with debug line info

Definition at line 86 of file OgreMemoryAllocatedObject.h.

## operator new[]() [2/2]

template<class Alloc >

void* Ogre::AllocatedObject< Alloc >::operator new[] | ( | size_t | sz | ) |

inherited

Definition at line 91 of file OgreMemoryAllocatedObject.h.

## optionChanged()

static void Ogre::ConfigDialog::optionChanged | ( | GtkComboBox * | widget,
|  | gpointer | data
| ) |  |

static protected

Callback function to change a renderer option.

## refreshParams()

static gboolean Ogre::ConfigDialog::refreshParams | ( | gpointer | data | ) |

static protected

Idle function to refresh renderer parameters.

## rendererChanged()

static void Ogre::ConfigDialog::rendererChanged | ( | GtkComboBox * | widget,
|  | gpointer | data
| ) |  |

static protected

Callback function for renderer select combobox.

## run() [1/3]

void Ogre::ConfigDialog::run | ( |  | ) |

## run() [2/3]

void Ogre::ConfigDialog::run | ( |  | ) |

## run() [3/3]

void Ogre::ConfigDialog::run | ( |  | ) |

## setupRendererParams()

void Ogre::ConfigDialog::setupRendererParams | ( |  | ) |

protected

Get parameters from selected renderer and fill the dialog.

## Member Data Documentation

## iDisplayStatus

bool Ogre::ConfigDialog::iDisplayStatus

protected

Definition at line 53 of file Android/OgreConfigDialogImp.h.

## iSelectedRenderSystem

RenderSystem * Ogre::ConfigDialog::iSelectedRenderSystem

protected

Definition at line 52 of file Android/OgreConfigDialogImp.h.

## mDialog

GtkWidget* Ogre::ConfigDialog::mDialog

protected

The dialog window.

Definition at line 79 of file gtk/OgreConfigDialogImp.h.

## mHInstance

HINSTANCE Ogre::ConfigDialog::mHInstance

protected

Definition at line 90 of file WIN32/OgreConfigDialogImp.h.

## mOKButton

GtkWidget* Ogre::ConfigDialog::mOKButton

protected

The button used to accept the dialog.

Definition at line 83 of file gtk/OgreConfigDialogImp.h.

## mParamTable

GtkWidget* Ogre::ConfigDialog::mParamTable

protected

The table with renderer parameters.

Definition at line 81 of file gtk/OgreConfigDialogImp.h.

## mSelectedRenderSystem

RenderSystem * Ogre::ConfigDialog::mSelectedRenderSystem

protected

The rendersystem selected by user.

Definition at line 72 of file GLX/OgreConfigDialogImp.h.

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

- Android/OgreConfigDialogImp.h
- OgreConfigDialogImpWinRT.h

Copyright © 2012 Torus Knot Software Ltd
This work is licensed under a Creative Commons Attribution-ShareAlike 3.0 Unported License.