Immutable rectangular area. More...

Inheritance diagram for Dragengine.Gui.RectArea:

Public Member Functions
Constructors
RectArea	new ()
	Create rectangular area with all coordinates set to 0.

RectArea	new (int x1, int y1, int x2, int y2)
	Create rectangular area with initial coordinates.

RectArea	new (RectArea rect)
	Create copy of rectangular area.

RectArea	new (Point position, Point size)
	Create recangular area from a point and size.

Management
int	getX1 ()
	X1-Coordinate.

int	getY1 ()
	Y1-Coordinate.

int	getX2 ()
	X2-Coordinate.

int	getY2 ()
	Y2-Coordinate.

RectArea	orientate ()
	Orientate rectangular area placing (x1,y1) top-left and (x2,y2) bottom-right.

Point	getPosition ()
	Position.

Point	getSize ()
	Size.

int	getWidth ()
	Width.

int	getHeight ()
	Height.

Point	getTopLeft ()
	Top-left corner (x1, y1).

Point	getTopRight ()
	Top-right corner (x2, y1).

Point	getBottomLeft ()
	Bottom-left corner (x1, y2).

Point	getBottomRight ()
	Bottom-right corner (x2, y2).

RectArea	move (int x, int y)
	Rectangular area moved by offset.

RectArea	move (Point distance)
	Rectangular area moved by offset.

RectArea	grow (int x, int y)
	Rectangular area grown by size at bottom right.

RectArea	grow (Point size)
	Rectangular area grown by size at bottom right.

RectArea	growInverse (int x, int y)
	Rectangular area grown by size at top left.

RectArea	growInverse (Point size)
	Rectangular area grown by size at top left.

RectArea	include (RectArea rect)
	Rectangular area grown to include another rectangular area.

RectArea	intersect (RectArea rect)
	Rectangular area set to the intersection area between two rectangular areas.

Point	clamp (Point point)
	Point clamped to rectangular area.

bool	isZeroWidth ()
	Width is 0 (x1=x2).

bool	isZeroHeight ()
	Height is 0 (y1=y2).

bool	isZeroSize ()
	Size is 0 (x1=x2, y1=y2).

bool	isZeroWidthOrHeight ()
	Width or height is 0 (x1=x2 or y1=y2).

bool	isInside (int x, int y)
	Point is inside rectangular area.

bool	isInsideX (int x)
	Point is inside rectangular area along X axis.

bool	isInsideY (int y)
	Point is inside rectangular area along Y axis.

bool	isOverlapping (RectArea rect)
	Rectangular areas overlap.

bool	isOverlappingX (RectArea rect)
	Rectangular areas overlap in X direction.

bool	isOverlappingY (RectArea rect)
	Rectangular areas overlap in Y direction.

bool	isEqual (RectArea rect)
	Rectangular areas is equal to another rectangular area.

String	toString ()
	String representation.

Public Attributes
int	pX1

File Handling
void	writeToFile (FileWriter writer)
	Write rectangular area to file writer.

static RectArea	readFromFile (FileReader reader)
	Read rectangular area from file reader.

Detailed Description

Immutable rectangular area.

Coordinate (x2,y2) is exclusive. Hence the rectangular area includes all points except row y2 and column x2.

Member Function Documentation

◆ clamp()

Point Dragengine.Gui.RectArea.clamp ( Point point )

Point clamped to rectangular area.

This excludes the row y2 and column x2 unless the width or height is 0.

◆ getBottomLeft()

Point Dragengine.Gui.RectArea.getBottomLeft ( )

Bottom-left corner (x1, y2).

Version: 1.13

◆ getBottomRight()

Point Dragengine.Gui.RectArea.getBottomRight ( )

Bottom-right corner (x2, y2).

Version: 1.13

◆ getHeight()

int Dragengine.Gui.RectArea.getHeight ( )

Height.

Version: 1.13

◆ getPosition()

Point Dragengine.Gui.RectArea.getPosition ( )

Position.

◆ getSize()

Point Dragengine.Gui.RectArea.getSize ( )

Size.

◆ getTopLeft()

Point Dragengine.Gui.RectArea.getTopLeft ( )

Top-left corner (x1, y1).

Version: 1.13

◆ getTopRight()

Point Dragengine.Gui.RectArea.getTopRight ( )

Top-right corner (x2, y1).

Version: 1.13

◆ getWidth()

int Dragengine.Gui.RectArea.getWidth ( )

Width.

Version: 1.13

◆ getX1()

int Dragengine.Gui.RectArea.getX1 ( )

X1-Coordinate.

◆ getX2()

int Dragengine.Gui.RectArea.getX2 ( )

X2-Coordinate.

◆ getY1()

