java.lang.Object

hm.zelha.particlesfx.shapers.parents.RotationHandler

hm.zelha.particlesfx.util.ParticleShapeCompound

All Implemented Interfaces:: Shape

public class ParticleShapeCompound extends RotationHandler implements Shape

Field Summary

Fields

Modifier and Type

Field

Description

protected final Map<String,Shape>

nameMap

protected boolean

recalc

protected final Map<Shape,Integer>

shapeLocationIndex

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

ParticleShapeCompound(Shape... shapes)
Method Summary

Modifier and Type

Method

Description

void

addMechanic(ShapeDisplayMechanic.Phase phase, ShapeDisplayMechanic mechanic)

Similar to Consumer
in the case of phases ShapeDisplayMechanic.Phase.BEFORE_ROTATION and ShapeDisplayMechanic.Phase.AFTER_ROTATION the given mechanic will run before the location is modified to display the next particle, allowing you to modify the addition vector however you want, though doing so may be very volatile

keep in mind that all changes to the given objects will be reflected in the display() method, and considering that the display() method often displays hundreds of particles, try to make sure the mechanic isn't very resource-intensive

ShapeDisplayMechanic.apply(Particle, Location, Vector, int)

void

addParticle(Particle particle, int particlesUntilDisplay)

adds a particle for this shape to display after a certain amount of other particles

void

addPlayer(UUID uuid)

adds a player for this shape to display to, defaults to all online players in the shape's world if the list is empty

void

addPlayer(org.bukkit.entity.Player player)

adds a player for this shape to display to, defaults to all online players in the shape's world if the list is empty

void

addShape(Shape shape)

void

addShape(Shape shape, String name)

Adds the given shape to this ParticleShapeCompound under the given name, so that you can easily access the shape via getShape(String)

ParticleShapeCompound

clone()

void

display()

int

getDelay()

Deprecated.

int

getMechanicAmount()

Deprecated.

Particle

getParticle()

Deprecated.

int

getParticleFrequency()

int

getParticlesPerDisplay()

int

getPlayerAmount()

List<UUID>

getPlayers()

Pair<Particle,Integer>

getSecondaryParticle(int index)

Deprecated.

int

getSecondaryParticleAmount()

Deprecated.

Shape

getShape(int index)

Shape

getShape(String name)

int

getShapeAmount()

Shape[]

getShapes()

boolean

hasPlayer(org.bukkit.entity.Player player)

boolean

isAsync()

Deprecated.

boolean

isRunning()

protected boolean

recalculateIfNeeded(org.bukkit.Location around)

void

removeMechanic(int index)

void

removeParticle(int index)

void

removePlayer(int index)

void

removePlayer(org.bukkit.entity.Player player)

void

removeShape(int index)

void

removeShape(String name)

Removes the shape with the given name from this ParticleShapeCompound. will do nothing if there are no shapes with the given name

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.

Shape

setAsync(boolean async)

Shape

setDelay(int delay)

void

setDisplayPosition(int position)

sets the current position of the shape's animation
(aka, sets the tracker that tells the shape how many particles have been displayed until this point)

void

setParticle(Particle particle)

void

setParticleFrequency(int particleFrequency)

Shape

setParticlesPerDisplay(int particlesPerDisplay)

0 means that the entire animation will be played when .display() is called

Shape

start()

Shape

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

Field Details
- shapeLocationIndex
  
  protected final Map<Shape,Integer> shapeLocationIndex
- nameMap
  
  protected final Map<String,Shape> nameMap
- recalc
  
  protected boolean recalc
Constructor Details
- ParticleShapeCompound
  
  public ParticleShapeCompound(Shape... shapes)
Method Details
- start
  
  public Shape start()
  
  Specified by:
  
  start in interface Shape
  
  Returns:
  
  this object
- stop
  
  public Shape stop()
  
  Specified by:
  
  stop in interface Shape
  
  Returns:
  
  this object
- display
  
  public void display()
  
  Specified by:
  
  display in interface Shape
- clone
  
  public ParticleShapeCompound clone()
  
  Specified by:
  
  clone in interface Shape
  
  Overrides:
  
  clone in class Object
- 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
- addParticle
  
  public void addParticle(Particle particle, int particlesUntilDisplay)
  
  Description copied from interface: Shape
  
  adds a particle for this shape to display after a certain amount of other particles
  
  Specified by:
  
  addParticle in interface Shape
  
  Parameters:
  
  particle - particle to add
  
  particlesUntilDisplay - how many particles need to be displayed before this one
