Справочник по ActionScript® 3.0 для платформы Adobe® Flash®
Домашняя страница  |  Скрыть список пакетов и классов |  Пакеты  |  Классы  |  Что нового  |  Указатель  |  Приложения  |  Почему по-английски?
Фильтры: Получение данных с сервера...
Получение данных с сервера...
flash.geom 

Rectangle  - AS3

Пакетflash.geom
Классpublic class Rectangle
НаследованиеRectangle Inheritance Object
Подклассы RoundedRectangle

Язык версии: ActionScript 3.0
Версии среды выполнения: AIR 1.0, Flash Player 9, Flash Lite 4

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

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

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

  • Методы applyFilter(), colorTransform(), copyChannel(), copyPixels(), draw(), fillRect(), generateFilterRect(), getColorBoundsRect(), getPixels(), merge(), paletteMap(), pixelDisolve(), setPixels(), threshold() и свойство rect класса BitmapData.
  • Методы getBounds(), getRect() и свойства scrollRect, scale9Grid класса DisplayObject.
  • Метод getCharBoundaries() класса TextField.
  • Свойство pixelBounds класса Transform.
  • Параметр bounds для метода startDrag() класса Sprite.
  • Параметр printArea метода addPage() класса PrintJob.

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

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

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

Связанные элементы API



Общедоступные свойства
 СвойствоОпределено
  bottom : Number
Сумма значений свойств y и height.
Rectangle
  bottomRight : Point
Расположение правого нижнего угла объекта Rectangle, заданного значениями свойств right и bottom.
Rectangle
 Inheritedconstructor : Object
Ссылка на объект класса или функцию конструктора для данного экземпляра объекта.
Object
  height : Number
Высота прямоугольника в пикселях.
Rectangle
  left : Number
Координата x левого верхнего угла прямоугольника.
Rectangle
  right : Number
Сумма свойств x и width.
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
  
copyFrom(sourceRect:Rectangle):void
Копирует все данные прямоугольника из исходного объекта Rectangle в вызывающий объект 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
  
setTo(xa:Number, ya:Number, widtha:Number, heighta:Number):void
Задает для членов объекта Rectangle определенные значения
Rectangle
 Inherited
Возвращает строковое представление этого объекта, отформатированного в соответствии со стандартами, принятыми для данной локали.
Object
  
Создает и возвращает строку, содержащую данные о горизонтальном и вертикальном расположении, а также о ширине и высоте объекта Rectangle.
Rectangle
  
Добавляет два прямоугольника для создания нового объекта Rectangle путем заполнения горизонтального и вертикального пространства между двумя прямоугольниками.
Rectangle
 Inherited
Возвращает элементарное значение заданного объекта.
Object
Сведения о свойстве

bottom

свойство
bottom:Number

Язык версии: ActionScript 3.0
Версии среды выполнения: AIR 1.0, Flash Player 9, Flash Lite 4

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

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



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

Связанные элементы API

bottomRight

свойство 
bottomRight:Point

Язык версии: ActionScript 3.0
Версии среды выполнения: AIR 1.0, Flash Player 9, Flash Lite 4

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

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



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

Связанные элементы API

height

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

Язык версии: ActionScript 3.0
Версии среды выполнения: AIR 1.0, Flash Player 9, Flash Lite 4

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

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

Связанные элементы API

left

свойство 
left:Number

Язык версии: ActionScript 3.0
Версии среды выполнения: AIR 1.0, Flash Player 9, Flash Lite 4

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

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

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



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

Связанные элементы API

right

свойство 
right:Number

Язык версии: ActionScript 3.0
Версии среды выполнения: AIR 1.0, Flash Player 9, Flash Lite 4

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

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



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

Связанные элементы API

size

свойство 
size:Point

Язык версии: ActionScript 3.0
Версии среды выполнения: AIR 1.0, Flash Player 9, Flash Lite 4

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



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

Связанные элементы API

top

свойство 
top:Number

Язык версии: ActionScript 3.0
Версии среды выполнения: AIR 1.0, Flash Player 9, Flash Lite 4

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

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

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



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

Связанные элементы API

topLeft

свойство 
topLeft:Point

Язык версии: ActionScript 3.0
Версии среды выполнения: AIR 1.0, Flash Player 9, Flash Lite 4

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

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



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

Связанные элементы API

width

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

Язык версии: ActionScript 3.0
Версии среды выполнения: AIR 1.0, Flash Player 9, Flash Lite 4

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

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

Связанные элементы API

x

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

Язык версии: ActionScript 3.0
Версии среды выполнения: AIR 1.0, Flash Player 9, Flash Lite 4

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

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

Связанные элементы API

y

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

