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 | List of all members
G3D::PhysicsFrameSplineEditor Class Reference

2D/3D control for editing PhysicsFrameSplines. More...

Inherits G3D::ControlPointEditor.

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

void addControlPoint ()
 Gui Callback. More...
 
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
 
SplineExtrapolationMode::Value extrapolationMode () const
 Extrapolation mode of the underlying spline. More...
 
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...
 
bool hitsControlPoint (const Ray &r)
 Given a world space ray, will determine if it goes through any of the control points. More...
 
SplineInterpolationMode::Value interpolationMode () const
 Interpolation mode of the underlying spline. More...
 
WidgetManagermanager () const
 
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) 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 > > &surface, Array< shared_ptr< Surface2D > > &surface2D) override
 
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) override
 
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...
 
GuiPanepane ()
 
const GuiPanepane () const
 
float pixelScale () const
 Size of a GUI pixel in rendering pixels. More...
 
virtual float positionalEventZ (const Point2 &pixel) const override
 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...
 
void removeSelectedControlPoint ()
 
void renderManipulator (RenderDevice *rd)
 
bool resizable () const
 Can this window be resized by the user? More...
 
int selectedControlPointIndex () const
 
String selectedNodePFrameAsString () const
 Used by the GUI. More...
 
float selectedNodeTime () const
 Used by the GUI. More...
 
virtual void setCaption (const GuiText &text)
 
virtual void setDepth (float d)
 Called by the WidgetManager. More...
 
virtual void setEnabled (bool e) override
 
void setExtrapolationMode (SplineExtrapolationMode::Value m)
 Sets the extrapolationMode of the underlying spline. More...
 
void setInterpolationMode (SplineInterpolationMode::Value m)
 Sets the interpolationMode of the underlying spline. More...
 
virtual void setManager (WidgetManager *m) override
 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)
 
virtual void setSelectedControlPointIndex (int i) override
 
void setSelectedNodePFrameFromString (const String &s)
 Used by the GUI. More...
 
void setSelectedNodeTime (float t)
 Used by the GUI. More...
 
virtual void setSpline (const PhysicsFrameSpline &p)
 
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 PhysicsFrameSplinespline () const
 
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< PhysicsFrameSplineEditorcreate (const GuiText &caption="Spline Editor", GuiPane *dockPane=nullptr, const shared_ptr< GuiTheme > &theme=shared_ptr< GuiTheme >())
 
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  { CONTROL_WIDTH = 180 }
 

Protected Member Functions

 PhysicsFrameSplineEditor (const GuiText &caption, GuiPane *dockPane, shared_ptr< GuiTheme > theme)
 
virtual void addControlPointAfter (int i) override
 
virtual bool allowAddingAndRemovingControlPoints () const
 
virtual bool allowRotation () const
 
virtual bool allowTranslation () const
 
void changeKeyFocus (GuiControl *oldControl, GuiControl *newControl)
 Fires events and updates keyFocusGuiControl. More...
 
virtual PhysicsFrame controlPoint (int index) const override
 
void hideModal ()
 
void increaseBounds (const Vector2 &extent)
 Called by GuiPane::increaseBounds() More...
 
virtual float intersectRayThroughPixel (const Point2 &pixel, int &index) const
 Returns the camera-space z position of the first intersection of the ray through pixel with a control point, and the index of that control point (-1 if none was hit) More...
 
virtual int numControlPoints () const override
 
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 removeControlPoint (int i) override
 
virtual void render (RenderDevice *rd) const
 Inherited from Surface2D. More...
 
virtual void renderBackground (RenderDevice *rd) const
 
virtual void renderControlPoints (RenderDevice *rd, const LightingEnvironment &environment) const override
 
void resizeControlPointDropDown (int i)
 
virtual bool resizeFrameContains (const Point2 &guiPoint) const
 Does the resize area of the window contain this mouse point? More...
 
virtual void setControlPoint (int index, const PhysicsFrame &frame) override
 
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

GuiPanecpPane
 
Rect2D dragOriginalRect
 