- addMechanic
  
  public void addMechanic(ShapeDisplayMechanic.Phase phase, ShapeDisplayMechanic mechanic)
  
  Description copied from interface: Shape
  
  Similar to Consumer
  in the case of phases ShapeDisplayMechanic.Phase.BEFORE_ROTATION and ShapeDisplayMechanic.Phase.AFTER_ROTATION the given mechanic will run before the location is modified to display the next particle, allowing you to modify the addition vector however you want, though doing so may be very volatile
  
  keep in mind that all changes to the given objects will be reflected in the display() method, and considering that the display() method often displays hundreds of particles, try to make sure the mechanic isn't very resource-intensive
  
  ShapeDisplayMechanic.apply(Particle, Location, Vector, int)
  
  Specified by:
  
  addMechanic in interface Shape
  
  Parameters:
  
  phase - phase that the mechanic should run at
  
  mechanic - mechanic to run during display
- addPlayer
  
  public void addPlayer(org.bukkit.entity.Player player)
  
  Description copied from interface: Shape
  
  adds a player for this shape to display to, defaults to all online players in the shape's world if the list is empty
  
  Specified by:
  
  addPlayer in interface Shape
  
  Parameters:
  
  player - player to add
- addPlayer
  
  public void addPlayer(UUID uuid)
  
  Description copied from interface: Shape
  
  adds a player for this shape to display to, defaults to all online players in the shape's world if the list is empty
  
  Specified by:
  
  addPlayer in interface Shape
  
  Parameters:
  
  uuid - ID of player to add
- removeParticle
  
  public void removeParticle(int index)
  Specified by:
  
  removeParticle in interface Shape
  
  Parameters:
  
  index - index of particle in list (main particle is not in list)
  
  See Also:
  
  ParticleShaper.addParticle(Particle, int)
- removeMechanic
  
  public void removeMechanic(int index)
  Specified by:
  
  removeMechanic in interface Shape
  
  Parameters:
  
  index - index of mechanic in list
  
  See Also:
  
  Shape.addMechanic(ShapeDisplayMechanic.Phase, ShapeDisplayMechanic)
- removePlayer
  
  public void removePlayer(int index)
  Specified by:
  
  removePlayer in interface Shape
  
  Parameters:
  
  index - index of player to remove from list
  
  See Also:
  
  Shape.addPlayer(Player)
- removePlayer
  
  public void removePlayer(org.bukkit.entity.Player player)
  Specified by:
  
  removePlayer in interface Shape
  
  Parameters:
  
  player - player to remove from list
  
  See Also:
  
  Shape.addPlayer(Player)
- hasPlayer
  
  public boolean hasPlayer(org.bukkit.entity.Player player)
  
  Specified by:
  
  hasPlayer in interface Shape
  
  Parameters:
  
  player - player to check for
  
  Returns:
  
  whether this shape displays to this player
- setParticle
  
  public void setParticle(Particle particle)
  
  Specified by:
  
  setParticle in interface Shape
- setParticleFrequency
  
  public void setParticleFrequency(int particleFrequency)
  
  Specified by:
  
  setParticleFrequency in interface Shape
  
  Parameters:
  
  particleFrequency - amount of times to display the particle per full animation
- setParticlesPerDisplay
  
  public Shape setParticlesPerDisplay(int particlesPerDisplay)
  
  Description copied from interface: Shape
  
  0 means that the entire animation will be played when .display() is called
  
  Specified by:
  
  setParticlesPerDisplay in interface Shape
  
  Parameters:
  
  particlesPerDisplay - amount of particles that will be shown per display
- setAsync
  
  public Shape setAsync(boolean async)
  
  Specified by:
  
  setAsync in interface Shape
- setDelay
  
  public Shape setDelay(int delay)
  
  Specified by:
  
  setDelay in interface Shape
  
  Parameters:
  
  delay - amount of ticks between Shape.display() being called
- setDisplayPosition
  
  public void setDisplayPosition(int position)
  
  Description copied from interface: Shape
  
  sets the current position of the shape's animation
  (aka, sets the tracker that tells the shape how many particles have been displayed until this point)
  
  Specified by:
  
  setDisplayPosition in interface Shape
  
  Parameters:
  
  position - position for shape to display at
- getParticle
  
  @Deprecated public Particle getParticle()
  
  Deprecated.
  
  Specified by:
  
  getParticle in interface Shape
