com.jmex.effects.particles
Class RampEntry

java.lang.Object
  com.jmex.effects.particles.RampEntry

All Implemented Interfaces:

Savable

Direct Known Subclasses:

ParticleAppearancePanel.EndRamp, ParticleAppearancePanel.StartRamp

public class RampEntry
extends java.lang.Object
implements Savable

RampEntry defines an entry for a ParticleAppearanceRamp.

Author:

Joshua Slack

See Also:

ParticleAppearanceRamp

Field Summary

protected ColorRGBA	color
static ColorRGBA	DEFAULT_COLOR
static float	DEFAULT_MASS
static float	DEFAULT_OFFSET
static float	DEFAULT_SIZE
static float	DEFAULT_SPIN
protected float	mass
protected float	offset
protected float	size
protected float	spin

Constructor Summary

RampEntry()

RampEntry(float offset)
Construct new addition to color ramp

Method Summary

java.lang.Class	getClassTag() The peristed type for the object.
ColorRGBA	getColor()
float	getMass()
float	getOffset()
float	getSize()
float	getSpin()
boolean	hasColorSet()
boolean	hasMassSet()
boolean	hasSizeSet()
boolean	hasSpinSet()
void	read(JMEImporter im)
void	setColor(ColorRGBA color)
void	setMass(float mass)
void	setOffset(float offset)
void	setSize(float size)
void	setSpin(float spin)
java.lang.String	toString()
void	write(JMEExporter ex)

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_OFFSET

public static final float DEFAULT_OFFSET

See Also:

Constant Field Values

DEFAULT_SIZE

public static final float DEFAULT_SIZE

See Also:

Constant Field Values

DEFAULT_SPIN

public static final float DEFAULT_SPIN

See Also:

Constant Field Values

DEFAULT_MASS

public static final float DEFAULT_MASS

See Also:

Constant Field Values

DEFAULT_COLOR

public static final ColorRGBA DEFAULT_COLOR

offset

protected float offset

color

protected ColorRGBA color

size

protected float size

spin

protected float spin

mass

protected float mass

Constructor Detail

RampEntry

public RampEntry()

RampEntry

public RampEntry(float offset)

Construct new addition to color ramp

Parameters:

offset - amount of time (as a percent of total lifetime) between the last appearance and this one.

Method Detail

getColor

public ColorRGBA getColor()

setColor

public void setColor(ColorRGBA color)

hasColorSet

public boolean hasColorSet()

getSize

public float getSize()

setSize

public void setSize(float size)

hasSizeSet

public boolean hasSizeSet()

getSpin

public float getSpin()

setSpin

public void setSpin(float spin)

hasSpinSet

public boolean hasSpinSet()

getMass

public float getMass()

setMass

public void setMass(float mass)

hasMassSet

public boolean hasMassSet()

getOffset

public float getOffset()

setOffset

public void setOffset(float offset)

getClassTag

public java.lang.Class getClassTag()

Description copied from interface: Savable

The peristed type for the object. Note that tag here does not mean XML tag, but the class that the object is tagged with.

Specified by:

getClassTag in interface Savable

read

public void read(JMEImporter im)
          throws java.io.IOException

Specified by:

read in interface Savable

Throws:

java.io.IOException

write

public void write(JMEExporter ex)
           throws java.io.IOException

Specified by:

write in interface Savable

Throws:

java.io.IOException

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object