Package studio.magemonkey.fabled.api.particle

Class PolarSettings

java.lang.Object

studio.magemonkey.fabled.api.particle.PolarSettings

public class PolarSettings
extends Object

Settings for a particle effect

Constructor Summary

Constructors

Constructor	Description
PolarSettings(studio.magemonkey.codex.mccore.config.parse.DataSection settings)	Loads settings from config data
PolarSettings(IValue formula, int steps)	Sets up a formula for particle effects
PolarSettings(IValue formula, int steps, int copies, double domain)	Sets up a formula for particle effects

Method Summary

Modifier and Type	Method	Description
int	getCopies()
Point3D[]	getPoints(DirectionHandler direction)	Grabs the base points that make up the shape of the effect
int	getSteps()
double	getT(int step)	Gets the time step value for the animation step
Point2D[]	getTrig(int step)	Fetches the trig values for the animation
PolarSettings	setOffset(double x, double y, double z)	Sets the offset for the effect

Methods inherited from class java.lang.Object

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

Constructor Details

PolarSettings

public PolarSettings(IValue formula,
 int steps)

Sets up a formula for particle effects

Parameters:

formula - formula to use

steps - the number of steps to apply

PolarSettings

public PolarSettings(IValue formula,
 int steps,
 int copies,
 double domain)

Sets up a formula for particle effects

Parameters:

formula - formula to use

steps - the number of steps to apply

copies - number of copies to use rotated about the origin

domain - domain of the input values

PolarSettings

public PolarSettings(studio.magemonkey.codex.mccore.config.parse.DataSection settings)

Loads settings from config data

Parameters:

settings - settings to load from

Method Details

getTrig

public Point2D[] getTrig(int step)

Fetches the trig values for the animation

Parameters:

step - animation step

Returns:

trig values

getCopies

public int getCopies()

Returns:

number of copies

getSteps

public int getSteps()

Returns:

number of steps in the formula

setOffset

public PolarSettings setOffset(double x,
 double y,
 double z)

Sets the offset for the effect

Parameters:

x - X-Axis offset

y - Y-Axis offset

z - Z-Axis offset

Returns:

this

getPoints

public Point3D[] getPoints(DirectionHandler direction)

Grabs the base points that make up the shape of the effect

Returns:

shape points

getT

public double getT(int step)

Gets the time step value for the animation step

Parameters:

step - animation step

Returns:

time step