org.pepsoft.worldpainter.objects

Interface WPObject

All Superinterfaces:

java.lang.Cloneable, java.io.Serializable

All Known Implementing Classes:

AbstractObject, Bo2Object, Bo3Object, GenericObject, MinecraftWorldObject, MirroredObject, NamedObjectWithAttributes, Plant, RotatedObject, Schem, Schematic, SkewedObject, Structure

public interface WPObject
extends java.io.Serializable, java.lang.Cloneable

A three-dimensional object, consisting of Minecraft blocks, which can be placed in a map.

This class uses the WorldPainter coordinate system (z is vertical).

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	WPObject.BlockVisitor

Field Summary

Fields

Modifier and Type	Field and Description
static org.pepsoft.util.AttributeKey<java.lang.Integer>	ATTRIBUTE_COLLISION_MODE Collision mode.
static org.pepsoft.util.AttributeKey<java.lang.Boolean>	ATTRIBUTE_CONNECT_BLOCKS Whether certain connecting blocks such as fences, glass panes and iron bars should have their west, north, east and south properties automatically set if there is a connecting block in that direction.
static org.pepsoft.util.AttributeKey<java.lang.Boolean>	ATTRIBUTE_EXTEND_FOUNDATION When set, the blocks on the lowest level of the object will be copied downwards until they meet a solid block, if they end up being placed floating in the air.
static org.pepsoft.util.AttributeKey<java.io.File>	ATTRIBUTE_FILE
static org.pepsoft.util.AttributeKey<java.lang.Integer>	ATTRIBUTE_FREQUENCY
static org.pepsoft.util.AttributeKey<java.lang.Integer>	ATTRIBUTE_HEIGHT_MODE
static org.pepsoft.util.AttributeKey<java.lang.Integer>	ATTRIBUTE_LEAF_DECAY_MODE Whether to change leaf blocks so that they do or do not decay.
static org.pepsoft.util.AttributeKey<java.lang.Boolean>	ATTRIBUTE_MANAGE_WATERLOGGED Whether the Material.WATERLOGGED property of the blocks should be automatically managed (set if there is already water where the blocks are placed and reset if the target location is dry) or exported as set in the object.
static org.pepsoft.util.AttributeKey<java.lang.Boolean>	ATTRIBUTE_NEEDS_FOUNDATION
static org.pepsoft.util.AttributeKey<javax.vecmath.Point3i>	ATTRIBUTE_OFFSET
static org.pepsoft.util.AttributeKey<java.lang.Boolean>	ATTRIBUTE_RANDOM_MIRRORING_ONLY
static org.pepsoft.util.AttributeKey<java.lang.Boolean>	ATTRIBUTE_RANDOM_ROTATION Random rotation and mirroring, for historical reasons.
static org.pepsoft.util.AttributeKey<java.lang.Boolean>	ATTRIBUTE_RANDOM_ROTATION_ONLY
static org.pepsoft.util.AttributeKey<int[]>	ATTRIBUTE_REPLACE_WITH_AIR Deprecated. Use ATTRIBUTE_REPLACE_WITH_AIR_MATERIAL
static org.pepsoft.util.AttributeKey<Material>	ATTRIBUTE_REPLACE_WITH_AIR_MATERIAL When set, describes a material which will be replaced with air blocks when this object is rendered.
static org.pepsoft.util.AttributeKey<java.lang.Boolean>	ATTRIBUTE_SPAWN_IN_LAVA
static org.pepsoft.util.AttributeKey<java.lang.Boolean>	ATTRIBUTE_SPAWN_IN_WATER
static org.pepsoft.util.AttributeKey<java.lang.Boolean>	ATTRIBUTE_SPAWN_ON_LAND
static org.pepsoft.util.AttributeKey<java.lang.Boolean>	ATTRIBUTE_SPAWN_ON_LAVA
static org.pepsoft.util.AttributeKey<java.lang.Boolean>	ATTRIBUTE_SPAWN_ON_WATER
static org.pepsoft.util.AttributeKey<java.lang.Boolean>	ATTRIBUTE_SPAWN_ON_WATER_NO_COLLIDE
static org.pepsoft.util.AttributeKey<java.lang.Integer>	ATTRIBUTE_UNDERGROUND_MODE Underground rendering mode.
static org.pepsoft.util.AttributeKey<java.lang.Integer>	ATTRIBUTE_VERTICAL_OFFSET
static org.pepsoft.util.AttributeKey<java.lang.Integer>	ATTRIBUTE_Y_VARIATION
static int	COLLISION_MODE_ALL
static int	COLLISION_MODE_NONE
static int	COLLISION_MODE_SOLID
static int	HEIGHT_MODE_FIXED
static int	HEIGHT_MODE_TERRAIN
static int	LEAF_DECAY_NO_CHANGE
static int	LEAF_DECAY_OFF
static int	LEAF_DECAY_ON

