Package hm.zelha.particlesfx.shapers

Class ParticleSpiral

java.lang.Object

hm.zelha.particlesfx.shapers.parents.RotationHandler

hm.zelha.particlesfx.shapers.parents.ParticleShaper

hm.zelha.particlesfx.shapers.ParticleSpiral

All Implemented Interfaces:

Shape

public class ParticleSpiral
extends ParticleShaper

Field Summary

Fields

Modifier and Type	Field	Description
protected final CircleInfo	circleHelper
protected final List<CircleInfo>	circleInfos
protected int	count
protected boolean	rotateCircles
protected double	spin
protected final org.bukkit.util.Vector	vectorHelper2

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
ParticleSpiral(Particle particle, double spin, int count, int particleFrequency, CircleInfo... circleInfos)
ParticleSpiral(Particle particle, double spin, int count, CircleInfo... circleInfos)
ParticleSpiral(Particle particle, double spin, CircleInfo... circleInfos)
ParticleSpiral(Particle particle, int count, CircleInfo... circleInfos)
ParticleSpiral(Particle particle, CircleInfo... circleInfos)

Method Summary

Modifier and Type	Method	Description
void	addCircleInfo(int index, CircleInfo circleInfo)
void	addCircleInfo(CircleInfo circleInfo)
ParticleSpiral	clone()
protected ParticleShaper	cloneConstructor()
void	display()
CircleInfo	getCircleInfo(int index)
int	getCircleInfoAmount()
CircleInfo[]	getCircleInfos()
int	getCount()
double	getSpin()
boolean	isRotatingCircles()
protected boolean	recalculateIfNeeded(org.bukkit.Location around)
void	removeCircleInfo(int index)
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.
void	setCount(int count)
ParticleSpiral	setRotateCircles(boolean rotateCircles)
void	setSpin(double spin)
void	setWorld(org.bukkit.World world)

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, 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, 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

circleInfos

protected final List<CircleInfo> circleInfos

vectorHelper2

protected final org.bukkit.util.Vector vectorHelper2

circleHelper

protected final CircleInfo circleHelper

rotateCircles

protected boolean rotateCircles

spin

protected double spin

count

protected int count

Constructor Details

ParticleSpiral

public ParticleSpiral(Particle particle,
 double spin,
 int count,
 int particleFrequency,
 CircleInfo... circleInfos)

ParticleSpiral

public ParticleSpiral(Particle particle,
 double spin,
 int count,
 CircleInfo... circleInfos)

ParticleSpiral

public ParticleSpiral(Particle particle,
 double spin,
 CircleInfo... circleInfos)

ParticleSpiral

public ParticleSpiral(Particle particle,
 int count,
 CircleInfo... circleInfos)

ParticleSpiral

public ParticleSpiral(Particle particle,
 CircleInfo... circleInfos)

Method Details

display

public void display()

Specified by:

display in interface Shape

Specified by:

display in class ParticleShaper

clone

public ParticleSpiral 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

recalculateIfNeeded

protected boolean recalculateIfNeeded(@Nullable
 org.bukkit.Location around)

Overrides:

recalculateIfNeeded in class RotationHandler

addCircleInfo

public void addCircleInfo(int index,
 CircleInfo circleInfo)

addCircleInfo

public void addCircleInfo(CircleInfo circleInfo)

removeCircleInfo

public void removeCircleInfo(int index)

setWorld

public void setWorld(org.bukkit.World world)

Specified by:

setWorld in interface Shape

Overrides:

setWorld in class ParticleShaper

setSpin

public void setSpin(double spin)

Parameters:

spin - how many times the spiral goes in a circle throughout the whole shape

setCount

public void setCount(int count)

Parameters:

count - how many spirals this shape displays

setRotateCircles

public ParticleSpiral setRotateCircles(boolean rotateCircles)

Parameters:

rotateCircles - whether circles are rotated with the shape, defaults to true

getCircleInfo

public CircleInfo getCircleInfo(int index)

getCircleInfos

public CircleInfo[] getCircleInfos()

getSpin

public double getSpin()

Returns:

how many times the spiral goes in a circle throughout the whole shape

getCount

public int getCount()

Returns:

how many spirals this shape displays

isRotatingCircles

public boolean isRotatingCircles()

Returns:

whether circles are rotated with the shape, defaults to true

getCircleInfoAmount

public int getCircleInfoAmount()