synergynet3.activitypack1.table.fishes.birdmodel

Class Flock

java.lang.Object

synergynet3.activitypack1.table.fishes.birdmodel.Flock

public class Flock
extends java.lang.Object

This class represents the group of all birds, predators and obstacles. It controls the coordinated movement of the birds and the detection, separation logic.

Version:

1.0

Author:

Michael LaLena

Field Summary

Fields

Modifier and Type	Field and Description
static int	DetectionRange The Detection range.
static int	SeparationRange The Separation range.

Constructor Summary

Constructors

Constructor and Description
Flock(BirdCollection birds) This is the flock contstructor.

Method Summary

Methods

Modifier and Type	Method and Description
void	addBird(Bird bird) Add a bird to the flock.
com.jme3.math.Vector2f	closestLocation(com.jme3.math.Vector2f p, com.jme3.math.Vector2f otherPoint) Sometimes, two birds are closer together if you go off one edge of the map and return on the other.
java.util.Vector<Bird>	move() Tells each Bird in the Vector to move in the direction of the generalHeading.
com.jme3.math.Vector2f	normalisePoint(com.jme3.math.Vector2f p, double n) Normalize a point.
void	setBirdParameters(java.awt.Color color, float speed, float theta) Set the settings for all birds of a given color.
void	setHunger(int hunger) Set the hunger value for all predators
double	sizeOfPoint(com.jme3.math.Vector2f p) Distance from the top left of the map to a given point
com.jme3.math.Vector2f	sumPoints(com.jme3.math.Vector2f p1, double w1, com.jme3.math.Vector2f p2, double w2) Add two points together, scaling both according to their weight

Methods inherited from class java.lang.Object

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

Field Detail

DetectionRange

public static int DetectionRange

The Detection range.

SeparationRange

public static int SeparationRange

The Separation range.

Constructor Detail

Flock

public Flock(BirdCollection birds)

This is the flock contstructor.

Method Detail

addBird

public void addBird(Bird bird)

Add a bird to the flock.

Parameters:

bird - The bird to add

closestLocation

public com.jme3.math.Vector2f closestLocation(com.jme3.math.Vector2f p,
                                     com.jme3.math.Vector2f otherPoint)

Sometimes, two birds are closer together if you go off one edge of the map and return on the other. This function will convert the "other point" into a point that closest to the point p, even if it is off the map.

Parameters:

p - The point to measure the distance to.

otherPoint - The point to measure the distance from.

move

public java.util.Vector<Bird> move()

Tells each Bird in the Vector to move in the direction of the generalHeading.

Returns:

A vector of birds that were removed. This is used to update the sliders for the number of birds still on the map.

normalisePoint

public com.jme3.math.Vector2f normalisePoint(com.jme3.math.Vector2f p,
                                    double n)

Normalize a point.

Parameters:

p - The point to normalize.

n - The normalization value.

setBirdParameters

public void setBirdParameters(java.awt.Color color,
                     float speed,
                     float theta)

Set the settings for all birds of a given color. Called either when the user changes a slider.

Parameters:

color - The color of the bird to remove

speed - The new speed of the bird

theta - The new theta of the bird

setHunger

public void setHunger(int hunger)

Set the hunger value for all predators

Parameters:

hunger - The new hunger value for all predators

sizeOfPoint

public double sizeOfPoint(com.jme3.math.Vector2f p)

Distance from the top left of the map to a given point

Parameters:

p - The point to measure the distance to.

sumPoints

public com.jme3.math.Vector2f sumPoints(com.jme3.math.Vector2f p1,
                               double w1,
                               com.jme3.math.Vector2f p2,
                               double w2)

Add two points together, scaling both according to their weight

Parameters:

p1 - The first point to add

w1 - The weight of the first poitn

p2 - The second point to add

w2 - The weight of the second point