Vector2 dragStart
 Position at which the drag started. More...
 
bool inDrag
 True when the window is being dragged. More...
 
bool inResize
 
GuiControlkeyFocusGuiControl
 
GuiPanem_addRemoveControlPointPane
 
String m_cachedPhysicsFrameString
 
PhysicsFrame m_cachedPhysicsFrameValue
 Used to avoid constantly unparsing the current physics frame in selectedNodePFrameAsString() More...
 
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
 
GuiNumberBox< float > * m_finalIntervalBox
 
GuiRadioButtonm_finalIntervalChoice [2]
 
bool m_focused
 
bool m_isDocked
 
int m_lastNodeManipulatorControlPointIndex
 
WidgetManagerm_manager
 The manager, set by setManager(). More...
 
EventCoordinateMapper m_mapper
 
Vector2 m_minSize
 
_internal::Morph m_morph
 
bool m_mouseOver
 
bool m_mouseVisible
 
shared_ptr< ThirdPersonManipulatorm_nodeManipulator
 
float m_pixelScale
 Size of a GUI pixel in rendering pixels. More...
 
Rect2D m_rect
 Window border bounds in GUI pixels. More...
 
GuiButtonm_removeSelectedButton
 
bool m_resizable
 
GuiPanem_rootPane
 
int m_selectedControlPointIndex
 If outside of the legal range, indicates that no point is selected. More...
 
GuiNumberBox< int > * m_selectedControlPointSlider
 
PhysicsFrameSpline m_spline
 
GuiTheme::WindowStyle m_style
 
shared_ptr< Surfacem_surface
 
GuiText m_text
 Window label. More...
 
shared_ptr< GuiThemem_theme
 
bool m_visible
 Is this window visible? More...
 
Modalmodal
 
GuiControlmouseOverGuiControl
 

Detailed Description

2D/3D control for editing PhysicsFrameSplines.

Used by SceneEditorWindow. Not intended for general use and likely to be private in a future release.

The spline manipulator is a GuiWindow that displays its controls. It also creates additional Widgets.

Invoking setVisible(false) on the PhysicsFrameSplineEditor hides the control window, but not the 3D controls. Use setEnabled(false) to hide the 3D controls.

Member Enumeration Documentation

◆ 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

◆ PhysicsFrameSplineEditor()

G3D::PhysicsFrameSplineEditor::PhysicsFrameSplineEditor ( const GuiText caption,
GuiPane dockPane,
shared_ptr< GuiTheme theme 
)
protected

Member Function Documentation

◆ addControlPoint()

void G3D::ControlPointEditor::addControlPoint ( )
inherited

Gui Callback.

◆ addControlPointAfter()

virtual void G3D::PhysicsFrameSplineEditor::addControlPointAfter ( int  i)
overrideprotectedvirtual

◆ 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

◆ allowAddingAndRemovingControlPoints()

virtual bool G3D::ControlPointEditor::allowAddingAndRemovingControlPoints ( ) const
inlineprotectedvirtualinherited

◆ allowRotation()

virtual bool G3D::ControlPointEditor::allowRotation ( ) const
inlineprotectedvirtualinherited

◆ allowTranslation()

virtual bool G3D::ControlPointEditor::allowTranslation ( ) const
inlineprotectedvirtualinherited

◆ bounds()

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

Inherited from Surface2D.

Reimplemented from G3D::Widget.

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

◆ controlPoint()

virtual PhysicsFrame G3D::PhysicsFrameSplineEditor::controlPoint ( int  index) const
overrideprotectedvirtual

◆ create() [1/2]

static shared_ptr<PhysicsFrameSplineEditor> G3D::PhysicsFrameSplineEditor::create ( const GuiText caption = "Spline Editor",
GuiPane dockPane = nullptr,
const shared_ptr< GuiTheme > &  theme = shared_ptr< GuiTheme >() 
)
static
Parameters
dockPaneIf not nullptr, the 2D GUI is placed into this pane and no visible window is created

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

◆ enabled()

