Retained-mode graphical user interface window. More...

Inherits G3D::Widget.

Inherited by G3D::ArticulatedModelSpecificationEditorDialog, G3D::CameraControlWindow, G3D::ControlPointEditor, G3D::DeveloperWindow, G3D::Discovery::Client, G3D::FileDialog, G3D::GuiMenu, G3D::ProfilerWindow, G3D::SceneEditorWindow, G3D::SettingsWindow, G3D::TextureBrowserWindow, and G3D::VideoRecordDialog.

Classes
class	ControlButton

class	Modal
	State for managing modal dialogs. More...

Public Types
enum	CloseAction { NO_CLOSE, IGNORE_CLOSE, HIDE_ON_CLOSE, REMOVE_ON_CLOSE }
	Controls the behavior when the close button is pressed (if there is one). More...

enum	ModalEffect { MODAL_EFFECT_NONE, MODAL_EFFECT_DARKEN, MODAL_EFFECT_DESATURATE, MODAL_EFFECT_LIGHTEN }
	Controls rendering of the screen behind the window when this is a modal dialog. More...

Public Member Functions
	~GuiWindow ()

virtual GuiDrawer *	addDrawer (const GuiText &caption="", GuiDrawer::Side side=GuiDrawer::RIGHT_SIDE)
	Drawers are like windows that slide out of the side of another GuiWindow. More...

virtual Rect2D	bounds () const
	Inherited from Surface2D. More...

const GuiText &	caption () const

const Rect2D &	clientRect () const
	Interior bounds of the window, absolute on the OSWindow in GUI pixels. More...

virtual void	close ()
	Take the specified close action. More...

virtual bool	contains (const Point2 &renderingPoint) const
	True if this point is within the region that the window considers for event delivery. More...

virtual float	depth () const
	Inherited from Surface2D. More...

bool	enabled () const

virtual void	fireEvent (const GEvent &event)
	Fire an event on the containing window. More...

bool	focused () const
	Is this window in focus on the WidgetManager? More...

bool	hasMouseOver () const
	Is the mouse currently over this window? More...

WidgetManager *	manager () const

const Vector2 &	minSize () const

bool	morphing () const
	Returns true while a morph is in progress. More...

virtual void	morphTo (const Rect2D &r)
	Causes the window to change shape and/or position to meet the specified location. More...

virtual void	moveTo (const Vector2 &position)

virtual void	moveToCenter ()
	Move to the center of the screen. More...

virtual void	onAfterEvents ()
	Invoked after all onEvent handlers for the current frame and before onUserInput for any other Widget. More...

virtual void	onAI ()

virtual void	onBeforeGraphics ()
	Invoked by WidgetManager immediately before GApp::onGraphics runs. More...

virtual bool	onEvent (const GEvent &event)
	The event is in OSWindow coordinates, NOT relative to this GuiWindow's rect. More...

virtual void	onNetwork ()

virtual void	onPose (Array< shared_ptr< Surface > > &surfaceArray, Array< shared_ptr< Surface2D > > &surface2DArray)
	Appends a posed model for this object to the array, if it has a graphic representation. More...

virtual void	onSimulation (RealTime rdt, SimTime sdt, SimTime idt)

virtual void	onUserInput (UserInput *ui)

virtual void	pack ()
	Resize the pane so that all of its controls are visible and so that there is no wasted space, then resize the window around the pane. More...

GuiPane *	pane ()

const GuiPane *	pane () const

float	pixelScale () const
	Size of a GUI pixel in rendering pixels. More...

virtual float	positionalEventZ (const Point2 &pixel) const
	The camera-space z position that this Widget considers this pixel to be at. More...

const Rect2D &	rect () const
	Window bounds, including shadow and glow, absolute on the OSWindow in GUI pixels. More...

bool	resizable () const
	Can this window be resized by the user? More...

virtual void	setCaption (const GuiText &text)

virtual void	setDepth (float d)
	Called by the WidgetManager. More...

virtual void	setEnabled (bool e)

