imagick.wave.inc in Imagick 7

File

effects/imagick.wave.inc

<?php

/**
 * Waves an image
 *
 * @param $image
 *   An image object. The $image->resource value will be modified by this call.
 * @param $amplitude
 *   The amplitude of the wave effect.
 * @param $length
 *   The length of the wave effect.
 * @return
 *   TRUE or FALSE, based on success.
 */
function image_imagick_wave(stdClass $image, $amplitude, $length) {
  return $image->resource
    ->waveImage($amplitude, $length);
}

/**
 * @param $dimensions
 *   Dimensions to be modified - an array with components width and height, in
 *   pixels.
 * @param $data
 */
function imagick_wave_dimensions(array &$dimensions, array $data) {
  if (!empty($dimensions['height'])) {
    $dimensions['height'] += $data['amplitude'] * 2;
  }
}

/**
 * Implements the imagick wave effect.
 *
 * @param $image
 *   An image object
 * @param array $data
 *   The data passed from the form
 */
function imagick_wave($image, $data = array()) {
  image_toolkit_invoke('wave', $image, $data);
}

/**
 * Settings form for the imagick wave effect.
 *
 * @param $action
 *   The saved action form parameters.
 */
function imagick_wave_form($data) {
  $data = array_merge(imagick_wave_defaults(), (array) $data);
  $form['amplitude'] = array(
    '#type' => 'textfield',
    '#title' => t('Amplitude'),
    '#description' => t('The amplitude of the wave effect.'),
    '#default_value' => $data['amplitude'],
    '#size' => 3,
  );
  $form['length'] = array(
    '#type' => 'textfield',
    '#title' => t('Length'),
    '#description' => t('The length of the wave effect.'),
    '#default_value' => $data['length'],
    '#size' => 3,
  );
  return $form;
}

/**
 * Returns the default settings of this effect.
 */
function imagick_wave_defaults() {
  return array(
    'amplitude' => '8',
    'length' => '64',
  );
}

Functions

Name	Description
image_imagick_wave	Waves an image
imagick_wave	Implements the imagick wave effect.
imagick_wave_defaults	Returns the default settings of this effect.
imagick_wave_dimensions
imagick_wave_form	Settings form for the imagick wave effect.