Package snap.gfx

Class EmbossEffect

java.lang.Object

snap.props.PropObject

snap.gfx.Effect

snap.gfx.EmbossEffect

All Implemented Interfaces:

PropChange.DoChange, XMLArchiver.Archivable

public class EmbossEffect
extends Effect

An Effect subclass that make drawing look slightly 3D with raised or lowered edges.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	Altitude_Prop
static final String	Azimuth_Prop
static final double	DEFAULT_ALTITUDE
static final double	DEFAULT_AZIMUTH
static final double	DEFAULT_RADIUS
static final String	Radius_Prop

Fields inherited from class snap.props.PropObject

_pcs, EMPTY_OBJECT

Constructor Summary

Constructors

Constructor	Description
EmbossEffect()	Creates an emboss effect.
EmbossEffect(double anAlt, double anAzi, double aRad)	Creates an emboss effect for given altitude, azimuth and radius.

Method Summary

Modifier and Type	Method	Description
void	applyEffect(PainterDVR aPDVR, Painter aPntr, Rect aRect)	Performs the ShadowEffect with given PainterDVR.
EmbossEffect	copyForAltitude(double anAlt)	Returns a new Emboss for given altitude.
EmbossEffect	copyForAzimuth(double anAzi)	Returns a new Emboss for given azimuth.
EmbossEffect	copyForRadius(double aRad)	Returns a new Emboss for given radius.
boolean	equals(Object anObj)	Standard equals implementation.
Object	fromXML(XMLArchiver anArchiver, XMLElement anElement)	XML unarchival.
double	getAltitude()	Returns altitude of light source.
double	getAzimuth()	Returns angle of light source.
Rect	getBounds(Rect aRect)	Override to account for blur radius.
Image	getEmbossImage(PainterDVR aPDVR, Rect aRect)	Creates emboss image.
Object	getPropValue(String aPropName)	Override to support props for this class.
double	getRadius()	Returns radius of edge rounding.
protected void	initProps(PropSet aPropSet)	Override to configure props for this class.
void	setPropValue(String aPropName, Object aValue)	Override to support props for this class.
XMLElement	toXML(XMLArchiver anArchiver)	XML archival.

Methods inherited from class snap.gfx.Effect

getName

Methods inherited from class snap.props.PropObject

addDeepChangeListener, addPropChangeListener, addPropChangeListener, clone, firePropChange, firePropChange, firePropChange, getPropDefault, getPropForName, getPropParent, getPropSet, getPropsForArchival, getPropsForArchivalExtra, isPropDefault, processPropChange, removeDeepChangeListener, removePropChangeListener, removePropChangeListener, toString, toStringProps

Methods inherited from class java.lang.Object

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

Field Details

Altitude_Prop

public static final String Altitude_Prop

See Also:

• Constant Field Values

Azimuth_Prop

public static final String Azimuth_Prop

See Also:

• Constant Field Values

Radius_Prop

public static final String Radius_Prop

See Also:

• Constant Field Values

DEFAULT_ALTITUDE

public static final double DEFAULT_ALTITUDE

See Also:

• Constant Field Values

DEFAULT_AZIMUTH

public static final double DEFAULT_AZIMUTH

See Also:

• Constant Field Values

DEFAULT_RADIUS

public static final double DEFAULT_RADIUS

See Also:

• Constant Field Values

Constructor Details

EmbossEffect

public EmbossEffect()

Creates an emboss effect.

EmbossEffect

public EmbossEffect(double anAlt,
 double anAzi,
 double aRad)

Creates an emboss effect for given altitude, azimuth and radius.

Method Details

getAltitude

public double getAltitude()

Returns altitude of light source.

getAzimuth

public double getAzimuth()

Returns angle of light source.

getRadius

public double getRadius()

Returns radius of edge rounding.

getBounds

public Rect getBounds(Rect aRect)

Override to account for blur radius.

Overrides:

getBounds in class Effect

applyEffect

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

Performs the ShadowEffect with given PainterDVR.

Overrides:

applyEffect in class Effect

getEmbossImage

public Image getEmbossImage(PainterDVR aPDVR,
 Rect aRect)

Creates emboss image.

copyForAltitude

public EmbossEffect copyForAltitude(double anAlt)

Returns a new Emboss for given altitude.

copyForAzimuth

public EmbossEffect copyForAzimuth(double anAzi)

Returns a new Emboss for given azimuth.

copyForRadius

public EmbossEffect copyForRadius(double aRad)

Returns a new Emboss for given radius.

equals

public boolean equals(Object anObj)

Standard equals implementation.

Overrides:

equals in class Object

initProps

protected void initProps(PropSet aPropSet)

Override to configure props for this class.

Overrides:

initProps in class PropObject

getPropValue

public Object getPropValue(String aPropName)

Override to support props for this class.

Overrides:

getPropValue in class PropObject

setPropValue

public void setPropValue(String aPropName,
 Object aValue)

Override to support props for this class.

Overrides:

setPropValue in class PropObject

toXML

public XMLElement toXML(XMLArchiver anArchiver)

XML archival.

Specified by:

toXML in interface XMLArchiver.Archivable

Overrides:

toXML in class Effect

fromXML

public Object fromXML(XMLArchiver anArchiver,
 XMLElement anElement)

XML unarchival.

Specified by:

fromXML in interface XMLArchiver.Archivable

Overrides:

fromXML in class Effect