org.pepsoft.worldpainter.layers.bo2

Class Bo2Object

java.lang.Object

org.pepsoft.worldpainter.objects.AbstractObject

org.pepsoft.worldpainter.layers.bo2.Bo2Object

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, Bo2ObjectProvider, WPObject

public final class Bo2Object
extends AbstractObject
implements Bo2ObjectProvider

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface org.pepsoft.worldpainter.objects.WPObject

WPObject.BlockVisitor

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	KEY_NEEDS_FOUNDATION
static java.lang.String	KEY_RANDOM_ROTATION
static java.lang.String	KEY_SPAWN_LAVA
static java.lang.String	KEY_SPAWN_WATER

Fields inherited from interface org.pepsoft.worldpainter.objects.WPObject

ATTRIBUTE_COLLISION_MODE, ATTRIBUTE_CONNECT_BLOCKS, ATTRIBUTE_EXTEND_FOUNDATION, ATTRIBUTE_FILE, ATTRIBUTE_FREQUENCY, ATTRIBUTE_HEIGHT_MODE, ATTRIBUTE_LEAF_DECAY_MODE, ATTRIBUTE_MANAGE_WATERLOGGED, ATTRIBUTE_NEEDS_FOUNDATION, ATTRIBUTE_OFFSET, ATTRIBUTE_RANDOM_MIRRORING_ONLY, ATTRIBUTE_RANDOM_ROTATION, ATTRIBUTE_RANDOM_ROTATION_ONLY, ATTRIBUTE_REPLACE_WITH_AIR, ATTRIBUTE_REPLACE_WITH_AIR_MATERIAL, ATTRIBUTE_SPAWN_IN_LAVA, ATTRIBUTE_SPAWN_IN_WATER, ATTRIBUTE_SPAWN_ON_LAND, ATTRIBUTE_SPAWN_ON_LAVA, ATTRIBUTE_SPAWN_ON_WATER, ATTRIBUTE_SPAWN_ON_WATER_NO_COLLIDE, ATTRIBUTE_UNDERGROUND_MODE, ATTRIBUTE_VERTICAL_OFFSET, ATTRIBUTE_Y_VARIATION, COLLISION_MODE_ALL, COLLISION_MODE_NONE, COLLISION_MODE_SOLID, HEIGHT_MODE_FIXED, HEIGHT_MODE_TERRAIN, LEAF_DECAY_NO_CHANGE, LEAF_DECAY_OFF, LEAF_DECAY_ON

Method Summary

Modifier and Type	Method and Description
Bo2Object	clone() Create a clone of the object.
java.util.List<WPObject>	getAllObjects() Obtain a list of all different WPObjects which this object provider can return.
java.util.Map<java.lang.String,java.io.Serializable>	getAttributes() Get a live view of the object metadata.
javax.vecmath.Point3i	getDimensions() Get the dimensions of the object.
java.util.List<Entity>	getEntities() Get any entities contained in the object.
boolean	getMask(int x, int y, int z) Determine whether a block should be placed at the specified relative coordinates.
Material	getMaterial(int x, int y, int z) Get the material to place at the specified relative coordinates.
java.lang.String	getName() Get the name of this object provider (if it represents one object this may be the name of the object).
Bo2Object	getObject() Obtain one WPObject, which may be the same one every time, or a different one from a random collection or sequence every time.
java.util.List<TileEntity>	getTileEntities() Get any tile entities contained in the object.
static Bo2Object	load(java.io.File file) Load a custom object in bo2 format from a file.
static Bo2Object	load(java.lang.String objectName, java.io.File file) Load a custom object in bo2 format from a file.
static Bo2Object	load(java.lang.String objectName, java.io.InputStream stream) Load a custom object in bo2 format from an input stream.
<T extends java.io.Serializable> void	setAttribute(org.pepsoft.util.AttributeKey<T> key, T value) Convenience method for setting the value of an attribute stored in the external metadata, if any.
void	setAttributes(java.util.Map<java.lang.String,java.io.Serializable> attributes) Store external metadata about the object.
void	setName(java.lang.String name) Set the name of the object.
void	setSeed(long seed) Sets the seed of the PRNG, for object providers which use one.
boolean	visitBlocks(WPObject.BlockVisitor visitor) Visit all blocks in the object.

Methods inherited from class org.pepsoft.worldpainter.objects.AbstractObject

getOffset, prepareForExport

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.pepsoft.worldpainter.objects.WPObject

dump, getAllMaterials, getAttribute, guessConnectBlocks, guessManageWaterlogged, guestimateOffset, hasAttribute

Field Detail

KEY_SPAWN_WATER

public static final java.lang.String KEY_SPAWN_WATER

See Also:

Constant Field Values

KEY_SPAWN_LAVA

public static final java.lang.String KEY_SPAWN_LAVA

See Also:

Constant Field Values

KEY_NEEDS_FOUNDATION

public static final java.lang.String KEY_NEEDS_FOUNDATION

See Also:

Constant Field Values

KEY_RANDOM_ROTATION

public static final java.lang.String KEY_RANDOM_ROTATION

See Also:

Constant Field Values

Method Detail

getName

public java.lang.String getName()

Description copied from interface: Bo2ObjectProvider

Get the name of this object provider (if it represents one object this may be the name of the object).

Specified by:

getName in interface Bo2ObjectProvider

Specified by:

getName in interface WPObject

Returns:

The name of this object provider.

setName

public void setName(java.lang.String name)

Description copied from interface: WPObject

Set the name of the object.

Specified by:

setName in interface WPObject

Parameters:

