ParallelepipedTest.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You 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
 *
 *      https://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 org.apache.commons.geometry.euclidean.threed.shape;

import java.util.Arrays;
import java.util.Comparator;
import java.util.List;
import java.util.Set;
import java.util.TreeSet;

import org.apache.commons.geometry.euclidean.EuclideanTestUtils;
import org.apache.commons.geometry.euclidean.threed.AffineTransformMatrix3D;
import org.apache.commons.geometry.euclidean.threed.PlaneConvexSubset;
import org.apache.commons.geometry.euclidean.threed.RegionBSPTree3D;
import org.apache.commons.geometry.euclidean.threed.Vector3D;
import org.apache.commons.geometry.euclidean.threed.rotation.QuaternionRotation;
import org.apache.commons.numbers.angle.Angle;
import org.apache.commons.numbers.core.Precision;
import org.junit.jupiter.api.Assertions;
import org.junit.jupiter.api.Test;

class ParallelepipedTest {

    private static final double TEST_EPS = 1e-10;

    private static final Precision.DoubleEquivalence TEST_PRECISION =
            Precision.doubleEquivalenceOfEpsilon(TEST_EPS);

    private static final Comparator<Vector3D> VERTEX_COMPARATOR = (a, b) -> {
        int cmp = TEST_PRECISION.compare(a.getX(), b.getX());
        if (cmp == 0) {
            cmp = TEST_PRECISION.compare(a.getY(), b.getY());
            if (cmp == 0) {
                cmp = TEST_PRECISION.compare(a.getZ(), b.getZ());
            }
        }
        return cmp;
    };

    @Test
    void testUnitCube() {
        // act
        final Parallelepiped p = Parallelepiped.unitCube(TEST_PRECISION);

        // assert
        Assertions.assertEquals(1, p.getSize(), TEST_EPS);
        Assertions.assertEquals(6, p.getBoundarySize(), TEST_EPS);
        EuclideanTestUtils.assertCoordinatesEqual(Vector3D.ZERO, p.getCentroid(), TEST_EPS);

        final List<PlaneConvexSubset> boundaries = p.getBoundaries();
        Assertions.assertEquals(6, boundaries.size());

        assertVertices(p,
            Vector3D.of(-0.5, -0.5, -0.5),
            Vector3D.of(0.5, -0.5, -0.5),
            Vector3D.of(0.5, 0.5, -0.5),
            Vector3D.of(-0.5, 0.5, -0.5),

            Vector3D.of(-0.5, -0.5, 0.5),
            Vector3D.of(0.5, -0.5, 0.5),
            Vector3D.of(0.5, 0.5, 0.5),
            Vector3D.of(-0.5, 0.5, 0.5)
        );
    }

    @Test
    void testFromTransformedUnitCube() {
        // arrange
        final AffineTransformMatrix3D t = AffineTransformMatrix3D.createTranslation(Vector3D.of(1, 0, 2))
                .rotate(QuaternionRotation.fromAxisAngle(Vector3D.Unit.PLUS_Z, Math.PI * 0.25))
                .scale(Vector3D.of(2, 1, 1));

        // act
        final Parallelepiped p = Parallelepiped.fromTransformedUnitCube(t, TEST_PRECISION);

        // assert
        final double sqrt2 = Math.sqrt(2);
        final double invSqrt2 = 1 / sqrt2;

        Assertions.assertEquals(2, p.getSize(), TEST_EPS);
        Assertions.assertEquals(4 + (4 * Math.sqrt(2.5)), p.getBoundarySize(), TEST_EPS);
        EuclideanTestUtils.assertCoordinatesEqual(Vector3D.of(2 * invSqrt2, invSqrt2, 2),
                p.getCentroid(), TEST_EPS);

        assertVertices(p,
            Vector3D.of(0, invSqrt2, 1.5),
            Vector3D.of(2 * invSqrt2, 0, 1.5),
            Vector3D.of(2 * sqrt2, invSqrt2, 1.5),
            Vector3D.of(2 * invSqrt2, sqrt2, 1.5),

            Vector3D.of(0, invSqrt2, 2.5),
            Vector3D.of(2 * invSqrt2, 0, 2.5),
            Vector3D.of(2 * sqrt2, invSqrt2, 2.5),
            Vector3D.of(2 * invSqrt2, sqrt2, 2.5)
        );
    }

