openlayers/src/ol/style/iconsymbolizer.js

goog.provide('ol.style.Icon');

goog.require('goog.asserts');
goog.require('ol.expr');
goog.require('ol.expr.Expression');
goog.require('ol.expr.Literal');
goog.require('ol.geom.GeometryType');
goog.require('ol.style.IconLiteral');
goog.require('ol.style.Point');
goog.require('ol.style.PointLiteral');



/**
 * @constructor
 * @extends {ol.style.Point}
 * @param {ol.style.IconOptions} options Icon options.
 */
ol.style.Icon = function(options) {

  goog.asserts.assert(options.url, 'url must be set');

  /**
   * @type {ol.expr.Expression}
   * @private
   */
  this.url_ = (options.url instanceof ol.expr.Expression) ?
          options.url : new ol.expr.Literal(options.url);

  /**
   * @type {ol.expr.Expression}
   * @private
   */
  this.width_ = !goog.isDef(options.width) ?
      null :
      (options.width instanceof ol.expr.Expression) ?
          options.width : new ol.expr.Literal(options.width);

  /**
   * @type {ol.expr.Expression}
   * @private
   */
  this.height_ = !goog.isDef(options.height) ?
      null :
      (options.height instanceof ol.expr.Expression) ?
          options.height : new ol.expr.Literal(options.height);

  /**
   * @type {ol.expr.Expression}
   * @private
   */
  this.opacity_ = !goog.isDef(options.opacity) ?
      new ol.expr.Literal(ol.style.IconDefaults.opacity) :
      (options.opacity instanceof ol.expr.Expression) ?
          options.opacity : new ol.expr.Literal(options.opacity);

  /**
   * @type {ol.expr.Expression}
   * @private
   */
  this.rotation_ = !goog.isDef(options.rotation) ?
      new ol.expr.Literal(ol.style.IconDefaults.rotation) :
      (options.rotation instanceof ol.expr.Expression) ?
          options.rotation : new ol.expr.Literal(options.rotation);

};


/**
 * @inheritDoc
 * @return {ol.style.IconLiteral} Literal shape symbolizer.
 */
ol.style.Icon.prototype.createLiteral = function(featureOrType) {
  var feature, type;
  if (featureOrType instanceof ol.Feature) {
    feature = featureOrType;
    var geometry = feature.getGeometry();
    type = geometry ? geometry.getType() : null;
  } else {
    type = featureOrType;
  }

  var literal = null;
  if (type === ol.geom.GeometryType.POINT ||
      type === ol.geom.GeometryType.MULTIPOINT) {

    var url = ol.expr.evaluateFeature(this.url_, feature);
    goog.asserts.assertString(url, 'url must be a string');
    goog.asserts.assert(url != '#', 'url must not be "#"');

    var width;
    if (!goog.isNull(this.width_)) {
      width = ol.expr.evaluateFeature(this.width_, feature);
      goog.asserts.assertNumber(width, 'width must be a number');
    }

    var height;
    if (!goog.isNull(this.height_)) {
      height = ol.expr.evaluateFeature(this.height_, feature);
      goog.asserts.assertNumber(height, 'height must be a number');
    }

    var opacity = ol.expr.evaluateFeature(this.opacity_, feature);
    goog.asserts.assertNumber(opacity, 'opacity must be a number');

    var rotation = ol.expr.evaluateFeature(this.rotation_, feature);
    goog.asserts.assertNumber(rotation, 'rotation must be a number');

    literal = new ol.style.IconLiteral({
      url: url,
      width: width,
      height: height,
      opacity: opacity,
      rotation: rotation
    });
  }

  return literal;
};


/**
 * Get the height.
 * @return {ol.expr.Expression} Icon height.
 */
ol.style.Icon.prototype.getHeight = function() {
  return this.height_;
};


/**
 * Get the opacity.
 * @return {ol.expr.Expression} Opacity.
 */
ol.style.Icon.prototype.getOpacity = function() {
  return this.opacity_;
};


/**
 * Get the rotation.
 * @return {ol.expr.Expression} Icon rotation.
 */
ol.style.Icon.prototype.getRotation = function() {
  return this.rotation_;
};


/**
 * Get the url.
 * @return {ol.expr.Expression} Icon url.
 */
ol.style.Icon.prototype.getUrl = function() {
  return this.url_;
};


/**
 * Get the width.
 * @return {ol.expr.Expression} Icon width.
 */
ol.style.Icon.prototype.getWidth = function() {
  return this.width_;
};


/**
 * Set the height.
 * @param {ol.expr.Expression} height Icon height.
 */
ol.style.Icon.prototype.setHeight = function(height) {
  goog.asserts.assertInstanceof(height, ol.expr.Expression);
  this.height_ = height;
};


/**
 * Set the opacity.
 * @param {ol.expr.Expression} opacity Opacity.
 */
ol.style.Icon.prototype.setOpacity = function(opacity) {
  goog.asserts.assertInstanceof(opacity, ol.expr.Expression);
  this.opacity_ = opacity;
};


/**
 * Set the rotation.
 * @param {ol.expr.Expression} rotation Icon rotation.
 */
ol.style.Icon.prototype.setRotation = function(rotation) {
  goog.asserts.assertInstanceof(rotation, ol.expr.Expression);
  this.rotation_ = rotation;
};


/**
 * Set the url.
 * @param {ol.expr.Expression} url Icon url.
 */
ol.style.Icon.prototype.setUrl = function(url) {
  goog.asserts.assertInstanceof(url, ol.expr.Expression);
  this.url_ = url;
};


/**
 * Set the width.
 * @param {ol.expr.Expression} width Icon width.
 */
ol.style.Icon.prototype.setWidth = function(width) {
  goog.asserts.assertInstanceof(width, ol.expr.Expression);
  this.width_ = width;
};


/**
 * @typedef {{opacity: (number),
 *            rotation: (number)}}
 */
ol.style.IconDefaults = {
  opacity: 1,
  rotation: 0
};