Главная / Action Script 3
Пакетflash.geom
Классpublic class Rectangle
НаследованиеRectangle Inheritance Object

Язык версии : ActionScript 3.0
Версии среды выполнения:  1.0 9

Объект Rectangle представляет собой область, которая определяется расположением, задаваемым точкой левого верхнего угла (x, y), шириной и высотой.

Свойства x, y, width и height класса Rectangle независимы друг от друга; изменение значения одного свойства не влияет на значения других свойств. Однако свойства right и bottom полностью связаны с этими четырьмя свойствами. Например, при изменении значения свойства right изменяется значение свойства width; при изменении свойства bottom изменяется значение свойства height.

В следующих методах и свойствах используются объекты Rectangle:

Конструктор new Rectangle() можно использовать для создания объекта Rectangle.

Примечание. Класс Rectangle не определяет экранный объект прямоугольной формы. Чтобы нарисовать объект прямоугольной формы на экране, необходимо использовать метод drawRect() класса Graphics.

Посмотреть примеры

См. также

flash.display.DisplayObject.scrollRect
flash.display.BitmapData
flash.display.DisplayObject
flash.text.TextField.getCharBoundaries()
flash.geom.Transform.pixelBounds
flash.display.Sprite.startDrag()
flash.printing.PrintJob.addPage()
Использование объектов Rectangle
Настройка размера, масштаба и ориентации страницы


Общедоступные свойства
 СвойствоОпределено
  bottom : Number
Сумма y и значения высоты.
Rectangle
  bottomRight : Point
Расположение правого нижнего угла объекта Rectangle, заданного значениями свойств right и bottom.
Rectangle
 Inheritedconstructor : Object
Ссылка на объект класса или функцию конструктора для данного экземпляра объекта.
Object
  height : Number
Высота прямоугольника в пикселах.
Rectangle
  left : Number
Координата x левого верхнего угла прямоугольника.
Rectangle
 Inheritedprototype : Object
[статические] Ссылка на модель объекта класса или функции.
Object
  right : Number
Сумма x и значения ширины.
Rectangle
  size : Point
Размер объекта Rectangle, обозначенного как объект Point со значениями свойств width и height.
Rectangle
  top : Number
Координата y левого верхнего угла прямоугольника.
Rectangle
  topLeft : Point
Расположение левого верхнего угла объекта Rectangle, заданного координатами x и y точки.
Rectangle
  width : Number
Ширина прямоугольника в пикселах.
Rectangle
  x : Number
Координата x левого верхнего угла прямоугольника.
Rectangle
  y : Number
Координата y левого верхнего угла прямоугольника.
Rectangle
Общедоступные методы
 МетодОпределено
  
Rectangle(x:Number = 0, y:Number = 0, width:Number = 0, height:Number = 0)
Создает новый объект Rectangle, левый верхний угол которого задан параметрами x и y, а также с заданными параметрами ширины и высоты.
Rectangle
  
Возвращает новый объект Rectangle с такими же значениями свойств x, y, width и height, как и у исходного объекта Rectangle.
Rectangle
  
Определяет, будет ли указанная точка находится в области прямоугольника, задаваемой этим объектом Rectangle.
Rectangle
  
Определяет, будет ли указанная точка находится в области прямоугольника, задаваемой этим объектом Rectangle.
Rectangle
  
Определяет, является ли объект Rectangle, задаваемый параметром rect, частью данного объекта Rectangle.
Rectangle
  
Определяет, является ли объект, задаваемый параметром toCompare, эквивалентом данного объекта типа Rectangle.
Rectangle
 Inherited
Показывает, определено ли заданное свойство для объекта.
Object
  
Увеличивает размер объекта Rectangle на заданные величины (в пикселах).
Rectangle
  
Увеличивает размер объекта Rectangle.
Rectangle
  
Если объект Rectangle, заданный в параметре toIntersect, пересекает этот объект Rectangle, возвращается область пересечения в виде объекта Rectangle.
Rectangle
  
