OGRE  1.12.12
Object-Oriented Graphics Rendering Engine
Ogre::ImGuiOverlay Class Reference

#include <OgreImGuiOverlay.h>

+ Inheritance diagram for Ogre::ImGuiOverlay:

Public Member Functions

 ImGuiOverlay ()
 
 ~ImGuiOverlay ()
 
void _findVisibleObjects (Camera *cam, RenderQueue *queue, Viewport *vp)
 Internal method to put the overlay contents onto the render queue. More...
 
ImFont * addFont (const String &name, const String &group=RGN_DEFAULT)
 add font from ogre .fontdef file must be called before first show() More...
 
- Public Member Functions inherited from Ogre::Overlay
 Overlay (const String &name)
 Constructor: do not call direct, use OverlayManager::create. More...
 
virtual ~Overlay ()
 
void _getWorldTransforms (Matrix4 *xform) const
 Used to transform the overlay when scrolling, scaling etc. More...
 
void _notifyOrigin (const String &origin)
 Notify this overlay of it's origin. More...
 
void add2D (OverlayContainer *cont)
 Adds a 2D 'container' to the overlay. More...
 
void add3D (SceneNode *node)
 Adds a node capable of holding 3D objects to the overlay. More...
 
void clear ()
 Clears the overlay of all attached items. More...
 
virtual OverlayElementfindElementAt (Real x, Real y)
 This returns a OverlayElement at position x,y. More...
 
const OverlayContainerListget2DElements () const
 Returns all 2D elements in this manager. More...
 
OverlayContainergetChild (const String &name)
 
const StringgetName (void) const
 Gets the name of this overlay. More...
 
const StringgetOrigin (void) const
 Get the origin of this overlay, e.g. More...
 
const RadiangetRotate (void) const
 Gets the rotation applied to this overlay, in degrees. More...
 
Real getScaleX (void) const
 Gets the current X scale value. More...
 
Real getScaleY (void) const
 Gets the current Y scale value. More...
 
Real getScrollX (void) const
 Gets the current X scroll value. More...
 
Real getScrollY (void) const
 Gets the current Y scroll value. More...
 
ushort getZOrder (void) const
 Gets the Z-order of this overlay. More...
 
void hide (void)
 Hides the overlay if it was visible. More...
 
bool isInitialised (void) const
 Gets whether the overlay is initialised or not. More...
 
bool isVisible (void) const
 Gets whether the overlay is displayed or not. More...
 
void remove2D (OverlayContainer *cont)
 Removes a 2D container from the overlay. More...
 
void remove3D (SceneNode *node)
 Removes a 3D element from the overlay. More...
 
void rotate (const Radian &angle)
 Adds the passed in angle to the rotation applied to this overlay. More...
 
void scroll (Real xoff, Real yoff)
 Scrolls the overlay by the offsets provided. More...
 
void setRotate (const Radian &angle)
 Sets the rotation applied to this overlay. More...
 
void setScale (Real x, Real y)
 Sets the scaling factor of this overlay. More...
 
void setScroll (Real x, Real y)
 Sets the scrolling factor of this overlay. More...
 
void setVisible (bool visible)
 Shows or hides this overlay. More...
 
void setZOrder (ushort zorder)
 Alters the Z-order of this overlay. More...
 
void show (void)
 Shows the overlay if it was hidden. More...
 

Static Public Member Functions

static void NewFrame ()
 
static void NewFrame (const FrameEvent &evt)
 

Additional Inherited Members

- Public Types inherited from Ogre::Overlay
typedef std::list< OverlayContainer * > OverlayContainerList
 

Constructor & Destructor Documentation

◆ ImGuiOverlay()

Ogre::ImGuiOverlay::ImGuiOverlay ( )

◆ ~ImGuiOverlay()

Ogre::ImGuiOverlay::~ImGuiOverlay ( )

Member Function Documentation

◆ addFont()

ImFont* Ogre::ImGuiOverlay::addFont ( const String name,
const String group = RGN_DEFAULT 
)

add font from ogre .fontdef file must be called before first show()

◆ NewFrame() [1/2]

static void Ogre::ImGuiOverlay::NewFrame ( )
static

◆ NewFrame() [2/2]

static void Ogre::ImGuiOverlay::NewFrame ( const FrameEvent evt)
inlinestatic

References NewFrame().

Referenced by NewFrame().

◆ _findVisibleObjects()

void Ogre::ImGuiOverlay::_findVisibleObjects ( Camera cam,
RenderQueue queue,
Viewport vp 
)
virtual

Internal method to put the overlay contents onto the render queue.

Reimplemented from Ogre::Overlay.


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