|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectartofillusion.image.filter.ImageFilter
public abstract class ImageFilter
This class defines an object which can filter rendered images. It is an abstract class, whose subclasses implement specific types of filters. An ImageFilter may present a user interface for configuring filtering options, and also may have a list of keyframeable parameters.
Constructor Summary | |
---|---|
ImageFilter()
Every ImageFilter subclass must provide a constructor which takes no arguments. |
Method Summary | |
---|---|
void |
copy(ImageFilter f)
Given another ImageFilter (of the same class as this one), make this one identical to it. |
ImageFilter |
duplicate()
Create an exact duplicate of this filter. |
abstract void |
filterImage(ComplexImage image,
Scene scene,
SceneCamera camera,
CoordinateSystem cameraPos)
Apply the filter to an image. |
Widget |
getConfigPanel(java.lang.Runnable changeCallback)
Get a Widget with which the user can specify options for the filter. |
int |
getDesiredComponents()
Get a list of all the image components required by this filter. |
abstract java.lang.String |
getName()
Get the name of this filter. |
TextureParameter[] |
getParameters()
Deprecated. |
double[] |
getParameterValues()
Deprecated. |
Property[] |
getProperties()
Get a list of Properties which affect the behavior of the filter. |
java.lang.Object |
getPropertyValue(int index)
Get the value of a Property. |
abstract void |
initFromStream(java.io.DataInputStream in,
Scene theScene)
Reconstruct this filter from its serialized representation. |
void |
setParameterValue(int index,
double value)
Deprecated. |
void |
setPropertyValue(int index,
java.lang.Object value)
Set the value of a Property. |
abstract void |
writeToStream(java.io.DataOutputStream out,
Scene theScene)
Write a serialized description of this filter to a stream. |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public ImageFilter()
Method Detail |
---|
public abstract java.lang.String getName()
public int getDesiredComponents()
public abstract void filterImage(ComplexImage image, Scene scene, SceneCamera camera, CoordinateSystem cameraPos)
image
- the image to filterscene
- the Scene which was rendered to create the imagecamera
- the camera from which the Scene was renderedcameraPos
- the position of the camera in the scenepublic ImageFilter duplicate()
public void copy(ImageFilter f)
@Deprecated public TextureParameter[] getParameters()
@Deprecated public double[] getParameterValues()
@Deprecated public void setParameterValue(int index, double value)
public Property[] getProperties()
public java.lang.Object getPropertyValue(int index)
index
- the index of the Property to getpublic void setPropertyValue(int index, java.lang.Object value)
index
- the index of the Property to setvalue
- the value of the Propertypublic abstract void writeToStream(java.io.DataOutputStream out, Scene theScene) throws java.io.IOException
java.io.IOException
public abstract void initFromStream(java.io.DataInputStream in, Scene theScene) throws java.io.IOException
java.io.IOException
public Widget getConfigPanel(java.lang.Runnable changeCallback)
changeCallback
- a Runnable which should be invoked whenever the filter's configuration
changes, so the containing window can update its preview
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |