Legacy Documentation: Version 4.6.2
Language: English
  • C#
  • JS
  • Boo

Script language

Select your preferred scripting language. All code snippets will be displayed in this language.

Rect

Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Sumbission failed

For some reason your suggested change could not be submitted. Please try again in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

Description

A 2D Rectangle defined by x, y position and width, height.

The Rect structure is mainly used for 2D operations. The UnityGUI system uses it extensively and it is also to set the onscreen position of a Camera's view.

The rectangle can be specified in two different ways. The first way involves supplying the top-left corner coordinate along with the width and height. This is done using the x, y, width and height properties.

The second way to specify the rectangle is to supply the X coordinates of its left and right sides and the Y coordinates of its top and bottom sides. These are denoted by the xMin, xMax, yMin and yMax properties.

Although the x and y properties may seem to be the same as xMin and xMax, their behaviour is actually slightly different. The x and y values are assumed to be used along with width and height. This means that if you change x or y without changing width or height then the rectangle will change position but stay the same size. On the other hand, if you change the values of xMin or yMin without changing xMax or yMax then the rectangle will change size and the top-left corner will also change.

See Also: GUI Scripting Guide, Camera.rect, Camera.pixelRect.

Variables

center Center coordinate of the rectangle.
height Height of the rectangle.
max Upper right corner of the rectangle.
min Lower left corner of the rectangle.
position The top left coordinates of the rectangle.
size The size of the rectangle.
width Width of the rectangle.
x Left coordinate of the rectangle.
xMax Right coordinate of the rectangle.
xMin Left coordinate of the rectangle.
y Top coordinate of the rectangle.
yMax Bottom coordinate of the rectangle.
yMin Top coordinate of the rectangle.

Constructors

Rect Creates a new rectangle.

Functions

Contains Returns true if the x and y components of point is a point inside this rectangle. If allowInverse is present and true, the width and height of the Rect are allowed to take negative values (ie, the min value is greater than the max), and the test will still work.
Overlaps Returns true if the other rectangle overlaps this one. If allowInverse is present and true, the widths and heights of the Rects are allowed to take negative values (ie, the min value is greater than the max), and the test will still work.
Set Set components of an existing Rect.
ToString Returns a nicely formatted string for this Rect.

Static Functions

MinMaxRect Creates a rectangle from min/max coordinate values.
NormalizedToPoint Returns a point inside a rectangle, given normalized coordinates.
PointToNormalized Returns the normalized coordinates cooresponding the the point.

Operators

operator != Returns true if the rectangles are different.
operator == Returns true if the rectangles are the same.
Copyright © 2014 Unity Technologies
LearnCommunityAsset StoreBuyDownload