Package net.rodofire.easierworldcreator.shape.block.gen

Class CylinderGen

java.lang.Object

net.rodofire.easierworldcreator.shape.block.instanciator.AbstractBlockShape

net.rodofire.easierworldcreator.shape.block.instanciator.AbstractFillableBlockShape

net.rodofire.easierworldcreator.shape.block.gen.CylinderGen

public class CylinderGen
extends AbstractFillableBlockShape

Class to generate cylinder related shapes
The Main purpose of this class is to generate the coordinates based on a shape. The coordinates are organized depending on a Map<ChunkPos, LongOpenHashSet>.

It emply some things:

• The coordinates are divided in chunk
• It uses LongOpenHashSet for several reasons.
  • First, We use a set to avoid doing unnecessary calculations on the shape. It ensures that no duplicate is present.
  • Second, it compresses the BlockPos: The BlockPos are saved under long using LongPosHelper. It saves some memory since that we save four bytes of data for each BlockPos, and there should not have overhead since that we use primitive data type.
  • Third, since that we use primitive data types and that they take less memory, coordinate generation, accession or deletion is much faster than using a Set<BlockPos>. Encoding and decoding blockPos and then adding it into LongOpenHashSetis extremely faster compared to only adding a BlockPos. ~60- 70% facter.

Dividing Coordinates into Chunk has some advantages :

• allow a multithreaded block assignement when using LayerManager
• allow to be used during WG, when using DividedBlockListManager or when placing using ShapePlacer

Nested Class Summary

Nested classes/interfaces inherited from class net.rodofire.easierworldcreator.shape.block.instanciator.AbstractFillableBlockShape

AbstractFillableBlockShape.Type

Field Summary

Fields inherited from class net.rodofire.easierworldcreator.shape.block.instanciator.AbstractBlockShape

centerPos, centerX, centerY, centerZ, chunkMap, rotator

Constructor Summary

Constructors

Constructor	Description
CylinderGen(@NotNull net.minecraft.util.math.BlockPos pos, int radius, int height)	init a cylinder object
CylinderGen(@NotNull net.minecraft.util.math.BlockPos pos, Rotator rotator, int radiusX, int radiusZ, int height)	init a Cylinder object

Method Summary

Modifier and Type	Method	Description
void	generateEmptyCylinder()	this generates a full cylinder.
void	generateFullCylinder()	this generates a full cylinder
int	getHeight()	Gets the height of the cylinder.
int	getRadiusX()	Gets the radius of the cylinder along the X-axis.
int	getRadiusZ()	Gets the radius of the cylinder along the Z-axis.
Map<net.minecraft.util.math.ChunkPos,it.unimi.dsi.fastutil.longs.LongOpenHashSet>	getShapeCoordinates()	Method to get the BlockPos of the shape
void	setHeight(int height)	Sets the height of the cylinder.
void	setRadiusX(int radius)	Sets the radius of the cylinder along the X-axis.
void	setRadiusZ(int radius)	Sets the radius of the cylinder along the Z-axis.

Methods inherited from class net.rodofire.easierworldcreator.shape.block.instanciator.AbstractFillableBlockShape

getCustomFill, getFillingType, setCustomFill, setFill, setFillingType

Methods inherited from class net.rodofire.easierworldcreator.shape.block.instanciator.AbstractBlockShape

modifyChunkMap, setRotator

Methods inherited from class java.lang.Object

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

Constructor Details

CylinderGen

public CylinderGen(@NotNull
 @NotNull net.minecraft.util.math.BlockPos pos,
 Rotator rotator,
 int radiusX,
 int radiusZ,
 int height)

init a Cylinder object

Parameters:

pos - the center of the spiral

radiusX - the radius of the cylinder on the x-axis

radiusZ - the radius of the cylinder on the z-axis

height - the height of the cylinder

CylinderGen

public CylinderGen(@NotNull
 @NotNull net.minecraft.util.math.BlockPos pos,
 int radius,
 int height)

init a cylinder object

Parameters:

pos - the center of the spiral

radius - the radius of the cylinder

height - the height of the cylinder

Method Details

setHeight

public void setHeight(int height)

Sets the height of the cylinder.

The height defines the vertical size of the cylinder.

Parameters:

height - the height of the cylinder, in units.

getHeight

public int getHeight()

Gets the height of the cylinder.

The height represents the vertical size of the cylinder.

Returns:

the height of the cylinder, in units.

setRadiusX

public void setRadiusX(int radius)

Sets the radius of the cylinder along the X-axis.

The radius along the X-axis determines the horizontal size of the cylinder in the X direction.

Parameters:

radius - the radius of the cylinder along the X-axis, in units.

getRadiusX

public int getRadiusX()

Gets the radius of the cylinder along the X-axis.

The radius along the X-axis determines the horizontal size of the cylinder in the X direction.

Returns:

the radius of the cylinder along the X-axis, in units.

setRadiusZ

public void setRadiusZ(int radius)

Sets the radius of the cylinder along the Z-axis.

The radius along the Z-axis determines the horizontal size of the cylinder in the Z direction.

Parameters:

radius - the radius of the cylinder along the Z-axis, in units.

getRadiusZ

public int getRadiusZ()

Gets the radius of the cylinder along the Z-axis.

The radius along the Z-axis determines the horizontal size of the cylinder in the Z direction.

Returns:

the radius of the cylinder along the Z-axis, in units.

getShapeCoordinates

public Map<net.minecraft.util.math.ChunkPos,it.unimi.dsi.fastutil.longs.LongOpenHashSet> getShapeCoordinates()

Method to get the BlockPos of the shape

Specified by:

getShapeCoordinates in class AbstractBlockShape

Returns:

the blockPos divided into chunkPos

generateFullCylinder

public void generateFullCylinder()

this generates a full cylinder

generateEmptyCylinder

public void generateEmptyCylinder()

this generates a full cylinder.