A special "popup" window that hides itself when it loses focus. More...

Inherits G3D::GuiWindow.

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
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...

void	hide ()

const Rect2D &	labelRect (int i)

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) override
	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...

virtual void	render (RenderDevice *rd) const override
	Inherited from Surface2D. 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...

virtual void	show (WidgetManager manager, GuiWindow superior, GuiControl *eventSource, const Vector2 &position, bool modal=false, const GuiControl::Callback &actionCallback=GuiControl::Callback())

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< GuiMenu >	create (const shared_ptr< GuiTheme > &theme, Array< GuiText > *listPtr, const Pointer< int > &indexValue, bool usePrefixTreeMenus=false, bool root=false)

static shared_ptr< GuiMenu >	create (const shared_ptr< GuiTheme > &theme, Array< String > *listPtr, const Pointer< int > &indexValue, bool usePrefixTreeMenus=false, bool root=false)

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...

Public Attributes
shared_ptr< GuiMenu >	m_child
	A submenu. More...

shared_ptr< GuiMenu >	m_parent

Protected Types
enum	{ CONTROL_WIDTH = 180 }

Protected Member Functions
	GuiMenu (const shared_ptr< GuiTheme > &theme, const Rect2D &rect, Array< GuiText > *listPtr, const Pointer< int > &indexValue, bool usePrefixTreeMenus)

	GuiMenu (const shared_ptr< GuiTheme > &theme, const Rect2D &rect, Array< String > *listPtr, const Pointer< int > &indexValue, bool usePrefixTreeMenus)

void	appendMenu (const shared_ptr< GuiMenu > &menu)
	Links new menu and current menu as child-parent menu pair. More...

shared_ptr< GuiMenu >	buildRootPrefixMenu (const shared_ptr< GuiTheme > theme, Array< GuiText > *listValue, const Pointer< int > &indexValue)
	Builds the root node of a prefix Menu, which must be initialized differently then the child nodes. More...

shared_ptr< GuiMenu >	buildRootPrefixMenu (const shared_ptr< GuiTheme > theme, Array< String > *listValue, const Pointer< int > &indexValue)
	Builds the root node of a prefix Menu, which must be initialized differently then the child nodes. More...

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

void	clear ()
	Resets the menu by deleting the current prefixTree. More...

void	closePrefixMenu ()
	Hides the current menu and then sets any child menu to be null. More...

bool	containsValue (const String &s) const
	Returns true if s is one of the values in the current menu. More...

shared_ptr< GuiMenu >	createPrefixMenu (const shared_ptr< PrefixTree > &node, const Pointer< int > &selectedIndex, const shared_ptr< GuiTheme > &theme)
	returns a prefix menu for specific prefixTree node More...

int	findAbsoluteIndex ()
	Finds the absolute index of a selected root in a prefix menu structure. More...

void	fireMyEvent (GEventType type)
	Fires an action event. More...

void	hideModal ()

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

void	init (const shared_ptr< GuiTheme > &skin, const Rect2D &rect, const Array< GuiText > &listPtr, const Pointer< int > &indexValue)

void	initializeChildMenu (WidgetManager manager, GuiWindow superior, GuiControl *eventSource, GuiControl::Callback actionCallback, const shared_ptr< GuiMenu > &prefixRootMenu)
	Helper function to pass on state from parent to child prefix menus. More...

int	labelIndexUnderMouse (Vector2 click) const
	Returns -1 if none. 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	prefixClickedOn (const Point2 click)
	evaluates onClick events that happen on prefix menus More...

void	prefixIndexSelected (int i)
	evaluates the action to be taken when an index in a prefix menu is selected More...

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

virtual void	renderBackground (RenderDevice *rd) const

virtual void	renderDecorations (RenderDevice *rd) const
	Called from render to draw chevrons and highlighting before child content. More...

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

const shared_ptr< PrefixTree > &	selectedNode (int index)
	Returns the selected prefix tree. More...

GuiText &	selectedValue ()
	Returns the selected Value of the menu. More...

void	setKeyFocusControl (GuiControl *c)

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

void	setList (const Array< GuiText > &c)
	Sets the menu to have the values in c. More...

