|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Operator
An operator in ImageApp commonly represents some image processing algorithm (although not all do eg/ there are also operators that read/write image data to/from files). Operators consist of a widget to allow it to be drawn on screen and a class that actually handles performing the underlying algorithm. So OpViewer can treat all the different operators as one type, they all must implement this interface.
OpViewer
Method Summary | |
---|---|
boolean |
acceptsInputFrom(Operator o)
Check the operators that are allowed to output data to this operator |
java.awt.image.RenderedImage |
execute(java.awt.image.renderable.ParameterBlock inData)
Execute this operator with the input data passed as a parameter |
int |
getAllowedInputs()
|
int |
getAllowedOutputs()
|
java.lang.String |
getHelpID()
Return a String help id that is the one used in the java help mapping file |
java.net.URL |
getIcon()
Get the URL to the icon for this operator |
java.awt.image.renderable.ParameterBlock |
getInputParameters()
|
java.awt.image.renderable.ParameterBlock |
getInputParametersForWriting()
|
OperatorDialog |
getOperatorDialog()
|
DataTypeConstant |
getOutputData()
Get the type of the data that is output from this operator. |
int |
getRequiredInputs()
|
void |
setInputParameters(java.awt.image.renderable.ParameterBlock inputParameters)
TODO: Should there be a different method when params have been read?? |
void |
setOperatorDialog(OperatorDialog dialog)
|
void |
showOperatorDialog()
Show a GUI that allows users to modify the parameters for the underlying operation |
Method Detail |
---|
void showOperatorDialog()
void setOperatorDialog(OperatorDialog dialog)
dialog
- - The OperatorDialog that handles getting this operators parametersOperatorDialog getOperatorDialog()
java.lang.String getHelpID()
int getAllowedInputs()
int getAllowedOutputs()
int getRequiredInputs()
boolean acceptsInputFrom(Operator o)
o
- -The Operator to check
DataTypeConstant getOutputData()
DataTypeConstant
java.awt.image.RenderedImage execute(java.awt.image.renderable.ParameterBlock inData) throws java.lang.Exception
inData
- - The input data to this operator
java.lang.Exception
java.net.URL getIcon()
java.awt.image.renderable.ParameterBlock getInputParameters()
void setInputParameters(java.awt.image.renderable.ParameterBlock inputParameters)
inputParameters
- java.awt.image.renderable.ParameterBlock getInputParametersForWriting()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |