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

Safe HaskellSafe-Infered

HGamer3D.Bindings.Ogre.ClassBillboard

Synopsis

Documentation

newSource

Arguments

:: IO HG3DClass 

Default constructor.

deleteSource

Arguments

:: HG3DClass

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

-> IO () 

Get the rotation of the billboard. This rotation is relative to the center of the billboard.

Default destructor.

getRotationSource

Arguments

:: HG3DClass

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

-> IO Radians 

setRotationSource

Arguments

:: HG3DClass

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

-> Radians

rotation

-> IO () 

Set the position of the billboard. This position is relative to a point on the quad which is the billboard. Depending on the BillboardSetBillboardSet::setBillboardOrigin

Set the rotation of the billboard. This rotation is relative to the center of the billboard.

setPositionSource

Arguments

:: HG3DClass

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

-> Vec3

position

-> IO () 

Set the position of the billboard. This position is relative to a point on the quad which is the billboard. Depending on the BillboardSetBillboardSet::setBillboardOrigin

setPosition2Source

Arguments

:: HG3DClass

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

-> Float

x

-> Float

y

-> Float

z

-> IO () 

Get the position of the billboard. This position is relative to a point on the quad which is the billboard. Depending on the BillboardSetBillboardSet::setBillboardOrigin

getPositionSource

Arguments

:: HG3DClass

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

-> IO Vec3 

setDimensionsSource

Arguments

:: HG3DClass

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

-> Float

width

-> Float

height

-> IO () 

Resets this BillboardBillboardSet

Sets the width and height for this billboard. Note that it is most efficient for every billboard in a BillboardSetBillboardSet::setDefaultDimensions

resetDimensionsSource

Arguments

:: HG3DClass

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

-> IO () 

Sets the colour of this billboard. Billboards can be tinted based on a base colour. This allows variations in colour irrespective of the base colour of the material allowing more varied billboards. The default colour is white. The tinting is effected using vertex colours.

setColourSource

Arguments

:: HG3DClass

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

-> Colour

colour

-> IO () 

Gets the colour of this billboard.

getColourSource

Arguments

:: HG3DClass

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

-> IO Colour 

hasOwnDimensionsSource

Arguments

:: HG3DClass

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

-> IO Bool 

Returns true if this billboard deviates from the BillboardSetBillboard::setDimensionsBillboard::setDimensions

getOwnWidthSource

Arguments

:: HG3DClass

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

-> IO Float 

Retrieves the billboard's personal width, if hasOwnDimensions is true.

getOwnHeightSource

Arguments

:: HG3DClass

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

-> IO Float 

Retrieves the billboard's personal width, if hasOwnDimensions is true.

isUseTexcoordRectSource

Arguments

:: HG3DClass

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

-> IO Bool 

Returns true if this billboard use individual texture coordinate rect (i.e. if the Billboard::setTexcoordRectBillboardSetBillboard::setTexcoordIndexBillboard::setTexcoordIndex()Billboard::setTexcoordRect()

setTexcoordIndexSource

Arguments

:: HG3DClass

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

-> Int

texcoordIndex

-> IO () 

getTexcoordIndex()setTexcoordIndex()This value is useful only when isUseTexcoordRect return false.

setTexcoordIndex()BillboardSet::setTextureCoords()

getTexcoordIndexSource

Arguments

:: HG3DClass

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

-> IO Int 

setTexcoordRect2Source

Arguments

:: HG3DClass

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

-> Float

u0

-> Float

v0

-> Float

u1

-> Float

v1

-> IO () 

setTexcoordRect()