void	setList (const Array< String > &c)
	Sets the menu to have the values in c. More...

void	setSelectedValue (const String &s)
	If the menu contains s, then the value is set to s. More...

void	showInternal (WidgetManager manager, GuiWindow superior, GuiControl *eventSource, const Vector2 &position, bool modal, const GuiControl::Callback &actionCallback)

void	showPrefixMenu (const Vector2 &menuPosition)
	Helper function for prefix menus to put menu at menuPosition. 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

GuiControl::Callback	m_actionCallback

Array< GuiText > *	m_captionListValue

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

GuiControl *	m_eventSource

bool	m_focused

int	m_highlightIndex
	Mouse is over this option. More...

Pointer< int >	m_indexValue

GuiScrollPane *	m_innerScrollPane
	Scroll pane to stick the menu options in if there are too many. More...

Array< GuiControl * >	m_labelArray
	The created labels for each menu item. More...

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...

int	m_prefixIndex
	Within child Menus, which index was selected. More...

Array< shared_ptr< PrefixTree > >	m_prefixNodes
	Used to quickly build up child menus on selection of an index. More...

shared_ptr< GuiMenu >	m_prefixRootMenu
	The outward facing GuiMenu that needs to return final selection. More...

shared_ptr< PrefixTree >	m_prefixTree
	The PrefixTree associated with this menu. More...

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

bool	m_resizable

GuiPane *	m_rootPane

GuiText	m_selectedValue
	The text selected by the menu. More...

Array< String > *	m_stringListValue

GuiTheme::WindowStyle	m_style

GuiWindow *	m_superior
	Window to select when the menu is closed. More...

GuiText	m_text
	Window label. More...

shared_ptr< GuiTheme >	m_theme

bool	m_usePrefixTreeMenus

bool	m_useStringList
	Which of the two list values to use. More...

bool	m_visible
	Is this window visible? More...

Modal *	modal

GuiControl *	mouseOverGuiControl

Friends
class	GuiDropDownList

Detailed Description

A special "popup" window that hides itself when it loses focus.

Used by GuiDropDownList for the popup and can be used to build context menus.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

protectedinherited

Enumerator
CONTROL_WIDTH

◆ CloseAction

enum G3D::GuiWindow::CloseAction

inherited

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

inherited

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

◆ GuiMenu() [1/2]

G3D::GuiMenu::GuiMenu	(	const shared_ptr< GuiTheme > &	theme,
		const Rect2D &	rect,
		Array< GuiText > *	listPtr,
		const Pointer< int > &	indexValue,
		bool	usePrefixTreeMenus
	)

protected

◆ GuiMenu() [2/2]

G3D::GuiMenu::GuiMenu	(	const shared_ptr< GuiTheme > &	theme,
		const Rect2D &	rect,
		Array< String > *	listPtr,
		const Pointer< int > &	indexValue,
		bool	usePrefixTreeMenus
	)

protected

Member Function Documentation

◆ addDrawer()

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

inlinevirtualinherited

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

◆ appendMenu()

void G3D::GuiMenu::appendMenu ( const shared_ptr< GuiMenu > & menu )

protected

Links new menu and current menu as child-parent menu pair.

◆ bounds()

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

virtualinherited

Inherited from Surface2D.

Reimplemented from G3D::Widget.

◆ buildRootPrefixMenu() [1/2]

shared_ptr<GuiMenu> G3D::GuiMenu::buildRootPrefixMenu	(	const shared_ptr< GuiTheme >	theme,
		Array< GuiText > *	listValue,
		const Pointer< int > &	indexValue
	)

protected

Builds the root node of a prefix Menu, which must be initialized differently then the child nodes.

◆ buildRootPrefixMenu() [2/2]

shared_ptr<GuiMenu> G3D::GuiMenu::buildRootPrefixMenu	(	const shared_ptr< GuiTheme >	theme,
		Array< String > *	listValue,
		const Pointer< int > &	indexValue
	)

protected

Builds the root node of a prefix Menu, which must be initialized differently then the child nodes.

◆ caption()

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

inlineinherited

