Om  1.0.0
A universal framework for multimedia simulation
Public Attributes | List of all members
om::graphics::gui::objects::RenderView::Delegate Class Reference

A class that contains function objects that recieve RenderView events. More...

#include <omGraphicsGUIRenderView.h>

Public Attributes

Function< void(RenderView &renderView, Float dt)> update
 A function object that is called whenever a render view's internal state is updated. More...
 
Function< Bool(RenderView &renderView, GUIRenderer &renderer, const AABB3f &localBounds, const Viewport &viewport)> render
 A function object that is called whenever a render view's display should update. More...
 
Function< Bool(RenderView &renderView, const GUIEvent &event)> guiEvent
 A function object called whenever an attached render view receives a GUI event. More...
 
Function< Bool(RenderView &renderView, const TextEvent &event)> textEvent
 A function object called whenever an attached render view receives text input. More...
 
Function< Bool(RenderView &renderView, const KeyEvent &event)> keyEvent
 A function object called whenever an attached render view receives a keyboard event. More...
 
Function< Bool(RenderView &renderView, const MouseButtonEvent &event)> mouseButtonEvent
 A function object called whenever an attached render view receives a mouse-button event. More...
 
Function< Bool(RenderView &renderView, const MouseMotionEvent &event)> mouseMotionEvent
 A function object called whenever an attached render view receives a mouse-motion event. More...
 
Function< Bool(RenderView &renderView, const MouseWheelEvent &event)> mouseWheelEvent
 A function object called whenever an attached render view receives a mouse-wheel event. More...
 
UserData data
 An object that stores an opaque pointer to delegate data. More...
 

Detailed Description

A class that contains function objects that recieve RenderView events.

Any render-view-related event that might be processed has an appropriate callback function object. Each callback function is called by the button whenever such an event is received. If a callback function in the delegate is not initialized, a render view simply ignores it.

Member Data Documentation

Function<void ( RenderView& renderView, Float dt )> om::graphics::gui::objects::RenderView::Delegate::update

A function object that is called whenever a render view's internal state is updated.

A render view calls this method when its update() method is called, allowing the user to perform any logic updates for the specified time interval which are needed for the RenderView.

Function<Bool ( RenderView& renderView, GUIRenderer& renderer, const AABB3f& localBounds, const Viewport& viewport )> om::graphics::gui::objects::RenderView::Delegate::render

A function object that is called whenever a render view's display should update.

A render view calls this method when the view area should be drawn. The view provides a GUI renderer to render child objects, the local box where the view should be drawn, and the screen-space viewport that that area covers.

The delegate function should return whether or not it successfully rendered anything to the specified viewport.

Function<Bool ( RenderView& renderView, const GUIEvent& event )> om::graphics::gui::objects::RenderView::Delegate::guiEvent

A function object called whenever an attached render view receives a GUI event.

Function<Bool ( RenderView& renderView, const TextEvent& event )> om::graphics::gui::objects::RenderView::Delegate::textEvent

A function object called whenever an attached render view receives text input.

Function<Bool ( RenderView& renderView, const KeyEvent& event )> om::graphics::gui::objects::RenderView::Delegate::keyEvent

A function object called whenever an attached render view receives a keyboard event.

Function<Bool ( RenderView& renderView, const MouseButtonEvent& event )> om::graphics::gui::objects::RenderView::Delegate::mouseButtonEvent

A function object called whenever an attached render view receives a mouse-button event.

Function<Bool ( RenderView& renderView, const MouseMotionEvent& event )> om::graphics::gui::objects::RenderView::Delegate::mouseMotionEvent

A function object called whenever an attached render view receives a mouse-motion event.

Function<Bool ( RenderView& renderView, const MouseWheelEvent& event )> om::graphics::gui::objects::RenderView::Delegate::mouseWheelEvent

A function object called whenever an attached render view receives a mouse-wheel event.

UserData om::graphics::gui::objects::RenderView::Delegate::data

An object that stores an opaque pointer to delegate data.


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