uk.ac.leeds.ccg.v3d.geometry.V3D_FiniteGeometry Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of ccg-v3d Show documentation
A Java Library for handling 3D spatial vector data.
There is a newer version: 0.19
/*
 * Copyright 2020 Andy Turner, University of Leeds.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package uk.ac.leeds.ccg.v3d.geometry;

import java.math.RoundingMode;
import java.util.ArrayList;
import java.util.Arrays;

/**
 * V3D_FiniteGeometry for representing finite geometries.
 *
 * @author Andy Turner
 * @version 1.0
 */
public abstract class V3D_FiniteGeometry extends V3D_Geometry {

    private static final long serialVersionUID = 1L;

    /**
     * For storing the envelope.
     */
    protected V3D_Envelope en;
    
    /**
     * For getting the envelope of the geometry
     *
     * @param oom The Order of Magnitude for the precision.
     * @param rm The RoundingMode for any rounding.
     * @return The V3D_Envelope.
     */
    public abstract V3D_Envelope getEnvelope(int oom, RoundingMode rm);
    
    /**
     * Creates a new instance with offset V3D_Vector.ZERO.
     */
    public V3D_FiniteGeometry() {
        this(V3D_Vector.ZERO);
    }
    
    /**
     * Creates a new instance.
     *
     * @param offset What {@link #offset} is set to.
     */
    public V3D_FiniteGeometry(V3D_Vector offset) {
        super(offset);
    }
    
    /**
     * @return A copy of the points of the geometry.
     * @param oom The Order of Magnitude for the precision.
     * @param rm The RoundingMode for any rounding.
     */
    public abstract V3D_Point[] getPoints(int oom, RoundingMode rm);
    
    /**
     * @return A copy of the points of the geometries gs.
     * @param oom The Order of Magnitude for the precision.
     * @param rm The RoundingMode for any rounding.
     * @param gs The geometries.
     */
    public static V3D_Point[] getPoints(int oom, RoundingMode rm, 
            V3D_FiniteGeometry... gs) {
        ArrayList list = new ArrayList<>();
        for (var x: gs) {
            V3D_Point[] pts = x.getPoints(oom, rm);
            list.addAll(Arrays.asList(pts));
        }
        return list.toArray(V3D_Point[]::new);
    }
    
    /**
     * Translate (move relative to the origin).
     *
     * @param v The vector to translate.
     * @param oom The Order of Magnitude for the precision.
     * @param rm The RoundingMode for any rounding.
     */
    @Override
    public void translate(V3D_Vector v, int oom, RoundingMode rm) {
        super.translate(v, oom, rm);
        if (en != null) {
            en.translate(v, oom, rm);
        }
        //en = null;
    }
}