bool G3D::GuiWindow::enabled ( ) const
inlineinherited

◆ extrapolationMode()

SplineExtrapolationMode::Value G3D::PhysicsFrameSplineEditor::extrapolationMode ( ) const

Extrapolation mode of the underlying spline.

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

◆ hasMouseOver()

bool G3D::GuiWindow::hasMouseOver ( ) const
inlineinherited

Is the mouse currently over this window?

◆ hideModal()

void G3D::GuiWindow::hideModal ( )
protectedinherited

◆ hitsControlPoint()

bool G3D::ControlPointEditor::hitsControlPoint ( const Ray r)
inherited

Given a world space ray, will determine if it goes through any of the control points.

If it does, it will set that control point as the the selectedControlPoint

◆ increaseBounds()

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

◆ interpolationMode()

SplineInterpolationMode::Value G3D::PhysicsFrameSplineEditor::interpolationMode ( ) const

Interpolation mode of the underlying spline.

◆ intersectRayThroughPixel()

virtual float G3D::ControlPointEditor::intersectRayThroughPixel ( const Point2 pixel,
int &  index 
) const
protectedvirtualinherited

Returns the camera-space z position of the first intersection of the ray through pixel with a control point, and the index of that control point (-1 if none was hit)

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

◆ numControlPoints()

virtual int G3D::PhysicsFrameSplineEditor::numControlPoints ( ) const
inlineoverrideprotectedvirtual

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

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::ControlPointEditor::onPose ( Array< shared_ptr< Surface > > &  surfaceArray,
Array< shared_ptr< Surface2D > > &  surface2DArray 
)
overridevirtualinherited


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

◆ onSimulation()

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

Reimplemented from G3D::ControlPointEditor.

◆ 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::ControlPointEditor::positionalEventZ ( const Point2 pixel) const
overridevirtualinherited

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 from G3D::Widget.

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

◆ removeControlPoint()

virtual void G3D::PhysicsFrameSplineEditor::removeControlPoint ( int  i)
overrideprotectedvirtual

◆ removeSelectedControlPoint()

void G3D::ControlPointEditor::removeSelectedControlPoint ( )
inherited

◆ 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

◆ renderControlPoints()

virtual void G3D::PhysicsFrameSplineEditor::renderControlPoints ( RenderDevice rd,
const LightingEnvironment environment 
) const
overrideprotectedvirtual

Reimplemented from G3D::ControlPointEditor.

◆ renderManipulator()

void G3D::ControlPointEditor::renderManipulator ( RenderDevice rd)
inherited

◆ resizable()

bool G3D::GuiWindow::resizable ( ) const
inlineinherited

Can this window be resized by the user?

◆ resizeControlPointDropDown()

void G3D::ControlPointEditor::resizeControlPointDropDown ( int  i)
protectedinherited

◆ resizeFrameContains()

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

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

◆ selectedControlPointIndex()

int G3D::ControlPointEditor::selectedControlPointIndex ( ) const
inlineinherited

◆ selectedNodePFrameAsString()

String G3D::ControlPointEditor::selectedNodePFrameAsString ( ) const
inherited

Used by the GUI.

◆ selectedNodeTime()

float G3D::PhysicsFrameSplineEditor::selectedNodeTime ( ) const

Used by the GUI.

◆ setCaption()

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

◆ setControlPoint()

virtual void G3D::PhysicsFrameSplineEditor::setControlPoint ( int  index,
const PhysicsFrame frame 
)
overrideprotectedvirtual

◆ 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::PhysicsFrameSplineEditor::setEnabled ( bool  e)
inlineoverridevirtual

Reimplemented from G3D::ControlPointEditor.

◆ setExtrapolationMode()

void G3D::PhysicsFrameSplineEditor::setExtrapolationMode ( SplineExtrapolationMode::Value  m)

Sets the extrapolationMode of the underlying spline.

◆ setInterpolationMode()

void G3D::PhysicsFrameSplineEditor::setInterpolationMode ( SplineInterpolationMode::Value  m)

Sets the interpolationMode of the underlying spline.

