HGamer3D.Bindings.Ogre.ClassBillboardChain

Documentation

delete

Arguments

:: HG3DClass

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

-> IO ()

destructor

setMaxChainElements

Arguments

:: HG3DClass

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

-> Int

maxElements

-> IO ()

Get the maximum number of chain elements per chain

Set the maximum number of chain elements per chain

getMaxChainElements

Arguments

:: HG3DClass

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

-> IO Int

setNumberOfChains

Arguments

:: HG3DClass

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

-> Int

numChains

-> IO ()

Get the number of chain segments (this class can render multiple chains

Set the number of chain segments (this class can render multiple chains at once using the same material).

getNumberOfChains

Arguments

:: HG3DClass

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

-> IO Int

Sets whether texture coordinate information should be included in the final buffers generated. You must use either texture coordinates or vertex colour since the vertices have no normals and without one of these there is no source of colour for the vertices.

setUseTextureCoords

Arguments

:: HG3DClass

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

-> Bool

use

-> IO ()

Gets whether texture coordinate information should be included in the final buffers generated.

getUseTextureCoords

Arguments

:: HG3DClass

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

-> IO Bool

setTextureCoordDirection

Arguments

:: HG3DClass

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

-> EnumBillboardChainTexCoordDirection

dir - The direction, default is TCD_U.

-> IO ()

Gets the direction in which texture coords specified on each element are deemed to run.

Sets the direction in which texture coords specified on each element are deemed to run along the length of the chain.

getTextureCoordDirection

Arguments

:: HG3DClass

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

-> IO EnumBillboardChainTexCoordDirection

setOtherTextureCoordRange

Arguments

:: HG3DClass

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

-> Float

start - Start coordinate, default 0.0

-> Float

end - End coordinate, default 1.0

-> IO ()

Sets whether vertex colour information should be included in the final buffers generated. You must use either texture coordinates or vertex colour since the vertices have no normals and without one of these there is no source of colour for the vertices.

Set the range of the texture coordinates generated across the width of the chain elements.

setUseVertexColours

Arguments

:: HG3DClass

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

-> Bool

use

-> IO ()

Gets whether vertex colour information should be included in the final buffers generated.

getUseVertexColours

Arguments

:: HG3DClass

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

-> IO Bool

setDynamic

Arguments

:: HG3DClass

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

-> Bool

dyn

-> IO ()

Gets whether or not the buffers created for this object are suitable for dynamic alteration.

Sets whether or not the buffers created for this object are suitable for dynamic alteration.

getDynamic

Arguments

:: HG3DClass

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

-> IO Bool

removeChainElement

Arguments

:: HG3DClass

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

-> Int

chainIndex - The index of the chain

-> IO ()

Returns the number of chain elements.

Remove an element from the tail of a chain.

getNumChainElements

Arguments

:: HG3DClass

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

-> Int

chainIndex

-> IO Int

clearChain

Arguments

:: HG3DClass

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

-> Int

chainIndex

-> IO ()

Remove all elements from all chains (but leave the chains themselves intact).

Remove all elements of a given chain (but leave the chain intact).

clearAllChains

Arguments

:: HG3DClass

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

-> IO ()

Sets whether the billboard should always be facing the camera or a custom direction set by each point element. Billboards facing the camera are useful for smoke trails, light beams, etc by simulating a cylinder. However, because of this property, wide trails can cause several artefacts unless the head is properly covered. Therefore, non-camera-facing billboards are much more convenient for leaving big trails of movement from thin objects, for example a sword swing as seen in many fighting games.

setFaceCamera

Arguments

:: HG3DClass

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

-> Bool

faceCamera - True to be always facing the camera (Default value: True)

-> Vec3

normalVector - Only used when faceCamera == false. Must be a non-zero vector. This vector is the point of reference for each point orientation. For example, if normalVector is Vector3::UNIT_Z, and the point's orientation is an identity matrix, the segment corresponding to that point will be facing towards UNIT_Z This vector is internally normalized.

-> IO ()

Get the material name in use.

getMaterialName

Arguments

:: HG3DClass

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

-> IO String

setMaterialName

Arguments

:: HG3DClass

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

-> String

name

-> String

groupName

-> IO ()

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.

Set the material name to use for rendering.

getSquaredViewDepth

Arguments

:: HG3DClass

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

-> HG3DClass

cam

-> IO Float

Retrieves the radius of the origin-centered bounding sphere for this object.

getBoundingRadius

Arguments

:: HG3DClass

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

-> IO Float

getMaterial

Arguments

:: HG3DClass

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

-> IO SharedPtr

Returns the type name of this object.

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

getMovableType

Arguments

:: HG3DClass

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

-> IO String

preRender

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 Renderable being rendered. OGRE 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

delete'_ :: HG3DClassPtr -> IO ()

setMaxChainElements'_ :: HG3DClassPtr -> CInt -> IO ()

getMaxChainElements'_ :: HG3DClassPtr -> Ptr CInt -> IO ()

setNumberOfChains'_ :: HG3DClassPtr -> CInt -> IO ()

getNumberOfChains'_ :: HG3DClassPtr -> Ptr CInt -> IO ()

setUseTextureCoords'_ :: HG3DClassPtr -> CInt -> IO ()

getUseTextureCoords'_ :: HG3DClassPtr -> Ptr CInt -> IO ()

setTextureCoordDirection'_ :: HG3DClassPtr -> CInt -> IO ()

getTextureCoordDirection'_ :: HG3DClassPtr -> Ptr CInt -> IO ()

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

setUseVertexColours'_ :: HG3DClassPtr -> CInt -> IO ()

getUseVertexColours'_ :: HG3DClassPtr -> Ptr CInt -> IO ()

setDynamic'_ :: HG3DClassPtr -> CInt -> IO ()

getDynamic'_ :: HG3DClassPtr -> Ptr CInt -> IO ()

removeChainElement'_ :: HG3DClassPtr -> CInt -> IO ()

getNumChainElements'_ :: HG3DClassPtr -> CInt -> Ptr CInt -> IO ()

clearChain'_ :: HG3DClassPtr -> CInt -> IO ()

clearAllChains'_ :: HG3DClassPtr -> IO ()

setFaceCamera'_ :: HG3DClassPtr -> CInt -> Vec3Ptr -> IO ()

getMaterialName'_ :: HG3DClassPtr -> Ptr CChar -> IO ()

setMaterialName'_ :: HG3DClassPtr -> Ptr CChar -> Ptr CChar -> IO ()

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

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

getMaterial'_ :: HG3DClassPtr -> SharedPtrPtr -> IO ()

getMovableType'_ :: HG3DClassPtr -> Ptr CChar -> IO ()

preRender'_ :: HG3DClassPtr -> HG3DClassPtr -> HG3DClassPtr -> Ptr CInt -> IO ()