virtual void	setManager (WidgetManager *m)
	Called by the WidgetManager when this module is added to it. More...

virtual void	setMinSize (const Vector2 &guiPixelSize)

virtual void	setRect (const Rect2D &rectInGUIPixels)
	Set the border bounds relative to the OSWindow. More...

virtual void	setResizable (bool r)

void	setStyle (GuiTheme::WindowStyle style)
	Change the window style. More...

virtual void	setVisible (bool v)
	Hide this entire window. More...

void	showModal (OSWindow *osWindow, ModalEffect m=MODAL_EFFECT_DESATURATE)
	Blocks until the dialog is closed (visible = false) More...

void	showModal (const shared_ptr< GuiWindow > &parent, ModalEffect m=MODAL_EFFECT_DESATURATE)

const shared_ptr< GuiTheme > &	theme () const

bool	visible () const

virtual OSWindow *	window () const
	Returns the operating system window that is currently rendering this Widget. More...

Static Public Member Functions
static shared_ptr< GuiWindow >	create (const GuiText &windowTitle, const shared_ptr< GuiTheme > &theme=shared_ptr< GuiTheme >(), const Rect2D &rect=Rect2D::xywh(100, 100, 100, 50), GuiTheme::WindowStyle style=GuiTheme::NORMAL_WINDOW_STYLE, CloseAction close=NO_CLOSE)
	As controls are added, the window will automatically grow to contain them as needed. More...

static void	sort (Array< shared_ptr< Surface2D >> &array)
	Sorts from farthest to nearest. More...

static void	sortAndRender (RenderDevice *rd, Array< shared_ptr< Surface2D >> &array)
	Calls sort, RenderDevice::push2D, and then render on all elements. More...

Protected Types
enum	{ CONTROL_WIDTH = 180 }

Protected Member Functions
	GuiWindow (const GuiText &text, const shared_ptr< GuiTheme > &skin, const Rect2D &rect, GuiTheme::WindowStyle style, CloseAction closeAction)

	GuiWindow ()
	Creates a non-functional window. More...

void	changeKeyFocus (GuiControl oldControl, GuiControl newControl)
	Fires events and updates keyFocusGuiControl. More...

void	hideModal ()

void	increaseBounds (const Vector2 &extent)
	Called by GuiPane::increaseBounds() More...

virtual void	onMouseButtonDown (const GEvent &event)
	Invoked from the default onEvent when a mouse click hits the back of a window that is not completely transparent. More...

bool	processMouseButtonDownEventForFocusChangeAndWindowDrag (const GEvent &event)
	Resolve the mouse button down event. More...

virtual void	render (RenderDevice *rd) const
	Inherited from Surface2D. More...

virtual void	renderBackground (RenderDevice *rd) const

virtual bool	resizeFrameContains (const Point2 &guiPoint) const
	Does the resize area of the window contain this mouse point? More...

void	setKeyFocusControl (GuiControl *c)

void	setKeyFocusOnNextControl ()
	Called when tab is pressed. More...

Static Protected Member Functions
template<class T , class ... ArgTypes>
static shared_ptr< T >	createShared (ArgTypes &&... args)
	Like std::make_shared, but works for protected constructors. More...

Protected Attributes
Rect2D	dragOriginalRect

Vector2	dragStart
	Position at which the drag started. More...

bool	inDrag
	True when the window is being dragged. More...

bool	inResize

GuiControl *	keyFocusGuiControl

Rect2D	m_clientRect
	Client rect bounds in GUI pixels, absolute on the OSWindow, but at the redefined scale. More...

CloseAction	m_closeAction

ControlButton	m_closeButton

float	m_depth

Array< GuiDrawer * >	m_drawerArray

bool	m_enabled

bool	m_focused

WidgetManager *	m_manager
	The manager, set by setManager(). More...

Vector2	m_minSize

_internal::Morph	m_morph

bool	m_mouseOver

bool	m_mouseVisible

float	m_pixelScale
	Size of a GUI pixel in rendering pixels. More...

