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

Safe HaskellSafe-Infered

HGamer3D.Bindings.Ogre.ClassAnimationState

Synopsis

Documentation

newSource

Arguments

:: String

animName

-> HG3DClass

parent

-> Float

timePos

-> Float

length

-> Float

weight

-> Bool

enabled

-> IO HG3DClass 

Normal constructor with all params supplied.

deleteSource

Arguments

:: HG3DClass

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

-> IO () 

Gets the name of the animation to which this state applies.

Destructor - is here because class has virtual functions and some compilers would whine if it won't exist.

getAnimationNameSource

Arguments

:: HG3DClass

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

-> IO String 

getTimePositionSource

Arguments

:: HG3DClass

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

-> IO Float 

Gets the time position for this animation.

setTimePositionSource

Arguments

:: HG3DClass

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

-> Float

timePos

-> IO () 

Gets the total length of this animation (may be shorter than whole animation)

Sets the time position for this animation.

getLengthSource

Arguments

:: HG3DClass

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

-> IO Float 

setLengthSource

Arguments

:: HG3DClass

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

-> Float

len

-> IO () 

Gets the weight (influence) of this animation.

Sets the total length of this animation (may be shorter than whole animation)

getWeightSource

Arguments

:: HG3DClass

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

-> IO Float 

setWeightSource

Arguments

:: HG3DClass

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

-> Float

weight

-> IO () 

Modifies the time position, adjusting for animation length This method loops at the edges if animation looping is enabled.

Sets the weight (influence) of this animation.

addTimeSource

Arguments

:: HG3DClass

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

-> Float

offset

-> IO () 

Returns true if the animation has reached the end and is not looping.

hasEndedSource

Arguments

:: HG3DClass

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

-> IO Bool 

getEnabledSource

Arguments

:: HG3DClass

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

-> IO Bool 

Returns true if this animation is currently enabled.

setEnabledSource

Arguments

:: HG3DClass

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

-> Bool

enabled

-> IO () 

Sets whether or not an animation loops at the start and end of the animation if the time continues to be altered.

Sets whether this animation is enabled.

setLoopSource

Arguments

:: HG3DClass

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

-> Bool

loop

-> IO () 

Gets whether or not this animation loops.

getLoopSource

Arguments

:: HG3DClass

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

-> IO Bool 

copyStateFromSource

Arguments

:: HG3DClass

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

-> HG3DClass

animState - Reference to animation state which will use as source.

-> IO () 

Get the parent animation state set.

Copies the states from another animation state, preserving the animation name (unlike operator=) but copying everything else.

getParentSource

Arguments

:: HG3DClass

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

-> IO HG3DClass 

createBlendMaskSource

Arguments

:: HG3DClass

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

-> Int

blendMaskSizeHint

-> Float

initialWeight

-> IO () 

destroy the currently set blend mask

create a new blend mask with the given number of entries - Details: In addition to assigning a single weight value to a skeletal animation, it may be desirable to assign animation weights per bone using a 'blend mask'.

destroyBlendMaskSource

Arguments

:: HG3DClass

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

-> IO () 

return whether there is currently a valid blend mask set

hasBlendMaskSource

Arguments

:: HG3DClass

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

-> IO Bool 

setBlendMaskEntrySource

Arguments

:: HG3DClass

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

-> Int

boneHandle

-> Float

weight

-> IO () 

get the weight for the bone identified by the given handle

set the weight for the bone identified by the given handle

getBlendMaskEntrySource

Arguments

:: HG3DClass

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

-> Int

boneHandle

-> IO Float