HGamer3D.Bindings.Ogre.ClassControllerManager

Documentation

new

Arguments

:: IO HG3DClass

delete

Arguments

:: HG3DClass

classpointer - pointer of Class instance which is going to be deleted.

-> IO ()

Destroys all the controllers in existence.

clearControllers

Arguments

:: HG3DClass

classpointer - pointer of Class instance from which this methods is called.

-> IO ()

Updates all the registered controllers.

updateAllControllers

Arguments

:: HG3DClass

classpointer - pointer of Class instance from which this methods is called.

-> IO ()

Return relative speed of time as perceived by time based controllers. See setTimeFactor for full information on the meaning of this value.

getTimeFactor

Arguments

:: HG3DClass

classpointer - pointer of Class instance from which this methods is called.

-> IO Float

setTimeFactor

Arguments

:: HG3DClass

classpointer - pointer of Class instance from which this methods is called.

-> Float

tf - The virtual speed of time (1.0 is real time).

-> IO ()

Gets the constant that is added to time lapsed between each frame. See setFrameDelay for full information on the meaning of this value.

Set the relative speed to update frame time based controllers. Normally any controllers which use time as an input (FrameTimeController) are updated automatically in line with the real passage of time. This method allows you to change that, so that controllers are told that the time is passing slower or faster than it actually is. Use this to globally speed up / slow down the effect of time-based controllers.

getFrameDelay

Arguments

:: HG3DClass

classpointer - pointer of Class instance from which this methods is called.

-> IO Float

setFrameDelay

Arguments

:: HG3DClass

classpointer - pointer of Class instance from which this methods is called.

-> Float

fd - The delay in seconds wanted between each frame (1.0f / 25.0f means a seconds worth of animation is done in 25 frames).

-> IO ()

Return the elapsed time. See setElapsedTime for full information on the meaning of this value.

Sets a constant frame rate. This function is useful when rendering a sequence to files that should create a film clip with constant frame rate. It will ensure that scrolling textures and animations move at a constant frame rate.

getElapsedTime

Arguments

:: HG3DClass

classpointer - pointer of Class instance from which this methods is called.

-> IO Float

setElapsedTime

Arguments

:: HG3DClass

classpointer - pointer of Class instance from which this methods is called.

-> Float

elapsedTime - The new elapsed time

-> IO ()

Override standard Singleton retrieval. Why do we do this? Well, it's because the Singleton implementation is in a .h file, which means it gets compiled into anybody who includes it. This is needed for the Singleton template to work, but we actually only want it compiled into the implementation of the class based on the Singleton, not all of them. If we don't change this, we get link errors when trying to use the Singleton-based class from an outside dll. This method just delegates to the template version anyway, but the implementation stays in this single compilation unit, preventing link errors.

Set the elapsed time. Normally elapsed time accumulated all frames time (which speed relative to time factor) since the rendering loop started. This method allows your to change that to special time, so some elapsed-time-based globally effect is repeatable.

getSingletonPtr

Arguments

:: IO HG3DClass

new'_ :: HG3DClassPtr -> IO ()

delete'_ :: HG3DClassPtr -> IO ()

clearControllers'_ :: HG3DClassPtr -> IO ()

updateAllControllers'_ :: HG3DClassPtr -> IO ()

getTimeFactor'_ :: HG3DClassPtr -> Ptr CFloat -> IO ()

setTimeFactor'_ :: HG3DClassPtr -> CFloat -> IO ()

getFrameDelay'_ :: HG3DClassPtr -> Ptr CFloat -> IO ()

setFrameDelay'_ :: HG3DClassPtr -> CFloat -> IO ()

getElapsedTime'_ :: HG3DClassPtr -> Ptr CFloat -> IO ()

setElapsedTime'_ :: HG3DClassPtr -> CFloat -> IO ()

getSingletonPtr'_ :: HG3DClassPtr -> IO ()