Определяет, пересекается ли объект, задаваемый параметром toIntersect, с данным объектом Rectangle.
Rectangle
  
Определяет, является ли объект Rectangle пустым.
Rectangle
 Inherited
Показывает, есть ли экземпляр класса Object в цепи прототипов объекта, заданного в качестве параметра.
Object
  
Настраивает положение объекта Rectangle, как определено его верхним левым углом, на заданные значения.
Rectangle
  
Регулирует местоположение объекта Rectangle, используя объект Point в качестве параметра.
Rectangle
 Inherited
Показывает наличие заданного свойства и его перечисляемость.
Object
  
Задает для всех свойств объекта Rectangle нулевые значения.
Rectangle
 Inherited
Задает доступность динамического свойства для операций цикла.
Object
  
Создает и возвращает строку, содержащую данные о горизонтальном и вертикальном расположении, а также о ширине и высоте объекта Rectangle.
Rectangle
  
Добавляет два прямоугольника для создания нового объекта Rectangle путем заполнения горизонтального и вертикального пространства между двумя прямоугольниками.
Rectangle
 Inherited
Возвращает элементарное значение заданного объекта.
Object
Сведения о свойстве
bottomсвойство
bottom:Number  [чтение и запись]

Язык версии : ActionScript 3.0
Версии среды выполнения:  1.0 9

Сумма значений свойств y и height.

Изображение прямоугольника, на котором показаны свойства расположения и измерения.



Реализация
    public function get bottom():Number
    public function set bottom(value:Number):void

См. также

bottomRightсвойство 
bottomRight:Point  [чтение и запись]

Язык версии : ActionScript 3.0
Версии среды выполнения:  1.0 9

Расположение правого нижнего угла объекта Rectangle, заданного значениями свойств right и bottom.

Изображение прямоугольника, на котором показаны свойства расположения и измерения.



Реализация
    public function get bottomRight():Point
    public function set bottomRight(value:Point):void

См. также

heightсвойство 
public var height:Number

Язык версии : ActionScript 3.0
Версии среды выполнения:  1.0 9

Высота прямоугольника в пикселах. Изменение значения свойства height объекта Rectangle не влияет на свойства x, y и width.

Изображение прямоугольника, на котором показаны свойства расположения и измерения.

См. также

leftсвойство 
left:Number  [чтение и запись]

Язык версии : ActionScript 3.0
Версии среды выполнения:  1.0 9

Координата x левого верхнего угла прямоугольника. Изменение свойства left объекта Rectangle не влияет на свойства y и height. Однако оно влияет на свойство width, тогда как изменение значения x не влияет на свойство width.

Значение свойства left равно значению свойства x.

Изображение прямоугольника, на котором показаны свойства расположения и измерения.



Реализация
    public function get left():Number
    public function set left(value:Number):void

См. также

rightсвойство 
right:Number  [чтение и запись]

Язык версии : ActionScript 3.0
Версии среды выполнения:  1.0 9

Сумма свойств x и width.

Изображение прямоугольника, на котором показаны свойства расположения и измерения.



Реализация
    public function get right():Number
    public function set right(value:Number):void

См. также

sizeсвойство 
size:Point  [чтение и запись]

Язык версии : ActionScript 3.0
Версии среды выполнения:  1.0 9

Размер объекта Rectangle, обозначенного как объект Point со значениями свойств width и height.



Реализация
    public function get size():Point
    public function set size(value:Point):void

См. также

topсвойство 
top:Number  [чтение и запись]

Язык версии : ActionScript 3.0
Версии среды выполнения:  1.0 9

Координата y левого верхнего угла прямоугольника. Изменение свойства top объекта Rectangle не влияет на свойства x и width. Однако оно влияет на свойство height, тогда как изменение значения y не влияет на свойство height.

Значение свойства top равно значению свойства y.

