All Downloads are FREE. Search and download functionalities are using the official Maven repository.

de.micromata.opengis.kml.v_2_2_0.ImagePyramid Maven / Gradle / Ivy

Go to download

This is JavaAPIforKMml, Micromata's library for use with applications that want to parse, generate and operate on KML. It is an implementation of the OGC KML 2.2 standard. It is written entirely in Java and makes heavy use of JAXB.

There is a newer version: 3.0.4
Show newest version

package de.micromata.opengis.kml.v_2_2_0;

import de.micromata.opengis.kml.v_2_2_0.annotations.Obvious;
import jakarta.xml.bind.annotation.*;

import java.util.ArrayList;
import java.util.List;


/**
 * {@code }
 * 

 * For very large images, you'll need to construct an image pyramid, which is a hierarchical 
 * set of images, each of which is an increasingly lower resolution version of the 
 * original image. Each image in the pyramid is subdivided into tiles, so that only 
 * the portions in view need to be loaded. Google Earth calculates the current viewpoint 
 * and loads the tiles that are appropriate to the user's distance from the image. 
 * As the viewpoint moves closer to the PhotoOverlay, Google Earth loads higher resolution 
 * tiles. Since all the pixels in the original image can't be viewed on the screen 
 * at once, this preprocessing allows Google Earth to achieve maximum performance because 
 * it loads only the portions of the image that are in view, and only the pixel details 
 * that can be discerned by the user at the current viewpoint. 
 * 

 * 

 * When you specify an image pyramid, you also modify the {@code }in the {@code }element 
 * to include specifications for which tiles to load. 
 * 

 * 
 * 
 * 
 */
