Package de.slikey.effectlib.util

Class BaseImageEffect

java.lang.Object

de.slikey.effectlib.Effect

de.slikey.effectlib.util.BaseImageEffect

All Implemented Interfaces:

Runnable

Direct Known Subclasses:

ColoredImageEffect, ImageEffect

public abstract class BaseImageEffect
extends Effect

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	BaseImageEffect.Plane

Field Summary

Fields

Modifier and Type	Field	Description
double	angularVelocityX	Turns the cube by this angle each iteration around the x-axis
double	angularVelocityY	Turns the cube by this angle each iteration around the y-axis
double	angularVelocityZ	Turns the cube by this angle each iteration around the z-axis
boolean	enableRotation	Should it rotate?
String	fileName	For configuration-driven files
int	frameDelay	How many ticks to show each frame
protected ImageLoadCallback	imageLoadCallback
protected BufferedImage[]	images	Image as BufferedImage
boolean	orient	Should it orient to face the player's direction?
boolean	orientPitch	Should it face in the same direction as the location.
BaseImageEffect.Plane	plane	What plane should it rotate?
org.bukkit.util.Vector	rotation	Apply a fixed rotation
protected int	rotationStep	Rotation step counter
float	size	Scale the image down
protected int	step	Step counter
protected int	stepDelay	Delay between steps
int	stepX	Each stepX pixel will be shown.
int	stepY	Each stepY pixel will be shown.
boolean	transparency	Whether to check for transparent pixels

Fields inherited from class de.slikey.effectlib.Effect

arrivalTime, asynchronous, autoOrient, blockData, blockDuration, callback, color, colorList, colors, delay, disappearWithOriginEntity, disappearWithTargetEntity, duration, effectManager, iterations, material, materialData, maxIterations, offset, origin, particle, particleCount, particleData, particleOffsetX, particleOffsetY, particleOffsetZ, particleSize, period, pitch, pitchOffset, probability, relativeOffset, sculkChargeRotation, shriekDelay, speed, subEffect, subEffectClass, target, targetOffset, targetPlayers, toColor, toColorList, toColors, type, updateDirections, updateLocations, visibleRange, yaw, yawOffset

Constructor Summary

Constructors

Constructor	Description
BaseImageEffect(EffectManager effectManager)

Method Summary

Modifier and Type	Method	Description
protected abstract void	display(BufferedImage image, org.bukkit.util.Vector v, org.bukkit.Location location, int pixel)
protected void	initialize()
void	load(String fileName)
void	loadFile(File file)
void	onRun()
void	reset()	Effects should override this if they want to be reusable, this is called prior to starting so state can be reset.

Methods inherited from class de.slikey.effectlib.Effect

cancel, cancel, canDisappearWithOriginEntity, canDisappearWithTargetEntity, canUpdateDirections, display, display, display, display, display, getArrivalTime, getBlockData, getBlockDuration, getCallback, getColor, getColorList, getColors, getDelay, getDuration, getDynamicOrigin, getDynamicTarget, getEffectManager, getEntity, getIterations, getLocation, getMaterial, getMaterialData, getMaxIterations, getOffset, getOrigin, getParticle, getParticleCount, getParticleData, getParticleOffsetX, getParticleOffsetY, getParticleOffsetZ, getParticleSize, getPeriod, getPitch, getPitchOffset, getProbability, getRelativeOffset, getSculkChargeRotation, getShriekDelay, getSpeed, getStartTime, getSubEffect, getSubEffectClass, getTarget, getTargetEntity, getTargetOffset, getTargetPlayer, getTargetPlayers, getToColor, getToColorList, getToColors, getType, getVisibleRange, getYaw, getYawOffset, infinite, isAsynchronous, isAutoOrient, isDone, isPlaying, isUpdateLocations, onDone, parseColorList, prepare, reloadParameters, run, setBlockData, setBlockDuration, setDynamicOrigin, setDynamicTarget, setEntity, setLocation, setMaterial, setMaterialData, setMaxIterations, setOrigin, setParticleCount, setParticleOffsetX, setParticleOffsetY, setParticleOffsetZ, setParticleSize, setStartTime, setTarget, setTargetEntity, setTargetLocation, setTargetPlayer, setTargetPlayers, setType, start, updateDuration, updateLocation, updateTarget, validate

Methods inherited from class java.lang.Object

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

Field Details

fileName

public String fileName

For configuration-driven files

transparency

public boolean transparency

Whether to check for transparent pixels

frameDelay

public int frameDelay

How many ticks to show each frame

stepX

public int stepX

Each stepX pixel will be shown. Saves packets for high resolutions.

stepY

public int stepY

Each stepY pixel will be shown. Saves packets for high resolutions.

size

public float size

Scale the image down

enableRotation

public boolean enableRotation

Should it rotate?

rotation

public org.bukkit.util.Vector rotation

Apply a fixed rotation

orient

public boolean orient

Should it orient to face the player's direction?

orientPitch

public boolean orientPitch

Should it face in the same direction as the location. Obeying yaw and pitch?

plane

public BaseImageEffect.Plane plane

What plane should it rotate?

angularVelocityX

public double angularVelocityX

Turns the cube by this angle each iteration around the x-axis

angularVelocityY

public double angularVelocityY

Turns the cube by this angle each iteration around the y-axis

angularVelocityZ

public double angularVelocityZ

Turns the cube by this angle each iteration around the z-axis

images

protected BufferedImage[] images

Image as BufferedImage

step

protected int step

Step counter

rotationStep

protected int rotationStep

Rotation step counter

stepDelay

protected int stepDelay

Delay between steps

imageLoadCallback

protected ImageLoadCallback imageLoadCallback

Constructor Details

BaseImageEffect

public BaseImageEffect(EffectManager effectManager)

Method Details

initialize

protected void initialize()

Overrides:

initialize in class Effect

reset

public void reset()

Description copied from class: Effect

Effects should override this if they want to be reusable, this is called prior to starting so state can be reset.

Overrides:

reset in class Effect

load

public void load(String fileName)

loadFile

public void loadFile(File file)

onRun

public void onRun()

Specified by:

onRun in class Effect

display

protected abstract void display(BufferedImage image,
 org.bukkit.util.Vector v,
 org.bukkit.Location location,
 int pixel)