OpenSim
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Events Macros
Public Member Functions | Public Attributes | Properties | List of all members
OpenSim.Region.Framework.Scenes.Border Class Reference

Public Member Functions

 Border ()
 
 Border (float lineStart, float lineEnd, float triggerCoordinate, uint triggerRegionX, uint triggerRegionY, Cardinals direction)
 Creates a Border. The line is perpendicular to the direction cardinal. IE: if the direction cardinal is South, the line is West->East More...
 
bool TestCross (Vector3 position)
 Tests to see if the given position would cross this border. More...
 

Public Attributes

Vector3 BorderLine = Vector3.Zero
 Line perpendicular to the Direction Cardinal. Z value is the More...
 
Cardinals CrossDirection = Cardinals.N
 Direction cardinal of the border, think, 'which side of the region this is'. EX South border: Cardinal.S More...
 
uint TriggerRegionX = 0
 
uint TriggerRegionY = 0
 

Properties

float Extent [get]
 

Detailed Description

Definition at line 35 of file Border.cs.

Constructor & Destructor Documentation

OpenSim.Region.Framework.Scenes.Border.Border ( )
inline

Definition at line 49 of file Border.cs.

OpenSim.Region.Framework.Scenes.Border.Border ( float  lineStart,
float  lineEnd,
float  triggerCoordinate,
uint  triggerRegionX,
uint  triggerRegionY,
Cardinals  direction 
)
inline

Creates a Border. The line is perpendicular to the direction cardinal. IE: if the direction cardinal is South, the line is West->East

Parameters
lineStartThe 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
lineEndThe 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
triggerCoordinateThe 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.
triggerRegionXWhen this border triggers, teleport to this regionX in the grid
triggerRegionYWhen this border triggers, teleport to this regionY in the grid
directionCardinal for border direction. Think, 'which side of the region is this'

Definition at line 74 of file Border.cs.

Member Function Documentation

bool OpenSim.Region.Framework.Scenes.Border.TestCross ( Vector3  position)
inline

Tests to see if the given position would cross this border.

Returns

Definition at line 87 of file Border.cs.

Here is the caller graph for this function:

Member Data Documentation

Vector3 OpenSim.Region.Framework.Scenes.Border.BorderLine = Vector3.Zero

Line perpendicular to the Direction Cardinal. Z value is the

Definition at line 40 of file Border.cs.

Cardinals OpenSim.Region.Framework.Scenes.Border.CrossDirection = Cardinals.N

Direction cardinal of the border, think, 'which side of the region this is'. EX South border: Cardinal.S

Definition at line 45 of file Border.cs.

uint OpenSim.Region.Framework.Scenes.Border.TriggerRegionX = 0

Definition at line 46 of file Border.cs.

uint OpenSim.Region.Framework.Scenes.Border.TriggerRegionY = 0

Definition at line 47 of file Border.cs.

Property Documentation

float OpenSim.Region.Framework.Scenes.Border.Extent
get

Definition at line 130 of file Border.cs.


The documentation for this class was generated from the following file: