Package hm.zelha.particlesfx.shapers

Class ParticleText

java.lang.Object

hm.zelha.particlesfx.shapers.parents.RotationHandler

hm.zelha.particlesfx.shapers.parents.ParticleShaper

hm.zelha.particlesfx.shapers.ParticleText

All Implemented Interfaces:

Shape

public class ParticleText
extends ParticleShaper

Field Summary

Fields

Modifier and Type	Field	Description
protected int	borderX
protected int	borderZ
protected boolean	centered
protected Font	font
protected int	height
protected BufferedImage	image
protected boolean	inverted
protected boolean	remakeImage
protected final ThreadLocalRandom	rng
protected int	startX
protected int	startZ
protected final List<String>	text
protected int	width
protected double	xRadius
protected double	zRadius

Fields inherited from class hm.zelha.particlesfx.shapers.parents.ParticleShaper

animator, async, currentCount, delay, locationHelper, mechanics, overallCount, particle, particleFrequency, particlesPerDisplay, players, secondaryParticles, vectorHelper

Fields inherited from class hm.zelha.particlesfx.shapers.parents.RotationHandler

centroid, compounds, lastRotatedAround, locations, originalCentroid, origins, rhLocationHelper, rhRotHelper, rhVectorHelper, rot, rot2, rotHelper

Constructor Summary

Constructors

Constructor	Description
ParticleText(Particle particle, LocationSafe center, double xRadius, double zRadius, int particleFrequency, String... text)
ParticleText(Particle particle, LocationSafe center, double xRadius, double zRadius, String... text)
ParticleText(Particle particle, LocationSafe center, double radius, int particleFrequency, String... text)
ParticleText(Particle particle, LocationSafe center, double radius, String... text)

Method Summary

Modifier and Type	Method	Description
void	addLines(int index, String... strings)
void	addLines(String... strings)
ParticleText	clone()
protected ParticleShaper	cloneConstructor()
void	display()
int	getBorderX()
int	getBorderZ()
org.bukkit.Location	getCenter()
Font	getFont()
String	getLine(int line)
int	getLineAmount()
String[]	getText()
double	getXRadius()
double	getZRadius()
boolean	isCentered()
boolean	isInverted()
protected void	remakeImage()
void	removeLine(int line)
void	scale(double x, double y, double z)	Rescales this shape such that a shape with the xyz radiuses of 4, 3, 4, resized by 1.25, 1.25, 1.25, would have its radiuses become 5, 3.75, 5.
ParticleText	setBorderX(int borderX)
ParticleText	setBorderZ(int borderZ)
void	setCenter(LocationSafe center)
ParticleText	setCentered(boolean centered)
ParticleText	setFont(Font font)
ParticleText	setInverted(boolean inverted)
void	setLine(int line, String text)
void	setXRadius(double xRadius)
void	setZRadius(double zRadius)

Methods inherited from class hm.zelha.particlesfx.shapers.parents.ParticleShaper

addMechanic, addParticle, addPlayer, addPlayer, applyMechanics, getCurrentParticle, getDelay, getMechanicAmount, getParticle, getParticleFrequency, getParticlesPerDisplay, getPlayerAmount, getPlayers, getSecondaryParticle, getSecondaryParticleAmount, hasPlayer, isAsync, isRunning, removeMechanic, removeParticle, removePlayer, removePlayer, setAsync, setDelay, setDisplayPosition, setParticle, setParticleFrequency, setParticlesPerDisplay, setWorld, start, stop

Methods inherited from class hm.zelha.particlesfx.shapers.parents.RotationHandler

addCompound, calculateCentroid, face, faceAroundLocation, getAroundAxisPitch, getAroundAxisRoll, getAroundAxisYaw, getAroundPitch, getAroundRoll, getAroundRotationOrder, getAroundYaw, getAxisPitch, getAxisRoll, getAxisYaw, getClonedCenter, getDirection, getLocationAmount, getLocations, getLocationsList, getPitch, getRoll, getRotationOrder, getTotalDistance, getWorld, getYaw, move, move, move, recalculateIfNeeded, removeCompound, rotate, rotateAroundLocation, scale, setAroundAxisPitch, setAroundAxisRoll, setAroundAxisRotation, setAroundAxisYaw, setAroundPitch, setAroundRoll, setAroundRotation, setAroundRotationOrder, setAroundYaw, setAxisPitch, setAxisRoll, setAxisRotation, setAxisYaw, setPitch, setRoll, setRotation, setRotationOrder, setYaw