Изображение прямоугольника, на котором показаны свойства расположения и измерения.



Реализация
    public function get top():Number
    public function set top(value:Number):void

См. также

topLeftсвойство 
topLeft:Point  [чтение и запись]

Язык версии : ActionScript 3.0
Версии среды выполнения:  1.0 9

Расположение левого верхнего угла объекта Rectangle, заданного координатами x и y точки.

Изображение прямоугольника, на котором показаны свойства расположения и измерения.



Реализация
    public function get topLeft():Point
    public function set topLeft(value:Point):void

См. также

widthсвойство 
public var width:Number

Версии среды выполнения:  1.0 9

Ширина прямоугольника в пикселах. Изменение значения свойства width объекта Rectangle не влияет на свойства x, y и height.

Изображение прямоугольника, на котором показаны свойства расположения и измерения.

См. также

xсвойство 
public var x:Number

Язык версии : ActionScript 3.0
Версии среды выполнения:  1.0 9

Координата x левого верхнего угла прямоугольника. Изменение значения свойства x объекта Rectangle не влияет на свойства y, width и height.

Значение свойства x равно значению свойства left.

См. также

yсвойство 
public var y:Number

Версии среды выполнения:  1.0 9

Координата y левого верхнего угла прямоугольника. Изменение значения свойства y объекта Rectangle не влияет на свойства x, width и height.

Значение свойства y равно значению свойства top.

См. также

Сведения о конструкторе
Rectangle()Конструктор
public function Rectangle(x:Number = 0, y:Number = 0, width:Number = 0, height:Number = 0)

Язык версии : ActionScript 3.0
Версии среды выполнения:  1.0 9

Создает новый объект Rectangle, левый верхний угол которого задан параметрами x и y, а также с заданными параметрами width и height. Если эта функция вызвана без параметров, создается прямоугольник, для которого значения свойств x, y, width и height равны 0.

Параметры
x:Number (default = 0) — Координата x левого верхнего угла прямоугольника.
 
y:Number (default = 0) — Координата y левого верхнего угла прямоугольника.
 
width:Number (default = 0) — Ширина прямоугольника в пикселах.
 
height:Number (default = 0) — Высота прямоугольника в пикселах.

См. также

Сведения о методе
clone()метод
public function clone():Rectangle

Язык версии : ActionScript 3.0
Версии среды выполнения:  1.0 9

Возвращает новый объект Rectangle с такими же значениями свойств x, y, width и height, как и у исходного объекта Rectangle.

Возвращает
Rectangle — Новый объект Rectangle с такими же значениями свойств x, y, width и height, как и у исходного объекта Rectangle.

См. также

contains()метод 
public function contains(x:Number, y:Number):Boolean

Язык версии : ActionScript 3.0
Версии среды выполнения:  1.0 9

Определяет, будет ли указанная точка находится в области прямоугольника, задаваемой этим объектом Rectangle.

Параметры

x:Number — Координата x точки (горизонтальное положение).
 
y:Number — Координата y точки (вертикальное положение).

Возвращает
Boolean — Значение true возвращается, если объект Rectangle содержит указанную точку; в противном случае возвращается false.

См. также

containsPoint()метод 
public function containsPoint(point:Point):Boolean

Язык версии : ActionScript 3.0
Версии среды выполнения:  1.0 9

Определяет, будет ли указанная точка находится в области прямоугольника, задаваемой этим объектом Rectangle. Этот метод аналогичен методу Rectangle.contains() за исключением того, что в нем объект Point используется как параметр.

Параметры

point:Point — Точка, представленная координатами x и y.

Возвращает
Boolean — Значение true возвращается, если объект Rectangle содержит указанную точку; в противном случае возвращается false.

См. также

containsRect()метод 
public function containsRect(rect:Rectangle):Boolean

Язык версии : ActionScript 3.0
Версии среды выполнения:  1.0 9

