com.inductiveautomation.rm.graphics

Class RMReflectionEffect

java.lang.Object

com.inductiveautomation.rm.base.RMListenerList

com.inductiveautomation.rm.base.RMObject

com.inductiveautomation.rm.graphics.RMEffect

com.inductiveautomation.rm.graphics.RMImageEffect

com.inductiveautomation.rm.graphics.RMReflectionEffect

All Implemented Interfaces:

Archivable, DeepChangeListener, RMPropertyChanger, java.beans.PropertyChangeListener, java.lang.Cloneable, java.util.EventListener

public class RMReflectionEffect
extends RMImageEffect

This class adds a reflection to a given shape.

Nested Class Summary

Nested classes/interfaces inherited from class com.inductiveautomation.rm.graphics.RMImageEffect

RMImageEffect.BoxKernel, RMImageEffect.ConeKernel, RMImageEffect.GaussianKernel

Constructor Summary

Constructors

Constructor and Description
RMReflectionEffect()

Method Summary

Modifier and Type	Method and Description
RMReflectionEffect	deriveEffect(float aReflectionHeight, float aFadeHeight, float aGapHeight) Creates a new reflection effect by cloning this one and substituting given reflection, fade and gap heights, if greater than zero.
boolean	equals(java.lang.Object anObj) Standard equals implementation.
java.lang.Object	fromXML(RXArchiver anArchiver, RXElement anElement) XML unarchival.
RMRect	getBounds(RMShape aShape) Returns the bounds required to render this fill for this shape.
float	getFadeHeight() Returns the height of the faded region as a fraction of reflection height (defaults to .5).
float	getGapHeight() Returns the height of the gap between the shape and the reflection in points (defaults to 0).
java.awt.image.BufferedImage	getImage(RMShape aShape) Returns the effect image.
float	getReflectionHeight() Returns the height of the reflected image as fraction of shape height (defaults to 1).
void	paint(RMShapePainter aPntr, RMShape aShape) Render this fill in a Java2D Graphics2D.
protected void	setFadeHeight(float aValue) Sets the height of the faded region as a fraction of reflection height.
protected void	setGapHeight(float aValue) Sets the height of the gap between the shape and the reflection in points.
protected void	setReflectionHeight(float aValue) Sets the height of the reflected image as fraction of shape height.
RXElement	toXML(RXArchiver anArchiver) XML archival.

Methods inherited from class com.inductiveautomation.rm.graphics.RMImageEffect

clone, getBlurredImage, getBlurredImage, getCachedImage, getShapeImage, reset

Methods inherited from class com.inductiveautomation.rm.graphics.RMEffect

deepChange, getName, isEnabled, propertyChange, setEnabled, toString

Methods inherited from class com.inductiveautomation.rm.base.RMObject

addPropertyChangeListener, animUpdate, firePropertyChange, firePropertyChange, firePropertyChange, getPCEvent, removePropertyChangeListener, sendPropertyChange

Methods inherited from class com.inductiveautomation.rm.base.RMListenerList

addListener, getListener, getListenerCount, getListenerCount, getListenerList, getListeners, hasListeners, removeListener

Methods inherited from class java.lang.Object

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

Constructor Detail

RMReflectionEffect

public RMReflectionEffect()

Method Detail

getReflectionHeight

public float getReflectionHeight()

Returns the height of the reflected image as fraction of shape height (defaults to 1).

setReflectionHeight

protected void setReflectionHeight(float aValue)

Sets the height of the reflected image as fraction of shape height.

getFadeHeight

public float getFadeHeight()

Returns the height of the faded region as a fraction of reflection height (defaults to .5).

setFadeHeight

protected void setFadeHeight(float aValue)

Sets the height of the faded region as a fraction of reflection height.

getGapHeight

public float getGapHeight()

Returns the height of the gap between the shape and the reflection in points (defaults to 0).

setGapHeight

protected void setGapHeight(float aValue)

Sets the height of the gap between the shape and the reflection in points.

deriveEffect

public RMReflectionEffect deriveEffect(float aReflectionHeight,
                                       float aFadeHeight,
                                       float aGapHeight)

Creates a new reflection effect by cloning this one and substituting given reflection, fade and gap heights, if greater than zero.

getBounds

public RMRect getBounds(RMShape aShape)

Returns the bounds required to render this fill for this shape.

Overrides:

getBounds in class RMEffect

getImage

public java.awt.image.BufferedImage getImage(RMShape aShape)

Returns the effect image.

Specified by:

getImage in class RMImageEffect

paint

public void paint(RMShapePainter aPntr,
                  RMShape aShape)

Render this fill in a Java2D Graphics2D.

Overrides:

paint in class RMEffect

equals

public boolean equals(java.lang.Object anObj)

Standard equals implementation.

Overrides:

equals in class java.lang.Object

toXML

public RXElement toXML(RXArchiver anArchiver)

XML archival.

Specified by:

toXML in interface Archivable

Overrides:

toXML in class RMEffect

fromXML

public java.lang.Object fromXML(RXArchiver anArchiver,
                                RXElement anElement)

XML unarchival.

Specified by:

fromXML in interface Archivable

Overrides:

fromXML in class RMEffect