org.pepsoft.worldpainter.gardenofeden

Class Seed

java.lang.Object

org.pepsoft.worldpainter.gardenofeden.Seed

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

Direct Known Subclasses:

PathNode

public abstract class Seed
extends java.lang.Object
implements java.io.Serializable, org.pepsoft.util.undo.Cloneable<Seed>

A seed for planting in a Garden for creating complex random structures that follow rules. A seed has a germination time, which is the number of ticks after planting when it will try to sprout. When it germinates it checks whether there is room to sprout and if so does so, optionally planting new seeds in the process.

Seeds may have parents and form a hierarchy, in which case parents will always sprout before children (and therefore children will not sprout if their parent hasn't), and parents will also be exported before their children during the export process.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Seed.Task

Field Summary

Fields

Modifier and Type	Field and Description
int	category
Garden	garden
javax.vecmath.Point3i	location
Seed	parent
long	seed

Constructor Summary

Constructors

Constructor and Description
Seed(Garden garden, long seed, Seed parent, javax.vecmath.Point3i location, int germinationTime, int category) Create a new seed.

Method Summary

Modifier and Type	Method and Description
void	buildFirstPass(Dimension dimension, Tile tile, Platform platform, MinecraftWorld minecraftWorld) Perform the first export pass.
void	buildSecondPass(Dimension dimension, Tile tile, Platform platform, MinecraftWorld minecraftWorld) Perform the second export pass.
Seed	clone()
protected void	doAlongLine(int x1, int y1, int x2, int y2, boolean stopWhenOccupied, Seed.Task task) Utility method for performing some arbitrary task along a straight line.
protected void	doAlongLine(int x1, int y1, int x2, int y2, boolean stopWhenOccupied, Seed.Task task, int every) Utility method for performing some arbitrary task at some interval along a straight line.
protected void	doAlongLine(int x1, int y1, int x2, int y2, int maxLength, Seed.Task task) Utility method for performing some arbitrary task along a straight line.
protected void	doAlongLine(int x1, int y1, int x2, int y2, int maxLength, Seed.Task task, int every) Utility method for performing some arbitrary task at some interval along a straight line.
protected void	doAlongLine(int x1, int y1, int x2, int y2, Seed.Task task) Utility method for performing some arbitrary task along a straight line, regardless of whether it is occupied or not.
protected void	doAlongLine(int x1, int y1, int x2, int y2, Seed.Task task, int every) Utility method for performing some arbitrary task at some interval along a straight line, regardless of whether it is occupied or not.
protected void	drawLine(int x1, int y1, int x2, int y2, int maxLength, int category) Utility method for setting the seed category on the garden along a straight line.
protected void	drawLine(javax.vecmath.Point3i location1, javax.vecmath.Point3i location2, int diameter, boolean stopWhenOccupied, int category) Utility method for setting the seed category on the garden along a straight line.
protected void	drawLine(javax.vecmath.Point3i location1, javax.vecmath.Point3i location2, int diameter, int maxLength, int category) Utility method for setting the seed category on the garden along a straight line.
protected void	drawLine(java.awt.Point location1, java.awt.Point location2, int category) Utility method for setting the seed category on the garden along a straight line, regardless of what is already there.
protected void	drawLine(java.awt.Point location1, java.awt.Point location2, int diameter, boolean stopWhenOccupied, int category) Utility method for setting the seed category on the garden along a straight line.
protected void	drawLine(java.awt.Point location1, java.awt.Point location2, int diameter, int maxLength, int category) Utility method for setting the seed category on the garden along a straight line.
boolean	equals(java.lang.Object obj)
protected void	fill(int x1, int y1, int width, int height, int category)
Garden	getGarden() Get the garden in which the seed is planted.
javax.vecmath.Point3i	getLocation() Get this seed's location.
Seed	getParent() Get this seed's parent, if any,
int	hashCode()
boolean	isFinished() Determine whether the seed is "alive", i.e.
boolean	isSprouted() Determine whether the seed has successfully sprouted.
void	neutralise() "Kill" the seed, i.e.
protected int	scanLine(int x1, int y1, int x2, int y2) Utility method for testing how much of a straight line is unoccupied.
protected abstract boolean	sprout() Try to sprout the seed.
void	tick() Tick the seed over.
void	transform(CoordinateTransform rotation) Transform the seed's location and rotation according to some coordinate transform.

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

location

public final javax.vecmath.Point3i location

garden

public transient Garden garden

parent

public final Seed parent

category

public final int category

seed

public final long seed

Constructor Detail

Seed

public Seed(Garden garden,
            long seed,
            Seed parent,
            javax.vecmath.Point3i location,
            int germinationTime,
            int category)

Create a new seed.

Parameters:

garden - The garden in which the seed will be planted.

seed - The random seed which it may use for seeding pseudo random number generators.

parent - The parent of this seed, if any. May be null.

location - The location of the seed. The z coordinate may be -1, meaning "on the surface", or it may be zero or higher to indicate a specific height.

germinationTime - The number of ticks after planting when the seed will germinate. If positive a random deviation will be applied. If negative it will be made positive without applying a random deviation.

category - The category of seed, as one of the CATEGORY_* constants in the GardenCategory class.

Method Detail

getGarden

public final Garden getGarden()

Get the garden in which the seed is planted.

Returns:

The garden in which the seed is planted.

getParent

public final Seed getParent()

Get this seed's parent, if any,

Returns:

This seed's parent, or null if it has none.

getLocation

public final javax.vecmath.Point3i getLocation()

Get this seed's location. The z coordinate may be -1, meaning "on the surface", or it may be zero or higher to indicate a specific height.

Returns:

This seed's location.

tick

public final void tick()

Tick the seed over. This involves determining whether it is time to sprout yet, and if so, attempt to sprout. It is time to sprout when the germination time has passed, and the parent (if it exits) has sprouted. If sprouting fails, the seed is removed from the garden.

isFinished

public final boolean isFinished()

Determine whether the seed is "alive", i.e. has not tried to sprout yet.

Returns:

true if the seed is dead, i.e. it has attempted to sprout, which either succeeded or failed.

isSprouted

public final boolean isSprouted()

Determine whether the seed has successfully sprouted.

Returns:

true if the seed has successfully sprouted.

neutralise

public final void neutralise()

"Kill" the seed, i.e. stop if from ever germinating.

buildFirstPass

public void buildFirstPass(Dimension dimension,
                           Tile tile,
                           Platform platform,
                           MinecraftWorld minecraftWorld)

Perform the first export pass. The seed may make what changes it wishes to the passed in Minecraft map. At this point the terrain has been rendered, all custom layers have been exported, and if the seed has a parent, its first (but not second) export pass has been executed.

For buildings it may be advantageous to export the exteriors in the first pass.

Parameters:

dimension - The dimension which is being exported.

tile - The tile which is being exported. Note that the seed does not have to constrain its changes to the area of the tile.

platform -

minecraftWorld - The Minecraft map to which the seed should export itself.

buildSecondPass

public void buildSecondPass(Dimension dimension,
                            Tile tile,
                            Platform platform,
                            MinecraftWorld minecraftWorld)

Perform the second export pass. The seed may make what changes it wishes to the passed in Minecraft map. At this point the terrain has been rendered, all custom layers have been exported, the first pass of all seeds has been executed, and if the seed has a parent, its second export pass has been executed.

For buildings it may be advantageous to export the interiors in the second pass.

Parameters:

dimension - The dimension which is being exported.

tile - The tile which is being exported. Note that the seed does not have to constrain its changes to the area of the tile.

platform -

minecraftWorld - The Minecraft map to which the seed should export itself.

transform

public void transform(CoordinateTransform rotation)

Transform the seed's location and rotation according to some coordinate transform.

Parameters:

rotation - The coordinate transform to apply to the seed's location and rotation.

clone

public Seed clone()

Overrides:

clone in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

sprout

protected abstract boolean sprout()

Try to sprout the seed. This may fail if not all conditions are met, such as if there is no space for it to sprout. Will only be invoked once, after the parent seed (if any) has sprouted and the germination time has elapsed. If it returns false, the seed will be considered to have died, and be removed from the garden automatically.

Returns:

true if the seed sprouted successfully, false if it could not sprout for whatever reason.

drawLine

protected final void drawLine(java.awt.Point location1,
                              java.awt.Point location2,
                              int diameter,
                              boolean stopWhenOccupied,
                              int category)

Utility method for setting the seed category on the garden along a straight line.

Parameters:

location1 - The start location of the line.

location2 - The end location of the line.

diameter - The thickness of the line.

stopWhenOccupied - Whether to stop drawing the line upon reaching a location which is already occupied.

category - The seed category with which to mark the line, as one of the CATEGORY_* constants in the GardenCategory class.

drawLine

protected final void drawLine(javax.vecmath.Point3i location1,
                              javax.vecmath.Point3i location2,
                              int diameter,
                              boolean stopWhenOccupied,
                              int category)

Utility method for setting the seed category on the garden along a straight line.

Parameters:

location1 - The start location of the line.

location2 - The end location of the line.

diameter - The thickness of the line.

stopWhenOccupied - Whether to stop drawing the line upon reaching a location which is already occupied.

category - The seed category with which to mark the line, as one of the CATEGORY_* constants in the GardenCategory class.

drawLine

protected final void drawLine(java.awt.Point location1,
                              java.awt.Point location2,
                              int diameter,
                              int maxLength,
                              int category)

Utility method for setting the seed category on the garden along a straight line.

Parameters:

location1 - The start location of the line.

location2 - The end location of the line.

diameter - The thickness of the line.

maxLength - The maximum lengh of the line. If this is shorter than the distance between location1 and location2, only the first maxLength blocks of the line will be painted.

category - The seed category with which to mark the line, as one of the CATEGORY_* constants in the GardenCategory class.

drawLine

protected final void drawLine(javax.vecmath.Point3i location1,
                              javax.vecmath.Point3i location2,
                              int diameter,
                              int maxLength,
                              int category)

Utility method for setting the seed category on the garden along a straight line.

Parameters:

location1 - The start location of the line.

location2 - The end location of the line.

diameter - The thickness of the line.

maxLength - The maximum lengh of the line. If this is shorter than the distance between location1 and location2, only the first maxLength blocks of the line will be painted.

category - The seed category with which to mark the line, as one of the CATEGORY_* constants in the GardenCategory class.

scanLine

protected final int scanLine(int x1,
                             int y1,
                             int x2,
                             int y2)

Utility method for testing how much of a straight line is unoccupied.

Parameters:

x1 - The X coordinate of the start of the line.

y1 - The Y coordinate of the start of the line.

x2 - The X coordinate of the end of the line.

y2 - The Y coordinate of the end of the line.

Returns:

The number of blocks along the line, from the start, that are unoccupied. Equal to the length of the line if it is entirely unoccupied. Note that if the start of the line is already occupied, that location is not counted as occupied, nor are any subsequent occupied locations until an unoccupied location is encountered.

drawLine

protected final void drawLine(int x1,
                              int y1,
                              int x2,
                              int y2,
                              int maxLength,
                              int category)

Utility method for setting the seed category on the garden along a straight line.

Parameters:

x1 - The X coordinate of the start of the line.

y1 - The Y coordinate of the start of the line.

x2 - The X coordinate of the end of the line.

y2 - The Y coordinate of the end of the line.

maxLength - The maximum lengh of the line. If this is shorter than the distance between location1 and location2, only the first maxLength blocks of the line will be painted.

category - The seed category with which to mark the line, as one of the CATEGORY_* constants in the GardenCategory class.

drawLine

protected final void drawLine(java.awt.Point location1,
                              java.awt.Point location2,
                              int category)

Utility method for setting the seed category on the garden along a straight line, regardless of what is already there.

Parameters:

location1 - The start location of the line.

location2 - The end location of the line.

category - The seed category with which to mark the line, as one of the CATEGORY_* constants in the GardenCategory class.

fill

protected final void fill(int x1,
                          int y1,
                          int width,
                          int height,
                          int category)

doAlongLine

protected final void doAlongLine(int x1,
                                 int y1,
                                 int x2,
                                 int y2,
                                 Seed.Task task)

Utility method for performing some arbitrary task along a straight line, regardless of whether it is occupied or not.

Parameters:

x1 - The X coordinate of the start of the line.

y1 - The Y coordinate of the start of the line.

x2 - The X coordinate of the end of the line.

y2 - The Y coordinate of the end of the line.

task - The task to perform at each loction along the specified line.

doAlongLine

protected final void doAlongLine(int x1,
                                 int y1,
                                 int x2,
                                 int y2,
                                 Seed.Task task,
                                 int every)

Utility method for performing some arbitrary task at some interval along a straight line, regardless of whether it is occupied or not.

Parameters:

x1 - The X coordinate of the start of the line.

y1 - The Y coordinate of the start of the line.

x2 - The X coordinate of the end of the line.

y2 - The Y coordinate of the end of the line.

task - The task to perform at each specified interval along the specified line.

every - The interval between performances of the specified task.

doAlongLine

protected final void doAlongLine(int x1,
                                 int y1,
                                 int x2,
                                 int y2,
                                 boolean stopWhenOccupied,
                                 Seed.Task task)

Utility method for performing some arbitrary task along a straight line.

Parameters:

x1 - The X coordinate of the start of the line.

y1 - The Y coordinate of the start of the line.

x2 - The X coordinate of the end of the line.

y2 - The Y coordinate of the end of the line.

stopWhenOccupied - Whether to stop performing the task upon reaching a location which is occupied.

task - The task to perform at each location along the specified line.

doAlongLine

protected final void doAlongLine(int x1,
                                 int y1,
                                 int x2,
                                 int y2,
                                 boolean stopWhenOccupied,
                                 Seed.Task task,
                                 int every)

Utility method for performing some arbitrary task at some interval along a straight line.

Parameters:

x1 - The X coordinate of the start of the line.

y1 - The Y coordinate of the start of the line.

x2 - The X coordinate of the end of the line.

y2 - The Y coordinate of the end of the line.

stopWhenOccupied - Whether to stop performing the task upon reaching a location which is occupied.

task - The task to perform at each specified interval along the specified line.

every - The interval between performances of the specified task.

doAlongLine

protected final void doAlongLine(int x1,
                                 int y1,
                                 int x2,
                                 int y2,
                                 int maxLength,
                                 Seed.Task task)

Utility method for performing some arbitrary task along a straight line.

Parameters:

x1 - The X coordinate of the start of the line.

y1 - The Y coordinate of the start of the line.

x2 - The X coordinate of the end of the line.

y2 - The Y coordinate of the end of the line.

maxLength - The maximum length for which to perform the task. If this is shorter than the distance between location1 and location2, the task will only be performed for the first maxLength blocks of the line.

task - The task to perform at each location along the specified line.

doAlongLine

protected final void doAlongLine(int x1,
                                 int y1,
                                 int x2,
                                 int y2,
                                 int maxLength,
                                 Seed.Task task,
                                 int every)

Utility method for performing some arbitrary task at some interval along a straight line.

Parameters:

x1 - The X coordinate of the start of the line.

y1 - The Y coordinate of the start of the line.

x2 - The X coordinate of the end of the line.

y2 - The Y coordinate of the end of the line.

maxLength - The maximum length for which to perform the task. If this is shorter than the distance between location1 and location2, the task will only be performed for the first maxLength blocks of the line.

task - The task to perform at each specified interval along the specified line.

every - The interval between performances of the specified task.