SLUiInterface Class Reference

Interface for ui integration in SLSceneView. More...

#include <SLUiInterface.h>

Inheritance diagram for SLUiInterface:

Public Member Functions
virtual	~SLUiInterface ()
virtual void	init (const string &configPath)
	initialization (called by SLSceneView init) More...
virtual void	onResize (SLint scrW, SLint scrH)
	inform the ui about scene view size change More...
virtual void	onClose ()
	shutdown ui More...
virtual void	onInitNewFrame (SLScene *s, SLSceneView *sv)
	prepare the ui for a new rendering, e.g. update visual ui representation (called by SLSceneView onPaint) More...
virtual void	onPaint (const SLRecti &viewport)
	ui render call (called by SLSceneView draw2DGL) More...
virtual void	renderExtraFrame (SLScene *s, SLSceneView *sv, SLint mouseX, SLint mouseY)
virtual void	onMouseDown (SLMouseButton button, SLint x, SLint y)
	forward user input to ui More...
virtual void	onMouseUp (SLMouseButton button, SLint x, SLint y)
	forward user input to ui More...
virtual void	onMouseMove (SLint xPos, SLint yPos)
	forward user input to ui More...
virtual void	onMouseWheel (SLfloat yoffset)
	forward user input to ui More...
virtual void	onKeyPress (SLKey key, SLKey mod)
	forward user input to ui More...
virtual void	onKeyRelease (SLKey key, SLKey mod)
	forward user input to ui More...
virtual void	onCharInput (SLuint c)
	forward user input to ui More...
virtual bool	doNotDispatchKeyboard ()
	inform if user keyboard input was consumed by the ui More...
virtual bool	doNotDispatchMouse ()
	inform if user mouse input was consumed by the ui More...
virtual void	drawMouseCursor (bool doDraw)
	Turns on or off the mouse cursor drawing. More...

Detailed Description

Interface for ui integration in SLSceneView.

(all functions are called by SLSceneView so basically it is a SLSceneViewUiInterface)

Constructor & Destructor Documentation

~SLUiInterface()

virtual SLUiInterface::~SLUiInterface ( )

inlinevirtual

Member Function Documentation

doNotDispatchKeyboard()

virtual bool SLUiInterface::doNotDispatchKeyboard ( )

inlinevirtual

inform if user keyboard input was consumed by the ui

Reimplemented in SLGLImGui.

doNotDispatchMouse()

virtual bool SLUiInterface::doNotDispatchMouse ( )

inlinevirtual

inform if user mouse input was consumed by the ui

(e.g. the ui was hit by a mouse click. In this case the user input would not be forwarded to 3D scene graph)

Reimplemented in SLGLImGui.

drawMouseCursor()

virtual void SLUiInterface::drawMouseCursor ( bool  doDraw )

inlinevirtual

Turns on or off the mouse cursor drawing.

Reimplemented in SLGLImGui.

init()

virtual void SLUiInterface::init ( const string &  configPath )

inlinevirtual

initialization (called by SLSceneView init)

Reimplemented in SLGLImGui.

onCharInput()

virtual void SLUiInterface::onCharInput ( SLuint  c )

inlinevirtual

forward user input to ui

Reimplemented in SLGLImGui.

onClose()

virtual void SLUiInterface::onClose ( )

inlinevirtual

shutdown ui

Reimplemented in SLGLImGui.

onInitNewFrame()

virtual void SLUiInterface::onInitNewFrame ( SLScene *  s, SLSceneView *  sv  )

inlinevirtual

prepare the ui for a new rendering, e.g. update visual ui representation (called by SLSceneView onPaint)

Reimplemented in SLGLImGui.

onKeyPress()

virtual void SLUiInterface::onKeyPress ( SLKey  key, SLKey  mod  )

inlinevirtual

forward user input to ui

Reimplemented in SLGLImGui.

onKeyRelease()

virtual void SLUiInterface::onKeyRelease ( SLKey  key, SLKey  mod  )

inlinevirtual

forward user input to ui

Reimplemented in SLGLImGui.

onMouseDown()

virtual void SLUiInterface::onMouseDown ( SLMouseButton  button, SLint  x, SLint  y  )

inlinevirtual

forward user input to ui

Reimplemented in SLGLImGui.

onMouseMove()

virtual void SLUiInterface::onMouseMove ( SLint  xPos, SLint  yPos  )

inlinevirtual

forward user input to ui

Reimplemented in SLGLImGui.

onMouseUp()

virtual void SLUiInterface::onMouseUp ( SLMouseButton  button, SLint  x, SLint  y  )

inlinevirtual

forward user input to ui

Reimplemented in SLGLImGui.

onMouseWheel()

virtual void SLUiInterface::onMouseWheel ( SLfloat  yoffset )

inlinevirtual

forward user input to ui

Reimplemented in SLGLImGui.

onPaint()

virtual void SLUiInterface::onPaint ( const SLRecti &  viewport )

inlinevirtual

ui render call (called by SLSceneView draw2DGL)

Reimplemented in SLGLImGui.

onResize()

virtual void SLUiInterface::onResize ( SLint  scrW, SLint  scrH  )

inlinevirtual

inform the ui about scene view size change

Reimplemented in SLGLImGui.

renderExtraFrame()

virtual void SLUiInterface::renderExtraFrame ( SLScene *  s, SLSceneView *  sv, SLint  mouseX, SLint  mouseY  )

inlinevirtual

Reimplemented in SLGLImGui.

---

The documentation for this class was generated from the following file:

• SLUiInterface.h