aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/OpenSim/Region/Framework/Scenes/Border.cs
blob: 9a08afe904c767d876b6888be1a346632d14b324 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
/*
 * 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.Text;
using OpenMetaverse;

namespace OpenSim.Region.Framework.Scenes
{
    public class Border
    {
        
        /// <summary>
        /// Line perpendicular to the Direction Cardinal.  Z value is the 
        /// </summary>
        public Vector3 BorderLine = Vector3.Zero;
        
        /// <summary>
        /// Direction cardinal of the border, think, 'which side of the region this is'.  EX South border: Cardinal.S
        /// </summary>
        public Cardinals CrossDirection = Cardinals.N;
        public uint TriggerRegionX = 0;
        public uint TriggerRegionY = 0;

        public Border()
        {
        }

        /// <summary>
        /// Creates a Border.  The line is perpendicular to the direction cardinal. 
        /// IE: if the direction cardinal is South, the line is West->East
        /// </summary>
        /// <param name="lineStart">The starting point for the line of the border.  
        /// The position of an object must be greater then this for this border to trigger.  
        /// Perpendicular to the direction cardinal</param>
        /// <param name="lineEnd">The ending point for the line of the border.  
        /// The position of an object must be less then this for this border to trigger.  
        /// Perpendicular to the direction cardinal</param>
        /// <param name="triggerCoordinate">The position that triggers border the border 
        /// cross parallel to the direction cardinal.  On the North cardinal, this 
        /// normally 256.  On the South cardinal, it's normally 0.  Any position past this 
        /// point on the cartesian coordinate will trigger the border cross as long as it 
        /// falls within the line start and the line end.</param>
        /// <param name="triggerRegionX">When this border triggers, teleport to this regionX 
        /// in the grid</param>
        /// <param name="triggerRegionY">When this border triggers, teleport to this regionY 
        /// in the grid</param>
        /// <param name="direction">Cardinal for border direction.  Think, 'which side of the 
        /// region is this'</param>
        public Border(float lineStart, float lineEnd, float triggerCoordinate, uint triggerRegionX, 
            uint triggerRegionY, Cardinals direction)
        {
            BorderLine = new Vector3(lineStart,lineEnd,triggerCoordinate);
            CrossDirection = direction;
            TriggerRegionX = triggerRegionX;
            TriggerRegionY = triggerRegionY;
        }

        public bool TestCross(Vector3 position)
        {
            bool result = false;
            switch (CrossDirection)
            {
                case Cardinals.N:  // x+0, y+1
                    if (position.X >= BorderLine.X && position.X <=BorderLine.Y && position.Y > BorderLine.Z )
                    {
                        return true;
                    }
                    break;
                case Cardinals.NE: // x+1, y+1
                    break;
                case Cardinals.E:  // x+1, y+0
                    if (position.Y >= BorderLine.X && position.Y <= BorderLine.Y && position.X > BorderLine.Z)
                    {
                        return true;
                    }
                    break;
                case Cardinals.SE: // x+1, y-1
                    break;
                case Cardinals.S:  // x+0, y-1
                    if (position.X >= BorderLine.X && position.X <= BorderLine.Y && position.Y < BorderLine.Z)
                    {
                        return true;
                    }
                    break;
                case Cardinals.SW: // x-1, y-1
                    break;
                case Cardinals.W:  // x-1, y+0
                    if (position.Y >= BorderLine.X && position.Y <= BorderLine.Y && position.X < BorderLine.Z)
                    {
                        return true;
                    }
                    break; 
                case Cardinals.NW: // x-1, y+1
                    break;

                
            }

            return result;
        }

        public float Extent
        {
            get
            {
                switch (CrossDirection)
                {
                    case Cardinals.N:
                        break;
                    case Cardinals.S:
                        break;
                    case Cardinals.W:
                        break;
                    case Cardinals.E:
                        break;
                }
                return 0;
            }
        }

    }
    
    
}