Method Summary

Modifier and Type	Method and Description
WPObject	clone() Create a clone of the object.
default void	dump() Dumps the object to the console.
default java.util.Set<Material>	getAllMaterials() Return all unique materials contained in this object.
default <T extends java.io.Serializable> T	getAttribute(org.pepsoft.util.AttributeKey<T> key) Convencience method for getting the value of an attribute stored in the external metadata, if any.
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 the object.
javax.vecmath.Point3i	getOffset() Get the offset to apply to this object when placing it.
java.util.List<TileEntity>	getTileEntities() Get any tile entities contained in the object.
default void	guessConnectBlocks() Will guess whether the ATTRIBUTE_CONNECT_BLOCKS attribute should be set and if so set it.
default void	guessManageWaterlogged() TODO only for formats with named blocks which could conceivable contain the waterlogged property
default javax.vecmath.Point3i	guestimateOffset() Guestimate an offset for the object.
default boolean	hasAttribute(org.pepsoft.util.AttributeKey<?> attributeKey) Determine whether the object contains a value for a particular attribute.
void	prepareForExport(Dimension dimension) Make preparations, if necessary, for exporting the object.
<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.
default boolean	visitBlocks(WPObject.BlockVisitor visitor) Visit all blocks in the object.

Field Detail

COLLISION_MODE_ALL

static final int COLLISION_MODE_ALL

See Also:

Constant Field Values

COLLISION_MODE_SOLID

static final int COLLISION_MODE_SOLID

See Also:

Constant Field Values

COLLISION_MODE_NONE

static final int COLLISION_MODE_NONE

See Also:

Constant Field Values

LEAF_DECAY_NO_CHANGE

static final int LEAF_DECAY_NO_CHANGE

See Also:

Constant Field Values

LEAF_DECAY_ON

static final int LEAF_DECAY_ON

See Also:

Constant Field Values

LEAF_DECAY_OFF

static final int LEAF_DECAY_OFF

See Also:

Constant Field Values

HEIGHT_MODE_TERRAIN

static final int HEIGHT_MODE_TERRAIN

See Also:

Constant Field Values

HEIGHT_MODE_FIXED

static final int HEIGHT_MODE_FIXED

See Also:

Constant Field Values

ATTRIBUTE_FILE

static final org.pepsoft.util.AttributeKey<java.io.File> ATTRIBUTE_FILE

ATTRIBUTE_OFFSET

static final org.pepsoft.util.AttributeKey<javax.vecmath.Point3i> ATTRIBUTE_OFFSET

ATTRIBUTE_RANDOM_ROTATION

static final org.pepsoft.util.AttributeKey<java.lang.Boolean> ATTRIBUTE_RANDOM_ROTATION

Random rotation and mirroring, for historical reasons. See ATTRIBUTE_RANDOM_ROTATION_ONLY and ATTRIBUTE_RANDOM_MIRRORING_ONLY for separate attributes. If one or both of those attributes are set, this one must be set to false, since otherwise it defaults to true and will override the separate attributes.

ATTRIBUTE_NEEDS_FOUNDATION

static final org.pepsoft.util.AttributeKey<java.lang.Boolean> ATTRIBUTE_NEEDS_FOUNDATION

ATTRIBUTE_SPAWN_IN_WATER

static final org.pepsoft.util.AttributeKey<java.lang.Boolean> ATTRIBUTE_SPAWN_IN_WATER

ATTRIBUTE_SPAWN_IN_LAVA

static final org.pepsoft.util.AttributeKey<java.lang.Boolean> ATTRIBUTE_SPAWN_IN_LAVA

ATTRIBUTE_SPAWN_ON_LAND

static final org.pepsoft.util.AttributeKey<java.lang.Boolean> ATTRIBUTE_SPAWN_ON_LAND

ATTRIBUTE_SPAWN_ON_WATER

