Operation PlugIns

From RealWorld Wiki

Document operation plug-ins perform an operation with a document according to their configuration. They may or may not modify the document.

Beside the actual document, the operation can also access view states, and sometimes to handle of current window and current locale identifier. Document operation should in general not interact with the user.

Contents 1 List of operation by document type 1.1 Common operations 1.2 Raster Image operations 1.3 Icon operations 1.4 Animation operations 1.5 3D graphics operations 2 Implementing an Operation

[edit] List of operation by document type

[edit] Common operations

• JScript - use custom JavaScript code to modify the document.
• Sequence - run one or more operations or transformations in sequence.
• Display configuration - show a configuration dialog before the operation is actually executed giving the user a change to modify operation's parameters. The dialog may contain a preview window.

[edit] Raster Image operations

• Automatic contrast - automatically adjust contrast of an image.
• Bevel - lit a beveled surface.
• Blend with background - blend transparent pixels with given background color.
• Blur - Gaussian blur with given radius.
• Canvas size - extend the size of the drawing canvas.
• Color adjustments - adjust brightness, contrast, gamma, and color saturation.
• Colorize - change hue and saturation of every pixel to selected values.
• Convolution - convolve the image with itself.
• Drop shadow - add a shadow to the image. The image must have transparent areas, or the shadow will not be visible unless the canvas is extended.
• Fade - apply another operation on raster image and set adjust its effect. The effect may be outside the 0-100% range.
• Fill - fill image with gradient or texture.
• Glow - make the bright parts of the image appear to glow by spreading their color to nearby pixels.
• Grayscale - convert image to gray tones with selected weight of RGB components.
• Mask - apply a filter on selected region only.
• Modify mask - use a filter to modify selection mask.
• Photoshop filter - run an Adobe Photoshop compatible filter.
• Properties - set image dimensions, resolution, alpha mode, and color depth.
• Remove empty border - remove solid-color border from an image (or add a border).
• Resample - change resolution of an image.
• Rotate - rotate the image around its center.
• Seam carving - content-aware image resizing.
• Set file format - set image file format (JPG, PNG, ...) and its properties.
• Shift hue - shift hue of every pixel while maintaining its saturation and luminance.
• Transform - apply affine or perspective transformation.
• Unsharp mask - sharpen picture.
• Vignetting - eliminate vignetting artefacts caused by low quality lens.
• Watermark - print a text or a logo image on the image.

[edit] Icon operations

• Create pre-XP formats - create 8-bits and 4-bits per pixel images from 32-bits sources.

[edit] Animation operations

• Delete frames - deletes selected frames from an animation.

[edit] 3D graphics operations

• Transform points - apply transformation on selected grip points (handles).

[edit] Implementing an Operation

From technical point of view an Operation plug-in is a COM class placed in a category CATID_DocumentOperation and implementing an IDocumentOperation interface.

GUID CATID_DocumentOperation =
    {0x902734f0, 0x00a5, 0x477c, {0xb3, 0x36, 0xb9, 0x22, 0x1d, 0x46, 0xa3, 0xdd}};