- getSecondaryParticle
  
  @Deprecated public Pair<Particle,Integer> getSecondaryParticle(int index)
  
  Deprecated.
  Specified by:
  
  getSecondaryParticle in interface Shape
  
  Parameters:
  
  index - index of particle to get from the list
  
  Returns:
  
  a pair of the particle and the amount of particles before it should be displayed
  
  See Also:
  
  ParticleShaper.addParticle(Particle, int)
- getParticleFrequency
  
  public int getParticleFrequency()
  
  Specified by:
  
  getParticleFrequency in interface Shape
- getParticlesPerDisplay
  
  public int getParticlesPerDisplay()
  Specified by:
  
  getParticlesPerDisplay in interface Shape
  
  Returns:
  
  the amount of particles per display
  
  See Also:
  
  Shape.setParticlesPerDisplay(int)
- getDelay
  
  @Deprecated public int getDelay()
  
  Deprecated.
  
  Specified by:
  
  getDelay in interface Shape
  
  Returns:
  
  amount of ticks between ParticleShaper.display() being called
- getSecondaryParticleAmount
  
  @Deprecated public int getSecondaryParticleAmount()
  
  Deprecated.
  Specified by:
  
  getSecondaryParticleAmount in interface Shape
  
  Returns:
  
  the amount of extra particles that this shape uses
  
  See Also:
  
  ParticleShaper.addParticle(Particle, int)
- getMechanicAmount
  
  @Deprecated public int getMechanicAmount()
  
  Deprecated.
  Specified by:
  
  getMechanicAmount in interface Shape
  
  Returns:
  
  the amount of mechanics used by this shape
  
  See Also:
  
  ParticleShaper.addMechanic(ShapeDisplayMechanic.Phase, ShapeDisplayMechanic)
- getPlayers
  
  public List<UUID> getPlayers()
  
  Specified by:
  
  getPlayers in interface Shape
  
  Returns:
  
  the UUIDs of all the players that this shape displays to. displays to all players if this list is empty
- getPlayerAmount
  
  public int getPlayerAmount()
  
  Specified by:
  
  getPlayerAmount in interface Shape
  
  Returns:
  
  amount of players this shape displays to
- isAsync
  
  @Deprecated public boolean isAsync()
  
  Deprecated.
  
  Specified by:
  
  isAsync in interface Shape
- isRunning
  
  public boolean isRunning()
  
  Specified by:
  
  isRunning in interface Shape
- recalculateIfNeeded
  
  protected boolean recalculateIfNeeded(@Nullable org.bukkit.Location around)
  
  Overrides:
  
  recalculateIfNeeded in class RotationHandler
- addShape
  
  public void addShape(Shape shape, String name)
  
  Adds the given shape to this ParticleShapeCompound under the given name, so that you can easily access the shape via getShape(String)
  
  Parameters:
  
  shape - shape to add
  
  name - name of shape
- addShape
  
  public void addShape(Shape shape)
- removeShape
  
  public void removeShape(String name)
  
  Removes the shape with the given name from this ParticleShapeCompound. will do nothing if there are no shapes with the given name
  
  Parameters:
  
  name - name of the shape to remove
- removeShape
  
  public void removeShape(int index)
- getShape
  
  public Shape getShape(String name)
  
  Parameters:
  
  name - name of shape, as added via addShape(Shape, String)
  
  Returns:
  
  the shape with the given name
- getShape
  
  public Shape getShape(int index)
- getShapes
  
  public Shape[] getShapes()
- getShapeAmount
  
  public int getShapeAmount()

Class ParticleShapeCompound

Field Summary

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

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

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

Field Details

shapeLocationIndex

nameMap

recalc

Constructor Details

ParticleShapeCompound

Method Details

start

stop

display

clone

scale

addParticle

addMechanic

addPlayer

addPlayer

removeParticle

removeMechanic

removePlayer

removePlayer

hasPlayer

setParticle

setParticleFrequency

setParticlesPerDisplay

setAsync

setDelay

setDisplayPosition

getParticle

getSecondaryParticle

getParticleFrequency

getParticlesPerDisplay

getDelay

getSecondaryParticleAmount

getMechanicAmount

getPlayers

getPlayerAmount

isAsync

isRunning

recalculateIfNeeded

addShape

addShape

removeShape

removeShape

getShape

getShape

getShapes

getShapeAmount