static final org.pepsoft.util.AttributeKey<java.lang.Boolean> ATTRIBUTE_SPAWN_ON_WATER

ATTRIBUTE_SPAWN_ON_LAVA

static final org.pepsoft.util.AttributeKey<java.lang.Boolean> ATTRIBUTE_SPAWN_ON_LAVA

ATTRIBUTE_FREQUENCY

static final org.pepsoft.util.AttributeKey<java.lang.Integer> ATTRIBUTE_FREQUENCY

ATTRIBUTE_SPAWN_ON_WATER_NO_COLLIDE

static final org.pepsoft.util.AttributeKey<java.lang.Boolean> ATTRIBUTE_SPAWN_ON_WATER_NO_COLLIDE

ATTRIBUTE_COLLISION_MODE

static final org.pepsoft.util.AttributeKey<java.lang.Integer> ATTRIBUTE_COLLISION_MODE

Collision mode. Possible values:

Value	Meaning
COLLISION_MODE_ALL	Will collide with (and therefore not render) any above ground block other than air
COLLISION_MODE_SOLID	Will collide with (and therefore not render) any above ground solid block (i.e. not air, grass, water, flowers, leaves, etc.). Default value
COLLISION_MODE_NONE	Will not collide with any above ground block (and therefore intersect any other object already there!)

ATTRIBUTE_UNDERGROUND_MODE

static final org.pepsoft.util.AttributeKey<java.lang.Integer> ATTRIBUTE_UNDERGROUND_MODE

Underground rendering mode. Possible values:

Value	Meaning
COLLISION_MODE_ALL	Every underground block belonging to the object will be rendered (including air blocks), regardless of what is already there. Default value
COLLISION_MODE_SOLID	Every solid (i.e. not air, grass, water, flowers, leaves, etc.) underground block belonging to the object will be rendered regardless of what is already there. Non-solid blocks will be rendered only if the existing block is air
COLLISION_MODE_NONE	Underground blocks belonging to the object will only be rendered if the existing block is air

ATTRIBUTE_LEAF_DECAY_MODE

static final org.pepsoft.util.AttributeKey<java.lang.Integer> ATTRIBUTE_LEAF_DECAY_MODE

Whether to change leaf blocks so that they do or do not decay. Possible values:

Value	Meaning
LEAF_DECAY_NO_CHANGE	Leaf blocks are copied unchanged from the custom object. Default value
LEAF_DECAY_ON	All leaf blocks are set to decay regardless of their setting in the custom object
LEAF_DECAY_OFF	All leaf blocks are set to not decay regardless of their setting in the custom object

ATTRIBUTE_REPLACE_WITH_AIR

@Deprecated
static final org.pepsoft.util.AttributeKey<int[]> ATTRIBUTE_REPLACE_WITH_AIR

Deprecated. Use ATTRIBUTE_REPLACE_WITH_AIR_MATERIAL

ATTRIBUTE_REPLACE_WITH_AIR_MATERIAL

static final org.pepsoft.util.AttributeKey<Material> ATTRIBUTE_REPLACE_WITH_AIR_MATERIAL

When set, describes a material which will be replaced with air blocks when this object is rendered. Mainly meant to be able to create voids underground using schematics, which is otherwise not possible since there is no way to tell whether an air block from a schematic is supposed to be placed or not.

ATTRIBUTE_EXTEND_FOUNDATION

static final org.pepsoft.util.AttributeKey<java.lang.Boolean> ATTRIBUTE_EXTEND_FOUNDATION

When set, the blocks on the lowest level of the object will be copied downwards until they meet a solid block, if they end up being placed floating in the air. This allows objects to have "legs", "roots" or a "foundation" which will be extended by WorldPainter to meet the ground.

ATTRIBUTE_RANDOM_ROTATION_ONLY

static final org.pepsoft.util.AttributeKey<java.lang.Boolean> ATTRIBUTE_RANDOM_ROTATION_ONLY

ATTRIBUTE_RANDOM_MIRRORING_ONLY

static final org.pepsoft.util.AttributeKey<java.lang.Boolean> ATTRIBUTE_RANDOM_MIRRORING_ONLY

ATTRIBUTE_HEIGHT_MODE

static final org.pepsoft.util.AttributeKey<java.lang.Integer> ATTRIBUTE_HEIGHT_MODE

ATTRIBUTE_VERTICAL_OFFSET