Определяет, является ли объект Rectangle, задаваемый параметром rect, частью данного объекта Rectangle. Можно сказать, что объект Rectangle содержит другой объект, если второй объект Rectangle полностью находится в границах первого объекта.

Параметры

rect:Rectangle — Проверенный объект Rectangle.

Возвращает
Boolean — Возвращается значение true, если заданный объект Rectangle является частью данного объекта Rectangle; в противном случае возвращается false.
equals()метод 
public function equals(toCompare:Rectangle):Boolean

Язык версии : ActionScript 3.0
Версии среды выполнения:  1.0 9

Определяет, является ли объект, задаваемый параметром toCompare, эквивалентом данного объекта типа Rectangle. Этот метод сравнивает свойства x, y, width и height объекта с такими же свойствами данного объекта Rectangle.

Параметры

toCompare:Rectangle — Прямоугольник, сравниваемый с данным объектом Rectangle.

Возвращает
Boolean — Возвращается значение true, если значения свойств x, y, width и height объекта и данного объекта Rectangle полностью совпадают; в противном случае возвращается false.

См. также

inflate()метод 
public function inflate(dx:Number, dy:Number):void

Язык версии : ActionScript 3.0
Версии среды выполнения:  9, 9

Увеличивает размер объекта Rectangle на заданные величины (в пикселах). Центральная точка объекта Rectangle остается неизменной, а его размеры увеличиваются слева и справа на значение dx и сверху и снизу на значение dy.

Параметры

dx:Number — Значение, добавляемое слева и справа от объекта Rectangle. Следующее уравнение используется для вычисления новой ширины и нового положения прямоугольника:
 x -= dx;
 width += 2 * dx;
 
 
dy:Number — Значение, добавляемое вверху и внизу прямоугольника Rectangle. Следующее уравнение используется для вычисления новой высоты и нового положения прямоугольника:
 y -= dy;
 height += 2 * dy;
 

См. также

inflatePoint()метод 
public function inflatePoint(point:Point):void

Язык версии : ActionScript 3.0
Версии среды выполнения:  1.0 9

Увеличивает размер объекта Rectangle. Этот метод аналогичен методу Rectangle.inflate() за исключением того, что в нем объект Point используется как параметр.

В следующих двух примерах кода получается одинаковый результат:

  rect1=new flash.geom.Rectangle(0,0,2,5);
  rect1.inflate(2,2)
  
  rect1=new flash.geom.Rectangle(0,0,2,5);
  pt1=new flash.geom.Point(2,2);
  rect1.inflatePoint(pt1)
  

Параметры

point:Point — Свойство x этого объекта Point используется для увеличения горизонтального размера объекта Rectangle. Свойство y используется для увеличения вертикального размера объекта Rectangle.

См. также

intersection()метод 
public function intersection(toIntersect:Rectangle):Rectangle

Язык версии : ActionScript 3.0
Версии среды выполнения:  1.0 9

Если объект Rectangle, заданный в параметре toIntersect, пересекает этот объект Rectangle, возвращается область пересечения в виде объекта Rectangle. Если пересечение отсутствует, этот метод возвращает пустой объект Rectangle с нулевыми значениями свойств.

Получающийся в результате пересечения прямоугольник.

Параметры

toIntersect:Rectangle — Сравниваемый объект Rectangle для просмотра наличия пересечений с данным объектом Rectangle.

Возвращает
Rectangle — Объект Rectangle, равный области пересечения. Если пересечение объекта отсутствует, этот метод возвращает пустой объект Rectangle; то есть прямоугольник с нулевыми значениями свойств x, y, width и height.

См. также

intersects()метод 
public function intersects(toIntersect:Rectangle):Boolean

Язык версии : ActionScript 3.0
Версии среды выполнения:  1.0 9

Определяет, пересекается ли объект, задаваемый параметром toIntersect, с данным объектом Rectangle. Этот метод проверяет свойства x, y, width и height заданного объекта Rectangle на наличие пересечения с данным объектом Rectangle.

