FilterEffect is a support class for managing effects hosted by the VectorFilter class.
The FilterEffect class provides base-class functionality for effect classes. FilterEffect objects mut not be instantiated directly by the client.
The documented fields and actions here are integral to all effects that utilise this class.
Structure
The FilterEffect class consists of the following fields:
Access | Name | Type | Comment |
|---|
|
| Dimensions | DMF | Dimension flags are stored here. |
|---|
Dimension flags are automatically defined when setting the X, Y, Width and Height fields.
| Name | Description |
|---|
| DMF::FIXED_CENTER_X | The CenterX field is a fixed size. |
|---|
| DMF::FIXED_CENTER_Y | The CenterY field is a fixed size. |
|---|
| DMF::FIXED_DEPTH | The Depth field is a fixed size. |
|---|
| DMF::FIXED_HEIGHT | The Height field is a fixed size. |
|---|
| DMF::FIXED_RADIUS_X | The RadiusX field is a fixed size. |
|---|
| DMF::FIXED_RADIUS_Y | The RadiusY field is a fixed size. |
|---|
| DMF::FIXED_WIDTH | The Width field is a fixed suze. |
|---|
| DMF::FIXED_X | The X field is a fixed coordinate. |
|---|
| DMF::FIXED_X_OFFSET | The XOffset field is a fixed coordinate. |
|---|
| DMF::FIXED_Y | The Y field is a fixed coordinate. |
|---|
| DMF::FIXED_Y_OFFSET | The YOffset field is a fixed coordinate. |
|---|
| DMF::FIXED_Z | The Z field is a fixed coordinate. |
|---|
| DMF::SCALED_CENTER_X | The CenterX field is scaled to this object's parent. |
|---|
| DMF::SCALED_CENTER_Y | The CenterY field is scaled to this object's parent. |
|---|
| DMF::SCALED_DEPTH | The Depth field is scaled to this object's parent. |
|---|
| DMF::SCALED_HEIGHT | The Height field is scaled to this object's parent. |
|---|
| DMF::SCALED_RADIUS_X | The RadiusX field is scaled to this object's parent. |
|---|
| DMF::SCALED_RADIUS_Y | The RadiusY field is a scaled size to this object's parent. |
|---|
| DMF::SCALED_WIDTH | The Width field is scaled to this object's parent. |
|---|
| DMF::SCALED_X | The X field is scaled to this object's parent. |
|---|
| DMF::SCALED_X_OFFSET | The XOffset field is scaled to this object's parent. |
|---|
| DMF::SCALED_Y | The Y field is scaled to this object's parent. |
|---|
| DMF::SCALED_Y_OFFSET | The YOffset field is scaled to this object's parent. |
|---|
| DMF::SCALED_Z | The Z field is a scaled coordinate to this object's parent. |
|---|
| DMF::STATUS_CHANGE_H | |
|---|
| DMF::STATUS_CHANGE_V | |
|---|
|
|
| Height | DOUBLE | Primitive height of the effect area. |
|---|
The (Width, Height) field values define the dimensions of the effect within the target clipping area.
|
|
| Input | *FilterEffect | Reference to another effect to be used as an input source. |
|---|
If another effect should be used as a source input, it must be referenced here. The SourceType will be automatically set to REFERENCE as a result.
This field is the SVG equivalent to in. If the Input is not defined by the client then it will default to the previous effect if available, otherwise the source graphic is used.
|
|
| Mix | *FilterEffect | Reference to another effect to be used a mixer with Input. |
|---|
If another effect should be used as a mixed source input, it must be referenced here. The MixType will be automatically set to REFERENCE as a result.
This field is the SVG equivalent to in2. It does nothing if the effect does not supported a mixed source input.
|
|
| MixType | VSF | If a secondary mix input is required for the effect, specify it here. |
|---|
Some effects support a secondary mix input for compositing, such as the CompositeFX class. If the mixing source is a reference to another effect, set the Mix field instead and this field will be set to REFERENCE automatically.
| Name | Description |
|---|
| VSF::ALPHA | As for GRAPHIC except that only the alpha channel is used. |
|---|
| VSF::BKGD | An image snapshot of the SVG document under the filter region at the time that the filter element was invoked. |
|---|
| VSF::BKGD_ALPHA | As for BKGD but only the alpha channel is used. |
|---|
| VSF::FILL | The value of the fill property on the target element for the filter effect. |
|---|
| VSF::GRAPHIC | Represents the graphics elements that were the original input into the filter element. |
|---|
| VSF::IGNORE | The filter does not require an input source. |
|---|
| VSF::PREVIOUS | Use the previous effect as input, or source graphic if no previous effect. |
|---|
| VSF::REFERENCE | This value is an assigned name for the filter primitive in the form of a custom-ident. If supplied, then graphics that result from processing this filter primitive can be referenced by an in attribute on a subsequent filter primitive within the same filter element. If no value is provided, the output will only be available for re-use as the implicit input into the next filter primitive if that filter primitive provides no value for its in attribute. |
|---|
| VSF::STROKE | The value of the stroke property on the target element for the filter effect. |
|---|
|
|
| Next | *FilterEffect | Next filter in the chain. |
|---|
|
| Prev | *FilterEffect | Previous filter in the chain. |
|---|
|
| SourceType | VSF | Specifies an input source for the effect algorithm, if required. |
|---|
If an effect requires an input source for processing, it must be specified here. If the source is a reference to another effect, set the Input field instead and this field will be set to REFERENCE automatically.
| Name | Description |
|---|
| VSF::ALPHA | As for GRAPHIC except that only the alpha channel is used. |
|---|
| VSF::BKGD | An image snapshot of the SVG document under the filter region at the time that the filter element was invoked. |
|---|
| VSF::BKGD_ALPHA | As for BKGD but only the alpha channel is used. |
|---|
| VSF::FILL | The value of the fill property on the target element for the filter effect. |
|---|
| VSF::GRAPHIC | Represents the graphics elements that were the original input into the filter element. |
|---|
| VSF::IGNORE | The filter does not require an input source. |
|---|
| VSF::PREVIOUS | Use the previous effect as input, or source graphic if no previous effect. |
|---|
| VSF::REFERENCE | This value is an assigned name for the filter primitive in the form of a custom-ident. If supplied, then graphics that result from processing this filter primitive can be referenced by an in attribute on a subsequent filter primitive within the same filter element. If no value is provided, the output will only be available for re-use as the implicit input into the next filter primitive if that filter primitive provides no value for its in attribute. |
|---|
| VSF::STROKE | The value of the stroke property on the target element for the filter effect. |
|---|
|
|
| Target | *Bitmap | Target bitmap for rendering the effect. |
|---|
|
| Width | DOUBLE | Primitive width of the effect area. |
|---|
The (Width,Height) field values define the dimensions of the effect within the target clipping area.
|
|
| X | DOUBLE | Primitive X coordinate for the effect. |
|---|
The (X,Y) field values define the offset of the effect within the target clipping area.
|
|
| Y | DOUBLE | Primitive Y coordinate for the effect. |
|---|
The (X,Y) field values define the offset of the effect within the target clipping area.
|
Actions
The following actions are currently supported:
| MoveToBack | Move an effect to the front of the VectorFilter's list order. |
|---|
| MoveToFront | Move an object to the front of its current location. |
|---|
VSF Type
Filter source types - these are used internally
| Name | Description |
|---|
| VSF::ALPHA | As for GRAPHIC except that only the alpha channel is used. |
|---|
| VSF::BKGD | An image snapshot of the SVG document under the filter region at the time that the filter element was invoked. |
|---|
| VSF::BKGD_ALPHA | As for BKGD but only the alpha channel is used. |
|---|
| VSF::FILL | The value of the fill property on the target element for the filter effect. |
|---|
| VSF::GRAPHIC | Represents the graphics elements that were the original input into the filter element. |
|---|
| VSF::IGNORE | The filter does not require an input source. |
|---|
| VSF::PREVIOUS | Use the previous effect as input, or source graphic if no previous effect. |
|---|
| VSF::REFERENCE | This value is an assigned name for the filter primitive in the form of a custom-ident. If supplied, then graphics that result from processing this filter primitive can be referenced by an in attribute on a subsequent filter primitive within the same filter element. If no value is provided, the output will only be available for re-use as the implicit input into the next filter primitive if that filter primitive provides no value for its in attribute. |
|---|
| VSF::STROKE | The value of the stroke property on the target element for the filter effect. |
|---|