opensim/OpenSim/Region/Framework/Scenes/Tests/BorderTests.cs

/*
 * Copyright (c) Contributors, http://opensimulator.org/
 * See CONTRIBUTORS.TXT for a full list of copyright holders.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *     * Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above copyright
 *       notice, this list of conditions and the following disclaimer in the
 *       documentation and/or other materials provided with the distribution.
 *     * Neither the name of the OpenSimulator Project nor the
 *       names of its contributors may be used to endorse or promote products
 *       derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY
 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THE CONTRIBUTORS BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

using System;
using System.Collections.Generic;
using System.IO;
using System.Text;
using NUnit.Framework;
using OpenMetaverse;
using OpenSim.Region.Framework.Scenes;
using OpenSim.Tests.Common;

namespace OpenSim.Region.Framework.Scenes.Tests
{
    [TestFixture]
    public class BorderTests
    {
        [Test]
        public void TestCross()
        {
            TestHelpers.InMethod();
            
            List<Border> testborders = new List<Border>();

            Border NorthBorder = new Border();
            NorthBorder.BorderLine = new Vector3(0, 256, 256);  //<---
            NorthBorder.CrossDirection = Cardinals.N;
            testborders.Add(NorthBorder);

            Border SouthBorder = new Border();
            SouthBorder.BorderLine = new Vector3(0, 256, 0);    //--->
            SouthBorder.CrossDirection = Cardinals.S;
            testborders.Add(SouthBorder);

            Border EastBorder = new Border();
            EastBorder.BorderLine = new Vector3(0, 256, 256);   //<---
            EastBorder.CrossDirection = Cardinals.E;
            testborders.Add(EastBorder);

            Border WestBorder = new Border();
            WestBorder.BorderLine = new Vector3(0, 256, 0);     //--->
            WestBorder.CrossDirection = Cardinals.W;
            testborders.Add(WestBorder);

            Vector3 position = new Vector3(200,200,21);
            
            foreach (Border b in testborders)
                Assert.That(!b.TestCross(position));

            position = new Vector3(200,280,21);
            Assert.That(NorthBorder.TestCross(position));

            // Test automatic border crossing
            // by setting the border crossing aabb to be the whole region
            position = new Vector3(25,25,21); // safely within one 256m region

            // The Z value of the BorderLine is reversed, making all positions within the region 
            // trigger bordercross

            SouthBorder.BorderLine = new Vector3(0,256,256); // automatic border cross in the region
            Assert.That(SouthBorder.TestCross(position));

            NorthBorder.BorderLine = new Vector3(0, 256, 0); // automatic border cross in the region
            Assert.That(NorthBorder.TestCross(position));
            
            EastBorder.BorderLine = new Vector3(0, 256, 0); // automatic border cross in the region
            Assert.That(EastBorder.TestCross(position));

            WestBorder.BorderLine = new Vector3(0, 256, 255); // automatic border cross in the region
            Assert.That(WestBorder.TestCross(position));
        }

        [Test]
        public void TestCrossSquare512()
        {
            TestHelpers.InMethod();
            
            List<Border> testborders = new List<Border>();

            Border NorthBorder = new Border();
            NorthBorder.BorderLine = new Vector3(0, 512, 512);
            NorthBorder.CrossDirection = Cardinals.N;
            testborders.Add(NorthBorder);

            Border SouthBorder = new Border();
            SouthBorder.BorderLine = new Vector3(0, 512, 0);
            SouthBorder.CrossDirection = Cardinals.S;
            testborders.Add(SouthBorder);

            Border EastBorder = new Border();
            EastBorder.BorderLine = new Vector3(0, 512, 512);
            EastBorder.CrossDirection = Cardinals.E;
            testborders.Add(EastBorder);

            Border WestBorder = new Border();
            WestBorder.BorderLine = new Vector3(0, 512, 0);
            WestBorder.CrossDirection = Cardinals.W;
            testborders.Add(WestBorder);

            Vector3 position = new Vector3(450,220,21);

            foreach (Border b in testborders)
            {
                Assert.That(!b.TestCross(position));

            }

            //Trigger east border
            position = new Vector3(513,220,21);
            foreach (Border b in testborders)
            {
                if (b.CrossDirection == Cardinals.E)
                    Assert.That(b.TestCross(position));
                else
                    Assert.That(!b.TestCross(position));

            }

            //Trigger west border
            position = new Vector3(-1, 220, 21);
            foreach (Border b in testborders)
            {
                if (b.CrossDirection == Cardinals.W)
                    Assert.That(b.TestCross(position));
                else
                    Assert.That(!b.TestCross(position));

            }

            //Trigger north border
            position = new Vector3(220, 513, 21);
            foreach (Border b in testborders)
            {
                if (b.CrossDirection == Cardinals.N)
                    Assert.That(b.TestCross(position));
                else
                    Assert.That(!b.TestCross(position));

            }

            //Trigger south border
            position = new Vector3(220, -1, 21);
            foreach (Border b in testborders)
            {
                if (b.CrossDirection == Cardinals.S)
                    Assert.That(b.TestCross(position));
                else
                    Assert.That(!b.TestCross(position));

            }
        }

        [Test]
        public void TestCrossRectangle512x256()
        {
            TestHelpers.InMethod();
            
            List<Border> testborders = new List<Border>();

            Border NorthBorder = new Border();
            NorthBorder.BorderLine = new Vector3(0, 512, 256);
            NorthBorder.CrossDirection = Cardinals.N;
            testborders.Add(NorthBorder);

            Border SouthBorder = new Border();
            SouthBorder.BorderLine = new Vector3(0, 512, 0);
            SouthBorder.CrossDirection = Cardinals.S;
            testborders.Add(SouthBorder);

            Border EastBorder = new Border();
            EastBorder.BorderLine = new Vector3(0, 256, 512);
            EastBorder.CrossDirection = Cardinals.E;
            testborders.Add(EastBorder);

            Border WestBorder = new Border();
            WestBorder.BorderLine = new Vector3(0, 256, 0);
            WestBorder.CrossDirection = Cardinals.W;
            testborders.Add(WestBorder);

            Vector3 position = new Vector3(450, 220, 21);

            foreach (Border b in testborders)
            {
                Assert.That(!b.TestCross(position));

            }

            //Trigger east border
            position = new Vector3(513, 220, 21);
            foreach (Border b in testborders)
            {
                if (b.CrossDirection == Cardinals.E)
                    Assert.That(b.TestCross(position));
                else
                    Assert.That(!b.TestCross(position));

            }

            //Trigger west border
            position = new Vector3(-1, 220, 21);
            foreach (Border b in testborders)
            {
                if (b.CrossDirection == Cardinals.W)
                    Assert.That(b.TestCross(position));
                else
                    Assert.That(!b.TestCross(position));

            }

            //Trigger north border
            position = new Vector3(220, 257, 21);
            foreach (Border b in testborders)
            {
                if (b.CrossDirection == Cardinals.N)
                    Assert.That(b.TestCross(position));
                else
                    Assert.That(!b.TestCross(position));

            }

            //Trigger south border
            position = new Vector3(220, -1, 21);
            foreach (Border b in testborders)
            {
                if (b.CrossDirection == Cardinals.S)
                    Assert.That(b.TestCross(position));
                else
                    Assert.That(!b.TestCross(position));
                
            }
        }

        [Test]
        public void TestCrossOdd512x512w256hole()
        {
            TestHelpers.InMethod();
            
            List<Border> testborders = new List<Border>();
            //   512____
            //      |  |
            // 256__|  |___
            //      |      |
            //      |______|
            //     0   |    512
            //        256

            // Compound North border since the hole is at the top
            Border NorthBorder1 = new Border();
            NorthBorder1.BorderLine = new Vector3(0, 256, 512);
            NorthBorder1.CrossDirection = Cardinals.N;
            testborders.Add(NorthBorder1);

            Border NorthBorder2 = new Border();
            NorthBorder2.BorderLine = new Vector3(256, 512, 256);
            NorthBorder2.CrossDirection = Cardinals.N;
            testborders.Add(NorthBorder2);

            Border SouthBorder = new Border();
            SouthBorder.BorderLine = new Vector3(0, 512, 0);
            SouthBorder.CrossDirection = Cardinals.S;
            testborders.Add(SouthBorder);

            //Compound East border
            Border EastBorder1 = new Border();
            EastBorder1.BorderLine = new Vector3(0, 256, 512);
            EastBorder1.CrossDirection = Cardinals.E;
            testborders.Add(EastBorder1);

            Border EastBorder2 = new Border();
            EastBorder2.BorderLine = new Vector3(257, 512, 256);
            EastBorder2.CrossDirection = Cardinals.E;
            testborders.Add(EastBorder2);



            Border WestBorder = new Border();
            WestBorder.BorderLine = new Vector3(0, 512, 0);
            WestBorder.CrossDirection = Cardinals.W;
            testborders.Add(WestBorder);

            Vector3 position = new Vector3(450, 220, 21);

            foreach (Border b in testborders)
            {
                Assert.That(!b.TestCross(position));

            }

            position = new Vector3(220, 450, 21);

            foreach (Border b in testborders)
            {
                Assert.That(!b.TestCross(position));

            }

            bool result = false;
            int bordersTriggered = 0;

            position = new Vector3(450, 450, 21);

            foreach (Border b in testborders)
            {
                if (b.TestCross(position))
                {
                    bordersTriggered++;
                    result = true;
                }
            }

            Assert.That(result);
            Assert.That(bordersTriggered == 2);

        }
    }
}