Язык версии: ActionScript 3.0
Версии среды выполнения: AIR 1.0, Flash Player 9, Flash Lite 4

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

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

Связанные элементы API

Сведения о конструкторе

Rectangle

()Конструктор
public function Rectangle(x:Number = 0, y:Number = 0, width:Number = 0, height:Number = 0)

Язык версии: ActionScript 3.0
Версии среды выполнения: AIR 1.0, Flash Player 9, Flash Lite 4

Создает новый объект 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) — Высота прямоугольника в пикселях.

Связанные элементы API

Сведения о методе

clone

()метод
public function clone():Rectangle

Язык версии: ActionScript 3.0
Версии среды выполнения: AIR 1.0, Flash Player 9, Flash Lite 4

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

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

Связанные элементы API

contains

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

Язык версии: ActionScript 3.0
Версии среды выполнения: AIR 1.0, Flash Player 9, Flash Lite 4

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

Параметры

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

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

Связанные элементы API

containsPoint

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

Язык версии: ActionScript 3.0
Версии среды выполнения: AIR 1.0, Flash Player 9, Flash Lite 4

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

Параметры

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

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

Связанные элементы API

containsRect

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

Язык версии: ActionScript 3.0
Версии среды выполнения: AIR 1.0, Flash Player 9, Flash Lite 4

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

Параметры

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

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

copyFrom

()метод 
public function copyFrom(sourceRect:Rectangle):void

Язык версии: ActionScript 3.0
Версии среды выполнения: Flash Player 11, AIR 3.0, Flash Lite 4

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

Параметры

sourceRect:Rectangle — Объект Rectangle, из которого следует скопировать данные.

equals

()метод 
public function equals(toCompare:Rectangle):Boolean

Язык версии: ActionScript 3.0
Версии среды выполнения: AIR 1.0, Flash Player 9, Flash Lite 4

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

Параметры

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

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

Связанные элементы API

inflate

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

Язык версии: ActionScript 3.0
Версии среды выполнения: AIR 1.0, Flash Player 9, Flash Player 9, Flash Lite 4

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

Параметры

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

Связанные элементы API

inflatePoint

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

Язык версии: ActionScript 3.0
Версии среды выполнения: AIR 1.0, Flash Player 9, Flash Lite 4

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

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

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

Параметры

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

Связанные элементы API

intersection

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

Язык версии: ActionScript 3.0
Версии среды выполнения: AIR 1.0, Flash Player 9, Flash Lite 4

Если объект 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
Версии среды выполнения: AIR 1.0, Flash Player 9, Flash Lite 4

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

Параметры

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

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

Связанные элементы API

isEmpty

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

Язык версии: ActionScript 3.0
Версии среды выполнения: AIR 1.0, Flash Player 9, Flash Lite 4

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

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

offset

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

Язык версии: ActionScript 3.0
Версии среды выполнения: AIR 1.0, Flash Player 9, Flash Lite 4

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

Параметры

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

offsetPoint

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

Язык версии: ActionScript 3.0
Версии среды выполнения: AIR 1.0, Flash Player 9, Flash Lite 4

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

Параметры

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

Связанные элементы API

setEmpty

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

Язык версии: ActionScript 3.0
Версии среды выполнения: AIR 1.0, Flash Player 9, Flash Lite 4

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

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

Связанные элементы API

setTo

()метод 
public function setTo(xa:Number, ya:Number, widtha:Number, heighta:Number):void

Язык версии: ActionScript 3.0
Версии среды выполнения: Flash Player 11, AIR 3.0, Flash Lite 4

Задает для членов объекта Rectangle определенные значения

Параметры

xa:Number — значения, которые следует задать для прямоугольника.
 
ya:Number
 
widtha:Number
 
heighta:Number

toString

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

Язык версии: ActionScript 3.0
Версии среды выполнения: AIR 1.0, Flash Player 9, Flash Lite 4

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

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

Связанные элементы API

union

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

Язык версии: ActionScript 3.0
Версии среды выполнения: AIR 1.0, Flash Player 9, Flash Lite 4

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

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

Примечание. Метод union() игнорирует прямоугольники со значением 0 в качестве значения для высоты или ширины, например, var rect2:Rectangle = new Rectangle(300,300,50,0);

Параметры

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
        }
    }
}




[ X ]Почему по-английски?
Содержимое Справочника ActionScript 3.0 отображается на английском языке

Не все части Справочника ActionScript 3.0 переводятся на все языки. Если какой-то текстовый элемент не переведен, он отображается на английском языке. Например, компонент ga.controls.HelpBox не переведен ни на один из языков. Это значит, что в русской версии справки компонент ga.controls.HelpBox будет отображаться на английском языке.