Package snap.gfx

Class Effect

java.lang.Object

snap.props.PropObject

snap.gfx.Effect

All Implemented Interfaces:

PropChange.DoChange, XMLArchiver.Archivable

Direct Known Subclasses:

BlurEffect, EmbossEffect, ReflectEffect, ShadowEffect

public class Effect
extends PropObject
implements XMLArchiver.Archivable

A class to represent a visual effect that can be applied to drawing done in a Painter (like blur, shadow, etc.).

Field Summary

Fields inherited from class snap.props.PropObject

_pcs, EMPTY_OBJECT

Constructor Summary

Constructors

Constructor	Description
Effect()	Constructor.

Method Summary

Modifier and Type	Method	Description
void	applyEffect(PainterDVR aPDVR, Painter aPntr, Rect aRect)	Apply the effect from given DVR to painter.
Object	fromXML(XMLArchiver anArchiver, XMLElement anElement)	XML unarchival.
Rect	getBounds(Rect aRect)	Returns the bounds required to render this effect applied to given rect.
String	getName()	Returns the name of the effect.
static Effect	of(Object anObj)	Parses an effect from given object.
XMLElement	toXML(XMLArchiver anArchiver)	XML archival.

Methods inherited from class snap.props.PropObject

addDeepChangeListener, addPropChangeListener, addPropChangeListener, clone, firePropChange, firePropChange, firePropChange, getPropDefault, getPropForName, getPropParent, getPropSet, getPropsForArchival, getPropsForArchivalExtra, getPropsString, getPropValue, initProps, isPropDefault, processPropChange, removeDeepChangeListener, removePropChangeListener, removePropChangeListener, setPropsString, setPropValue, setPropValues, toString, toStringProps

Methods inherited from class java.lang.Object

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

Constructor Details

Effect

public Effect()

Constructor.

Method Details

getName

public String getName()

Returns the name of the effect.

getBounds

public Rect getBounds(Rect aRect)

Returns the bounds required to render this effect applied to given rect.

applyEffect

public void applyEffect(PainterDVR aPDVR,
 Painter aPntr,
 Rect aRect)

Apply the effect from given DVR to painter.

toXML

public XMLElement toXML(XMLArchiver anArchiver)

XML archival.

Specified by:

toXML in interface XMLArchiver.Archivable

fromXML

public Object fromXML(XMLArchiver anArchiver,
 XMLElement anElement)

XML unarchival.

Specified by:

fromXML in interface XMLArchiver.Archivable

of

public static Effect of(Object anObj)

Parses an effect from given object.