Methods inherited from class java.lang.Object

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

Methods inherited from interface hm.zelha.particlesfx.shapers.parents.Shape

face, faceAroundLocation, getAroundAxisPitch, getAroundAxisRoll, getAroundAxisYaw, getAroundPitch, getAroundRoll, getAroundRotationOrder, getAroundYaw, getAxisPitch, getAxisRoll, getAxisYaw, getClonedCenter, getLocationAmount, getLocations, getPitch, getRoll, getRotationOrder, getTotalDistance, getWorld, getYaw, move, move, move, rotate, rotateAroundLocation, scale, setAroundAxisPitch, setAroundAxisRoll, setAroundAxisRotation, setAroundAxisYaw, setAroundPitch, setAroundRoll, setAroundRotation, setAroundRotationOrder, setAroundYaw, setAxisPitch, setAxisRoll, setAxisRotation, setAxisYaw, setPitch, setRoll, setRotation, setRotationOrder, setYaw

Field Details

rng

protected final ThreadLocalRandom rng

text

protected final List<String> text

font

protected Font font

xRadius

protected double xRadius

zRadius

protected double zRadius

inverted

protected boolean inverted

centered

protected boolean centered

borderX

protected int borderX

borderZ

protected int borderZ

image

protected BufferedImage image

remakeImage

protected boolean remakeImage

width

protected int width

height

protected int height

startX

protected int startX

startZ

protected int startZ

Constructor Details

ParticleText

public ParticleText(Particle particle,
 LocationSafe center,
 double xRadius,
 double zRadius,
 int particleFrequency,
 String... text)

ParticleText

public ParticleText(Particle particle,
 LocationSafe center,
 double xRadius,
 double zRadius,
 String... text)

ParticleText

public ParticleText(Particle particle,
 LocationSafe center,
 double radius,
 int particleFrequency,
 String... text)

ParticleText

public ParticleText(Particle particle,
 LocationSafe center,
 double radius,
 String... text)

Method Details

display

public void display()

Specified by:

display in interface Shape

Specified by:

display in class ParticleShaper

clone

public ParticleText clone()

Specified by:

clone in interface Shape

Overrides:

clone in class ParticleShaper

cloneConstructor

protected ParticleShaper cloneConstructor()

Specified by:

cloneConstructor in class ParticleShaper

scale

public void scale(double x,
 double y,
 double z)

Description copied from interface: Shape

Rescales this shape such that a shape with the xyz radiuses of 4, 3, 4, resized by 1.25, 1.25, 1.25, would have its radiuses become 5, 3.75, 5.

Specified by:

scale in interface Shape

Overrides:

scale in class RotationHandler

Parameters:

x - x scale

y - y scale

z - z scale

remakeImage

protected void remakeImage()

addLines

public void addLines(int index,
 String... strings)

addLines

public void addLines(String... strings)

removeLine

public void removeLine(int line)

setFont

public ParticleText setFont(Font font)

setLine

public void setLine(int line,
 String text)

setCenter

public void setCenter(LocationSafe center)

setXRadius

public void setXRadius(double xRadius)

setZRadius

public void setZRadius(double zRadius)

setInverted

public ParticleText setInverted(boolean inverted)

Parameters:

inverted - whether particles should appear within the text or outlining the text, default false

setCentered

public ParticleText setCentered(boolean centered)

Parameters:

centered - whether the text should be centered or not, default true

setBorderX

public ParticleText setBorderX(int borderX)

Parameters:

borderX - how wide the border around the text should be, only used if isInverted() is true.

setBorderZ

public ParticleText setBorderZ(int borderZ)

Parameters:

borderZ - how tall the border around the text should be, only used if isInverted() is true.

getFont

public Font getFont()

getLine

public String getLine(int line)

getCenter

public org.bukkit.Location getCenter()

getXRadius

public double getXRadius()

getZRadius

public double getZRadius()

isInverted

public boolean isInverted()

Returns:

whether particles should appear within the text or outlining the text, default false

isCentered

public boolean isCentered()

Returns:

whether the text should be centered or not, default true

getBorderX

public int getBorderX()

Returns:

how wide the border around the text should be, only used if isInverted() is true.

getBorderZ

public int getBorderZ()

Returns:

how tall the border around the text should be, only used if isInverted() is true.

getText

public String[] getText()

getLineAmount

public int getLineAmount()