static final org.pepsoft.util.AttributeKey<java.lang.Integer> ATTRIBUTE_VERTICAL_OFFSET

ATTRIBUTE_Y_VARIATION

static final org.pepsoft.util.AttributeKey<java.lang.Integer> ATTRIBUTE_Y_VARIATION

ATTRIBUTE_CONNECT_BLOCKS

static final org.pepsoft.util.AttributeKey<java.lang.Boolean> ATTRIBUTE_CONNECT_BLOCKS

Whether certain connecting blocks such as fences, glass panes and iron bars should have their west, north, east and south properties automatically set if there is a connecting block in that direction. Does not currently include stone walls. Default value: false.

ATTRIBUTE_MANAGE_WATERLOGGED

static final org.pepsoft.util.AttributeKey<java.lang.Boolean> ATTRIBUTE_MANAGE_WATERLOGGED

Whether the Material.WATERLOGGED property of the blocks should be automatically managed (set if there is already water where the blocks are placed and reset if the target location is dry) or exported as set in the object.

Method Detail

getName

java.lang.String getName()

Get the name of the object.

Returns:

The name of the object.

setName

void setName(java.lang.String name)

Set the name of the object.

Parameters:

name - The new name of the object.

getDimensions

javax.vecmath.Point3i getDimensions()

Get the dimensions of the object.

Returns:

The dimensions of the object.

getOffset

javax.vecmath.Point3i getOffset()

Get the offset to apply to this object when placing it. In other words these are the reverse of the coordinates of the "anchor" block of this object.

This is a convenience method which must return the same as invoking getAttribute(ATTRIBUTE_OFFSET). See getAttribute(AttributeKey) and ATTRIBUTE_OFFSET.

Returns:

The offset to apply to this object when placing it.

getMaterial

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

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

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.

getAllMaterials

default java.util.Set<Material> getAllMaterials()

Return all unique materials contained in this object.

Returns:

All unique materials contained in this object.

getMask

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

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

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.

getEntities

java.util.List<Entity> getEntities()

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

Returns:

Any entities contained in the object. May be null.

getTileEntities

java.util.List<TileEntity> getTileEntities()

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

Returns:

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

prepareForExport

void prepareForExport(Dimension dimension)

Make preparations, if necessary, for exporting the object. For example retrieving and applying a mapping. This method will be invoked by WorldPainter before getMask(int, int, int) or getMaterial(int, int, int) are invoked.

Parameters:

dimension - The dimension for which the object is being exported.

getAttributes

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

Get a live view of the object metadata.

Returns:

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

hasAttribute

default boolean hasAttribute(org.pepsoft.util.AttributeKey<?> attributeKey)

Determine whether the object contains a value for a particular attribute.

Parameters:

attributeKey - The attribute key to check.

Returns:

true if a value is set for the specified attribute.

getAttribute

default <T extends java.io.Serializable> T getAttribute(org.pepsoft.util.AttributeKey<T> key)

Convencience method for getting the value of an attribute stored in the external metadata, if any. Should return the value of the attribute if it is present, or a default value (which may be null) if it is not.

Type Parameters:

T - The type of the attribute.

Parameters:

key - The key of the attribute.

Returns:

The value of the specified attribute, or the specified default value if the attribute is not set.

setAttributes

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

Store external metadata about the object.

Parameters:

attributes - The external metadata to store.

setAttribute

<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. Setting the value to null will delete the attribute from the store. If the store becomes empty it is deleted entirely.

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.

clone

WPObject clone()

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.

Returns:

A clone of the object.

guestimateOffset

default javax.vecmath.Point3i guestimateOffset()

Guestimate an offset for the object. If an offset cannot be calculated because the object is entirely empty, null will be returned.

Note that this method calls getDimensions() and getMask(int, int, int), so they must return valid values.

visitBlocks

default boolean visitBlocks(WPObject.BlockVisitor visitor)

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

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.

guessConnectBlocks

default void guessConnectBlocks()

Will guess whether the ATTRIBUTE_CONNECT_BLOCKS attribute should be set and if so set it. Should only be called for custom object formats which have legacy, numerical block IDs, for which you might want to set that property.

guessManageWaterlogged

default void guessManageWaterlogged()

TODO only for formats with named blocks which could conceivable contain the waterlogged property

dump

default void dump()

Dumps the object to the console.