li.cil.architect.common.item.data

Class SketchData

java.lang.Object

li.cil.architect.common.item.data.SketchData

All Implemented Interfaces:

net.minecraftforge.common.util.INBTSerializable<net.minecraft.nbt.NBTTagCompound>

public final class SketchData
extends java.lang.Object
implements net.minecraftforge.common.util.INBTSerializable<net.minecraft.nbt.NBTTagCompound>

Data representing a currently being edited sketch.

As such, this merely consists of an origin coordinate (minimum corner of the bounding box around the being edited sketch), and the set positions, relative to the origin coordinate. No actual block state data is stored here.

Constructor Summary

Constructors

Constructor and Description
SketchData()

Method Summary

Modifier and Type	Method and Description
void	deserializeNBT(net.minecraft.nbt.NBTTagCompound nbt)
java.util.stream.Stream<net.minecraft.util.math.BlockPos>	getBlocks() Get a stream over all block positions currently set in this sketch.
net.minecraft.util.math.AxisAlignedBB	getBounds() Get the current bounds of the sketch in world space.
net.minecraft.util.math.BlockPos	getOrigin() Get the current origin of the sketch in world space.
net.minecraft.util.math.AxisAlignedBB	getPotentialBounds() Get the potential bounds of the sketch in world space.
net.minecraft.util.math.AxisAlignedBB	getPotentialBounds(net.minecraft.util.math.BlockPos including) Get the potential bounds of the sketch in world space, assuming the specified position is also added to the sketch.
boolean	isEmpty() Whether the sketch is currently empty, i.e.
boolean	isSet(net.minecraft.util.math.BlockPos pos) Get whether the specified block position in world space is set in this sketch.
boolean	isValid(net.minecraft.util.math.BlockPos pos) Checks whether the position can be added to this sketch.
boolean	reset(net.minecraft.util.math.BlockPos pos) Remove the specified block position in world space from the sketch.
net.minecraft.nbt.NBTTagCompound	serializeNBT()
boolean	set(net.minecraft.world.World world, net.minecraft.util.math.BlockPos pos) Add the specified block position in world space the sketch.
boolean	toggle(net.minecraft.world.World world, net.minecraft.util.math.BlockPos pos) Toggle a block in the sketch.

Methods inherited from class java.lang.Object

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

Constructor Detail

SketchData

public SketchData()

Method Detail

isEmpty

public boolean isEmpty()

Whether the sketch is currently empty, i.e. not a single block is set.

Returns:

true if the sketch is empty; false otherwise.

getOrigin

@Nullable
public net.minecraft.util.math.BlockPos getOrigin()

Get the current origin of the sketch in world space.

Returns:

the origin of the sketch.

getBounds

@Nullable
public net.minecraft.util.math.AxisAlignedBB getBounds()

Get the current bounds of the sketch in world space.

May be null if no block is set in the sketch.

Returns:

the bounds of the sketch.

isValid

public boolean isValid(net.minecraft.util.math.BlockPos pos)

Checks whether the position can be added to this sketch.

Parameters:

pos - the position to check.

Returns:

true if it can be added; false otherwise.

getPotentialBounds

public net.minecraft.util.math.AxisAlignedBB getPotentialBounds()

Get the potential bounds of the sketch in world space.

This is the bounds box indicating in what are blocks may be added to the sketch without it exceeding the maximum blueprint size.

Returns:

the potential bounds of the sketch.

getPotentialBounds

public net.minecraft.util.math.AxisAlignedBB getPotentialBounds(net.minecraft.util.math.BlockPos including)

Get the potential bounds of the sketch in world space, assuming the specified position is also added to the sketch.

This is the bounds box indicating in what are blocks may be added to the sketch without it exceeding the maximum blueprint size.

This variant is used to determine the potential bounds during a range selection (where the specified position is the start position of the range).

Parameters:

including - the position to assume also to belong to the sketch.

Returns:

the potential bounds of the extended sketch.

Throws:

java.lang.IllegalArgumentException - if the specified coordinate does not lie in the bounds returned by getPotentialBounds().

isSet

public boolean isSet(net.minecraft.util.math.BlockPos pos)

Get whether the specified block position in world space is set in this sketch.

Parameters:

pos - the position to check.

Returns:

true if the position is set; false otherwise.

toggle

public boolean toggle(net.minecraft.world.World world,
                      net.minecraft.util.math.BlockPos pos)

Toggle a block in the sketch.

This can fail if the specified position is outside the potential bounds of the sketch, in which case this will return false.

Parameters:

world - the world containing the position to add.

pos - the position of the block to toggle.

Returns:

true if the change was applied; false otherwise.

set

public boolean set(net.minecraft.world.World world,
                   net.minecraft.util.math.BlockPos pos)

Add the specified block position in world space the sketch.

This can fail if the specified position is outside the potential bounds of the sketch, in which case this will return false.

Parameters:

world - the world containing the position to add.

pos - the position of the block to add.

Returns:

true if the position was added; false otherwise.

reset

public boolean reset(net.minecraft.util.math.BlockPos pos)

Remove the specified block position in world space from the sketch.

Parameters:

pos - the position of the block to remove.

Returns:

true if the position was removed; false otherwise.

getBlocks

public java.util.stream.Stream<net.minecraft.util.math.BlockPos> getBlocks()

Get a stream over all block positions currently set in this sketch.

Returns:

a stream of all positions in this sketch.

serializeNBT

public net.minecraft.nbt.NBTTagCompound serializeNBT()

Specified by:

serializeNBT in interface net.minecraftforge.common.util.INBTSerializable<net.minecraft.nbt.NBTTagCompound>

deserializeNBT

public void deserializeNBT(net.minecraft.nbt.NBTTagCompound nbt)

Specified by:

deserializeNBT in interface net.minecraftforge.common.util.INBTSerializable<net.minecraft.nbt.NBTTagCompound>