name - The new name of the object.

getDimensions

public javax.vecmath.Point3i getDimensions()

Description copied from interface: WPObject

Get the dimensions of the object.

Specified by:

getDimensions in interface WPObject

Returns:

The dimensions of the object.

getMaterial

public Material getMaterial(int x,
                            int y,
                            int z)

Description copied from interface: WPObject

Get the material to place at the specified relative coordinates. Should only be invoked for coordinates for which WPObject.getMask(int, int, int) returns true. These coordinates are zero-based and must never be negative.

Specified by:

getMaterial in interface WPObject

Parameters:

x - The relative X coordinate.

y - The relative Y coordinate.

z - The relative Z coordinate.

Returns:

The material to place at the specified relative coordinates.

getMask

public boolean getMask(int x,
                       int y,
                       int z)

Description copied from interface: WPObject

Determine whether a block should be placed at the specified relative coordinates. These coordinates are zero-based and must never be negative.

Specified by:

getMask in interface WPObject

Parameters:

x - The relative X coordinate.

y - The relative Y coordinate.

z - The relative Z coordinate.

Returns:

true if a block should be placed at the specified relative coordinates.

getObject

public Bo2Object getObject()

Description copied from interface: Bo2ObjectProvider

Obtain one WPObject, which may be the same one every time, or a different one from a random collection or sequence every time.

Specified by:

getObject in interface Bo2ObjectProvider

Returns:

One WPObject.

getEntities

public java.util.List<Entity> getEntities()

Description copied from interface: WPObject

Get any entities contained in the object. The entities' coordinates should be relative to the object, not absolute.

Specified by:

getEntities in interface WPObject

Returns:

Any entities contained in the object. May be null.

getTileEntities

public java.util.List<TileEntity> getTileEntities()

Description copied from interface: WPObject

Get any tile entities contained in the object. The entities' coordinates should be relative to the object, not absolute.

Specified by:

getTileEntities in interface WPObject

Returns:

Any tile entities contained in the object. May be null.

getAllObjects

public java.util.List<WPObject> getAllObjects()

Description copied from interface: Bo2ObjectProvider

Obtain a list of all different WPObjects which this object provider can return. This is an optional operation which may throw an UnsupportedOperationException if this object provider does not support it.

Specified by:

getAllObjects in interface Bo2ObjectProvider

Returns:

A list of all objects which this provider can return.

getAttributes

public java.util.Map<java.lang.String,java.io.Serializable> getAttributes()

Description copied from interface: WPObject

Get a live view of the object metadata.

Specified by:

getAttributes in interface WPObject

Returns:

A live view of the object metadata. May be null.

setAttributes

public void setAttributes(java.util.Map<java.lang.String,java.io.Serializable> attributes)

Description copied from interface: WPObject

Store external metadata about the object.

Specified by:

setAttributes in interface WPObject

Parameters:

attributes - The external metadata to store.

setAttribute

public <T extends java.io.Serializable> void setAttribute(org.pepsoft.util.AttributeKey<T> key,
                                                          T value)

Description copied from interface: WPObject

Convenience method for setting the value of an attribute stored in the external metadata, if any. Setting the value to null will delete the attribute from the store. If the store becomes empty it is deleted entirely.

Specified by:

setAttribute in interface WPObject

Type Parameters:

T - The type of the attribute.

Parameters:

key - The key of the attribute to set or delete.

value - The value of the attribute to set, or null to delete it.

setSeed

public void setSeed(long seed)

Description copied from interface: Bo2ObjectProvider

Sets the seed of the PRNG, for object providers which use one. Does nothing for other object providers.

Specified by:

setSeed in interface Bo2ObjectProvider

Parameters:

seed - The seed to set on the PRNG, if any.

visitBlocks

public boolean visitBlocks(WPObject.BlockVisitor visitor)

Description copied from interface: WPObject

Visit all blocks in the object. The order in which the blocks are visited is undefined.

Specified by:

visitBlocks in interface WPObject

Parameters:

visitor - The visitor to invoke for each block. If the visitor returns false the operation is aborted.

Returns:

true if all blocks were visited or false if the visitor returned false at some point.

clone

public Bo2Object clone()

Description copied from interface: WPObject

Create a clone of the object. The block data is immutable so may be shared, but all mutable settings are copied so they can be changed independently.

Specified by:

clone in interface Bo2ObjectProvider

Specified by:

clone in interface WPObject

Overrides:

clone in class AbstractObject

Returns:

A clone of the object.

load

public static Bo2Object load(java.io.File file)
                      throws java.io.IOException

Load a custom object in bo2 format from a file.

Parameters:

file - The file from which to load the object.

Returns:

A new Bo2Object containing the contents of the specified file.

Throws:

java.io.IOException - If an I/O error occurred while reading the file.

load

public static Bo2Object load(java.lang.String objectName,
                             java.io.File file)
                      throws java.io.IOException

Load a custom object in bo2 format from a file.

Parameters:

objectName - The name of the object.

file - The file from which to load the object.

Returns:

A new Bo2Object containing the contents of the specified file.

Throws:

java.io.IOException - If an I/O error occurred while reading the file.

load

public static Bo2Object load(java.lang.String objectName,
                             java.io.InputStream stream)
                      throws java.io.IOException

Load a custom object in bo2 format from an input stream. The stream is closed before exiting this method.

Parameters:

objectName - The name of the object.

stream - The input stream from which to load the object.

Returns:

A new Bo2Object containing the contents of the specified stream.

Throws:

java.io.IOException - If an I/O error occurred while reading the stream.