Параметры

toIntersect:Rectangle — Объект Rectangle, сравниваемый с данным объектом Rectangle.

Возвращает
Boolean — Возвращается значение true, если заданный объект пересекает данный объект Rectangle; в противном случае возвращается false.

См. также

isEmpty()метод 
public function isEmpty():Boolean

Язык версии : ActionScript 3.0
Версии среды выполнения:  1.0 9

Определяет, является ли объект Rectangle пустым.

Возвращает
Boolean — Возвращается значение true, если ширина или высота объекта Rectangle меньше или равна 0; в противном случае возвращается false.
offset()метод 
public function offset(dx:Number, dy:Number):void

Язык версии : ActionScript 3.0
Версии среды выполнения:  1.0 9

Настраивает положение объекта Rectangle, как определено его верхним левым углом, на заданные значения.

Параметры

dx:Number — Перемещает значение x объекта Rectangle на это расстояние.
 
dy:Number — Перемещает значение y объекта Rectangle на это расстояние.

См. также

offsetPoint()метод 
public function offsetPoint(point:Point):void

Язык версии : ActionScript 3.0
Версии среды выполнения:  1.0 9

Регулирует местоположение объекта Rectangle, используя объект Point в качестве параметра. Этот метод аналогичен методу Rectangle.offset() за исключением того, что в нем объект Point используется как параметр.

Параметры

point:Point — Объект Point, используемый для коррекции этого объекта Rectangle.

См. также

setEmpty()метод 
public function setEmpty():void

Язык версии : ActionScript 3.0
Версии среды выполнения:  1.0 9

Задает для всех свойств объекта Rectangle нулевые значения. Объект Rectangle является пустым, если его ширина или высота меньше или равна 0.

Этот метод задает нулевые значения свойств x, y, width и height.

См. также

toString()метод 
public function toString():String

Язык версии : ActionScript 3.0
Версии среды выполнения:  1.0 9

Создает и возвращает строку, содержащую данные о горизонтальном и вертикальном расположении, а также о ширине и высоте объекта Rectangle.

Возвращает
String — Строка, в которой перечислены значения всех следующих свойств объекта Rectangle: x, y, width и height.

См. также

union()метод 
public function union(toUnion:Rectangle):Rectangle

Язык версии : ActionScript 3.0
Версии среды выполнения:  1.0 9

Добавляет два прямоугольника для создания нового объекта Rectangle путем заполнения горизонтального и вертикального пространства между двумя прямоугольниками.

Получающийся в результате объединения прямоугольник.

Параметры

toUnion:Rectangle — Объект Rectangle, добавляемый к данному объекту Rectangle.

Возвращает
Rectangle — Новый объект Rectangle, который является объединением двух прямоугольников.

См. также

Примеры Как пользоваться примерами
RectangleExample.as

В следующем примере класс RectangleExample используется для создания трех новых объектов Rectangle с различными координатами x,y и различными значениями высоты и ширины, а затем метод trace() используется для подтверждения успешного создания экземпляров Rectangle. Далее логическая переменная isContained назначается результату вызова метода containsRect(), который определяет, что второй прямоугольник не полностью заключает в себя третий прямоугольник.
package {
    import flash.display.Sprite;
    import flash.geom.Rectangle;

    public class RectangleExample extends Sprite {

        public function RectangleExample() {
            var firstRect:Rectangle = new Rectangle();
            trace(firstRect);  // (x=0, y=0, w=0, h=0)
            var secondRect:Rectangle = new Rectangle(1, 3, 11, 13);
            trace(secondRect); // (x=1, y=3, w=11, h=13)
            var thirdRect:Rectangle = new Rectangle(5, 8, 17, 19);
            trace(thirdRect);  // (x=5, y=8, w=17, h=19)
            var isContained:Boolean = secondRect.containsRect(thirdRect);
            trace(isContained); // false
        }
    }
}