◆ setKeyFocusControl()

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

◆ setKeyFocusOnNextControl()

void G3D::GuiWindow::setKeyFocusOnNextControl ( )
protectedinherited

Called when tab is pressed.

◆ setManager()

virtual void G3D::ControlPointEditor::setManager ( WidgetManager m)
overridevirtualinherited

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

◆ setSelectedControlPointIndex()

virtual void G3D::PhysicsFrameSplineEditor::setSelectedControlPointIndex ( int  i)
overridevirtual

Reimplemented from G3D::ControlPointEditor.

◆ setSelectedNodePFrameFromString()

void G3D::ControlPointEditor::setSelectedNodePFrameFromString ( const String s)
inherited

Used by the GUI.

◆ setSelectedNodeTime()

void G3D::PhysicsFrameSplineEditor::setSelectedNodeTime ( float  t)

Used by the GUI.

◆ setSpline()

virtual void G3D::PhysicsFrameSplineEditor::setSpline ( const PhysicsFrameSpline p)
virtual

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

◆ spline()

const PhysicsFrameSpline& G3D::PhysicsFrameSplineEditor::spline ( ) const
inline

◆ theme()

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

◆ 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

◆ cpPane

GuiPane* G3D::ControlPointEditor::cpPane
protectedinherited

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

GuiPane* G3D::ControlPointEditor::m_addRemoveControlPointPane
protectedinherited

◆ m_cachedPhysicsFrameString

String G3D::ControlPointEditor::m_cachedPhysicsFrameString
mutableprotectedinherited

◆ m_cachedPhysicsFrameValue

PhysicsFrame G3D::ControlPointEditor::m_cachedPhysicsFrameValue
mutableprotectedinherited

Used to avoid constantly unparsing the current physics frame in selectedNodePFrameAsString()

◆ 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

◆ m_drawerArray

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

◆ m_enabled

bool G3D::GuiWindow::m_enabled
protectedinherited

◆ m_finalIntervalBox

GuiNumberBox<float>* G3D::PhysicsFrameSplineEditor::m_finalIntervalBox
protected

◆ m_finalIntervalChoice

GuiRadioButton* G3D::PhysicsFrameSplineEditor::m_finalIntervalChoice[2]
protected

◆ m_focused

bool G3D::GuiWindow::m_focused
protectedinherited

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

◆ m_isDocked

bool G3D::ControlPointEditor::m_isDocked
protectedinherited

Referenced by setEnabled().

◆ m_lastNodeManipulatorControlPointIndex

int G3D::ControlPointEditor::m_lastNodeManipulatorControlPointIndex
protectedinherited

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

EventCoordinateMapper G3D::ControlPointEditor::m_mapper
mutableprotectedinherited

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

shared_ptr<ThirdPersonManipulator> G3D::ControlPointEditor::m_nodeManipulator
protectedinherited

◆ m_pixelScale

float G3D::GuiWindow::m_pixelScale
protectedinherited

Size of a GUI pixel in rendering pixels.

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

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

GuiButton* G3D::ControlPointEditor::m_removeSelectedButton
protectedinherited

◆ m_resizable

bool G3D::GuiWindow::m_resizable
protectedinherited

◆ m_rootPane

GuiPane* G3D::GuiWindow::m_rootPane
protectedinherited

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

◆ m_selectedControlPointIndex

int G3D::ControlPointEditor::m_selectedControlPointIndex
protectedinherited

If outside of the legal range, indicates that no point is selected.

Referenced by G3D::ControlPointEditor::selectedControlPointIndex().

◆ m_selectedControlPointSlider

GuiNumberBox<int>* G3D::ControlPointEditor::m_selectedControlPointSlider
protectedinherited

◆ m_spline

PhysicsFrameSpline G3D::PhysicsFrameSplineEditor::m_spline
protected

Referenced by numControlPoints(), and spline().

◆ m_style

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

◆ m_surface

shared_ptr<Surface> G3D::PhysicsFrameSplineEditor::m_surface
protected

◆ 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

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