SoWx Class Reference
[Wx]

Routines for Open Inventor/Wx compatibility. More...

#include <Inventor/Wx/SoWx.h>

Static Public Member Functions
static void	init (wxApp app, wxFrame topLevelWidget)
static wxWindow *	init (const char appName, const char className=NULL)
static void	threadInit (wxApp app, wxFrame topLevelWidget)
static bool	isInitialized ()
static void	show (wxWindow *widget)
static void	hide (wxWindow *widget)
static void	mainLoop ()
static SbGlContextHelper::Display	getDisplay ()
static wxFrame *	getTopLevelWidget ()
static void	setWidgetSize (wxWindow *widget, const SbVec2s &size)
static SbVec2s	getWidgetSize (wxWindow *widget)
static void	createSimpleErrorDialog (wxWindow widget, char dialogTitle, char errorStr1, char errorStr2=NULL)
static void	finish ()

Detailed Description

Routines for Open Inventor/Wx compatibility.

The SoWx class initializes Open Inventor for use with Wx. SoWx::init() must be called in order for Open Inventor to work properly with Wx. SoWx::finish() should be called to clean up static memory allocations.

Refer to the SoWxComponent reference pages for examples on how this class should be used when using Open Inventor Wx components.

Member Function Documentation

static void SoWx::createSimpleErrorDialog	(	wxWindow *	widget,
		char *	dialogTitle,
		char *	errorStr1,
		char *	errorStr2 = `NULL`
	)			`[static]`

Convenience routine which brings a simple Wx error dialog box displaying the given error string(s) and window title.

The OK button, which destroys the dialog, is the only button displayed.

static void SoWx::finish ( ) [static]

Frees Open Inventor's internal static memory allocations.

This avoids false positives from memory leak checking software. We recommend calling this method and it should be the last Open Inventor method called by the application. This method calls SoDB::finish(), SoNodeKit::finish(), and SoInteraction::finish().

static SbGlContextHelper::Display SoWx::getDisplay ( ) [static]

This method is included for portability only.

static wxFrame* SoWx::getTopLevelWidget ( ) [static]

Returns information based on the initial wxWindow handle returned by or passed to init.

static SbVec2s SoWx::getWidgetSize ( wxWindow * widget ) [static]

Convenience routine to get the size of the given widget.

static void SoWx::hide ( wxWindow * widget ) [static]

Convenience routine to hide the passed widget handle.

This includes any children the widget may have.

static wxWindow* SoWx::init	(	const char *	appName,
		const char *	className = `NULL`
	)			`[static]`

Same as above but it initializes wxWidgets and return a wxWindow pointer without using the "classic" initialization of wxWidgets.

static void SoWx::init	(	wxApp *	app,
		wxFrame *	topLevelWidget
	)			`[static]`

This is called to initialize Open Inventor and Wx, and bind Open Inventor with Wx message handling so that Open Inventor sensors will work correctly.

The passed widget handle should be the top level widget handle returned from the Wx initialization. This method will call SoDB::init(), SoNodeKit::init(), and SoInteraction::init().

static bool SoWx::isInitialized ( ) [static]

Returns TRUE if SoWx module is currently initialized.

static void SoWx::mainLoop ( ) [static]

This retrieves and dispatches messages (loops forever).

static void SoWx::setWidgetSize	(	wxWindow *	widget,
		const SbVec2s &	size
	)			`[static]`

Convenience routine to set the size of the given widget.

static void SoWx::show ( wxWindow * widget ) [static]

Convenience routine to show the passed widget handle.

This includes any children the widget may have.

static void SoWx::threadInit	(	wxApp *	app,
		wxFrame *	topLevelWidget
	)			`[static]`

This method calls SoDB::threadInit() rather than SoDB::init().

Otherwise it is the same as the corresponding SoWx::init() method.

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

Inventor/Wx/SoWx.h

SoWx Class Reference [Wx]

Static Public Member Functions

Detailed Description

SEE ALSO

Member Function Documentation

SoWx Class Reference
[Wx]