Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   File Members   Related Pages  

Ogre::FrameTimeControllerValue Class Reference

Predefined controller value for getting the latest frame time. More...

#include <OgrePredefinedControllers.h>

Inheritance diagram for Ogre::FrameTimeControllerValue:

Ogre::ControllerValue Ogre::FrameListener List of all members.

Public Methods

 FrameTimeControllerValue ()
bool frameEnded (const FrameEvent &evt)
 Called just after a frame has been rendered. More...

bool frameStarted (const FrameEvent &evt)
 Called when a frame is about to begin rendering. More...

Real getValue (void)
void setValue (Real value)
Real getTimeFactor (void)
void setTimeFactor (Real tf)

Protected Attributes

Real mFrameTime
Real mTimeFactor

Detailed Description

Predefined controller value for getting the latest frame time.


Constructor & Destructor Documentation

Ogre::FrameTimeControllerValue::FrameTimeControllerValue (    ) 
 


Member Function Documentation

bool Ogre::FrameTimeControllerValue::frameEnded (  const FrameEvent &    evt )  [virtual]
 

Called just after a frame has been rendered.

Returns:
True to continue with the next frame, false to drop out of the rendering loop.

Reimplemented from Ogre::FrameListener.

bool Ogre::FrameTimeControllerValue::frameStarted (  const FrameEvent &    evt )  [virtual]
 

Called when a frame is about to begin rendering.

Returns:
True to go ahead, false to abort rendering and drop out of the rendering loop.

Reimplemented from Ogre::FrameListener.

Real Ogre::FrameTimeControllerValue::getTimeFactor (  void    ) 
 

Real Ogre::FrameTimeControllerValue::getValue (  void    )  [virtual]
 

Implements Ogre::ControllerValue.

void Ogre::FrameTimeControllerValue::setTimeFactor (  Real    tf ) 
 

void Ogre::FrameTimeControllerValue::setValue (  Real    value )  [virtual]
 

Implements Ogre::ControllerValue.


Member Data Documentation

Real Ogre::FrameTimeControllerValue::mFrameTime [protected]
 

Real Ogre::FrameTimeControllerValue::mTimeFactor [protected]
 

Copyright © 2002 by The OGRE Team