Referenced by G3D::GuiWindow::addDrawer().

◆ changeKeyFocus()

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

protectedinherited

Fires events and updates keyFocusGuiControl.

◆ clear()

void G3D::GuiMenu::clear ( )

protected

Resets the menu by deleting the current prefixTree.

◆ clientRect()

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

inlineinherited

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

◆ close()

virtual void G3D::GuiWindow::close ( )

virtualinherited

Take the specified close action.

May be overriden.

Reimplemented in G3D::ArticulatedModelSpecificationEditorDialog.

◆ closePrefixMenu()

void G3D::GuiMenu::closePrefixMenu ( )

protected

Hides the current menu and then sets any child menu to be null.

◆ contains()

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

virtualinherited

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)

◆ containsValue()

bool G3D::GuiMenu::containsValue ( const String & s ) const

protected

Returns true if s is one of the values in the current menu.

◆ create() [1/3]

static shared_ptr<GuiMenu> G3D::GuiMenu::create	(	const shared_ptr< GuiTheme > &	theme,
		Array< GuiText > *	listPtr,
		const Pointer< int > &	indexValue,
		bool	usePrefixTreeMenus = `false`,
		bool	root = `false`
	)

static

◆ create() [2/3]

static shared_ptr<GuiMenu> G3D::GuiMenu::create	(	const shared_ptr< GuiTheme > &	theme,
		Array< String > *	listPtr,
		const Pointer< int > &	indexValue,
		bool	usePrefixTreeMenus = `false`,
		bool	root = `false`
	)

static