Rect2D	m_rect
	Window border bounds in GUI pixels. More...

bool	m_resizable

GuiPane *	m_rootPane

GuiTheme::WindowStyle	m_style

GuiText	m_text
	Window label. More...

shared_ptr< GuiTheme >	m_theme

bool	m_visible
	Is this window visible? More...

Modal *	modal

GuiControl *	mouseOverGuiControl

Friends
class	_GuiSliderBase

class	GuiButton

class	GuiContainer

class	GuiControl

class	GuiDropDownList

class	GuiPane

class	GuiRadioButton

class	GuiTextBox

Detailed Description

Retained-mode graphical user interface window.

G3D Guis (Graphical User Interfaces) are "skinnable", meaning that the appearance is controled by data files. G3D provides already made skins in the data/gui directory of the installation. See GuiTheme for information on how to draw your own.

The Gui API connects existing variables and methods directly to controls. Except for GuiButton, you don't have to write event handlers like in other APIs. Just pass a pointer to the variable that you want to receive the value of the control when the control is created. An example of creating a dialog is shown below:

     shared_ptr<GuiWindow> window = GuiWindow::create("Person");

     GuiPane* pane = window->pane();
     pane->addCheckBox("Likes cats", &player.likesCats);
     pane->addCheckBox("Is my friend", &player, &Person::getIsMyFriend, &Person::setIsMyFriend);
     pane->addRadioButton("Student", Person::STUDEN, &player.role);
     pane->addRadioButton("Professor", Person::PROFESSOR, &player.role);
     pane->addNumberBox<int>("Age", &player.age, "yrs", true, 1, 100);
     player.height = 1.5;
     pane->addSlider("Height", &player.height, 1.0f, 2.2f);
     GuiButton* invite = pane->addButton("Invite");

     addWidget(window);

