org.pepsoft.worldpainter.objects

Class AbstractObject

java.lang.Object

org.pepsoft.worldpainter.objects.AbstractObject

All Implemented Interfaces:

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

Direct Known Subclasses:

Bo2Object, Bo3Object, MirroredObject, NamedObjectWithAttributes, RotatedObject, SkewedObject, Structure

public abstract class AbstractObject
extends java.lang.Object
implements WPObject

Abstract base class for WPObject implementations.

See Also:

Serialized Form

Nested Class Summary

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

WPObject.BlockVisitor

Field Summary

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

Constructor Summary

Constructors

Constructor and Description
AbstractObject()

Method Summary

Modifier and Type	Method and Description
AbstractObject	clone() Create a clone of the object.
javax.vecmath.Point3i	getOffset() Get the offset to apply to this object when placing it.
void	prepareForExport(Dimension dimension) Make preparations, if necessary, for exporting the object.

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, getAttributes, getDimensions, getEntities, getMask, getMaterial, getName, getTileEntities, guessConnectBlocks, guessManageWaterlogged, guestimateOffset, hasAttribute, setAttribute, setAttributes, setName, visitBlocks

Constructor Detail

AbstractObject

public AbstractObject()

Method Detail

prepareForExport

public void prepareForExport(Dimension dimension)

Description copied from interface: WPObject

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

Specified by:

prepareForExport in interface WPObject

Parameters:

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

clone

public AbstractObject 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 WPObject

Overrides:

clone in class java.lang.Object

Returns:

A clone of the object.

getOffset

public final javax.vecmath.Point3i getOffset()

Description copied from interface: WPObject

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 WPObject.getAttribute(AttributeKey) and WPObject.ATTRIBUTE_OFFSET.

Specified by:

getOffset in interface WPObject

Returns:

The offset to apply to this object when placing it.