◆ create() [3/3]

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`
	)

staticinherited

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

◆ createPrefixMenu()

shared_ptr<GuiMenu> G3D::GuiMenu::createPrefixMenu	(	const shared_ptr< PrefixTree > &	node,
		const Pointer< int > &	selectedIndex,
		const shared_ptr< GuiTheme > &	theme
	)

protected

returns a prefix menu for specific prefixTree node

◆ 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

virtualinherited

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

inlineinherited

◆ findAbsoluteIndex()

int G3D::GuiMenu::findAbsoluteIndex ( )

protected

Finds the absolute index of a selected root in a prefix menu structure.

◆ fireEvent()

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

virtualinherited

Fire an event on the containing window.

Reimplemented in G3D::WidgetManager.

◆ fireMyEvent()

void G3D::GuiMenu::fireMyEvent ( GEventType type )

protected

Fires an action event.

◆ focused()

bool G3D::GuiWindow::focused ( ) const

inlineinherited

Is this window in focus on the WidgetManager?

◆ hasMouseOver()

bool G3D::GuiWindow::hasMouseOver ( ) const

inlineinherited

Is the mouse currently over this window?

◆ hide()

void G3D::GuiMenu::hide ( )

◆ hideModal()

void G3D::GuiWindow::hideModal ( )

protectedinherited

◆ increaseBounds()

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

protectedinherited

Called by GuiPane::increaseBounds()

◆ init()

void G3D::GuiMenu::init	(	const shared_ptr< GuiTheme > &	skin,
		const Rect2D &	rect,
		const Array< GuiText > &	listPtr,
		const Pointer< int > &	indexValue
	)

protected

◆ initializeChildMenu()

void G3D::GuiMenu::initializeChildMenu	(	WidgetManager *	manager,
		GuiWindow *	superior,
		GuiControl *	eventSource,
		GuiControl::Callback	actionCallback,
		const shared_ptr< GuiMenu > &	prefixRootMenu
	)

protected

Helper function to pass on state from parent to child prefix menus.

◆ labelIndexUnderMouse()

int G3D::GuiMenu::labelIndexUnderMouse ( Vector2 click ) const

protected

Returns -1 if none.

◆ labelRect()

const Rect2D& G3D::GuiMenu::labelRect ( int i )

inline

◆ manager()

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

inlineinherited

◆ minSize()

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

inlineinherited

◆ morphing()

bool G3D::GuiWindow::morphing ( ) const

inlineinherited

Returns true while a morph is in progress.

◆ morphTo()

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

virtualinherited

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 )

virtualinherited

◆ moveToCenter()

virtual void G3D::GuiWindow::moveToCenter ( )

virtualinherited

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 ( )

inlinevirtualinherited

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::GuiMenu::onEvent ( const GEvent & event )

overridevirtual

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

Reimplemented from G3D::GuiWindow.

◆ onMouseButtonDown()

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

protectedvirtualinherited

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 ( )

inlinevirtualinherited

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
	)

virtualinherited

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
	)

virtualinherited

Reimplemented from G3D::Widget.

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

◆ onUserInput()

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

virtualinherited

Reimplemented from G3D::Widget.

Reimplemented in G3D::CameraControlWindow.

◆ pack()

virtual void G3D::GuiWindow::pack ( )

virtualinherited

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 ( )

inlineinherited

◆ pane() [2/2]

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

inlineinherited

◆ pixelScale()

float G3D::GuiWindow::pixelScale ( ) const

inlineinherited

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.

◆ prefixClickedOn()

bool G3D::GuiMenu::prefixClickedOn ( const Point2 click )

protected

evaluates onClick events that happen on prefix menus

◆ prefixIndexSelected()

void G3D::GuiMenu::prefixIndexSelected ( int i )

protected

evaluates the action to be taken when an index in a prefix menu is selected

◆ processMouseButtonDownEventForFocusChangeAndWindowDrag()

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

protectedinherited

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

inlineinherited

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

◆ render()

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

overridevirtual

Inherited from Surface2D.

Reimplemented from G3D::GuiWindow.

◆ renderBackground()

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

protectedvirtualinherited

◆ renderDecorations()

virtual void G3D::GuiMenu::renderDecorations ( RenderDevice * rd ) const

protectedvirtual

Called from render to draw chevrons and highlighting before child content.

◆ resizable()

bool G3D::GuiWindow::resizable ( ) const

inlineinherited

Can this window be resized by the user?

◆ resizeFrameContains()

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

protectedvirtualinherited

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

◆ selectedNode()

const shared_ptr<PrefixTree>& G3D::GuiMenu::selectedNode ( int index )

protected

Returns the selected prefix tree.

◆ selectedValue()

GuiText& G3D::GuiMenu::selectedValue ( )

protected

Returns the selected Value of the menu.

◆ setCaption()

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

virtualinherited

◆ 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 )

inlinevirtualinherited

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

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

◆ setKeyFocusControl()

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

protectedinherited

◆ setKeyFocusOnNextControl()

void G3D::GuiWindow::setKeyFocusOnNextControl ( )

protectedinherited

Called when tab is pressed.

◆ setList() [1/2]

void G3D::GuiMenu::setList ( const Array< GuiText > & c )

protected

Sets the menu to have the values in c.

◆ setList() [2/2]

void G3D::GuiMenu::setList ( const Array< String > & c )

protected

Sets the menu to have the values in c.

◆ 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 )

inlinevirtualinherited

◆ setRect()

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

virtualinherited

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 )

inlinevirtualinherited

◆ setSelectedValue()

void G3D::GuiMenu::setSelectedValue ( const String & s )

protected

If the menu contains s, then the value is set to s.

◆ setStyle()

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

inlineinherited

Change the window style.

May lead to inconsistent layout.

◆ setVisible()

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

inlinevirtualinherited

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().

◆ show()

virtual void G3D::GuiMenu::show	(	WidgetManager *	manager,
		GuiWindow *	superior,
		GuiControl *	eventSource,
		const Vector2 &	position,
		bool	modal = `false`,
		const GuiControl::Callback &	actionCallback = `GuiControl::Callback()`
	)

virtual

Parameters

superior The window from which the menu is being created.

◆ showInternal()

void G3D::GuiMenu::showInternal	(	WidgetManager *	manager,
		GuiWindow *	superior,
		GuiControl *	eventSource,
		const Vector2 &	position,
		bool	modal,
		const GuiControl::Callback &	actionCallback
	)

protected

◆ showModal() [1/2]

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

inherited

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`
	)

inherited

◆ showPrefixMenu()

void G3D::GuiMenu::showPrefixMenu ( const Vector2 & menuPosition )

