Support Forum       G3D Web Page     
Public Types | Public Member Functions | Static Public Member Functions | Protected Types | Protected Member Functions | Static Protected Member Functions | Protected Attributes | Static Protected Attributes | List of all members
G3D::CameraControlWindow Class Reference


Gui used by DeveloperWindow default for recording camera position and making splines. 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 GuiDraweraddDrawer (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 GuiTextcaption () const
 
const Rect2DclientRect () 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...
 
WidgetManagermanager () const
 
bool manipulatorEnabled () const
 True if either the manual manipulator or the spline playback manipulator is currently driving the camera. More...
 
const Vector2minSize () 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 *)
 
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...
 
GuiPanepane ()
 
const GuiPanepane () 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 Rect2Drect () 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 *manager)
 Called by the WidgetManager when this module is added to it. More...
 
virtual void setMinSize (const Vector2 &guiPixelSize)
 
virtual void setRect (const Rect2D &r)
 
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 OSWindowwindow () const
 Returns the operating system window that is currently rendering this Widget. More...
 

Static Public Member Functions

static shared_ptr< CameraControlWindowcreate (const shared_ptr< FirstPersonManipulator > &manualManipulator, const shared_ptr< UprightSplineManipulator > &trackManipulator, const Pointer< shared_ptr< Manipulator > > &cameraManipulator, const shared_ptr< Camera > &camera, const shared_ptr< GuiTheme > &theme)
 
More...
 