Note that in the example, one check-box is connected to a field of "player" and another to methods to get and set a value. To process the button click, extend the GApp (or another Widget's) GApp::onEvent method as follows:

bool App::onEvent(const GEvent& e) {
    if (e.type == GEventType::GUI_ACTION) {
        if (e.gui.control == invite) {
            ... handle the invite action here ...
            return true;
        }
    }
    return false;
}

It is not necessary to subclass GuiWindow to create a user interface. Just instantiate GuiWindow and add controls to its pane. If you do choose to subclass GuiWindow, be sure to call the superclass methods for those that you override.

When a GuiWindow has focus from a WidgetManager, it assigns keyboard focus to one of the controls within itself.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

protected

Enumerator
CONTROL_WIDTH

◆ CloseAction

enum G3D::GuiWindow::CloseAction

Controls the behavior when the close button is pressed (if there is one).

NO_CLOSE - Do not show the close button IGNORE_CLOSE - Fire G3D::GEvent::GUI_CLOSE event but take no further action HIDE_ON_CLOSE - Set the window visibility to false and fire G3D::GEvent::GUI_CLOSE REMOVE_ON_CLOSE - Remove this GuiWindow from its containing WidgetManager and fire G3D::GEvent::GUI_CLOSE with a nullptr window argument (since the window may be garbage collected before the event is received).

Enumerator
NO_CLOSE
IGNORE_CLOSE
HIDE_ON_CLOSE
REMOVE_ON_CLOSE

◆ ModalEffect

enum G3D::GuiWindow::ModalEffect

Controls rendering of the screen behind the window when this is a modal dialog.

Enumerator
MODAL_EFFECT_NONE
MODAL_EFFECT_DARKEN
MODAL_EFFECT_DESATURATE
MODAL_EFFECT_LIGHTEN

Constructor & Destructor Documentation

◆ GuiWindow() [1/2]

G3D::GuiWindow::GuiWindow	(	const GuiText &	text,
		const shared_ptr< GuiTheme > &	skin,
		const Rect2D &	rect,
		GuiTheme::WindowStyle	style,
		CloseAction	closeAction
	)

protected

◆ GuiWindow() [2/2]

G3D::GuiWindow::GuiWindow ( )

protected

Creates a non-functional window.

Useful for subclasses that also need to operate on a compute server that does not intialize OpenGL.

◆ ~GuiWindow()

G3D::GuiWindow::~GuiWindow ( )

Member Function Documentation

◆ addDrawer()

virtual GuiDrawer* G3D::GuiWindow::addDrawer	(	const GuiText &	caption = `""`,
		GuiDrawer::Side	side = `GuiDrawer::RIGHT_SIDE`
	)

inlinevirtual

Drawers are like windows that slide out of the side of another GuiWindow.

Drawers are initially sized based on the side of the window that they slide out of, but they can be explicitly sized. Multiple drawers can be attached to the same side, however it is up to the caller to ensure that they do not overlap.

Parameters

side	Side that the drawer sticks out of

◆ bounds()

virtual Rect2D G3D::GuiWindow::bounds ( ) const

virtual

Inherited from Surface2D.

Reimplemented from G3D::Widget.

◆ caption()

const GuiText& G3D::GuiWindow::caption ( ) const

inline

Referenced by addDrawer().

◆ changeKeyFocus()

void G3D::GuiWindow::changeKeyFocus	(	GuiControl *	oldControl,
		GuiControl *	newControl
	)

protected

Fires events and updates keyFocusGuiControl.

◆ clientRect()

const Rect2D& G3D::GuiWindow::clientRect ( ) const

inline

Interior bounds of the window, absolute on the OSWindow in GUI pixels.

◆ close()

virtual void G3D::GuiWindow::close ( )

virtual

Take the specified close action.

May be overriden.

Reimplemented in G3D::ArticulatedModelSpecificationEditorDialog.

◆ contains()

virtual bool G3D::GuiWindow::contains ( const Point2 & renderingPoint ) const

virtual

True if this point is within the region that the window considers for event delivery.

Allows irregular window shapes. Default implementation returns true for all points inside rect().

Parameters

renderingPoint in rendering pixels (not GUI pixels)

◆ create()

static shared_ptr<GuiWindow> G3D::GuiWindow::create	(	const GuiText &	windowTitle,
		const shared_ptr< GuiTheme > &	theme = `shared_ptr< GuiTheme >()`,
		const Rect2D &	rect = `Rect2D::xywh(100, 100, 100, 50)`,
		GuiTheme::WindowStyle	style = `GuiTheme::NORMAL_WINDOW_STYLE`,
		CloseAction	close = `NO_CLOSE`
	)

static

As controls are added, the window will automatically grow to contain them as needed.

◆ createShared()

template<class T , class ... ArgTypes>

static shared_ptr<T> G3D::ReferenceCountedObject::createShared ( ArgTypes &&... args )

inlinestaticprotectedinherited

Like std::make_shared, but works for protected constructors.

Call as createShared<myclass>.

◆ depth()

virtual float G3D::GuiWindow::depth ( ) const

virtual

Inherited from Surface2D.

Controls the depth of objects when rendering. Subclasses may override this but it can interfere with the normal handling of rendering and event delivery. depth = 0 is usually the "top" widget and depth = 1 is usually the "bottom" widget.

Reimplemented from G3D::Widget.

◆ enabled()

bool G3D::GuiWindow::enabled ( ) const

inline

◆ fireEvent()

virtual void G3D::Widget::fireEvent ( const GEvent & event )

virtualinherited

Fire an event on the containing window.

Reimplemented in G3D::WidgetManager.

◆ focused()

bool G3D::GuiWindow::focused ( ) const

inline

Is this window in focus on the WidgetManager?

◆ hasMouseOver()

bool G3D::GuiWindow::hasMouseOver ( ) const

inline

Is the mouse currently over this window?

◆ hideModal()

void G3D::GuiWindow::hideModal ( )

protected

◆ increaseBounds()

void G3D::GuiWindow::increaseBounds ( const Vector2 & extent )

protected

Called by GuiPane::increaseBounds()

◆ manager()

WidgetManager* G3D::GuiWindow::manager ( ) const

inline

◆ minSize()

const Vector2& G3D::GuiWindow::minSize ( ) const

inline

◆ morphing()

bool G3D::GuiWindow::morphing ( ) const

inline

Returns true while a morph is in progress.

◆ morphTo()

virtual void G3D::GuiWindow::morphTo ( const Rect2D & r )

virtual

Causes the window to change shape and/or position to meet the specified location.

The window will not respond to drag events while it is morphing.

◆ moveTo()

virtual void G3D::GuiWindow::moveTo ( const Vector2 & position )

virtual

◆ moveToCenter()

virtual void G3D::GuiWindow::moveToCenter ( )

virtual

Move to the center of the screen.

◆ onAfterEvents()

virtual void G3D::Widget::onAfterEvents ( )

inlinevirtualinherited

Invoked after all onEvent handlers for the current frame and before onUserInput for any other Widget.

Reimplemented in G3D::WidgetManager, and G3D::GameController.

◆ onAI()

virtual void G3D::GuiWindow::onAI ( )

inlinevirtual

Reimplemented from G3D::Widget.

Reimplemented in G3D::VideoRecordDialog.

◆ onBeforeGraphics()

virtual void G3D::Widget::onBeforeGraphics ( )

inlinevirtualinherited

Invoked by WidgetManager immediately before GApp::onGraphics runs.

Reimplemented in G3D::WidgetManager, G3D::CallbackWidget, and G3D::XRWidget.

◆ onEvent()

virtual bool G3D::GuiWindow::onEvent ( const GEvent & event )

virtual

The event is in OSWindow coordinates, NOT relative to this GuiWindow's rect.

Reimplemented from G3D::Widget.

Reimplemented in G3D::Discovery::Client, G3D::SceneEditorWindow, G3D::VideoRecordDialog, G3D::CameraControlWindow, G3D::GuiMenu, G3D::ControlPointEditor, G3D::DeveloperWindow, and G3D::ArticulatedModelSpecificationEditorDialog.

◆ onMouseButtonDown()

virtual void G3D::GuiWindow::onMouseButtonDown ( const GEvent & event )

protectedvirtual

Invoked from the default onEvent when a mouse click hits the back of a window that is not completely transparent.

Parameters

event In rendering (not GUI) coordinates.

◆ onNetwork()

virtual void G3D::GuiWindow::onNetwork ( )

inlinevirtual

Reimplemented from G3D::Widget.

Reimplemented in G3D::Discovery::Client.

◆ onPose()

virtual void G3D::GuiWindow::onPose	(	Array< shared_ptr< Surface > > &	surfaceArray,
		Array< shared_ptr< Surface2D > > &	surface2DArray
	)

virtual

Appends a posed model for this object to the array, if it has a graphic representation.

The posed model appended is allowed to reference the agent and is allowed to mutate if the agent is mutated.

Reimplemented from G3D::Widget.

Reimplemented in G3D::Discovery::Client, G3D::SceneEditorWindow, and G3D::ControlPointEditor.

◆ onSimulation()

virtual void G3D::GuiWindow::onSimulation	(	RealTime	rdt,
		SimTime	sdt,
		SimTime	idt
	)

virtual

Reimplemented from G3D::Widget.

Reimplemented in G3D::SceneEditorWindow, G3D::ControlPointEditor, and G3D::PhysicsFrameSplineEditor.

◆ onUserInput()

virtual void G3D::GuiWindow::onUserInput ( UserInput * ui )

virtual

Reimplemented from G3D::Widget.

Reimplemented in G3D::CameraControlWindow.

◆ pack()

virtual void G3D::GuiWindow::pack ( )

virtual

Resize the pane so that all of its controls are visible and so that there is no wasted space, then resize the window around the pane.

See also: G3D::GuiPane::pack

◆ pane() [1/2]

GuiPane* G3D::GuiWindow::pane ( )

inline

◆ pane() [2/2]

const GuiPane* G3D::GuiWindow::pane ( ) const

inline

◆ pixelScale()

float G3D::GuiWindow::pixelScale ( ) const

inline

Size of a GUI pixel in rendering pixels.

Default is 1.0f

Set greater than 1 on high-DPI displays to enlarge the GUI for this window only. Mouse events will be divided by this scale and graphics commands will be multiplied by it.

See also: G3D::G3DSpecification::defaultGuiWindowPixelScale

◆ positionalEventZ()

virtual float G3D::Widget::positionalEventZ ( const Point2 & pixel ) const

inlinevirtualinherited

The camera-space z position that this Widget considers this pixel to be at.

Used for positional event (e.g., mouse click) delivery. Higher means closer.

Large negative values are far away. 0 is the closest 3D object. Values greater than zero are used for 2D objects. Returning fnan() [the default] requests the WidgetManager to set hte positionalEventZ to the object's normal event zorder.

See the implementation of ControlPointEditor::positionalEventZ for an example of how to use this with a 3D object.

Reimplemented in G3D::ControlPointEditor.

◆ processMouseButtonDownEventForFocusChangeAndWindowDrag()

bool G3D::GuiWindow::processMouseButtonDownEventForFocusChangeAndWindowDrag ( const GEvent & event )

protected

Resolve the mouse button down event.

Called from onEvent.
This is handled specially because it can change the focus. event is in rendering coordinates (not GUI coordinates)

◆ rect()

const Rect2D& G3D::GuiWindow::rect ( ) const

inline

Window bounds, including shadow and glow, absolute on the OSWindow in GUI pixels.

◆ render()

virtual void G3D::GuiWindow::render ( RenderDevice * rd ) const

protectedvirtual

Inherited from Surface2D.

Reimplemented from G3D::Widget.

Reimplemented in G3D::GuiMenu.

◆ renderBackground()

virtual void G3D::GuiWindow::renderBackground ( RenderDevice * rd ) const

protectedvirtual

◆ resizable()

bool G3D::GuiWindow::resizable ( ) const

inline

Can this window be resized by the user?

◆ resizeFrameContains()

virtual bool G3D::GuiWindow::resizeFrameContains ( const Point2 & guiPoint ) const

protectedvirtual

Does the resize area of the window contain this mouse point?

◆ setCaption()

virtual void G3D::GuiWindow::setCaption ( const GuiText & text )

virtual

◆ setDepth()

virtual void G3D::Widget::setDepth ( float d )

inlinevirtualinherited

Called by the WidgetManager.

This is the depth that the Widget is expected to use when posed as a Surface2D. Subclasses may override or ignore this but it can interfere with the normal handling of rendering.

◆ setEnabled()

virtual void G3D::GuiWindow::setEnabled ( bool e )

inlinevirtual

Reimplemented in G3D::ControlPointEditor, and G3D::PhysicsFrameSplineEditor.

Referenced by G3D::PhysicsFrameSplineEditor::setEnabled().

◆ setKeyFocusControl()

void G3D::GuiWindow::setKeyFocusControl ( GuiControl * c )

protected

◆ setKeyFocusOnNextControl()

void G3D::GuiWindow::setKeyFocusOnNextControl ( )

protected

Called when tab is pressed.

◆ setManager()

virtual void G3D::Widget::setManager ( WidgetManager * m )

inlinevirtualinherited

Called by the WidgetManager when this module is added to it.

The argument may be nullptr

Reimplemented in G3D::SceneEditorWindow, G3D::ControlPointEditor, G3D::CameraControlWindow, G3D::GameController, G3D::DeveloperWindow, G3D::ProfilerWindow, G3D::TextureBrowserWindow, and G3D::SettingsWindow.

◆ setMinSize()

virtual void G3D::GuiWindow::setMinSize ( const Vector2 & guiPixelSize )

inlinevirtual

◆ setRect()

virtual void G3D::GuiWindow::setRect ( const Rect2D & rectInGUIPixels )

virtual

Set the border bounds relative to the OSWindow.

The window may render outside the bounds because of drop shadows and glows.

Reimplemented in G3D::SceneEditorWindow, and G3D::CameraControlWindow.

◆ setResizable()

virtual void G3D::GuiWindow::setResizable ( bool r )

inlinevirtual

◆ setStyle()

void G3D::GuiWindow::setStyle ( GuiTheme::WindowStyle style )

inline

Change the window style.

May lead to inconsistent layout.

◆ setVisible()

virtual void G3D::GuiWindow::setVisible ( bool v )

inlinevirtual

Hide this entire window.

The window cannot have focus if it is not visible.

Removing the GuiWindow from the WidgetManager is more efficient than making it invisible.

Referenced by G3D::PhysicsFrameSplineEditor::setEnabled().

◆ showModal() [1/2]

void G3D::GuiWindow::showModal	(	OSWindow *	osWindow,
		ModalEffect	m = `MODAL_EFFECT_DESATURATE`
	)

Blocks until the dialog is closed (visible = false)

See also: hideModal. Do not call between RenderDevice::beginFrame and RenderDevice::endFrame.

◆ showModal() [2/2]

void G3D::GuiWindow::showModal	(	const shared_ptr< GuiWindow > &	parent,
		ModalEffect	m = `MODAL_EFFECT_DESATURATE`
	)

◆ sort()

static void G3D::Surface2D::sort ( Array< shared_ptr< Surface2D >> & array )

staticinherited

Sorts from farthest to nearest.

◆ sortAndRender()

static void G3D::Surface2D::sortAndRender	(	RenderDevice *	rd,
		Array< shared_ptr< Surface2D >> &	array
	)

staticinherited

Calls sort, RenderDevice::push2D, and then render on all elements.

◆ theme()

const shared_ptr<GuiTheme>& G3D::GuiWindow::theme ( ) const

inline

Referenced by G3D::ArticulatedModelSpecificationEditorDialog::create().

◆ visible()

bool G3D::GuiWindow::visible ( ) const

inline

◆ window()

virtual OSWindow* G3D::Widget::window ( ) const

virtualinherited

Returns the operating system window that is currently rendering this Widget.

Reimplemented in G3D::WidgetManager.

Referenced by G3D::FullScreenWidget::bounds().

Friends And Related Function Documentation

◆ _GuiSliderBase

friend class _GuiSliderBase

friend

◆ GuiButton

friend class GuiButton

friend

◆ GuiContainer

friend class GuiContainer

friend

◆ GuiControl

friend class GuiControl

friend

◆ GuiDropDownList

friend class GuiDropDownList

friend

◆ GuiPane

friend class GuiPane

friend

◆ GuiRadioButton

friend class GuiRadioButton

friend

◆ GuiTextBox

friend class GuiTextBox

friend

Member Data Documentation

◆ dragOriginalRect

Rect2D G3D::GuiWindow::dragOriginalRect

protected

◆ dragStart

Vector2 G3D::GuiWindow::dragStart

protected

Position at which the drag started.

◆ inDrag

bool G3D::GuiWindow::inDrag

protected

True when the window is being dragged.

◆ inResize

bool G3D::GuiWindow::inResize

protected

◆ keyFocusGuiControl

GuiControl* G3D::GuiWindow::keyFocusGuiControl

protected

◆ m_clientRect

Rect2D G3D::GuiWindow::m_clientRect

protected

Client rect bounds in GUI pixels, absolute on the OSWindow, but at the redefined scale.

Referenced by clientRect().

◆ m_closeAction

CloseAction G3D::GuiWindow::m_closeAction

protected

◆ m_closeButton

ControlButton G3D::GuiWindow::m_closeButton

protected

◆ m_depth

float G3D::Widget::m_depth

protectedinherited

Referenced by G3D::Widget::depth(), and G3D::Widget::setDepth().

◆ m_drawerArray

Array<GuiDrawer*> G3D::GuiWindow::m_drawerArray

protected

◆ m_enabled

bool G3D::GuiWindow::m_enabled

protected

Referenced by enabled(), and setEnabled().

◆ m_focused

bool G3D::GuiWindow::m_focused

protected

Referenced by focused().

◆ m_manager

WidgetManager* G3D::Widget::m_manager

protectedinherited

The manager, set by setManager().

This cannot be a reference counted pointer because that would create a cycle between the Widget and its manager.

Referenced by G3D::Widget::manager(), manager(), G3D::Widget::setManager(), and setVisible().

◆ m_minSize

Vector2 G3D::GuiWindow::m_minSize

protected

Referenced by minSize(), and setMinSize().

◆ m_morph

_internal::Morph G3D::GuiWindow::m_morph

protected

Referenced by morphing().

◆ m_mouseOver

bool G3D::GuiWindow::m_mouseOver

protected

Referenced by hasMouseOver().

◆ m_mouseVisible

bool G3D::GuiWindow::m_mouseVisible

protected

◆ m_pixelScale

float G3D::GuiWindow::m_pixelScale

protected

Size of a GUI pixel in rendering pixels.

Referenced by pixelScale().

◆ m_rect

Rect2D G3D::GuiWindow::m_rect

protected

Window border bounds in GUI pixels.

Actual rendering may be outside these bounds.

Referenced by rect().

◆ m_resizable

bool G3D::GuiWindow::m_resizable

protected

Referenced by resizable(), and setResizable().

◆ m_rootPane

GuiPane* G3D::GuiWindow::m_rootPane

protected

Referenced by pane().

◆ m_style

GuiTheme::WindowStyle G3D::GuiWindow::m_style

protected

Referenced by setStyle().

◆ m_text

GuiText G3D::GuiWindow::m_text

protected

Window label.

Referenced by caption().

◆ m_theme

shared_ptr<GuiTheme> G3D::GuiWindow::m_theme

protected

Referenced by theme().

◆ m_visible

bool G3D::GuiWindow::m_visible

protected

Is this window visible?

Referenced by setVisible(), and visible().

◆ modal

Modal* G3D::GuiWindow::modal

protected

◆ mouseOverGuiControl

GuiControl* G3D::GuiWindow::mouseOverGuiControl

protected

Classes

Public Types

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Friends

Detailed Description

Member Enumeration Documentation

◆ anonymous enum

◆ CloseAction

◆ ModalEffect

Constructor & Destructor Documentation

◆ GuiWindow() [1/2]

◆ GuiWindow() [2/2]

◆ ~GuiWindow()

Member Function Documentation

◆ addDrawer()

◆ bounds()

◆ caption()

◆ changeKeyFocus()

◆ clientRect()

◆ close()

◆ contains()

◆ create()

◆ createShared()

◆ depth()

◆ enabled()

◆ fireEvent()

◆ focused()

◆ hasMouseOver()

◆ hideModal()

◆ increaseBounds()

◆ manager()

◆ minSize()

◆ morphing()

◆ morphTo()

◆ moveTo()

◆ moveToCenter()

◆ onAfterEvents()

◆ onAI()

◆ onBeforeGraphics()

◆ onEvent()

◆ onMouseButtonDown()

◆ onNetwork()

◆ onPose()

◆ onSimulation()

◆ onUserInput()

◆ pack()

◆ pane() [1/2]

◆ pane() [2/2]

◆ pixelScale()

◆ positionalEventZ()

◆ processMouseButtonDownEventForFocusChangeAndWindowDrag()

◆ rect()

◆ render()

◆ renderBackground()

◆ resizable()

◆ resizeFrameContains()

◆ setCaption()

◆ setDepth()

◆ setEnabled()

◆ setKeyFocusControl()

◆ setKeyFocusOnNextControl()

◆ setManager()

◆ setMinSize()

◆ setRect()

◆ setResizable()

◆ setStyle()

◆ setVisible()

◆ showModal() [1/2]

◆ showModal() [2/2]

◆ sort()

◆ sortAndRender()

◆ theme()

◆ visible()

◆ window()

Friends And Related Function Documentation