buildcraft.api.filler

Class FilledTemplate

java.lang.Object

buildcraft.api.filler.FilledTemplate

public class FilledTemplate
extends java.lang.Object

A template, to be returned by an IFillerPattern

As this is backed by a BitSet ordered [x][y][z] it is much faster to fill in the X axis than the Y or Z axis, so many methods are provided that take advantage of this.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FilledTemplate.TemplateState

Field Summary

Fields

Modifier and Type	Field and Description
net.minecraft.util.math.BlockPos	max
int	maxX
int	maxY
int	maxZ
net.minecraft.util.math.BlockPos	min
net.minecraft.util.math.BlockPos	size
int	sizeX
int	sizeXY
int	sizeXYZ
int	sizeY
int	sizeZ

Constructor Summary

Constructors

Constructor and Description
FilledTemplate(net.minecraft.util.math.BlockPos min, net.minecraft.util.math.BlockPos max)
FilledTemplate(FilledTemplate from)
FilledTemplate(IBox box)
FilledTemplate(net.minecraft.nbt.NBTTagCompound nbt)

Method Summary

Modifier and Type	Method and Description
void	clear() Completely fills up this template.
void	clear(net.minecraft.util.math.BlockPos pos)
void	clear(int x, int y, int z)
void	clearAreaYZ(int x, int fy, int fz, int ty, int tz)
void	clearAxisZ(int x, int y) Fills up the entire Z axis of a particular co-ord.
void	clearLineZ(int x, int y, int fz, int tz) Fills a line in the Z-axis.
void	clearPlaneYZ(int x) Fills an entire plane of a particular X co-ord
void	clearVolume(net.minecraft.util.math.BlockPos from, net.minecraft.util.math.BlockPos to)
void	clearVolume(int fx, int fy, int fz, int tx, int ty, int tz)
void	fill() Completely fills up this template.
void	fill(net.minecraft.util.math.BlockPos pos)
void	fill(int x, int y, int z)
void	fillAreaXY(int fx, int tx, int fy, int ty, int z)
void	fillAreaXZ(int fx, int tx, int y, int fz, int tz)
void	fillAreaYZ(int x, int fy, int ty, int fz, int tz)
void	fillAxisX(int y, int z)
void	fillAxisY(int x, int z)
void	fillAxisZ(int x, int y) Fills up the entire Z axis of a particular co-ord.
void	fillLineX(int fx, int tx, int y, int z) Fills a line in the X-axis.
void	fillLineY(int x, int fy, int ty, int z)
void	fillLineZ(int x, int y, int fz, int tz)
void	fillPlaneXY(int z)
void	fillPlaneXZ(int y)
void	fillPlaneYZ(int x) Fills an entire plane of a particular X co-ord
void	fillVolume(net.minecraft.util.math.BlockPos from, net.minecraft.util.math.BlockPos to)
void	fillVolume(int fx, int tx, int fy, int ty, int fz, int tz)
FilledTemplate.TemplateState	get(int x, int y, int z)
FilledTemplate.TemplateState	getAbsolute(net.minecraft.util.math.BlockPos pos)
FilledTemplate.TemplateState	getOffset(net.minecraft.util.math.BlockPos offset)
void	ignore()
void	ignore(int x, int y, int z)
void	invert() Swaps every clear with fill, and fill with clear.
void	set(net.minecraft.util.math.BlockPos pos, boolean fill)
void	set(int x, int y, int z, boolean fill)
void	set(int x, int y, int z, FilledTemplate.TemplateState state)
boolean	shouldFill(int x, int y, int z)
boolean	shouldIgnore(int x, int y, int z)
java.lang.String	toString()
net.minecraft.nbt.NBTTagCompound	writeToNbt()

Methods inherited from class java.lang.Object

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

Field Detail

min

public final net.minecraft.util.math.BlockPos min

max

public final net.minecraft.util.math.BlockPos max

size

public final net.minecraft.util.math.BlockPos size

sizeX

public final int sizeX

sizeY

public final int sizeY

sizeZ

public final int sizeZ

sizeXY

public final int sizeXY

sizeXYZ

public final int sizeXYZ

maxX

public final int maxX

maxY

public final int maxY

maxZ

public final int maxZ

Constructor Detail