@XmlAccessorType(XmlAccessType.FIELD)
@XmlType(name = "ImagePyramidType", propOrder = {
    "tileSize",
    "maxWidth",
    "maxHeight",
    "gridOrigin",
    "imagePyramidSimpleExtension",
    "imagePyramidObjectExtension"
})
@XmlRootElement(name = "ImagePyramid", namespace = "http://www.opengis.net/kml/2.2")
public class ImagePyramid
    extends AbstractObject
    implements Cloneable
{

    /**
     * {@code }
     * 

     * Size of the tiles, in pixels. Tiles must be square, and {@code } must be a power
     * of 2. A tile size of 256 (the default) or 512 is recommended. The original image 
     * is divided into tiles of this size, at varying resolutions. 
     * 

     * 
     * 
     * 
     */
    @XmlElement(defaultValue = "256")
    protected int tileSize;
    /**
     * {@code }
     * 

     * Width in pixels of the original image. 
     * 

     * 
     * 
     * 
     */
    @XmlElement(defaultValue = "0")
    protected int maxWidth;
    /**
     * {@code }
     * 

     * Height in pixels of the original image. 
     * 

     * 
     * 
     * 
     */
    @XmlElement(defaultValue = "0")
    protected int maxHeight;
    /**
     * GridOrigin
     * 

     * lowerLeft, upperLeft 
     * 

     * 
     * See Also: 
     * See {@code }
     * 
     * 
     * 
     */
    @XmlElement(defaultValue = "lowerLeft")
    protected GridOrigin gridOrigin;
    @XmlElement(name = "ImagePyramidSimpleExtensionGroup")
    @XmlSchemaType(name = "anySimpleType")
    protected List imagePyramidSimpleExtension;
    /**
     * {@code }
     * 

     * This is an abstract base class and cannot be used directly in a KML file. It provides 
     * the id attribute, which allows unique identification of a KML element, and the targetId 
     * attribute, which is used to reference objects that have already been loaded into 
     * Google Earth. The id attribute must be assigned if the Update mechanism is to 
     * be used. 
     * 

     * 
     * Syntax: 
     * 
<!-- abstract element; do not create -->
     * <!-- Object id="ID" targetId="NCName" -->
     * <!-- /Object> -->

     * 
     * 
     * 
     */
    @XmlElement(name = "ImagePyramidObjectExtensionGroup")
    protected List imagePyramidObjectExtension;

    public ImagePyramid() {
        super();
    }

    /**
     *
     * 
     * @return
     *     possible object is
     *     {@link Integer}
     *     
     */
    public int getTileSize() {
        return tileSize;
    }

    /**
     *
     * 
     * @param value
     *     allowed object is
     *     {@link Integer}
     *     
     */
    public void setTileSize(int value) {
        this.tileSize = value;
    }

    /**
     *
     * 
     * @return
     *     possible object is
     *     {@link Integer}
     *     
     */
    public int getMaxWidth() {
        return maxWidth;
    }

    /**
     *
     * 
     * @param value
     *     allowed object is
     *     {@link Integer}
     *     
     */
    public void setMaxWidth(int value) {
        this.maxWidth = value;
    }

    /**
     *
     * 
     * @return
     *     possible object is
     *     {@link Integer}
     *     
     */
    public int getMaxHeight() {
        return maxHeight;
    }

    /**
     *
     * 
     * @param value
     *     allowed object is
     *     {@link Integer}
     *     
     */
    public void setMaxHeight(int value) {
        this.maxHeight = value;
    }

    /**
     *
     * 
     * @return
     *     possible object is
     *     {@link GridOrigin}
     *     
     */
    public GridOrigin getGridOrigin() {
        return gridOrigin;
    }

    /**
     *
     * 
     * @param value
     *     allowed object is
     *     {@link GridOrigin}
     *     
     */
    public void setGridOrigin(GridOrigin value) {
        this.gridOrigin = value;
    }

    /**
     *
     * 
     */
    public List getImagePyramidSimpleExtension() {
        if (imagePyramidSimpleExtension == null) {
            imagePyramidSimpleExtension = new ArrayList();
        }
        return this.imagePyramidSimpleExtension;
    }

    /**
     *
     * 
     */
    public List getImagePyramidObjectExtension() {
        if (imagePyramidObjectExtension == null) {
            imagePyramidObjectExtension = new ArrayList();
        }
        return this.imagePyramidObjectExtension;
    }

    @Override
    public int hashCode() {
        final int prime = 31;
        int result = super.hashCode();
        result = ((prime*result)+ tileSize);
        result = ((prime*result)+ maxWidth);
        result = ((prime*result)+ maxHeight);
        result = ((prime*result)+((gridOrigin == null)? 0 :gridOrigin.hashCode()));
        result = ((prime*result)+((imagePyramidSimpleExtension == null)? 0 :imagePyramidSimpleExtension.hashCode()));
        result = ((prime*result)+((imagePyramidObjectExtension == null)? 0 :imagePyramidObjectExtension.hashCode()));
        return result;
    }

    @Override
    public boolean equals(Object obj) {
        if (this == obj) {
            return true;
        }
        if (obj == null) {
            return false;
        }
        if (super.equals(obj) == false) {
            return false;
        }
        if ((obj instanceof ImagePyramid) == false) {
            return false;
        }
        ImagePyramid other = ((ImagePyramid) obj);
        if (tileSize!= other.tileSize) {
            return false;
        }
        if (maxWidth!= other.maxWidth) {
            return false;
        }
        if (maxHeight!= other.maxHeight) {
            return false;
        }
        if (gridOrigin == null) {
            if (other.gridOrigin!= null) {
                return false;
            }
        } else {
            if (gridOrigin.equals(other.gridOrigin) == false) {
                return false;
            }
        }
        if (imagePyramidSimpleExtension == null) {
            if (other.imagePyramidSimpleExtension!= null) {
                return false;
            }
        } else {
            if (imagePyramidSimpleExtension.equals(other.imagePyramidSimpleExtension) == false) {
                return false;
            }
        }
        if (imagePyramidObjectExtension == null) {
            if (other.imagePyramidObjectExtension!= null) {
                return false;
            }
        } else {
            if (imagePyramidObjectExtension.equals(other.imagePyramidObjectExtension) == false) {
                return false;
            }
        }
        return true;
    }

    /**
     *
     * 
     * @param imagePyramidSimpleExtension
     *     Objects of the following type are allowed in the list: {@link Object}
     */
    public void setImagePyramidSimpleExtension(final List imagePyramidSimpleExtension) {
        this.imagePyramidSimpleExtension = imagePyramidSimpleExtension;
    }

    /**
     * add a value to the imagePyramidSimpleExtension property collection
     * 
     * @param imagePyramidSimpleExtension
     *     Objects of the following type are allowed in the list: {@link Object}
     * @return
     *     true (as general contract of Collection.add). 
     */
    public ImagePyramid addToImagePyramidSimpleExtension(final Object imagePyramidSimpleExtension) {
        this.getImagePyramidSimpleExtension().add(imagePyramidSimpleExtension);
        return this;
    }

    /**
     *
     * 
     * @param imagePyramidObjectExtension
     *     Objects of the following type are allowed in the list: {@link AbstractObject}
     */
    public void setImagePyramidObjectExtension(final List imagePyramidObjectExtension) {
        this.imagePyramidObjectExtension = imagePyramidObjectExtension;
    }

    /**
     * add a value to the imagePyramidObjectExtension property collection
     * 
     * @param imagePyramidObjectExtension
     *     Objects of the following type are allowed in the list: {@link AbstractObject}
     * @return
     *     true (as general contract of Collection.add). 
     */
    public ImagePyramid addToImagePyramidObjectExtension(final AbstractObject imagePyramidObjectExtension) {
        this.getImagePyramidObjectExtension().add(imagePyramidObjectExtension);
        return this;
    }

    /**
     *
     * 
     */
    @Obvious
    @Override
    public void setObjectSimpleExtension(final List objectSimpleExtension) {
        super.setObjectSimpleExtension(objectSimpleExtension);
    }

    @Obvious
    @Override
    public ImagePyramid addToObjectSimpleExtension(final Object objectSimpleExtension) {
        super.getObjectSimpleExtension().add(objectSimpleExtension);
        return this;
    }

    /**
     * fluent setter
     *
     * 
     * @param tileSize
     *     required parameter
     */
    public ImagePyramid withTileSize(final int tileSize) {
        this.setTileSize(tileSize);
        return this;
    }

    /**
     * fluent setter
     *
     * 
     * @param maxWidth
     *     required parameter
     */
    public ImagePyramid withMaxWidth(final int maxWidth) {
        this.setMaxWidth(maxWidth);
        return this;
    }

    /**
     * fluent setter
     *
     * 
     * @param maxHeight
     *     required parameter
     */
    public ImagePyramid withMaxHeight(final int maxHeight) {
        this.setMaxHeight(maxHeight);
        return this;
    }

    /**
     * fluent setter
     *
     * 
     * @param gridOrigin
     *     required parameter
     */
    public ImagePyramid withGridOrigin(final GridOrigin gridOrigin) {
        this.setGridOrigin(gridOrigin);
        return this;
    }

    /**
     * fluent setter
     *
     * 
     * @param imagePyramidSimpleExtension
     *     required parameter
     */
    public ImagePyramid withImagePyramidSimpleExtension(final List imagePyramidSimpleExtension) {
        this.setImagePyramidSimpleExtension(imagePyramidSimpleExtension);
        return this;
    }

    /**
     * fluent setter
     *
     * 
     * @param imagePyramidObjectExtension
     *     required parameter
     */
    public ImagePyramid withImagePyramidObjectExtension(final List imagePyramidObjectExtension) {
        this.setImagePyramidObjectExtension(imagePyramidObjectExtension);
        return this;
    }

    @Obvious
    @Override
    public ImagePyramid withObjectSimpleExtension(final List objectSimpleExtension) {
        super.withObjectSimpleExtension(objectSimpleExtension);
        return this;
    }

    @Obvious
    @Override
    public ImagePyramid withId(final String id) {
        super.withId(id);
        return this;
    }

    @Obvious
    @Override
    public ImagePyramid withTargetId(final String targetId) {
        super.withTargetId(targetId);
        return this;
    }

    @Override
    public ImagePyramid clone() {
        ImagePyramid copy;
        copy = ((ImagePyramid) super.clone());
        copy.imagePyramidSimpleExtension = new ArrayList((getImagePyramidSimpleExtension().size()));
        for (Object iter: imagePyramidSimpleExtension) {
            copy.imagePyramidSimpleExtension.add(iter);
        }
        copy.imagePyramidObjectExtension = new ArrayList((getImagePyramidObjectExtension().size()));
        for (AbstractObject iter: imagePyramidObjectExtension) {
            copy.imagePyramidObjectExtension.add(iter.clone());
        }
        return copy;
    }

}
 















© 2015 - 2024 Weber Informatics LLC | Privacy Policy