org.pepsoft.worldpainter

Class MixedMaterial

java.lang.Object

org.pepsoft.worldpainter.MixedMaterial

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.lang.Comparable<MixedMaterial>

public final class MixedMaterial
extends java.lang.Object
implements java.io.Serializable, java.lang.Comparable<MixedMaterial>, java.lang.Cloneable

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MixedMaterial.Mode
static class	MixedMaterial.Row

Constructor Summary

Constructors

Constructor and Description
MixedMaterial(java.lang.String name, MixedMaterial.Row[] rows, int biome, java.lang.Integer colour) Create a new noisy mixed material.
MixedMaterial(java.lang.String name, MixedMaterial.Row[] rows, int biome, java.lang.Integer colour, float scale) Create a new blobby mixed material.
MixedMaterial(java.lang.String name, MixedMaterial.Row[] rows, int biome, java.lang.Integer colour, NoiseSettings variation, double layerXSlope, double layerYSlope, boolean repeat) Create a new layered mixed material.
MixedMaterial(java.lang.String name, MixedMaterial.Row row, int biome, java.lang.Integer colour) Create a new "mixed material" which contains only one material.

Method Summary

Modifier and Type	Method and Description
MixedMaterial	clone()
int	compareTo(MixedMaterial o)
static MixedMaterial	create(Platform platform, int blockType) Deprecated. Use create(Platform, Material)
static MixedMaterial	create(Platform platform, Material material) Utility method for creating a simple mixed material, consisting of one material, with a default name targeted to a specific platform.
static MixedMaterial	create(java.lang.String name, Material material) Utility method for creating a simple mixed material, consisting of one material, with a specific name.
static <V> V	duplicateNewMaterialsWhile(java.util.concurrent.Callable<V> task) Perform a task during which any new materials deserialised on the same thread will be duplicated and given new identities, instead of being replaced with existing instances with the same identity if available.
boolean	equals(java.lang.Object obj)
int	getBiome()
java.lang.Integer	getColour()
java.awt.image.BufferedImage	getIcon(ColourScheme colourScheme)
java.util.UUID	getId()
double	getLayerXSlope()
double	getLayerYSlope()
Material	getMaterial(long seed, int x, int y, float z)
Material	getMaterial(long seed, int x, int y, int z)
MixedMaterial.Mode	getMode()
java.lang.String	getName()
int	getPatternHeight() Get the height of the pattern, or -1 if this does not apply because there is no pattern.
MixedMaterial.Row[]	getRows()
float	getScale()
Material	getSingleMaterial() Get the single material of which this mixed material consists, or null if it contains more than one material.
NoiseSettings	getVariation()
int	hashCode()
boolean	isRepeat()
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

MixedMaterial

public MixedMaterial(java.lang.String name,
                     MixedMaterial.Row row,
                     int biome,
                     java.lang.Integer colour)

Create a new "mixed material" which contains only one material.

Parameters:

name - The name of the mixed material.

row - A single row describing the material.

biome - The default biome associated with this mixed material, or -1 for no default biome.

colour - The colour associated with this mixed material, or null for no default colour.

MixedMaterial

public MixedMaterial(java.lang.String name,
                     MixedMaterial.Row[] rows,
                     int biome,
                     java.lang.Integer colour)

Create a new noisy mixed material.

Parameters:

name - The name of the mixed material.

rows - The rows describing the materials to be used together with their occurrences.

biome - The default biome associated with this mixed material, or -1 for no default biome.

colour - The colour associated with this mixed material, or null for no default colour.

MixedMaterial

public MixedMaterial(java.lang.String name,
                     MixedMaterial.Row[] rows,
                     int biome,
                     java.lang.Integer colour,
                     float scale)

Create a new blobby mixed material.

Parameters:

name - The name of the mixed material.

rows - The rows describing the materials to be used together with their occurrences.

biome - The default biome associated with this mixed material, or -1 for no default biome.

colour - The colour associated with this mixed material, or null for no default colour.

scale - The scale of the blobs. 1.0f for default size.

MixedMaterial

public MixedMaterial(java.lang.String name,
                     MixedMaterial.Row[] rows,
                     int biome,
                     java.lang.Integer colour,
                     NoiseSettings variation,
                     double layerXSlope,
                     double layerYSlope,
                     boolean repeat)

Create a new layered mixed material.

Parameters:

name - The name of the mixed material.

rows - The rows describing the materials to be used together with their heights.

biome - The default biome associated with this mixed material, or -1 for no default biome.

colour - The colour associated with this mixed material, or null for no default colour.

variation - The variation in layer height which should be applied, or null for no variation.

layerXSlope - The slope of the layer for the x-axis. Must be zero if repeat is false.

layerYSlope - The slope of the layer for the y-axis. Must be zero if repeat is false.

repeat - Whether the layers should repeat vertically.

Method Detail

getId

public java.util.UUID getId()

getName

public java.lang.String getName()

getBiome

public int getBiome()

getMode

public MixedMaterial.Mode getMode()

getScale

public float getScale()

getColour

public java.lang.Integer getColour()

getVariation

public NoiseSettings getVariation()

isRepeat

public boolean isRepeat()

getLayerXSlope

public double getLayerXSlope()

getLayerYSlope

public double getLayerYSlope()

getIcon

public java.awt.image.BufferedImage getIcon(ColourScheme colourScheme)

getMaterial

public Material getMaterial(long seed,
                            int x,
                            int y,
                            float z)

getMaterial

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

getSingleMaterial

public Material getSingleMaterial()

Get the single material of which this mixed material consists, or null if it contains more than one material.

Returns:

The single material of which this mixed material consists, or null if it contains more than one material.

getRows

public MixedMaterial.Row[] getRows()

getPatternHeight

public int getPatternHeight()

Get the height of the pattern, or -1 if this does not apply because there is no pattern.

Returns:

The height of the pattern, or -1 if this does not apply.

compareTo

public int compareTo(MixedMaterial o)

Specified by:

compareTo in interface java.lang.Comparable<MixedMaterial>

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

clone

public MixedMaterial clone()

Overrides:

clone in class java.lang.Object

create

public static MixedMaterial create(Platform platform,
                                   int blockType)

Deprecated. Use create(Platform, Material)

Utility method for creating a simple mixed material, consisting of one block type with data value 0, with a default name targeted to a specific platform.

Parameters:

platform - The platform to which to target the name.

blockType - The block type the mixed material should consist of

Returns:

A new mixed material with the specified block type, and the block type's name

create

public static MixedMaterial create(Platform platform,
                                   Material material)

Utility method for creating a simple mixed material, consisting of one material, with a default name targeted to a specific platform.

Parameters:

platform - The platform to which to target the name.

material - The simple material the mixed material should consist of

Returns:

A new mixed material with the specified material and an appropriate name

create

public static MixedMaterial create(java.lang.String name,
                                   Material material)

Utility method for creating a simple mixed material, consisting of one material, with a specific name.

Parameters:

name - The name to give the mixed material.

material - The simple material the mixed material should consist of

Returns:

A new mixed material with the specified material and an appropriate name

duplicateNewMaterialsWhile

public static <V> V duplicateNewMaterialsWhile(java.util.concurrent.Callable<V> task)

Perform a task during which any new materials deserialised on the same thread will be duplicated and given new identities, instead of being replaced with existing instances with the same identity if available.

Type Parameters:

V - The return type of the task. May be Void for tasks which do not return a value.

Parameters:

task - The task to perform.

Returns:

The return value of the task or null if it does not return a value.

Throws:

java.lang.RuntimeException - If the task throws a checked exception it will be wrapped in a RuntimeException.