net.stemkoski.bagel

Class ActionFactory

java.lang.Object

net.stemkoski.bagel.ActionFactory

public class ActionFactory
extends java.lang.Object

A factory class for creating Action objects.

Constructor Summary

Constructors

Constructor and Description
ActionFactory()

Method Summary

Modifier and Type	Method and Description
static Action	boundToScreen(double screenWidth, double screenHeight) Create an Action that automatically calls Sprite.boundToScreen(double, double).
static Action	delay(double duration) Create an Action that waits for a specified amount of time.
static Action	destroyOutsideScreen(double screenWidth, double screenHeight) Create an Action that removes a Sprite if no portion of the Sprite remains within the screen boundaries.
static Action	fadeIn(double fadeRate) Create an Action to fade in (increase opacity of) a Sprite over a period of time.
static Action	fadeOut(double fadeRate) Create an Action to fade out (reduce opacity of) a Sprite over a period of time.
static Action	forever(Action action) Create an Action that repeats another Action forever.
static Action	moveBy(double deltaX, double deltaY, double duration) Create an Action to move a Sprite by a fixed amount over a period of time.
static Action	remove() Create an Action that automatically removes a Sprite.
static Action	repeat(Action action, int totalTimes) Create an Action that repeats another Action a fixed number of times.
static Action	rotateBy(double deltaAngle, double duration) Create an Action to rotate a Sprite by a fixed amount over a period of time.
static Action	sequence(Action... actions) Create an Action to perform a sequence of actions.
static Action	wrapToScreen(double screenWidth, double screenHeight) Create an Action that automatically calls Sprite.wrapToScreen(double, double).

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ActionFactory

public ActionFactory()

Method Detail

moveBy

public static Action moveBy(double deltaX,
                            double deltaY,
                            double duration)

Create an Action to move a Sprite by a fixed amount over a period of time.
This Action is complete once movement has finished.

Parameters:

deltaX - distance to move Sprite in the x-direction

deltaY - distance to move Sprite in the y-direction

duration - total time to be used for movement

Returns:

Action to move a Sprite by a fixed amount over a period of time.

rotateBy

public static Action rotateBy(double deltaAngle,
                              double duration)

Create an Action to rotate a Sprite by a fixed amount over a period of time.
This Action is complete once rotation has finished.

Parameters:

deltaAngle - angle to rotate Sprite

duration - total time to be used for movement

Returns:

Action to rotate a Sprite by a fixed amount over a period of time

fadeOut

public static Action fadeOut(double fadeRate)

Create an Action to fade out (reduce opacity of) a Sprite over a period of time.
To automatically remove a Sprite once it has finished fading out, use:
ActionFactory.sequence( ActionFactory.fadeOut(fadeRate), ActionFactory,remove() )
This Action is complete once the Sprite's opacity reaches 0.

Parameters:

fadeRate - amount to reduce opacity by per second

Returns:

Action to fade out a Sprite over a period of time

fadeIn

public static Action fadeIn(double fadeRate)

Create an Action to fade in (increase opacity of) a Sprite over a period of time.
This Action is complete once the Sprite's opacity reaches 1.

Parameters:

fadeRate - amount to increase opacity by per second

Returns:

Action to fade in a Sprite over a period of time

sequence

public static Action sequence(Action... actions)

Create an Action to perform a sequence of actions. Each Action in the list is performed only after all previous actions in the list have completed.
This Action is complete once all the corresponding actions are complete.

Parameters:

actions - one or more actions to perform in sequence

Returns:

Action to perform a sequence of actions

repeat

public static Action repeat(Action action,
                            int totalTimes)

Create an Action that repeats another Action a fixed number of times.
This Action is complete once the specified Action has been completed the specified number of times.

Parameters:

action - Action to be repeated

totalTimes - total number of times to repeat the specified Action

Returns:

Action that repeats another Action a fixed number of times

forever

public static Action forever(Action action)

Create an Action that repeats another Action forever.
This Action is never complete.

Parameters:

action - Action to be repeated

Returns:

Action that repeats another Action forever

delay

public static Action delay(double duration)

Create an Action that waits for a specified amount of time. This is typically used in conjunction with sequence(Action...).
This Action is complete once the specified amount of time passes.

Parameters:

duration - amount of time to wait

Returns:

Action that waits for a specified amount of time

remove

public static Action remove()

Create an Action that automatically removes a Sprite.
This Action is complete immediately.

Returns:

Action that automatically removes a Sprite

boundToScreen

public static Action boundToScreen(double screenWidth,
                                   double screenHeight)

Create an Action that automatically calls Sprite.boundToScreen(double, double).
This Action is never completed.

Parameters:

screenWidth - width of screen

screenHeight - height of screen

Returns:

Action that automatically calls Sprite.boundToScreen(double, double).

wrapToScreen

public static Action wrapToScreen(double screenWidth,
                                  double screenHeight)

Create an Action that automatically calls Sprite.wrapToScreen(double, double).
This Action is never completed.

Parameters:

screenWidth - width of screen

screenHeight - height of screen

Returns:

Action that automatically calls Sprite.wrapToScreen(double, double).

destroyOutsideScreen

public static Action destroyOutsideScreen(double screenWidth,
                                          double screenHeight)

Create an Action that removes a Sprite if no portion of the Sprite remains within the screen boundaries.
This Action is complete if the Sprite is removed from the screen.

Parameters:

screenWidth - width of screen

screenHeight - height of screen

Returns:

Action that removes an object if no portion of the object remains within the screen boundaries