HGamer3D-Ogre-Binding-0.1.9: Windows Game Engine for the Haskell Programmer - Ogre Bindings

Safe HaskellNone

HGamer3D.Bindings.Ogre.ClassAnimationState

Synopsis

Documentation

newSource

Arguments

:: String

animName - The name of this state.

-> HG3DClass

parent - The parent AnimationStateSet that this state will belong to.

-> Float

timePos - The position, in seconds, where this state will begin.

-> Float

length - The length, in seconds, of this animation state.

-> Float

weight - Weight to apply the animation state with.

-> Bool

enabled - Whether the animation state is 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.

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 - The amount of time, in seconds, to extend the animation.

-> 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

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