| ca.forklabs.media.jai.CollectionDescriptor
 ca.forklabs.media.jai.operator.ApplyToCollectionDescriptor
| ApplyToCollectionDescriptor | | public class ApplyToCollectionDescriptor extends CollectionDescriptor (Code) | | Class
ApplyToCollectionDescriptor is an
OperationDescriptor describing the applytocollection operation. This operation applies
the same operation to all the image of a collection.
The applytocollection operation takes two parameters: the name of
the operation to apply and the parameter of the operation. No source need
to be added to the parameter, it will be done internally.
Resource List
| Name | Value |
|---|
| GlobalName | ApplyToCollection |
| LocalName | ApplyToCollection |
| Vendor | ca.forklabs.media.jai.opimage |
| Description | Applies the same operator to a collection of images |
| DocURL | n/a |
| Version | $Version$ |
| Arg0Desct | The operation name |
| Arg1Desct | The parameter block |
Parameter List
| Name | Class Type | Default Value |
|---|
| operation |
String |
"null" |
| parameters |
ParameterBlock |
new ParameterBlock() |
author:
Daniel Léonard
version:
$Revision: 1.6 $ |
| Method Summary | |
| public static Collection<RenderedImage> | createCollection(Collection<RenderedImage> sources, String operation, ParameterBlock parameters, RenderingHints hints)
Performs the operation on a collection of rendered images.
Parameters:
sources - the source images.
Parameters:
operation - the name of the operation.
Parameters:
parameters - the parameter block for the operation.
Parameters:
hints - the rendering hints, may be null . | | protected static ParameterBlockJAI | createParameterBlock(String mode, Object source, String operation, ParameterBlock parameters)
Creates and fills a new parameter block.
Parameters:
mode - the rendering mode.
Parameters:
source - the source image.
Parameters:
operation - the name of the operation.
Parameters:
parameters - the parameter block for the operation. | | public static Collection<RenderableImage> | createRenderableCollection(Collection<RenderableImage> sources, String operation, ParameterBlock parameters, RenderingHints hints)
Performs the operation on a collection of renderable images.
Parameters:
sources - the source images.
Parameters:
operation - the name of the operation.
Parameters:
parameters - the parameter block for the operation.
Parameters:
hints - the rendering hints, may be null . | | protected static String | getArg0Description()
Gets the description for the first argument, the operation name. | | protected static String | getArg1Description()
Gets the description for the second argument, the parameter block. | | protected static String | getDescription()
Gets the description of this operation. |
| NAME | | final public static String NAME(Code) | | The name of this operator.
|
| OPERATION_PARAMETER_INDEX | | final public static int OPERATION_PARAMETER_INDEX(Code) | | The index in the parameter block of the operation parameter.
|
| OPERATION_PARAMETER_NAME | | final public static String OPERATION_PARAMETER_NAME(Code) | | The name of the operation parameter.
|
| PARAMETERS_PARAMETER_INDEX | | final public static int PARAMETERS_PARAMETER_INDEX(Code) | | The index in the parameter block of the parameter block parameter.
|
| PARAMETERS_PARAMETER_NAME | | final public static String PARAMETERS_PARAMETER_NAME(Code) | | The name of the parameter block parameter.
|
| ApplyToCollectionDescriptor | | public ApplyToCollectionDescriptor()(Code) | | Constructor.
|
| createCollection | | public static Collection<RenderedImage> createCollection(Collection<RenderedImage> sources, String operation, ParameterBlock parameters, RenderingHints hints)(Code) | | Performs the operation on a collection of rendered images.
Parameters:
sources - the source images.
Parameters:
operation - the name of the operation.
Parameters:
parameters - the parameter block for the operation.
Parameters:
hints - the rendering hints, may be null . the rendered result image. |
| createParameterBlock | | protected static ParameterBlockJAI createParameterBlock(String mode, Object source, String operation, ParameterBlock parameters)(Code) | | Creates and fills a new parameter block.
Parameters:
mode - the rendering mode.
Parameters:
source - the source image.
Parameters:
operation - the name of the operation.
Parameters:
parameters - the parameter block for the operation. a new parameter block. |
| createRenderableCollection | | public static Collection<RenderableImage> createRenderableCollection(Collection<RenderableImage> sources, String operation, ParameterBlock parameters, RenderingHints hints)(Code) | | Performs the operation on a collection of renderable images.
Parameters:
sources - the source images.
Parameters:
operation - the name of the operation.
Parameters:
parameters - the parameter block for the operation.
Parameters:
hints - the rendering hints, may be null . the rendered result image. |
| getArg0Description | | protected static String getArg0Description()(Code) | | Gets the description for the first argument, the operation name.
the description message. |
| getArg1Description | | protected static String getArg1Description()(Code) | | Gets the description for the second argument, the parameter block.
the description message. |
| getDescription | | protected static String getDescription()(Code) | | Gets the description of this operation.
the description message. |
|
|