A widget that allows the user to launch recording of the on-screen image to a movie. 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

bool	captureGui () const
	When false, the screen is captured at the beginning of Posed2DModel rendering from the back buffer, which may slow down rendering. More...

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

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

float	quality () const

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

String	screenShotFormat ()

virtual void	setCaption (const GuiText &text)

void	setCaptureGui (bool b)
	When false, the screen is captured at the beginning of Posed2DModel rendering from the back buffer, which may slow down rendering. More...

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

virtual void	setEnabled (bool e)

void	setHalfSize (bool b)
	Programmatically set the video recording to half size (defaults to true). More...

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

virtual void	setMinSize (const Vector2 &guiPixelSize)

void	setQuality (float f)
	Scales the default bit rate. More...

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

virtual void	setResizable (bool r)

bool	setScreenShotFormat (const String &fmt)
	Returns true if the format is supported. More...

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)

void	startRecording ()
	Automatically invoked when the record button or hotkey is pressed. More...

void	stopRecording ()

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< VideoRecordDialog >	create (const shared_ptr< GuiTheme > &theme, GApp *app=nullptr)

static shared_ptr< VideoRecordDialog >	create (GApp *app)

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
	VideoRecordDialog (const shared_ptr< GuiTheme > &theme, GApp *app)

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

void	hideModal ()

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

void	makeGUI ()
	Called from constructor. 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

GApp *	m_app

bool	m_captureGUI

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

shared_ptr< Texture >	m_downsampleDst

shared_ptr< Framebuffer >	m_downsampleFBO

shared_ptr< Texture >	m_downsampleSrc
	For downsampling. More...

Array< GuiDrawer * >	m_drawerArray

bool	m_enabled

bool	m_enableMotionBlur

int	m_encoderIndex
	Index into m_encoders and m_formatList. More...

Array< String >	m_encoderNames
	Parallel array to m_settingsTemplate of the descriptions for use with a drop-down list. More...

Array< VideoOutput::Encoder >	m_encoders

String	m_filenamePrefix
	May include a directory. More...

bool	m_focused

shared_ptr< GFont >	m_font
	For drawing messages on the screen. More...

GuiNumberBox< int > *	m_framesBox
	Motion blur frames. More...

bool	m_halfSize

GKey	m_hotKey
	Key to start/stop recording even when the GUI is not visible. More...

GKeyMod	m_hotKeyMod

String	m_hotKeyString
	Hotkey + mod as a human readable string. More...

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

Vector2	m_minSize

_internal::Morph	m_morph

int	m_motionBlurFrames

bool	m_mouseOver

bool	m_mouseVisible

RealTime	m_oldRealTimeTargetDuration

SimTime	m_oldSimTimeStep
	Recording modifies the GApp::simTimeStep; this is the old value. More...

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

float	m_playbackFPS

float	m_quality

GuiButton *	m_recordButton

float	m_recordFPS

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

bool	m_resizable

GuiPane *	m_rootPane

bool	m_showCursor
	Draw a software cursor on the frame after capture, since the hardware cursor will not be visible. More...

int	m_ssFormatIndex
	Index into m_ssFormatList. More...

Array< String >	m_ssFormatList

GKey	m_ssHotKey

GKeyMod	m_ssHotKeyMod

String	m_ssHotKeyString

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	GApp

class	Texture

Detailed Description

A widget that allows the user to launch recording of the on-screen image to a movie.

The playback rate is the frames-per-second value to be stored in the movie file. The record rate 1 / G3D::GApp::simTimeStep.

Set enabled to false to prevent hot-key handling.

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

◆ VideoRecordDialog()

G3D::VideoRecordDialog::VideoRecordDialog	(	const shared_ptr< GuiTheme > &	theme,
		GApp *	app
	)

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

◆ bounds()

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

virtualinherited

Inherited from Surface2D.

Reimplemented from G3D::Widget.

◆ caption()

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

inlineinherited

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

◆ captureGui()

bool G3D::VideoRecordDialog::captureGui ( ) const

inline

When false, the screen is captured at the beginning of Posed2DModel rendering from the back buffer, which may slow down rendering.

When true, the screen is captured from the the previous frame, which will not introduce latency into rendering.

◆ changeKeyFocus()

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

protectedinherited

Fires events and updates keyFocusGuiControl.

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

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

◆ create() [1/3]

static shared_ptr<VideoRecordDialog> G3D::VideoRecordDialog::create	(	const shared_ptr< GuiTheme > &	theme,
		GApp *	app = `nullptr`
	)

static

Parameters

app	If not nullptr, the VideoRecordDialog will set the app's simTimeStep.
prefix	Prefix, which may include a path, of where to store screenshots.

◆ create() [2/3]

static shared_ptr<VideoRecordDialog> G3D::VideoRecordDialog::create ( GApp * app )

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.

◆ 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

◆ 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

inlineinherited

Is this window in focus on the WidgetManager?

◆ halfSize()

bool G3D::VideoRecordDialog::halfSize ( ) const

inline

◆ hasMouseOver()

bool G3D::GuiWindow::hasMouseOver ( ) const

inlineinherited

Is the mouse currently over this window?

◆ hideModal()

void G3D::GuiWindow::hideModal ( )

protectedinherited

◆ increaseBounds()

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

protectedinherited

Called by GuiPane::increaseBounds()

◆ makeGUI()

void G3D::VideoRecordDialog::makeGUI ( )

protected

Called from constructor.

◆ 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::VideoRecordDialog::onAI ( )

virtual

Reimplemented from G3D::GuiWindow.

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

virtual

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.

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

◆ quality()

float G3D::VideoRecordDialog::quality ( ) const

inline

◆ 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::GuiWindow::render ( RenderDevice * rd ) const

protectedvirtualinherited

Inherited from Surface2D.

Reimplemented from G3D::Widget.

Reimplemented in G3D::GuiMenu.

◆ renderBackground()

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

protectedvirtualinherited

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

◆ screenShotFormat()

String G3D::VideoRecordDialog::screenShotFormat ( )

inline

◆ setCaption()

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

virtualinherited

◆ setCaptureGui()

void G3D::VideoRecordDialog::setCaptureGui ( bool b )

inline

When false, the screen is captured at the beginning of Posed2DModel rendering from the back buffer, which may slow down rendering.

When true, the screen is captured from the the previous frame, which will not introduce latency into rendering.

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

◆ setHalfSize()

void G3D::VideoRecordDialog::setHalfSize ( bool b )

inline

Programmatically set the video recording to half size (defaults to true).

This can also be changed through the GUI.

◆ setKeyFocusControl()

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

protectedinherited

◆ setKeyFocusOnNextControl()

void G3D::GuiWindow::setKeyFocusOnNextControl ( )

protectedinherited

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 )

inlinevirtualinherited

◆ setQuality()

void G3D::VideoRecordDialog::setQuality ( float f )

inline

Scales the default bit rate.

◆ 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

◆ setScreenShotFormat()

bool G3D::VideoRecordDialog::setScreenShotFormat ( const String & fmt )

inline

Returns true if the format is supported.

e.g., PNG, JPG, BMP

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

◆ 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

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

◆ startRecording()

void G3D::VideoRecordDialog::startRecording ( )

Automatically invoked when the record button or hotkey is pressed.

Can be called explicitly to force recording.

◆ stopRecording()

void G3D::VideoRecordDialog::stopRecording ( )

◆ 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

◆ GApp

friend class GApp

friend

◆ Texture

friend class Texture

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_app

GApp* G3D::VideoRecordDialog::m_app

protected

◆ m_captureGUI

bool G3D::VideoRecordDialog::m_captureGUI

protected

Referenced by captureGui(), and setCaptureGui().

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

shared_ptr<Texture> G3D::VideoRecordDialog::m_downsampleDst

protected

◆ m_downsampleFBO

shared_ptr<Framebuffer> G3D::VideoRecordDialog::m_downsampleFBO

protected

◆ m_downsampleSrc

shared_ptr<Texture> G3D::VideoRecordDialog::m_downsampleSrc

protected

For downsampling.

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

bool G3D::VideoRecordDialog::m_enableMotionBlur

protected

◆ m_encoderIndex

int G3D::VideoRecordDialog::m_encoderIndex

protected

Index into m_encoders and m_formatList.

◆ m_encoderNames

Array<String> G3D::VideoRecordDialog::m_encoderNames

protected

Parallel array to m_settingsTemplate of the descriptions for use with a drop-down list.

◆ m_encoders

Array<VideoOutput::Encoder> G3D::VideoRecordDialog::m_encoders

protected

◆ m_filenamePrefix

String G3D::VideoRecordDialog::m_filenamePrefix

protected

May include a directory.

◆ m_focused

bool G3D::GuiWindow::m_focused

protectedinherited

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

◆ m_font

shared_ptr<GFont> G3D::VideoRecordDialog::m_font

protected

For drawing messages on the screen.

◆ m_framesBox

GuiNumberBox<int>* G3D::VideoRecordDialog::m_framesBox

protected

Motion blur frames.

◆ m_halfSize

bool G3D::VideoRecordDialog::m_halfSize

protected

Referenced by halfSize(), and setHalfSize().

◆ m_hotKey

GKey G3D::VideoRecordDialog::m_hotKey

protected

Key to start/stop recording even when the GUI is not visible.

◆ m_hotKeyMod

GKeyMod G3D::VideoRecordDialog::m_hotKeyMod

protected

◆ m_hotKeyString

String G3D::VideoRecordDialog::m_hotKeyString

protected

Hotkey + mod as a human readable string.

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

int G3D::VideoRecordDialog::m_motionBlurFrames

protected

◆ m_mouseOver

bool G3D::GuiWindow::m_mouseOver

protectedinherited

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

◆ m_mouseVisible

bool G3D::GuiWindow::m_mouseVisible

protectedinherited

◆ m_oldRealTimeTargetDuration

RealTime G3D::VideoRecordDialog::m_oldRealTimeTargetDuration

protected

◆ m_oldSimTimeStep

SimTime G3D::VideoRecordDialog::m_oldSimTimeStep

protected

Recording modifies the GApp::simTimeStep; this is the old value.

◆ m_pixelScale

float G3D::GuiWindow::m_pixelScale

protectedinherited

Size of a GUI pixel in rendering pixels.

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

◆ m_playbackFPS

float G3D::VideoRecordDialog::m_playbackFPS

protected

◆ m_quality

float G3D::VideoRecordDialog::m_quality

protected

Referenced by quality(), and setQuality().

◆ m_recordButton

GuiButton* G3D::VideoRecordDialog::m_recordButton

protected

◆ m_recordFPS

float G3D::VideoRecordDialog::m_recordFPS

protected

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

bool G3D::VideoRecordDialog::m_showCursor

protected

Draw a software cursor on the frame after capture, since the hardware cursor will not be visible.

◆ m_ssFormatIndex

int G3D::VideoRecordDialog::m_ssFormatIndex

protected

Index into m_ssFormatList.

Referenced by screenShotFormat(), and setScreenShotFormat().

◆ m_ssFormatList

Array<String> G3D::VideoRecordDialog::m_ssFormatList

protected

Referenced by screenShotFormat(), and setScreenShotFormat().

◆ m_ssHotKey

GKey G3D::VideoRecordDialog::m_ssHotKey

protected

◆ m_ssHotKeyMod

GKeyMod G3D::VideoRecordDialog::m_ssHotKeyMod

protected

◆ m_ssHotKeyString

String G3D::VideoRecordDialog::m_ssHotKeyString

protected

◆ m_style

GuiTheme::WindowStyle G3D::GuiWindow::m_style

protectedinherited

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

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

Protected Types

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Friends

Detailed Description

Member Enumeration Documentation

◆ anonymous enum

◆ CloseAction

◆ ModalEffect

Constructor & Destructor Documentation

◆ VideoRecordDialog()

Member Function Documentation

◆ addDrawer()

◆ bounds()

◆ caption()

◆ captureGui()

◆ changeKeyFocus()

◆ clientRect()

◆ close()

◆ contains()

◆ create() [1/3]

◆ create() [2/3]

◆ create() [3/3]

◆ createShared()

◆ depth()

◆ enabled()

◆ fireEvent()

◆ focused()

◆ halfSize()

◆ hasMouseOver()

◆ hideModal()

◆ increaseBounds()

◆ makeGUI()

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

◆ quality()

◆ rect()

◆ render()

◆ renderBackground()

◆ resizable()

◆ resizeFrameContains()

◆ screenShotFormat()

◆ setCaption()

◆ setCaptureGui()

◆ setDepth()

◆ setEnabled()

◆ setHalfSize()

◆ setKeyFocusControl()

◆ setKeyFocusOnNextControl()

◆ setManager()

◆ setMinSize()

◆ setQuality()

◆ setRect()

◆ setResizable()

◆ setScreenShotFormat()

◆ setStyle()

◆ setVisible()