synergynet3.behaviours.networkflick

Class NetworkFlickAnimationElement

java.lang.Object

multiplicity3.csys.animation.elements.AnimationElement

synergynet3.behaviours.networkflick.NetworkFlickAnimationElement

public class NetworkFlickAnimationElement
extends AnimationElement

Repositions an item when flick using the JME animation system. Calculates trajectories when an item bounces off a display border and detects when an item should be transferred. Initiates network transfers when required.

Constructor Summary

Constructors

Constructor and Description
NetworkFlickAnimationElement(IItem item, IStage stage) Creates an animation element for the supplied item which can then create the flick motion by repositioning the managed item using JME's animation system.

Method Summary

Methods

Modifier and Type	Method and Description
void	bounce(float vX, float vY, float tpf, BehaviourUtilities.RelativePosition bouncePosition) Bounce.
void	elementStart(float tpf) Called on the first
float	getDeceleration() Gets the deceleration at which the managed item's momentum is reduced.
float	getMaxDimension() Uses the managed item's bounding box to find the largest of its width or height.
boolean	isFinished() When this method returns true, the animation element will be reset.
void	moveWithVelocity(com.jme3.math.Vector2f velocity) This method effectively initiates the flick of the managed item.
void	reset() Called when the animation element is finished.
void	setDeceleration(float deceleration) Sets the deceleration at which the managed item's momentum is reduced.
void	setMaxDimension(float maxDim) Sets the predetermined max dimension of the managed item.
void	updateAnimationState(float tpf) Called each frame in the game loop.

Methods inherited from class multiplicity3.csys.animation.elements.AnimationElement

enable, toString, updateState

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

NetworkFlickAnimationElement

public NetworkFlickAnimationElement(IItem item,
                            IStage stage)

Creates an animation element for the supplied item which can then create the flick motion by repositioning the managed item using JME's animation system.

Parameters:

item - The item to be influenced by this animation.

stage - The stage the item currently resides in.

Method Detail

bounce

public void bounce(float vX,
          float vY,
          float tpf,
          BehaviourUtilities.RelativePosition bouncePosition)

Bounce.

Parameters:

vX - the v x

vY - the v y

tpf - the tpf

bouncePosition - the bounce position

elementStart

public void elementStart(float tpf)

Description copied from class: AnimationElement

Called on the first

Specified by:

elementStart in class AnimationElement

getDeceleration

public float getDeceleration()

Gets the deceleration at which the managed item's momentum is reduced.

Returns:

A float representing the deceleration at which the managed item's momentum is reduced.

getMaxDimension

public float getMaxDimension()

Uses the managed item's bounding box to find the largest of its width or height. If the managed item does not have a bounding box then a predetermined value is used.

Returns:

A float representing the largest of the managed item's width or height.

isFinished

public boolean isFinished()

Description copied from class: AnimationElement

When this method returns true, the animation element will be reset.

Specified by:

isFinished in class AnimationElement

Returns:

moveWithVelocity

public void moveWithVelocity(com.jme3.math.Vector2f velocity)

This method effectively initiates the flick of the managed item.

Parameters:

velocity - The direction and momentum with which the managed item is to be flicked.

reset

public void reset()

Description copied from class: AnimationElement

Called when the animation element is finished. See isFinished()

Specified by:

reset in class AnimationElement

setDeceleration

public void setDeceleration(float deceleration)

Sets the deceleration at which the managed item's momentum is reduced.

Parameters:

drag - The deceleration at which the managed item's momentum is reduced.

setMaxDimension

public void setMaxDimension(float maxDim)

Sets the predetermined max dimension of the managed item. This is used for items which may not have a bounding box.

Parameters:

maxDim - The predetermined max dimension of the managed item

updateAnimationState

public void updateAnimationState(float tpf)

Description copied from class: AnimationElement

Called each frame in the game loop.

Specified by:

updateAnimationState in class AnimationElement