protected

Helper function for prefix menus to put menu at menuPosition.

◆ 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

inlineinherited

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

◆ visible()

bool G3D::GuiWindow::visible ( ) const

inlineinherited

◆ 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

◆ GuiDropDownList

friend class GuiDropDownList

friend

Member Data Documentation

◆ dragOriginalRect

Rect2D G3D::GuiWindow::dragOriginalRect

protectedinherited

◆ dragStart

Vector2 G3D::GuiWindow::dragStart

protectedinherited

Position at which the drag started.

◆ inDrag

bool G3D::GuiWindow::inDrag

protectedinherited

True when the window is being dragged.

◆ inResize

bool G3D::GuiWindow::inResize

protectedinherited

◆ keyFocusGuiControl

GuiControl* G3D::GuiWindow::keyFocusGuiControl

protectedinherited

◆ m_actionCallback

GuiControl::Callback G3D::GuiMenu::m_actionCallback

protected

◆ m_captionListValue

Array<GuiText>* G3D::GuiMenu::m_captionListValue

protected

◆ m_child

shared_ptr<GuiMenu> G3D::GuiMenu::m_child

A submenu.

If the child is not null, then this window will not close.

◆ m_clientRect

Rect2D G3D::GuiWindow::m_clientRect

protectedinherited

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

Referenced by G3D::GuiWindow::clientRect().

◆ m_closeAction

CloseAction G3D::GuiWindow::m_closeAction

protectedinherited

◆ m_closeButton

ControlButton G3D::GuiWindow::m_closeButton

protectedinherited

◆ 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

protectedinherited

◆ m_enabled

bool G3D::GuiWindow::m_enabled

protectedinherited

Referenced by G3D::GuiWindow::enabled(), and G3D::GuiWindow::setEnabled().

◆ m_eventSource

GuiControl* G3D::GuiMenu::m_eventSource

protected

◆ m_focused

bool G3D::GuiWindow::m_focused

protectedinherited

Referenced by G3D::GuiWindow::focused().

◆ m_highlightIndex

int G3D::GuiMenu::m_highlightIndex

protected

Mouse is over this option.

◆ m_indexValue

Pointer<int> G3D::GuiMenu::m_indexValue

protected

◆ m_innerScrollPane

GuiScrollPane* G3D::GuiMenu::m_innerScrollPane

protected

Scroll pane to stick the menu options in if there are too many.

Null if no need for scroll

◆ m_labelArray

Array<GuiControl*> G3D::GuiMenu::m_labelArray

protected

The created labels for each menu item.

Referenced by labelRect().

◆ 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(), G3D::GuiWindow::manager(), G3D::Widget::setManager(), and G3D::GuiWindow::setVisible().

◆ m_minSize

Vector2 G3D::GuiWindow::m_minSize

protectedinherited

Referenced by G3D::GuiWindow::minSize(), and G3D::GuiWindow::setMinSize().

◆ m_morph

_internal::Morph G3D::GuiWindow::m_morph

protectedinherited

Referenced by G3D::GuiWindow::morphing().

◆ m_mouseOver

bool G3D::GuiWindow::m_mouseOver

protectedinherited

Referenced by G3D::GuiWindow::hasMouseOver().

◆ m_mouseVisible

bool G3D::GuiWindow::m_mouseVisible

protectedinherited

◆ m_parent

shared_ptr<GuiMenu> G3D::GuiMenu::m_parent

◆ m_pixelScale

float G3D::GuiWindow::m_pixelScale

protectedinherited

Size of a GUI pixel in rendering pixels.

Referenced by G3D::GuiWindow::pixelScale().

◆ m_prefixIndex

int G3D::GuiMenu::m_prefixIndex

protected

Within child Menus, which index was selected.

◆ m_prefixNodes

Array<shared_ptr<PrefixTree> > G3D::GuiMenu::m_prefixNodes

protected

Used to quickly build up child menus on selection of an index.

◆ m_prefixRootMenu

shared_ptr<GuiMenu> G3D::GuiMenu::m_prefixRootMenu

protected

The outward facing GuiMenu that needs to return final selection.

