HGamer3D-Ogre-Binding-0.1.8: Library to enable 3D game development for Haskell - Ogre Bindings

Safe HaskellSafe-Infered

HGamer3D.Bindings.Ogre.ClassRenderable

Synopsis

Documentation

deleteSource

Arguments

:: HG3DClass

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

-> IO () 

Virtual destructor needed as class has virtual methods.

getMaterialSource

Arguments

:: HG3DClass

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

-> IO SharedPtr 

Retrieves a weak reference to the material this renderable object uses. Note that the Renderable

preRenderSource

Arguments

:: HG3DClass

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

-> HG3DClass

sm

-> HG3DClass

rsys

-> IO Bool

return value - true if the automatic render should proceed, false to skip it on the assumption that the

Called just prior to the RenderableOGRE is a queued renderer, so the actual render commands are executed at a later time than the point at which an object is discovered to be visible. This allows ordering & grouping of renders without the discovery process having to be aware of it. It also means OGRE uses declarative render information rather than immediate mode rendering - this is very useful in that certain effects and processes can automatically be applied to a wide range of scenes, but the downside is that special cases are more difficult to handle, because there is not the declared state to cope with it. This method allows a RenderableRenderableRenderable

postRenderSource

Arguments

:: HG3DClass

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

-> HG3DClass

sm

-> HG3DClass

rsys

-> IO () 

Returns the number of world transform matrices this renderable requires. When a renderable uses vertex blending, it uses multiple world matrices instead of a single one. Each vertex sent to the pipeline can reference one or more matrices in this list with given weights. If a renderable does not use vertex blending this method returns 1, which is the default for simplicity.

Called immediately after the Renderable

getNumWorldTransformsSource

Arguments

:: HG3DClass

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

-> IO Int 

setUseIdentityProjectionSource

Arguments

:: HG3DClass

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

-> Bool

useIdentityProjection

-> IO () 

Returns whether or not to use an identity projection. Usually RenderableRenderable::setUseIdentityProjection

Sets whether or not to use an identity projection. Usually RenderableRenderable::getUseIdentityProjection

getUseIdentityProjectionSource

Arguments

:: HG3DClass

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

-> IO Bool 

setUseIdentityViewSource

Arguments

:: HG3DClass

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

-> Bool

useIdentityView

-> IO () 

Returns whether or not to use an identity view. Usually RenderableRenderable::setUseIdentityView

Sets whether or not to use an identity view. Usually RenderableRenderable::getUseIdentityView

getUseIdentityViewSource

Arguments

:: HG3DClass

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

-> IO Bool 

getSquaredViewDepthSource

Arguments

:: HG3DClass

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

-> HG3DClass

cam

-> IO Float 

Returns the camera-relative squared depth of this renderable. Used to sort transparent objects. Squared depth is used rather than actual depth to avoid having to perform a square root on the result.

getCastsShadowsSource

Arguments

:: HG3DClass

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

-> IO Bool 

Method which reports whether this renderable would normally cast a shadow. Subclasses should override this if they could have been used to generate a shadow.

setPolygonModeOverrideableSource

Arguments

:: HG3DClass

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

-> Bool

override - true means that a lower camera detail will override this renderables detail level, false means it won't.

-> IO () 

Gets whether this renderable's chosen detail level can be overridden (downgraded) by the camera setting.

Sets whether this renderable's chosen detail level can be overridden (downgraded) by the camera setting.

getPolygonModeOverrideableSource

Arguments

:: HG3DClass

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

-> IO Bool