FilledTemplate

public FilledTemplate(net.minecraft.util.math.BlockPos min,
                      net.minecraft.util.math.BlockPos max)

FilledTemplate

public FilledTemplate(IBox box)

FilledTemplate

public FilledTemplate(FilledTemplate from)

FilledTemplate

public FilledTemplate(net.minecraft.nbt.NBTTagCompound nbt)

Method Detail

writeToNbt

public net.minecraft.nbt.NBTTagCompound writeToNbt()

getAbsolute

public FilledTemplate.TemplateState getAbsolute(net.minecraft.util.math.BlockPos pos)

getOffset

public FilledTemplate.TemplateState getOffset(net.minecraft.util.math.BlockPos offset)

get

public FilledTemplate.TemplateState get(int x,
                                        int y,
                                        int z)

shouldFill

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

Returns:

true if this should fill the given position. NOTE: This IGNORES if the given position should be ignored. Provided for patterns which never ignore anything.

shouldIgnore

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

fill

public void fill(net.minecraft.util.math.BlockPos pos)

fill

public void fill(int x,
                 int y,
                 int z)

fillVolume

public void fillVolume(net.minecraft.util.math.BlockPos from,
                       net.minecraft.util.math.BlockPos to)

fillVolume

public void fillVolume(int fx,
                       int tx,
                       int fy,
                       int ty,
                       int fz,
                       int tz)

fillAreaYZ

public void fillAreaYZ(int x,
                       int fy,
                       int ty,
                       int fz,
                       int tz)

fillAreaXZ

public void fillAreaXZ(int fx,
                       int tx,
                       int y,
                       int fz,
                       int tz)

fillAreaXY

public void fillAreaXY(int fx,
                       int tx,
                       int fy,
                       int ty,
                       int z)

fill

public void fill()

Completely fills up this template.

fillPlaneYZ

public void fillPlaneYZ(int x)

Fills an entire plane of a particular X co-ord

fillPlaneXZ

public void fillPlaneXZ(int y)

fillPlaneXY

public void fillPlaneXY(int z)

fillAxisX

public void fillAxisX(int y,
                      int z)

fillAxisY

public void fillAxisY(int x,
                      int z)

fillAxisZ

public void fillAxisZ(int x,
                      int y)

Fills up the entire Z axis of a particular co-ord.

fillLineX

public void fillLineX(int fx,
                      int tx,
                      int y,
                      int z)

Fills a line in the X-axis. Likely to be faster than manually, as this delegates to the bitset impl, which can set large lines at once.

fillLineY

public void fillLineY(int x,
                      int fy,
                      int ty,
                      int z)

fillLineZ

public void fillLineZ(int x,
                      int y,
                      int fz,
                      int tz)

clear

public void clear(net.minecraft.util.math.BlockPos pos)

clear

public void clear(int x,
                  int y,
                  int z)

clearVolume

public void clearVolume(net.minecraft.util.math.BlockPos from,
                        net.minecraft.util.math.BlockPos to)

clearVolume

public void clearVolume(int fx,
                        int fy,
                        int fz,
                        int tx,
                        int ty,
                        int tz)

clearAreaYZ

public void clearAreaYZ(int x,
                        int fy,
                        int fz,
                        int ty,
                        int tz)

clear

public void clear()

Completely fills up this template.

clearPlaneYZ

public void clearPlaneYZ(int x)

Fills an entire plane of a particular X co-ord

clearAxisZ

public void clearAxisZ(int x,
                       int y)

Fills up the entire Z axis of a particular co-ord.

clearLineZ

public void clearLineZ(int x,
                       int y,
                       int fz,
                       int tz)

Fills a line in the Z-axis. Likely to be faster than manually, as this delegates to the bitset impl, which can set large lines at once.

ignore

public void ignore()

ignore

public void ignore(int x,
                   int y,
                   int z)

set

public void set(net.minecraft.util.math.BlockPos pos,
                boolean fill)

set

public void set(int x,
                int y,
                int z,
                boolean fill)

set

public void set(int x,
                int y,
                int z,
                FilledTemplate.TemplateState state)

invert

public void invert()

Swaps every clear with fill, and fill with clear.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

Returns:

A massivly long (potentially) string, which is sliced section of this template. Better for debugging.