◆ m_prefixTree

shared_ptr<PrefixTree> G3D::GuiMenu::m_prefixTree

protected

The PrefixTree associated with this menu.

◆ m_rect

Rect2D G3D::GuiWindow::m_rect

protectedinherited

Window border bounds in GUI pixels.

Actual rendering may be outside these bounds.

Referenced by G3D::GuiWindow::rect().

◆ m_resizable

bool G3D::GuiWindow::m_resizable

protectedinherited

Referenced by G3D::GuiWindow::resizable(), and G3D::GuiWindow::setResizable().

◆ m_rootPane

GuiPane* G3D::GuiWindow::m_rootPane

protectedinherited

Referenced by G3D::GuiWindow::pane().

◆ m_selectedValue

GuiText G3D::GuiMenu::m_selectedValue

protected

The text selected by the menu.

◆ m_stringListValue

Array<String>* G3D::GuiMenu::m_stringListValue

protected

◆ m_style

GuiTheme::WindowStyle G3D::GuiWindow::m_style

protectedinherited

Referenced by G3D::GuiWindow::setStyle().

◆ m_superior

GuiWindow* G3D::GuiMenu::m_superior

protected

Window to select when the menu is closed.

◆ m_text

GuiText G3D::GuiWindow::m_text

protectedinherited

Window label.

Referenced by G3D::GuiWindow::caption().

◆ m_theme

shared_ptr<GuiTheme> G3D::GuiWindow::m_theme

protectedinherited

Referenced by G3D::GuiWindow::theme().

◆ m_usePrefixTreeMenus

bool G3D::GuiMenu::m_usePrefixTreeMenus

protected

◆ m_useStringList

bool G3D::GuiMenu::m_useStringList

protected

Which of the two list values to use.

◆ m_visible

bool G3D::GuiWindow::m_visible

protectedinherited

Is this window visible?

Referenced by G3D::GuiWindow::setVisible(), and G3D::GuiWindow::visible().

◆ modal

Modal* G3D::GuiWindow::modal

protectedinherited

◆ mouseOverGuiControl

GuiControl* G3D::GuiWindow::mouseOverGuiControl

protectedinherited

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Types

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Friends

Detailed Description

Member Enumeration Documentation

◆ anonymous enum

◆ CloseAction

◆ ModalEffect

Constructor & Destructor Documentation

◆ GuiMenu() [1/2]

◆ GuiMenu() [2/2]

Member Function Documentation

◆ addDrawer()

◆ appendMenu()

◆ bounds()

◆ buildRootPrefixMenu() [1/2]

◆ buildRootPrefixMenu() [2/2]

◆ caption()

◆ changeKeyFocus()

◆ clear()

◆ clientRect()

◆ close()

◆ closePrefixMenu()

◆ contains()

◆ containsValue()

◆ create() [1/3]

◆ create() [2/3]

◆ create() [3/3]

◆ createPrefixMenu()

◆ createShared()

◆ depth()

◆ enabled()

◆ findAbsoluteIndex()

◆ fireEvent()

◆ fireMyEvent()

◆ focused()

◆ hasMouseOver()

◆ hide()

◆ hideModal()

◆ increaseBounds()

◆ init()

◆ initializeChildMenu()

◆ labelIndexUnderMouse()

◆ labelRect()

◆ manager()

◆ minSize()

◆ morphing()

◆ morphTo()

◆ moveTo()

◆ moveToCenter()

◆ onAfterEvents()

◆ onAI()

◆ onBeforeGraphics()

◆ onEvent()

◆ onMouseButtonDown()

◆ onNetwork()

◆ onPose()

◆ onSimulation()

◆ onUserInput()

◆ pack()

◆ pane() [1/2]

◆ pane() [2/2]

◆ pixelScale()

◆ positionalEventZ()

◆ prefixClickedOn()

◆ prefixIndexSelected()

◆ processMouseButtonDownEventForFocusChangeAndWindowDrag()

◆ rect()

◆ render()

◆ renderBackground()

◆ renderDecorations()

◆ resizable()

◆ resizeFrameContains()

◆ selectedNode()