src.gov.nasa.worldwind.symbology.milstd2525.graphics.areas.AviationZone Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of worldwindx Show documentation
World Wind is a collection of components that interactively display 3D geographic information within Java applications or applets.
There is a newer version: 2.0.0-986
Show 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.milstd2525.graphics.areas;

import gov.nasa.worldwind.avlist.AVKey;
import gov.nasa.worldwind.render.Offset;
import gov.nasa.worldwind.symbology.*;
import gov.nasa.worldwind.symbology.milstd2525.graphics.TacGrpSidc;

import java.util.*;

/**
 * Implementation of aviation area graphics. This class implements the following graphics:
 * 
 * 
 Restricted Operations Zone (2.X.2.2.3.1)
 Short Range Air Defense Engagement Zone (2.X.2.2.3.2)
 * High Density Airspace Control Zone (2.X.2.2.3.3)
 Missile Engagement Zone (2.X.2.2.3.4)
 Low
 * Altitude Missile Engagement Zone (2.X.2.2.3.4.1)
 High Altitude Missile Engagement Zone (2.X.2.2.3.4.2)
 * 
 *
 * @author pabercrombie
 * @version $Id: AviationZone.java 1171 2013-02-11 21:45:02Z dcollins $
 */
public class AviationZone extends BasicArea
{
    /** Center text block on label position. */
    protected final static Offset LABEL_OFFSET = new Offset(-0.5d, -0.5d, AVKey.FRACTION, AVKey.FRACTION);

    /**
     * Indicates the graphics supported by this class.
     *
     * @return List of masked SIDC strings that identify graphics that this class supports.
     */
    public static List getSupportedGraphics()
    {
        return Arrays.asList(
            TacGrpSidc.C2GM_AVN_ARS_ROZ,
            TacGrpSidc.C2GM_AVN_ARS_SHRDEZ,
            TacGrpSidc.C2GM_AVN_ARS_HIDACZ,
            TacGrpSidc.C2GM_AVN_ARS_MEZ,
            TacGrpSidc.C2GM_AVN_ARS_MEZ_LAMEZ,
            TacGrpSidc.C2GM_AVN_ARS_MEZ_HAMEZ);
    }

    /**
     * Create a new aviation area.
     *
     * @param sidc Symbol code the identifies the graphic.
     */
    public AviationZone(String sidc)
    {
        super(sidc);
        // Do not draw "ENY" labels on hostile entities.
        this.setShowHostileIndicator(false);
    }

    @Override
    protected Offset getDefaultLabelOffset()
    {
        return LABEL_OFFSET;
    }

    @Override
    protected String getLabelAlignment()
    {
        return AVKey.LEFT;
    }

    @Override
    protected String createLabelText()
    {
        return doCreateLabelText(true);
    }

    /**
     * Create text for the area's label.
     *
     * @param includeAltitude Indicates whether to include altitude information in the label (if the
     *                        SymbologyConstants.ALTITUDE_DEPTH modifier is set). Not all aviation area graphics support
     *                        the altitude modifier.
     *
     * @return Text for the label, based on the active modifiers.
     */
    protected String doCreateLabelText(boolean includeAltitude)
    {
        StringBuilder sb = new StringBuilder();
        sb.append(this.getGraphicLabel());
        sb.append("\n");

        Object o = this.getModifier(SymbologyConstants.UNIQUE_DESIGNATION);
        if (o != null)
        {
            sb.append(o);
            sb.append("\n");
        }

        if (includeAltitude)
        {
            Object[] altitudes = TacticalGraphicUtil.getAltitudeRange(this);
            if (altitudes[0] != null)
            {
                sb.append("MIN ALT: ");
                sb.append(altitudes[0]);
                sb.append("\n");
            }

            if (altitudes[1] != null)
            {
                sb.append("MAX ALT: ");
                sb.append(altitudes[1]);
                sb.append("\n");
            }
        }

        Object[] dates = TacticalGraphicUtil.getDateRange(this);
        if (dates[0] != null)
        {
            sb.append("TIME FROM: ");
            sb.append(dates[0]);
            sb.append("\n");
        }

        if (dates[1] != null)
        {
            sb.append("TIME TO: ");
            sb.append(dates[1]);
        }

        return sb.toString();
    }

    @Override
    protected String getGraphicLabel()
    {
        String code = this.maskedSymbolCode;

        if (TacGrpSidc.C2GM_AVN_ARS_ROZ.equalsIgnoreCase(code))
            return "ROZ";
        else if (TacGrpSidc.C2GM_AVN_ARS_SHRDEZ.equalsIgnoreCase(code))
            return "SHORADEZ";
        else if (TacGrpSidc.C2GM_AVN_ARS_HIDACZ.equalsIgnoreCase(code))
            return "HIDACZ";
        else if (TacGrpSidc.C2GM_AVN_ARS_MEZ.equalsIgnoreCase(code))
            return "MEZ";
        else if (TacGrpSidc.C2GM_AVN_ARS_MEZ_LAMEZ.equalsIgnoreCase(code))
            return "LOMEZ";
        else if (TacGrpSidc.C2GM_AVN_ARS_MEZ_HAMEZ.equalsIgnoreCase(code))
            return "HIMEZ";

        return "";
    }
}