gov.nasa.worldwind.symbology.BasicTacticalGraphicAttributes Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of worldwind-pcm Show documentation
worldwind-pcm
The newest version!
/*
 * Copyright (C) 2012 United States Government as represented by the Administrator of the
 * National Aeronautics and Space Administration.
 * All Rights Reserved.
 */

package gov.nasa.worldwind.symbology;

import gov.nasa.worldwind.render.Material;
import gov.nasa.worldwind.util.Logging;

import java.awt.*;

/**
 * Basic implementation of {@link TacticalGraphicAttributes}.
 *
 * @author pabercrombie
 * @version $Id: BasicTacticalGraphicAttributes.java 1171 2013-02-11 21:45:02Z dcollins $
 */
public class BasicTacticalGraphicAttributes implements TacticalGraphicAttributes
{
    /**
     * Indicates the symbol scale as a ratio of the symbol's original size, or null to use the symbol's
     * default scale. Initially null.
     */
    protected Double scale;
    /** Indicates the material properties of the graphic's interior. Initially null. */
    protected Material interiorMaterial;
    /** Indicates the material properties of the graphic's outline. Initially null. */
    protected Material outlineMaterial;
    /**
     * Indicates the opacity of the graphic's interior as a floating-point value in the range 0.0 to 1.0. Initially
     * 0.0.
     */
    protected Double interiorOpacity;
    /** Indicates the opacity of the graphic's outline as a floating-point value in the range 0.0 to 1.0. Initially 0.0. */
    protected Double outlineOpacity;
    /** Indicates the line width (in pixels) used when rendering the shape's outline. Initially 0.0. */
    protected double outlineWidth;
    /** Indicates the font used to render text modifiers. */
    protected Font font;
    /** Indicates the material used to render text modifiers. */
    protected Material textMaterial;

    /** Creates a new BasicTacticalGraphicAttributes. */
    public BasicTacticalGraphicAttributes()
    {
    }

    /**
     * Creates a new BasicTacticalGraphicAttributes configured with the specified attributes.
     *
     * @param attributes the attributes to configure the new BasicTacticalGraphicAttributes with.
     *
     * @throws IllegalArgumentException if attributes is null.
     */
    public BasicTacticalGraphicAttributes(TacticalGraphicAttributes attributes)
    {
        if (attributes == null)
        {
            String message = Logging.getMessage("nullValue.AttributesIsNull");
            Logging.logger().severe(message);
            throw new IllegalArgumentException(message);
        }

        this.scale = attributes.getScale();
        this.font = attributes.getTextModifierFont();
        this.textMaterial = attributes.getTextModifierMaterial();
        this.interiorMaterial = attributes.getInteriorMaterial();
        this.outlineMaterial = attributes.getOutlineMaterial();
        this.interiorOpacity = attributes.getInteriorOpacity();
        this.outlineOpacity = attributes.getOutlineOpacity();
        this.outlineWidth = attributes.getOutlineWidth();
    }

    /** {@inheritDoc} */
    public TacticalGraphicAttributes copy()
    {
        return new BasicTacticalGraphicAttributes(this);
    }

    /** {@inheritDoc} */
    public void copy(TacticalGraphicAttributes attributes)
    {
        if (attributes != null)
        {
            this.scale = attributes.getScale();
            this.font = attributes.getTextModifierFont();
            this.textMaterial = attributes.getTextModifierMaterial();
            this.interiorMaterial = attributes.getInteriorMaterial();
            this.outlineMaterial = attributes.getOutlineMaterial();
            this.interiorOpacity = attributes.getInteriorOpacity();
            this.outlineOpacity = attributes.getOutlineOpacity();
            this.outlineWidth = attributes.getOutlineWidth();
        }
    }

    /** {@inheritDoc} */
    public Double getScale()
    {
        return this.scale;
    }

    /** {@inheritDoc} */
    public void setScale(Double scale)
    {
        if (scale != null && scale < 0d)
        {
            String msg = Logging.getMessage("generic.ScaleOutOfRange", scale);
            Logging.logger().severe(msg);
            throw new IllegalArgumentException(msg);
        }

        this.scale = scale;
    }

    /** {@inheritDoc} */
    public Font getTextModifierFont()
    {
        return this.font;
    }

    /** {@inheritDoc} */
    public void setTextModifierFont(Font font)
    {
        this.font = font;
    }

    /** {@inheritDoc} */
    public Material getTextModifierMaterial()
    {
        return this.textMaterial;
    }

    /** {@inheritDoc} */
    public void setTextModifierMaterial(Material material)
    {
        this.textMaterial = material;
    }

    /** {@inheritDoc} */
    public Material getInteriorMaterial()
    {
        return this.interiorMaterial;
    }

    /** {@inheritDoc} */
    public void setInteriorMaterial(Material material)
    {
        if (material == null)
        {
            String message = Logging.getMessage("nullValue.MaterialIsNull");
            Logging.logger().severe(message);
            throw new IllegalArgumentException(message);
        }

        this.interiorMaterial = material;
    }

    /** {@inheritDoc} */
    public Material getOutlineMaterial()
    {
        return this.outlineMaterial;
    }

    /** {@inheritDoc} */
    public void setOutlineMaterial(Material material)
    {
        this.outlineMaterial = material;
    }

    /** {@inheritDoc} */
    public Double getInteriorOpacity()
    {
        return this.interiorOpacity;
    }

    /** {@inheritDoc} */
    public void setInteriorOpacity(Double opacity)
    {
        if (opacity < 0 || opacity > 1)
        {
            String message = Logging.getMessage("generic.OpacityOutOfRange", opacity);
            Logging.logger().severe(message);
            throw new IllegalArgumentException(message);
        }

        this.interiorOpacity = opacity;
    }

    /** {@inheritDoc} */
    public Double getOutlineOpacity()
    {
        return this.outlineOpacity;
    }

    /** {@inheritDoc} */
    public void setOutlineOpacity(Double opacity)
    {
        if (opacity < 0 || opacity > 1)
        {
            String message = Logging.getMessage("generic.OpacityOutOfRange", opacity);
            Logging.logger().severe(message);
            throw new IllegalArgumentException(message);
        }

        this.outlineOpacity = opacity;
    }

    /** {@inheritDoc} */
    public Double getOutlineWidth()
    {
        return this.outlineWidth;
    }

    /** {@inheritDoc} */
    public void setOutlineWidth(Double width)
    {
        if (width < 0)
        {
            String message = Logging.getMessage("Geom.WidthIsNegative", width);
            Logging.logger().severe(message);
            throw new IllegalArgumentException(message);
        }

        this.outlineWidth = width;
    }
}