    @Test
    void testFromTransformedUnitCube_transformDoesNotPreserveOrientation() {
        // arrange
        final AffineTransformMatrix3D t = AffineTransformMatrix3D.createTranslation(Vector3D.of(1, 0, 2))
                .rotate(QuaternionRotation.fromAxisAngle(Vector3D.Unit.PLUS_Z, Math.PI * 0.25))
                .scale(Vector3D.of(2, 1, -1));

        // act
        final Parallelepiped p = Parallelepiped.fromTransformedUnitCube(t, TEST_PRECISION);

        // assert
        final double sqrt2 = Math.sqrt(2);
        final double invSqrt2 = 1 / sqrt2;

        Assertions.assertEquals(2, p.getSize(), TEST_EPS);
        Assertions.assertEquals(4 + (4 * Math.sqrt(2.5)), p.getBoundarySize(), TEST_EPS);
        EuclideanTestUtils.assertCoordinatesEqual(Vector3D.of(2 * invSqrt2, invSqrt2, -2),
                p.getCentroid(), TEST_EPS);

        assertVertices(p,
            Vector3D.of(0, invSqrt2, -1.5),
            Vector3D.of(2 * invSqrt2, 0, -1.5),
            Vector3D.of(2 * sqrt2, invSqrt2, -1.5),
            Vector3D.of(2 * invSqrt2, sqrt2, -1.5),

            Vector3D.of(0, invSqrt2, -2.5),
            Vector3D.of(2 * invSqrt2, 0, -2.5),
            Vector3D.of(2 * sqrt2, invSqrt2, -2.5),
            Vector3D.of(2 * invSqrt2, sqrt2, -2.5)
        );
    }

    @Test
    void testFromTransformedUnitCube_zeroSizeRegion() {
        // act/assert
        Assertions.assertThrows(IllegalArgumentException.class, () -> Parallelepiped.fromTransformedUnitCube(AffineTransformMatrix3D.createScale(Vector3D.of(1e-16, 1, 1)),
                TEST_PRECISION));
        Assertions.assertThrows(IllegalArgumentException.class, () -> Parallelepiped.fromTransformedUnitCube(AffineTransformMatrix3D.createScale(Vector3D.of(1, 1e-16, 1)),
                TEST_PRECISION));
        Assertions.assertThrows(IllegalArgumentException.class, () -> Parallelepiped.fromTransformedUnitCube(AffineTransformMatrix3D.createScale(Vector3D.of(1, 1, 1e-16)),
                TEST_PRECISION));
    }

    @Test
    void testAxisAligned_minFirst() {
        // act
        final Parallelepiped p = Parallelepiped.axisAligned(Vector3D.of(1, 2, 3), Vector3D.of(4, 5, 6), TEST_PRECISION);

        // assert
        final List<PlaneConvexSubset> boundaries = p.getBoundaries();
        Assertions.assertEquals(6, boundaries.size());

        assertVertices(p,
            Vector3D.of(1, 2, 3),
            Vector3D.of(4, 2, 3),
            Vector3D.of(4, 5, 3),
            Vector3D.of(1, 5, 3),

            Vector3D.of(1, 2, 6),
            Vector3D.of(4, 2, 6),
            Vector3D.of(4, 5, 6),
            Vector3D.of(1, 5, 6)
        );
    }

    @Test
    void testAxisAligned_maxFirst() {
        // act
        final Parallelepiped p = Parallelepiped.axisAligned(Vector3D.of(4, 5, 6), Vector3D.of(1, 2, 3), TEST_PRECISION);

        // assert
        final List<PlaneConvexSubset> boundaries = p.getBoundaries();
        Assertions.assertEquals(6, boundaries.size());

        assertVertices(p,
            Vector3D.of(1, 2, 3),
            Vector3D.of(4, 2, 3),
            Vector3D.of(4, 5, 3),
            Vector3D.of(1, 5, 3),

            Vector3D.of(1, 2, 6),
            Vector3D.of(4, 2, 6),
            Vector3D.of(4, 5, 6),
            Vector3D.of(1, 5, 6)
        );
    }

    @Test
    void testAxisAligned_illegalArgs() {
        // act/assert
        Assertions.assertThrows(IllegalArgumentException.class, () -> Parallelepiped.axisAligned(Vector3D.of(1, 2, 3), Vector3D.of(1, 5, 6), TEST_PRECISION));
        Assertions.assertThrows(IllegalArgumentException.class, () -> Parallelepiped.axisAligned(Vector3D.of(1, 2, 3), Vector3D.of(4, 2, 6), TEST_PRECISION));
        Assertions.assertThrows(IllegalArgumentException.class, () -> Parallelepiped.axisAligned(Vector3D.of(1, 2, 3), Vector3D.of(1, 5, 3), TEST_PRECISION));
    }

