org.osbot.rs07.api.map

Class Area

java.lang.Object

org.osbot.rs07.api.map.Area

Direct Known Subclasses:

Location

public class Area
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
Area(int[][] positions) Constructs a polygonal area using each set in a 2d array as a pair of x and y position coordinates.
Area(int x1, int y1, int x2, int y2) Constructs a rectangular area using x and y coordinates from two separate positions.
Area(java.awt.Polygon polygon) Constructs an area based on a Polygon
Area(Position[] positions) Constructs a polygonal area using each position as a point in the polygon.
Area(Position southWest, Position northEast) Constructs a rectangular area using two positions Note: The plane is set to the z coordinate of both positions, throwing an IllegalArgumentException if they do not match
Area(java.awt.Rectangle rectangle) Constructs a rectangular area using a Rectangle.

Method Summary

Modifier and Type	Method and Description
boolean	contains(Entity entity) Checks if the entity is within the area
boolean	contains(int x, int y)
boolean	contains(int x, int y, int z)
boolean	contains(Position position) Checks if the position is within the area
Position	getCentralPosition() Gets the central position of the area When the central position is not a round number, the values are rounded up.
int	getPlane()
java.awt.Polygon	getPolygon()
java.util.List<Position>	getPositions()
Position	getRandomPosition()
Area	setPlane(int plane) Sets the plane (z coordinate) for this area; by default this value is set to 0.
java.lang.String	toString() Returns Position#toString() for all positions within the area

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Area

public Area(int[][] positions)

Constructs a polygonal area using each set in a 2d array as a pair of x and y position coordinates. Note: By default the plane is set to 0

Parameters:

positions - A 2d array of map positions

Area

public Area(Position[] positions)

Constructs a polygonal area using each position as a point in the polygon. Note: By default the plane is set to 0

Parameters:

positions - An array of positions to add to the area

Area

public Area(int x1,
            int y1,
            int x2,
            int y2)

Constructs a rectangular area using x and y coordinates from two separate positions. Note: By default the plane is set to 0

Parameters:

x1 - The bottom left x bound (inclusive)

y1 - The bottom left y bound (inclusive)

x2 - The top right x bound (inclusive)

y2 - The top right y bound (inclusive)

Area

public Area(java.awt.Polygon polygon)

Constructs an area based on a Polygon

Parameters:

polygon - The polygon area

Area

public Area(java.awt.Rectangle rectangle)

Constructs a rectangular area using a Rectangle. Note: The width and height are NOT the south-east position but function as actual width and height

Parameters:

rectangle - The area rectangle

Area

public Area(Position southWest,
            Position northEast)

Constructs a rectangular area using two positions
Note: The plane is set to the z coordinate of both positions, throwing an IllegalArgumentException if they do not match

Parameters:

southWest - A south-west position

northEast - A north-east position

Method Detail

setPlane

public Area setPlane(int plane)

Sets the plane (z coordinate) for this area; by default this value is set to 0. The plane will be used for operations involving Position such as getPositions(), getRandomPosition(), contains(Position), etc.

Parameters:

plane - The plane to for this area

Returns:

This area

getPlane

public int getPlane()

Returns:

The plane (z coordinate) in which this area covers

getPolygon

public java.awt.Polygon getPolygon()

Returns:

The java.awt.Polygon which this class is based off

contains

public boolean contains(int x,
                        int y)

Parameters:

x - The position x coordinate

y - The position y coordinate

Returns:

True if the position x and y coordinate is within the area without plane verification

contains

public boolean contains(int x,
                        int y,
                        int z)

Parameters:

x - The position x coordinate

y - The position y coordinate

z - The position z coordinate

Returns:

True if the position x and y coordinate is within the area with plane verification and the plane is equal to z

contains

public boolean contains(Position position)

Checks if the position is within the area

Parameters:

position - The position to check

Returns:

True if the position is within the area

contains

public boolean contains(Entity entity)

Checks if the entity is within the area

Parameters:

entity - The entity to check

Returns:

True if the entity is within the area

getPositions

public java.util.List<Position> getPositions()

Returns:

All the positions within this area

getRandomPosition

public Position getRandomPosition()

Returns:

A random position within this area

getCentralPosition

public Position getCentralPosition()

Gets the central position of the area When the central position is not a round number, the values are rounded up.

Returns:

The central position of the area

toString

public java.lang.String toString()

Returns Position#toString() for all positions within the area

Overrides:

toString in class java.lang.Object

Returns:

Position#toString() for all positions within the area