net.middlemind.MmgGameApiJava.MmgBase

Class MmgPulse

java.lang.Object

net.middlemind.MmgGameApiJava.MmgBase.MmgPulse

public class MmgPulse
extends java.lang.Object

Class that represents a pulse or changing value. Created on June 1, 2005, 10:57 PM by Middlemind Games Created by Middlemind Games

Constructor Summary

Constructors

Constructor and Description
MmgPulse(int startDir, long totalMs, double chng, MmgVector2 blS) Constructor that sets the start direction, the total milliseconds, the change, and a baseline scaling value.

Method Summary

Modifier and Type	Method and Description
double	GetChange() Gets the rate of change.
int	GetDirection() Gets the direction of the oscillation.
long	GetTimeFlip() Gets the oscillation time flip for this object.
long	GetTimeStart() Gets the oscillation start time.
long	GetTimeTotal() Gets the total oscillation time.
void	SetChange(double c) Sets the rate of change.
void	SetDirection(int d) Sets the direction of the oscillation.
void	SetTimeFlip(long l) Sets the oscillation time flip for this object.
void	SetTimeStart(long l) Sets the oscillation start time.
void	SetTimeTotal(long l) Sets the total oscillation time.
void	Update(MmgVector2 v) Updates the current pulse state.

Methods inherited from class java.lang.Object

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

Constructor Detail

MmgPulse

public MmgPulse(int startDir,
                long totalMs,
                double chng,
                MmgVector2 blS)

Constructor that sets the start direction, the total milliseconds, the change, and a baseline scaling value.

Parameters:

startDir - The oscillation start direction.

totalMs - The total milliseconds to use for the entire oscillation.

chng - The change to apply to the object.

blS - A baseline scaling value.

Method Detail

GetDirection

public int GetDirection()

Gets the direction of the oscillation.

Returns:

The direction of the oscillation.

SetDirection

public void SetDirection(int d)

Sets the direction of the oscillation.

Parameters:

d - The direction of the oscillation.

GetTimeFlip

public long GetTimeFlip()

Gets the oscillation time flip for this object.

Returns:

The oscillation time flip.

SetTimeFlip

public void SetTimeFlip(long l)

Sets the oscillation time flip for this object.

Parameters:

l - The oscillation time flip.

GetTimeTotal

public long GetTimeTotal()

Gets the total oscillation time.

Returns:

The total oscillation time.

SetTimeTotal

public void SetTimeTotal(long l)

Sets the total oscillation time.

Parameters:

l - The total oscillation time.

GetTimeStart

public long GetTimeStart()

Gets the oscillation start time.

Returns:

The oscillation start time.

SetTimeStart

public void SetTimeStart(long l)

Sets the oscillation start time.

Parameters:

l - The oscillation start time.

GetChange

public double GetChange()

Gets the rate of change.

Returns:

The rate of change.

SetChange

public void SetChange(double c)

Sets the rate of change.

Parameters:

c - The rate of change.

Update

public void Update(MmgVector2 v)

Updates the current pulse state.

Parameters:

v - The current object position.