int Dragengine.Gui.RectArea.getY1 ( )

Y1-Coordinate.

◆ getY2()

int Dragengine.Gui.RectArea.getY2 ( )

Y2-Coordinate.

◆ grow() [1/2]

RectArea Dragengine.Gui.RectArea.grow	(	int	x,
		int	y
	)

Rectangular area grown by size at bottom right.

◆ grow() [2/2]

RectArea Dragengine.Gui.RectArea.grow ( Point size )

Rectangular area grown by size at bottom right.

◆ growInverse() [1/2]

RectArea Dragengine.Gui.RectArea.growInverse	(	int	x,
		int	y
	)

Rectangular area grown by size at top left.

◆ growInverse() [2/2]

RectArea Dragengine.Gui.RectArea.growInverse ( Point size )

Rectangular area grown by size at top left.

◆ include()

RectArea Dragengine.Gui.RectArea.include ( RectArea rect )

Rectangular area grown to include another rectangular area.

◆ intersect()

RectArea Dragengine.Gui.RectArea.intersect ( RectArea rect )

Rectangular area set to the intersection area between two rectangular areas.

◆ isEqual()

bool Dragengine.Gui.RectArea.isEqual ( RectArea rect )

Rectangular areas is equal to another rectangular area.

◆ isInside()

bool Dragengine.Gui.RectArea.isInside	(	int	x,
		int	y
	)

Point is inside rectangular area.

This excludes the row y2 and column x2. If the width or height is 0 the point is never inside.

◆ isInsideX()

bool Dragengine.Gui.RectArea.isInsideX ( int x )

Point is inside rectangular area along X axis.

Version: 1.29

This excludes the column x2. If the width is 0 the point is never inside.

◆ isInsideY()

bool Dragengine.Gui.RectArea.isInsideY ( int y )

Point is inside rectangular area along Y axis.

Version: 1.29

This excludes the row y2. If the height is 0 the point is never inside.

◆ isOverlapping()

bool Dragengine.Gui.RectArea.isOverlapping ( RectArea rect )

Rectangular areas overlap.

Version: 1.29

◆ isOverlappingX()

bool Dragengine.Gui.RectArea.isOverlappingX ( RectArea rect )

Rectangular areas overlap in X direction.

Version: 1.29

◆ isOverlappingY()

bool Dragengine.Gui.RectArea.isOverlappingY ( RectArea rect )

Rectangular areas overlap in Y direction.

Version: 1.29

◆ isZeroHeight()

bool Dragengine.Gui.RectArea.isZeroHeight ( )

Height is 0 (y1=y2).

Version: 1.29

◆ isZeroSize()

bool Dragengine.Gui.RectArea.isZeroSize ( )

Size is 0 (x1=x2, y1=y2).

Version: 1.29

◆ isZeroWidth()

bool Dragengine.Gui.RectArea.isZeroWidth ( )

Width is 0 (x1=x2).

Version: 1.29

◆ isZeroWidthOrHeight()

bool Dragengine.Gui.RectArea.isZeroWidthOrHeight ( )

Width or height is 0 (x1=x2 or y1=y2).

Version: 1.29

◆ move() [1/2]

RectArea Dragengine.Gui.RectArea.move	(	int	x,
		int	y
	)

Rectangular area moved by offset.

◆ move() [2/2]

RectArea Dragengine.Gui.RectArea.move ( Point distance )

Rectangular area moved by offset.

◆ new() [1/4]

RectArea Dragengine.Gui.RectArea.new ( )

Create rectangular area with all coordinates set to 0.

◆ new() [2/4]

RectArea Dragengine.Gui.RectArea.new	(	int	x1,
		int	y1,
		int	x2,
		int	y2
	)

Create rectangular area with initial coordinates.

◆ new() [3/4]

RectArea Dragengine.Gui.RectArea.new	(	Point	position,
		Point	size
	)

Create recangular area from a point and size.

◆ new() [4/4]

RectArea Dragengine.Gui.RectArea.new ( RectArea rect )

Create copy of rectangular area.

◆ orientate()

RectArea Dragengine.Gui.RectArea.orientate ( )

Orientate rectangular area placing (x1,y1) top-left and (x2,y2) bottom-right.

◆ readFromFile()

static RectArea Dragengine.Gui.RectArea.readFromFile ( FileReader reader )

static

Read rectangular area from file reader.

◆ toString()

String Dragengine.Gui.RectArea.toString ( )

String representation.

◆ writeToFile()

void Dragengine.Gui.RectArea.writeToFile ( FileWriter writer )

Write rectangular area to file writer.

Member Data Documentation

◆ pX1

int Dragengine.Gui.RectArea.pX1

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

RectArea.ds

Public Member Functions

Public Attributes

File Handling