gm-mirrorize

Extension for Node.js image manipulation library gm which allows to mirror images (create reflections of the images).

Based on original script for ImageMagick by Fred Weinhaus: http://www.fmwconcepts.com/imagemagick/mirrorize/index.php

Extension was implemented accroding to the guide, method called mirrorize will be embedded into gm prototype.

Support

Extension works only with ImageMagick, it will not work with GraphicsMagick, which is default for gm. If ImageMagick was not enabled, the method mirrorize will do nothing to the image.

Supported version of gm is >=1.3.2.

Description

  .mirrorize(direction)

• direction (optional, defaults to West) - describes which part of the image will be reflected. For example North will result into the north half of the image to be reflected, reflection will be placed over the south part of the image (see examples below)

Available directions:

• North
• South
• West (default)
• East
• NorthWest
• NorthEast
• SouthWest
• SouthEast

Usage

// use ImageMagick
var gm = require('gm').subClass({ imageMagick: true });

// extend "gm" with "mirrorize" method
require('gm-mirrorize');


// basic

gm('/path/to/my/img.jpg')
  .mirrorize('NorthWest')
  .write('/path/to/mirrorize.jpg', function (err) {
    // ...
  });


// multiple

gm('/path/to/my/img.jpg')
  .mirrorize('North')
  .mirrorize('West')
  .write('/path/to/mirrorize.jpg', function (err) {
    // ...
  });


// chain

gm('/path/to/my/img.jpg')
  .rezise(800, 600)
  .crop(400, 200, 10, 30)
  .mirrorize('South')
  .flop()
  .rezise(200, 200)
  .write('/path/to/mirrorize.jpg', function (err) {
    // ...
  });

Examples

Original

Mirrorized

Test

Run from the extension directory:

npm test

License

Copyright © Michael Radionov Copyright © Fred Weinhaus

License terms are based on the original script license terms provided by Fred Weinhaus and can be found at http://www.fmwconcepts.com/imagemagick/mirrorize/index.php.

This software and associated documentation files (the "Software") is available free of charge ONLY for non-commercial use. To use the Software in commercial (for-profit) environments or non-free applications, and also to modify, publish, distribute, sublicinse, incorporate into other software or reprogramming into another scripting languages, you must contact Fred Weinhaus for licensing arrangements ( contact information - http://www.fmwconcepts.com/imagemagick/index.php ).

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.