    @Test
    void testBuilder_defaultValues() {
        // arrange
        final Parallelepiped.Builder builder = Parallelepiped.builder(TEST_PRECISION);

        // act
        final Parallelepiped p = builder.build();

        // assert
        Assertions.assertEquals(1, p.getSize(), TEST_EPS);
        Assertions.assertEquals(6, p.getBoundarySize(), TEST_EPS);
        EuclideanTestUtils.assertCoordinatesEqual(Vector3D.ZERO, p.getCentroid(), TEST_EPS);

        final List<PlaneConvexSubset> boundaries = p.getBoundaries();
        Assertions.assertEquals(6, boundaries.size());

        assertVertices(p,
            Vector3D.of(-0.5, -0.5, -0.5),
            Vector3D.of(0.5, -0.5, -0.5),
            Vector3D.of(0.5, 0.5, -0.5),
            Vector3D.of(-0.5, 0.5, -0.5),

            Vector3D.of(-0.5, -0.5, 0.5),
            Vector3D.of(0.5, -0.5, 0.5),
            Vector3D.of(0.5, 0.5, 0.5),
            Vector3D.of(-0.5, 0.5, 0.5)
        );
    }

    @Test
    void testBuilder_withRotation() {
        // arrange
        final Parallelepiped.Builder builder = Parallelepiped.builder(TEST_PRECISION);

        // act
        final Parallelepiped p = builder
                .setScale(1, 2, 3)
                .setRotation(QuaternionRotation.fromAxisAngle(Vector3D.Unit.PLUS_Z, Angle.PI_OVER_TWO))
                .setPosition(Vector3D.of(1, 2, -1))
                .build();

        // assert
        Assertions.assertEquals(6, p.getSize(), TEST_EPS);
        Assertions.assertEquals(22, p.getBoundarySize(), TEST_EPS);
        EuclideanTestUtils.assertCoordinatesEqual(Vector3D.of(1, 2, -1), p.getCentroid(), TEST_EPS);

        assertVertices(p,
            Vector3D.of(0, 1.5, 0.5),
            Vector3D.of(2, 1.5, 0.5),
            Vector3D.of(2, 2.5, 0.5),
            Vector3D.of(0, 2.5, 0.5),

            Vector3D.of(0, 1.5, -2.5),
            Vector3D.of(2, 1.5, -2.5),
            Vector3D.of(2, 2.5, -2.5),
            Vector3D.of(0, 2.5, -2.5)
        );
    }

    @Test
    void testBuilder_withUniformScale() {
        // arrange
        final Parallelepiped.Builder builder = Parallelepiped.builder(TEST_PRECISION);

        // act
        final Parallelepiped p = builder
                .setScale(0.5)
                .build();

        // assert
        Assertions.assertEquals(0.125, p.getSize(), TEST_EPS);
        Assertions.assertEquals(1.5, p.getBoundarySize(), TEST_EPS);
        EuclideanTestUtils.assertCoordinatesEqual(Vector3D.ZERO, p.getCentroid(), TEST_EPS);

        assertVertices(p,
            Vector3D.of(-0.25, -0.25, -0.25),
            Vector3D.of(0.25, -0.25, -0.25),
            Vector3D.of(0.25, 0.25, -0.25),
            Vector3D.of(-0.25, 0.25, -0.25),

            Vector3D.of(-0.25, -0.25, 0.25),
            Vector3D.of(0.25, -0.25, 0.25),
            Vector3D.of(0.25, 0.25, 0.25),
            Vector3D.of(-0.25, 0.25, 0.25)
        );
    }

    @Test
    void testToTree() {
        // arrange
        final Parallelepiped p = Parallelepiped.axisAligned(Vector3D.of(1, 2, 3), Vector3D.of(4, 5, 6), TEST_PRECISION);

        // act
        final RegionBSPTree3D tree = p.toTree();

        // assert
        Assertions.assertEquals(27, tree.getSize(), TEST_EPS);
        EuclideanTestUtils.assertCoordinatesEqual(Vector3D.of(2.5, 3.5, 4.5), tree.getCentroid(), TEST_EPS);
    }

    private static void assertVertices(final Parallelepiped p, final Vector3D... vertices) {
        final Set<Vector3D> expectedVertices = new TreeSet<>(VERTEX_COMPARATOR);
        expectedVertices.addAll(Arrays.asList(vertices));

        final Set<Vector3D> actualVertices = new TreeSet<>(VERTEX_COMPARATOR);
        for (final PlaneConvexSubset boundary : p.getBoundaries()) {
            actualVertices.addAll(boundary.getVertices());
        }

        Assertions.assertEquals(expectedVertices.size(), actualVertices.size());
        for (final Vector3D expected : expectedVertices) {
            Assertions.assertTrue(actualVertices.contains(expected), "Expected vertices to contain " + expected);
        }
    }
}