static shared_ptr< GuiWindowcreate (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  { NO_BOOKMARK = -1 }
 
enum  { CONTROL_WIDTH = 180 }
 

Protected Member Functions

 CameraControlWindow (const shared_ptr< FirstPersonManipulator > &manualManipulator, const shared_ptr< UprightSplineManipulator > &trackManipulator, const Pointer< shared_ptr< Manipulator > > &cameraManipulator, const shared_ptr< Camera > &camera, const shared_ptr< GuiTheme > &theme)
 
CFrame cameraFrame () const
 
void changeKeyFocus (GuiControl *oldControl, GuiControl *newControl)
 Fires events and updates keyFocusGuiControl. More...
 
void copyToClipboard ()
 
int depthOfFieldModel () const
 
float focusZ () const
 
void hideModal ()
 
void increaseBounds (const Vector2 &extent)
 Called by GuiPane::increaseBounds() More...
 
float lensRadius () const
 
void loadSpline (const String &filename)
 
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 saveSpline (const String &filename)
 
void setCameraFrame (const CFrame &f)
 
void setCameraLocation (const String &s)
 Parses either prettyprinted or CFrame version. More...
 
void setDepthOfFieldModel (int e)
 
void setFocusZ (float z)
 
void setKeyFocusControl (GuiControl *c)
 
void setKeyFocusOnNextControl ()
 Called when tab is pressed. More...
 
void setLensRadius (float r)
 
void sync ()
 
void updateTrackFiles ()
 Updates the trackFileArray from the list of track files. 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
 
GuiControlkeyFocusGuiControl
 
GuiText m_autoHelpCaption
 
shared_ptr< Cameram_camera
 
Pointer< shared_ptr< Manipulator > > m_cameraManipulator
 The manipulator from which the camera is copying its frame. More...
 
GuiRadioButtonm_clampedSplineButton
 
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
 
GuiRadioButtonm_cyclicSplineButton
 
float m_depth
 
Array< GuiDrawer * > m_drawerArray
 
GuiButtonm_drawerButton
 Button to expand and contract additional manual controls. More...
 
GuiPanem_drawerButtonPane
 The button must be in its own pane so that it can float over the expanded pane. More...
 
GuiText m_drawerCollapseCaption
 
GuiText m_drawerExpandCaption
 
bool m_enabled
 
bool m_expanded
 If true, the window is big enough to show all controls. More...
 
GuiNumberBox< float > * m_farPlaneZSlider
 
bool m_focused
 
GuiLabelm_helpLabel
 
GuiRadioButtonm_linearSplineButton
 
WidgetManagerm_manager
 The manager, set by setManager(). More...
 
GuiText m_manualHelpCaption
 
shared_ptr< FirstPersonManipulatorm_manualManipulator
 
bool m_manualOperation
 True when the user has chosen to override program control of the camera. More...
 
shared_ptr< GuiMenum_menu
 
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...
 
GuiRadioButtonm_playButton
 
GuiText m_playHelpCaption
 
GuiRadioButtonm_recordButton
 
GuiText m_recordHelpCaption
 
Rect2D m_rect
 Window border bounds in GUI pixels. More...
 
bool m_resizable
 
GuiPanem_rootPane
 
GuiButtonm_saveButton
 
GuiRadioButtonm_stopButton
 
GuiTheme::WindowStyle m_style
 
GuiText m_text
 Window label. More...
 
shared_ptr< GuiThemem_theme
 
Array< Stringm_trackFileArray
 Array of all .trk files in the current directory. More...
 
int m_trackFileIndex
 Index into trackFileArray. More...
 
GuiDropDownListm_trackList
 
shared_ptr< UprightSplineManipulatorm_trackManipulator
 
bool m_visible
 Is this window visible? More...
 
GuiCheckBoxm_visibleCheckBox
 
Modalmodal
 
GuiControlmouseOverGuiControl
 

Static Protected Attributes

static const Vector2 sDefaultWindowSize
 
static const Vector2 sExpandedWindowSize
 

Detailed Description


Gui used by DeveloperWindow default for recording camera position and making splines.

See also
G3D::DeveloperWindow, G3D::GApp

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
protected
Enumerator
NO_BOOKMARK 

◆ anonymous enum

anonymous enum
protectedinherited
Enumerator
CONTROL_WIDTH 

◆ 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

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

◆ CameraControlWindow()

G3D::CameraControlWindow::CameraControlWindow ( const shared_ptr< FirstPersonManipulator > &  manualManipulator,
const shared_ptr< UprightSplineManipulator > &  trackManipulator,
const Pointer< shared_ptr< Manipulator > > &  cameraManipulator,
const shared_ptr< Camera > &  camera,
const shared_ptr< GuiTheme > &  theme 
)
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
sideSide that the drawer sticks out of

◆ bounds()

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

Inherited from Surface2D.

Reimplemented from G3D::Widget.

◆ cameraFrame()

CFrame G3D::CameraControlWindow::cameraFrame ( ) const
protected

◆ caption()

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

◆ 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
renderingPointin rendering pixels (not GUI pixels)

◆ copyToClipboard()

void G3D::CameraControlWindow::copyToClipboard ( )
protected

◆ create() [1/2]

static shared_ptr<CameraControlWindow> G3D::CameraControlWindow::create ( const shared_ptr< FirstPersonManipulator > &  manualManipulator,
const shared_ptr< UprightSplineManipulator > &  trackManipulator,
const Pointer< shared_ptr< Manipulator > > &  cameraManipulator,
const shared_ptr< Camera > &  camera,
const shared_ptr< GuiTheme > &  theme 
)
static


Parameters
cameraManipulatorThe manipulator that should drive the camera. This will be assigned to as the program runs.

◆ create() [2/2]

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.

◆ depthOfFieldModel()

int G3D::CameraControlWindow::depthOfFieldModel ( ) const
protected

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

◆ focusZ()

float G3D::CameraControlWindow::focusZ ( ) const
protected

◆ 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

◆ lensRadius()

float G3D::CameraControlWindow::lensRadius ( ) const
protected

◆ loadSpline()

void G3D::CameraControlWindow::loadSpline ( const String filename)
protected

◆ manager()

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

◆ manipulatorEnabled()

bool G3D::CameraControlWindow::manipulatorEnabled ( ) const
inline

True if either the manual manipulator or the spline playback manipulator is currently driving the camera.

◆ 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::CameraControlWindow::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
eventIn 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

◆ onUserInput()

virtual void G3D::CameraControlWindow::onUserInput ( UserInput )
virtual

Reimplemented from G3D::GuiWindow.

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

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

◆ saveSpline()

void G3D::CameraControlWindow::saveSpline ( const String filename)
protected

◆ setCameraFrame()

void G3D::CameraControlWindow::setCameraFrame ( const CFrame f)
protected

◆ setCameraLocation()

void G3D::CameraControlWindow::setCameraLocation ( const String s)
protected

Parses either prettyprinted or CFrame version.

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

◆ setDepthOfFieldModel()

void G3D::CameraControlWindow::setDepthOfFieldModel ( int  e)
protected

◆ setEnabled()

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

◆ setFocusZ()

void G3D::CameraControlWindow::setFocusZ ( float  z)
protected

◆ setKeyFocusControl()

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

◆ setKeyFocusOnNextControl()

void G3D::GuiWindow::setKeyFocusOnNextControl ( )
protectedinherited

Called when tab is pressed.

◆ setLensRadius()

void G3D::CameraControlWindow::setLensRadius ( float  r)
protected

◆ setManager()

virtual void G3D::CameraControlWindow::setManager ( WidgetManager m)
virtual

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

The argument may be nullptr

Reimplemented from G3D::Widget.

◆ setMinSize()

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

◆ setRect()

virtual void G3D::CameraControlWindow::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 from G3D::GuiWindow.

◆ setResizable()

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

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

◆ sync()

void G3D::CameraControlWindow::sync ( )
protected

◆ theme()

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

◆ updateTrackFiles()

void G3D::CameraControlWindow::updateTrackFiles ( )
protected

Updates the trackFileArray from the list of track files.

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

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_autoHelpCaption

GuiText G3D::CameraControlWindow::m_autoHelpCaption
protected

◆ m_camera

shared_ptr<Camera> G3D::CameraControlWindow::m_camera
protected

◆ m_cameraManipulator

Pointer<shared_ptr<Manipulator> > G3D::CameraControlWindow::m_cameraManipulator
protected

The manipulator from which the camera is copying its frame.

◆ m_clampedSplineButton

GuiRadioButton* G3D::CameraControlWindow::m_clampedSplineButton
protected

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

GuiRadioButton* G3D::CameraControlWindow::m_cyclicSplineButton
protected

◆ m_depth

float G3D::Widget::m_depth
protectedinherited

◆ m_drawerArray

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

◆ m_drawerButton

GuiButton* G3D::CameraControlWindow::m_drawerButton
protected

Button to expand and contract additional manual controls.

◆ m_drawerButtonPane

GuiPane* G3D::CameraControlWindow::m_drawerButtonPane
protected

The button must be in its own pane so that it can float over the expanded pane.

◆ m_drawerCollapseCaption

GuiText G3D::CameraControlWindow::m_drawerCollapseCaption
protected

◆ m_drawerExpandCaption

GuiText G3D::CameraControlWindow::m_drawerExpandCaption
protected

◆ m_enabled

bool G3D::GuiWindow::m_enabled
protectedinherited

◆ m_expanded

bool G3D::CameraControlWindow::m_expanded
protected

If true, the window is big enough to show all controls.

◆ m_farPlaneZSlider

GuiNumberBox<float>* G3D::CameraControlWindow::m_farPlaneZSlider
protected

◆ m_focused

bool G3D::GuiWindow::m_focused
protectedinherited

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

◆ m_helpLabel

GuiLabel* G3D::CameraControlWindow::m_helpLabel
protected

◆ m_linearSplineButton

GuiRadioButton* G3D::CameraControlWindow::m_linearSplineButton
protected

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

GuiText G3D::CameraControlWindow::m_manualHelpCaption
protected

◆ m_manualManipulator

shared_ptr<FirstPersonManipulator> G3D::CameraControlWindow::m_manualManipulator
protected

Referenced by manipulatorEnabled().

◆ m_manualOperation

bool G3D::CameraControlWindow::m_manualOperation
protected

True when the user has chosen to override program control of the camera.

◆ m_menu

shared_ptr<GuiMenu> G3D::CameraControlWindow::m_menu
protected

◆ m_minSize

Vector2 G3D::GuiWindow::m_minSize
protectedinherited

◆ m_morph

_internal::Morph G3D::GuiWindow::m_morph
protectedinherited

◆ m_mouseOver

bool G3D::GuiWindow::m_mouseOver
protectedinherited

◆ m_mouseVisible

bool G3D::GuiWindow::m_mouseVisible
protectedinherited

◆ m_pixelScale

float G3D::GuiWindow::m_pixelScale
protectedinherited

Size of a GUI pixel in rendering pixels.

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

◆ m_playButton

GuiRadioButton* G3D::CameraControlWindow::m_playButton
protected

◆ m_playHelpCaption

GuiText G3D::CameraControlWindow::m_playHelpCaption
protected

◆ m_recordButton

GuiRadioButton* G3D::CameraControlWindow::m_recordButton
protected

◆ m_recordHelpCaption

GuiText G3D::CameraControlWindow::m_recordHelpCaption
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

◆ m_rootPane

GuiPane* G3D::GuiWindow::m_rootPane
protectedinherited

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

◆ m_saveButton

GuiButton* G3D::CameraControlWindow::m_saveButton
protected

◆ m_stopButton

GuiRadioButton* G3D::CameraControlWindow::m_stopButton
protected

◆ m_style

GuiTheme::WindowStyle G3D::GuiWindow::m_style
protectedinherited

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

Array<String> G3D::CameraControlWindow::m_trackFileArray
protected

Array of all .trk files in the current directory.

◆ m_trackFileIndex

int G3D::CameraControlWindow::m_trackFileIndex
protected

Index into trackFileArray.

◆ m_trackList

GuiDropDownList* G3D::CameraControlWindow::m_trackList
protected

◆ m_trackManipulator

shared_ptr<UprightSplineManipulator> G3D::CameraControlWindow::m_trackManipulator
protected

Referenced by manipulatorEnabled().

◆ m_visible

bool G3D::GuiWindow::m_visible
protectedinherited

Is this window visible?

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

◆ m_visibleCheckBox

GuiCheckBox* G3D::CameraControlWindow::m_visibleCheckBox
protected

◆ modal

Modal* G3D::GuiWindow::modal
protectedinherited

◆ mouseOverGuiControl

GuiControl* G3D::GuiWindow::mouseOverGuiControl
protectedinherited

◆ sDefaultWindowSize

const Vector2 G3D::CameraControlWindow::sDefaultWindowSize
staticprotected

◆ sExpandedWindowSize

const Vector2 G3D::CameraControlWindow::sExpandedWindowSize
staticprotected

documentation generated on Wed Nov 24 2021 08:01:53 using doxygen 1.8.15