org.pepsoft.worldpainter.objects

Class GenericObject

java.lang.Object

org.pepsoft.worldpainter.objects.AbstractObject

org.pepsoft.worldpainter.objects.NamedObjectWithAttributes

org.pepsoft.worldpainter.objects.GenericObject

All Implemented Interfaces:

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

public final class GenericObject
extends NamedObjectWithAttributes

A generic WPObject, not tied to any particular platform or file format. Created by Pepijn on 9-3-2017.

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
GenericObject(java.lang.String name, int dimX, int dimY, int dimZ, Material[] data)
GenericObject(java.lang.String name, int dimX, int dimY, int dimZ, Material[] data, java.util.List<Entity> entities, java.util.List<TileEntity> tileEntities, java.util.Map<java.lang.String,java.io.Serializable> attributes)
GenericObject(WPObject object)

Method Summary

Modifier and Type	Method and Description
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.util.List<TileEntity>	getTileEntities() Get any tile entities contained in the object.

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

getAttributes, getName, setAttribute, setAttributes, setName

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

clone, 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, visitBlocks

Constructor Detail

GenericObject

public GenericObject(java.lang.String name,
                     int dimX,
                     int dimY,
                     int dimZ,
                     Material[] data)

GenericObject

public GenericObject(java.lang.String name,
                     int dimX,
                     int dimY,
                     int dimZ,
                     Material[] data,
                     java.util.List<Entity> entities,
                     java.util.List<TileEntity> tileEntities,
                     java.util.Map<java.lang.String,java.io.Serializable> attributes)

GenericObject

public GenericObject(WPObject object)

Method Detail

getDimensions

public javax.vecmath.Point3i getDimensions()

Description copied from interface: WPObject

Get the dimensions of the object.

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.

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.

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

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.

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.

Returns:

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