OpenSpace.ScreenBounds

Instances of this class represent bounding boxes.  Data stored as left, bottom, right, top floats.  All values are initialized to null, however, you should make sure you set them before using the bounds for anything.

Possible use case

bounds = new OpenSpace.ScreenBounds();
bounds.extend(new OpenSpace.ScreenPoint(40,50));
bounds.extend(new OpenSpace.ScreenPoint(50,60));
bounds.toBBOX(); // returns 40,50,50,60

Inherits

  • <OpenLayers.Bounds>
Summary
OpenSpace.ScreenBoundsInstances of this class represent bounding boxes.
Properties
srs{Number} The spatial reference system
Constructor
OpenSpace.ScreenBoundsConstruct a new Screen bounds object.
Functions
cloneCreate a cloned instance of this bounds.
equalsTest a two bounds for equivalence.
toString{String} String representation of bounds object.
toArray{Array} array of left, top, right, bottom
getWidth{Float} The width of the bounds
getHeight{Float} The height of the bounds (bottom minus top).
getSize{OpenSpace.ScreenSize} The size of the box.
getCenterPixel{OpenSpace.ScreenPoint} The center of the bounds in pixel space.
add
extendExtend the bounds to include the point, lonlat, or bounds specified.
containsPixel
contains
intersectsBounds
containsBounds
determineQuadrant
oppositeQuadrantGet the opposite quadrant for a given quadrant string.

Properties

srs

{Number} The spatial reference system

Constructor

OpenSpace.ScreenBounds

Construct a new Screen bounds object.

Parameters

left{Float} The left bounds of the box.  Note that for width calculations, this is assumed to be less than the right value.
top{Float} The top bounds of the box.  Note that for height calculations, this is assumed to be less than the bottom value.
right{Float} The right bounds.
bottom{Float} The bottom bounds.

Functions

clone

clone:function()

Create a cloned instance of this bounds.

Returns

{OpenSpace.ScreenBounds} A fresh copy of the bounds

equals

equals:function(bounds)

Test a two bounds for equivalence.

Parameters

bounds{OpenSpace.ScreenBounds}

Returns

{Boolean} The passed-in bounds object has the same left, right, top, bottom components as this.  Note that if bounds passed in is null, returns false.

toString

toString:function()

Returns

{String} String representation of bounds object.  (ex.<i>”left-top=(5,42) right-bottom=(10,45)”</i>)

toArray

toArray: function()

Returns

{Array} array of left, top, right, bottom

getWidth

getWidth:function()

Returns

{Float} The width of the bounds

getHeight

getHeight:function()

Returns

{Float} The height of the bounds (bottom minus top).

getSize

getSize:function()

Returns

{OpenSpace.ScreenSize} The size of the box.

getCenterPixel

getCenterPixel:function()

Returns

{OpenSpace.ScreenPoint} The center of the bounds in pixel space.

add

add:function(x,
y)

Parameters

x{Float}
y{Float}

Returns

{OpenSpace.ScreenBounds} A new bounds whose coordinates are the same as this, but shifted by the passed-in x and y values.

extend

extend:function(object)

Extend the bounds to include the point, lonlat, or bounds specified.  Note, this function assumes that left < right and bottom < top.

Parameters

object{Object} Can be LonLat, Point, or Bounds

containsPixel

containsPixel:function(px,
inclusive)

Parameters

px{OpenSpace.ScreenPoint}
inclusive{Boolean} Whether or not to include the border.  Default is true.

Returns

{Boolean} The passed-in pixel is within this bounds.

contains

contains:function(x,
y,
inclusive)

Parameters

x{Float}
y{Float}
inclusive{Boolean} Whether or not to include the border.  Default is true.

Returns

{Boolean} Whether or not the passed-in coordinates are within this bounds.

intersectsBounds

intersectsBounds:function(bounds,
inclusive)

Parameters

bounds{OpenSpace.ScreenBounds}
inclusive{<Boolean>} Whether or not to include the border.  Default is true.

Returns

{Boolean} The passed-in OpenLayers.Bounds object intersects this bounds.  Simple math just check if either contains the other, allowing for partial.

containsBounds

containsBounds:function(bounds,
partial,
inclusive)
bounds{OpenSpace.ScreenBounds}
partial{<Boolean>} If true, only part of passed-in bounds needs be within this bounds.  If false, the entire passed-in bounds must be within.  Default is false
inclusive{<Boolean>} Whether or not to include the border.  Default is true.

Returns

{Boolean} The passed-in bounds object is contained within this bounds.

determineQuadrant

determineQuadrant: function(px)

Parameters

px{OpenSpace.ScreenPoint}

Returns

{String} The quadrant (“br” “tr” “tl” “bl”) of the bounds in which the coordinate lies.

oppositeQuadrant

OpenSpace.ScreenBounds.oppositeQuadrant = function(quadrant)

Get the opposite quadrant for a given quadrant string.

Parameters

quadrant{String} two character quadrant shortstring

Returns

{String} The opposing quadrant (“br” “tr” “tl” “bl”).  For Example, if you pass in “bl” it returns “tr”, if you pass in “br” it returns “tl”, etc.

clone:function()
Create a cloned instance of this bounds.
equals:function(bounds)
Test a two bounds for equivalence.
toString:function()
{String} String representation of bounds object.
toArray: function()
{Array} array of left, top, right, bottom
getWidth:function()
{Float} The width of the bounds
getHeight:function()
{Float} The height of the bounds (bottom minus top).
getSize:function()
{OpenSpace.ScreenSize} The size of the box.
Instances of this class represent a width/height pair
getCenterPixel:function()
{OpenSpace.ScreenPoint} The center of the bounds in pixel space.
This class represents a screen coordinate, in x and y coordinates
add:function(x,
y)
extend:function(object)
Extend the bounds to include the point, lonlat, or bounds specified.
containsPixel:function(px,
inclusive)
contains:function(x,
y,
inclusive)
intersectsBounds:function(bounds,
inclusive)
containsBounds:function(bounds,
partial,
inclusive)
determineQuadrant: function(px)
OpenSpace.ScreenBounds.oppositeQuadrant = function(quadrant)
Get the opposite quadrant for a given quadrant string.
Construct a new Screen bounds object.
Close