Referenshandbok för ActionScript® 3.0 i Adobe® Flash®-plattformen
Hem  |  Dölj paket och klasslista |  Paket  |  Klasser  |  Nyheter  |  Index  |  Bilagor  |  Varför på engelska?
Filter: AIR 30.0 och tidigare, Flash Player 30.0 och tidigare, Flash Lite 4
Flex 4.6 och tidigare, Flash Pro CS6 och tidigare
Dölj filter
flash.geom 

Rectangle  - AS3

Paketflash.geom
Klasspublic class Rectangle
ArvRectangle Inheritance Object
Underklasser RoundedRectangle

Språkversion: ActionScript 3.0
Körningsmiljöversioner: AIR 1.0, Flash Player 9, Flash Lite 4

Ett Rectangle-objekt är ett område som definieras av sin position, som indikeras av dess övre vänstra hörnpunkt (x, y) och av dess bredd och höjd.

Egenskaperna x, y, width och height i klassen Rectangle är oberoende av varandra. Om du ändrar den ena egenskapens värde påverkas inte den andra. Egenskaperna right och bottom är däremot relaterade till dessa fyra egenskaper. Om du till exempel ändrar värdet på right-egenskapen, ändras width-egenskapens värde. Om du ändrar bottom-egenskapen ändras värdet för height-egenskapen.

Rectangle-objekt används i följande metoder och egenskaper:

  • Metoderna applyFilter(), colorTransform(), copyChannel(), copyPixels(), draw(), fillRect(), generateFilterRect(), getColorBoundsRect(), getPixels(), merge(), paletteMap(), pixelDisolve(), setPixels() och threshold() och rect-egenskapen i BitmapData-klassen.
  • Metoderna getBounds() och getRect() och egenskaperna scrollRect och scale9Grid i DisplayObject-klassen
  • Metoden getCharBoundaries() i TextField-klassen
  • Egenskapen pixelBounds i Transform-klassen
  • Parametern bounds i metodenstartDrag() i Sprite-klassen
  • Parametern printArea i metodenaddPage() i PrintJob-klassen

Du kan skapa ett Rectangle-objekt med hjälp av konstruktorn new Rectangle().

Obs! Rectangle-klassen definierar inte ett rektangulärt Shape-visningsobjekt. Om du vill rita ett rektangulärt Shape-objekt på skärmen använder du metodendrawRect() i Graphics-klassen.

Visa exemplen

Relaterade API-element



Publika egenskaper
 EgenskapDefinieras med
  bottom : Number
Summan av egenskaperna y och höjd.
Rectangle
  bottomRight : Point
Positionen för Rectangle-objektets nedre högra hörn, som avgörs av värdena för egenskaperna right och bottom.
Rectangle
 Inheritedconstructor : Object
En referens till klassobjektet eller konstruktorfunktionen för en given objektinstans.
Object
  height : Number
Rektangelns höjd i pixlar.
Rectangle
  left : Number
X-koordinaten för rektangelns övre vänstra hörn.
Rectangle
  right : Number
Summan av egenskaperna x och bredd.
Rectangle
  size : Point
Rectangle-objektets storlek, uttryckt som ett Point-objekt med värdena för egenskaperna width och height.
Rectangle
  top : Number
Y-koordinaten för rektangelns övre vänstra hörn.
Rectangle
  topLeft : Point
Positionen för Rectangle-objektets övre vänstra hörn, som avgörs av punktens x- och y-koordinater.
Rectangle
  width : Number
Rektangelns bredd i pixlar.
Rectangle
  x : Number
X-koordinaten för rektangelns övre vänstra hörn.
Rectangle
  y : Number
Y-koordinaten för rektangelns övre vänstra hörn.
Rectangle
Publika metoder
 MetodDefinieras med
  
Rectangle(x:Number = 0, y:Number = 0, width:Number = 0, height:Number = 0)
Skapar ett nytt Rectangle-objekt med det övre vänstra hörnet som anges av parametrarna x och y och med de angivna parametrarna för bredd och höjd.
Rectangle
  
Returnerar ett nytt Rectangle-objekt med samma värden för egenskaperna x, y, bredd och höjd som det ursprungliga Rectangle-objektet.
Rectangle
  
Avgör om den angivna punkten finns inuti det rektangulära området som definieras av det här Rectangle-objektet.
Rectangle
  
Avgör om den angivna punkten finns inuti det rektangulära området som definieras av det här Rectangle-objektet.
Rectangle
  
Avgör om det Rectangle-objekt som anges av parametern rect finns inuti det här Rectangle-objektet.
Rectangle
  
copyFrom(sourceRect:Rectangle):void
Kopierar alla rektangeldata från källans Rectangle-objekt till anropande Rectangle-objekt.
Rectangle
  
Fastställer om det objekt som anges av parametern toCompare är lika med det här Rectangle-objektet.
Rectangle
 Inherited
Anger om det finns en egenskap angiven för ett objekt.
Object
  
Ökar storleken på objektet Rectangle med den angivna mängden, i pixlar.
Rectangle
  
Ökar Rectangle-objektets storlek.
Rectangle
  
Om det Rectangle-objekt som anges av parametern toIntersect överlappar det här Rectangle-objektet, returneras det överlappande området som ett Rectangle-objekt.
Rectangle
  
Avgör om det objekt som anges av parametern toIntersect överlappar det här Rectangle-objektet.
Rectangle
  
Avgör om det här Rectangle-objektet är tomt.
Rectangle
 Inherited
Anger om en instans av klassen Object finns i prototypkedjan för objektet som anges som parameter.
Object
  
Justerar positionen för Rectangle-objektet, som avgörs av dess övre vänstra hörn, med de värden som anges.
Rectangle
  
Justerar Rectangle-objektets placering med ett punktobjekt som parameter.
Rectangle
 Inherited
Anger om den angivna egenskapen finns och är uppräkningsbar.
Object
  
Ställer in alla egenskaper i Rectangle-objektet på 0.
Rectangle
 Inherited
Anger tillgänglighet för en dynamisk egenskap för slingåtgärder.
Object
  
setTo(xa:Number, ya:Number, widtha:Number, heighta:Number):void
Tilldelar rektangelmedlemmarna det angivna värdet
Rectangle
 Inherited
Returnerar det här objektets strängrepresentation, formaterad i enlighet med språkspecifika konventioner.
Object
  
Skapar och returnerar en sträng som listar de vågräta och lodräta positionerna och bredden och höjden för Rectangle-objektet.
Rectangle
  
Lägger ihop två rektanglar för att skapa ett nytt Rectangle-objekt genom att fylla i det vågräta och lodräta utrymmet mellan de två rektanglarna.
Rectangle
 Inherited
Returnerar det angivna objektets primitiva värde.
Object
Egenskapsdetaljer

bottom

egenskap
bottom:Number

Språkversion: ActionScript 3.0
Körningsmiljöversioner: AIR 1.0, Flash Player 9, Flash Lite 4

Summan av egenskaperna y och height.

En rektangelbild som visar plats- och måttegenskaper.



Implementering
    public function get bottom():Number
    public function set bottom(value:Number):void

Relaterade API-element

bottomRight

egenskap 
bottomRight:Point

Språkversion: ActionScript 3.0
Körningsmiljöversioner: AIR 1.0, Flash Player 9, Flash Lite 4

Positionen för Rectangle-objektets nedre högra hörn, som avgörs av värdena för egenskaperna right och bottom.

En rektangelbild som visar plats- och måttegenskaper.



Implementering
    public function get bottomRight():Point
    public function set bottomRight(value:Point):void

Relaterade API-element

height

egenskap 
public var height:Number

Språkversion: ActionScript 3.0
Körningsmiljöversioner: AIR 1.0, Flash Player 9, Flash Lite 4

Rektangelns höjd i pixlar. Om du ändrar värdet för egenskapen height för ett Rectangle-objekt påverkas inte egenskaperna x, y och width.

En rektangelbild som visar plats- och måttegenskaper.

Relaterade API-element

left

egenskap 
left:Number

Språkversion: ActionScript 3.0
Körningsmiljöversioner: AIR 1.0, Flash Player 9, Flash Lite 4

X-koordinaten för rektangelns övre vänstra hörn. Om du ändrar left-egenskapen i ett Rectangle-objekt påverkas inte egenskaperna y och height. Däremot påverkas egenskapen width, men om du ändrar x-värdet påverkas inte egenskapen width.

Värdet för egenskapen left är lika med värdet för egenskapen x.

En rektangelbild som visar plats- och måttegenskaper.



Implementering
    public function get left():Number
    public function set left(value:Number):void

Relaterade API-element

right

egenskap 
right:Number

Språkversion: ActionScript 3.0
Körningsmiljöversioner: AIR 1.0, Flash Player 9, Flash Lite 4

Summan av egenskaperna x och width.

En rektangelbild som visar plats- och måttegenskaper.



Implementering
    public function get right():Number
    public function set right(value:Number):void

Relaterade API-element

size

egenskap 
size:Point

Språkversion: ActionScript 3.0
Körningsmiljöversioner: AIR 1.0, Flash Player 9, Flash Lite 4

Rectangle-objektets storlek, uttryckt som ett Point-objekt med värdena för egenskaperna width och height.



Implementering
    public function get size():Point
    public function set size(value:Point):void

Relaterade API-element

top

egenskap 
top:Number

Språkversion: ActionScript 3.0
Körningsmiljöversioner: AIR 1.0, Flash Player 9, Flash Lite 4

Y-koordinaten för rektangelns övre vänstra hörn. Om du ändrar top-egenskapen i ett Rectangle-objekt påverkas inte egenskaperna x och width. Däremot påverkas egenskapen height, men om du ändrar y-värdet påverkas inte egenskapen height.

Värdet för egenskapen top är lika med värdet för egenskapen y.

En rektangelbild som visar plats- och måttegenskaper.



Implementering
    public function get top():Number
    public function set top(value:Number):void

Relaterade API-element

topLeft

egenskap 
topLeft:Point

Språkversion: ActionScript 3.0
Körningsmiljöversioner: AIR 1.0, Flash Player 9, Flash Lite 4

Positionen för Rectangle-objektets övre vänstra hörn, som avgörs av punktens x och y-koordinater.

En rektangelbild som visar plats- och måttegenskaper.



Implementering
    public function get topLeft():Point
    public function set topLeft(value:Point):void

Relaterade API-element

width

egenskap 
public var width:Number

Språkversion: ActionScript 3.0
Körningsmiljöversioner: AIR 1.0, Flash Player 9, Flash Lite 4

Rektangelns bredd i pixlar. Om du ändrar värdet för egenskapen width för ett Rectangle-objekt påverkas inte egenskaperna x, y och height.

En rektangelbild som visar plats- och måttegenskaper.

Relaterade API-element

x

egenskap 
public var x:Number

Språkversion: ActionScript 3.0
Körningsmiljöversioner: AIR 1.0, Flash Player 9, Flash Lite 4

X-koordinaten för rektangelns övre vänstra hörn. Om du ändrar värdet för egenskapen x för ett Rectangle-objekt påverkas inte egenskaperna y, width och height.

Värdet för egenskapen x är lika med värdet för egenskapen left.

Relaterade API-element

y

egenskap 
public var y:Number

Språkversion: ActionScript 3.0
Körningsmiljöversioner: AIR 1.0, Flash Player 9, Flash Lite 4

Y-koordinaten för rektangelns övre vänstra hörn. Om du ändrar värdet för egenskapen yi ett Rectangle-objekt påverkas inte egenskaperna x, width och height.

Värdet för egenskapen y är lika med värdet för egenskapen top.

Relaterade API-element

Konstruktordetaljer

Rectangle

()Konstruktor
public function Rectangle(x:Number = 0, y:Number = 0, width:Number = 0, height:Number = 0)

Språkversion: ActionScript 3.0
Körningsmiljöversioner: AIR 1.0, Flash Player 9, Flash Lite 4

Skapar ett nytt Rectangle-objekt med det övre vänstra hörnet som anges av parametrarna x och y och med de angivna parametrarna width och height. Om du anropar den här funktionen utan parametrar, skapas en rektangel med egenskaperna x, y, width och height inställda på 0.

Parametrar
x:Number (default = 0)X-koordinaten för rektangelns övre vänstra hörn.
 
y:Number (default = 0)Y-koordinaten för rektangelns övre vänstra hörn.
 
width:Number (default = 0) — Rektangelns bredd i pixlar.
 
height:Number (default = 0) — Rektangelns höjd i pixlar.

Relaterade API-element

Metoddetaljer

clone

()metod
public function clone():Rectangle

Språkversion: ActionScript 3.0
Körningsmiljöversioner: AIR 1.0, Flash Player 9, Flash Lite 4

Returnerar ett nytt Rectangle-objekt med samma värden för egenskaperna x, y, width och height som det ursprungliga Rectangle-objektet.

Returnerar
Rectangle — Returnerar ett nytt Rectangle-objekt med samma värden för egenskaperna x, y, width och height som det ursprungliga Rectangle-objektet.

Relaterade API-element

contains

()metod 
public function contains(x:Number, y:Number):Boolean

Språkversion: ActionScript 3.0
Körningsmiljöversioner: AIR 1.0, Flash Player 9, Flash Lite 4

Avgör om den angivna punkten finns inuti det rektangulära området som definieras av det här Rectangle-objektet.

Parametrar

x:Number — Punktens x-koordinat (vågräta position).
 
y:Number — Punktens y-koordinat (lodräta position).

Returnerar
Boolean — Returnerar true om Rectangle-objektet innehåller den angivna punkten. Annars returneras false.

Relaterade API-element

containsPoint

()metod 
public function containsPoint(point:Point):Boolean

Språkversion: ActionScript 3.0
Körningsmiljöversioner: AIR 1.0, Flash Player 9, Flash Lite 4

Avgör om den angivna punkten finns inuti det rektangulära området som definieras av det här Rectangle-objektet. Metoden liknar metoden Rectangle.contains() förutom att den tar ett Point-objekt som parameter.

Parametrar

point:Point — Punkten i form av dess x- och y-koordinater.

Returnerar
Boolean — Returnerar true om Rectangle-objektet innehåller den angivna punkten. Annars returneras false.

Relaterade API-element

containsRect

()metod 
public function containsRect(rect:Rectangle):Boolean

Språkversion: ActionScript 3.0
Körningsmiljöversioner: AIR 1.0, Flash Player 9, Flash Lite 4

Avgör om det Rectangle-objekt som anges av parametern rect finns inuti det här Rectangle-objektet. Ett Rectangle-objekt anses innehålla ett annat om det andra Rectangle-objektet är helt inom den första rektangelns gränser.

Parametrar

rect:Rectangle — Det Rectangle-objekt som kontrolleras.

Returnerar
Boolean — Returnerar true om det angivna Rectangle-objektet finns i det här Rectangle-objektet. Annars returneras false.

copyFrom

()metod 
public function copyFrom(sourceRect:Rectangle):void

Språkversion: ActionScript 3.0
Körningsmiljöversioner: Flash Player 11, AIR 3.0, Flash Lite 4

Kopierar alla rektangeldata från källans Rectangle-objekt till anropande Rectangle-objekt.

Parametrar

sourceRect:Rectangle — Rectangle-objektet varifrån data kopieras.

equals

()metod 
public function equals(toCompare:Rectangle):Boolean

Språkversion: ActionScript 3.0
Körningsmiljöversioner: AIR 1.0, Flash Player 9, Flash Lite 4

Fastställer om det objekt som anges av parametern toCompare är lika med det här Rectangle-objektet. Med den här metoden jämförs egenskaperna x, y, width och height i ett objekt med samma egenskaper i det här Rectangle-objektet.

Parametrar

toCompare:Rectangle — Rektangeln som ska jämföras med det här Rectangle-objektet.

Returnerar
Boolean — Värdet true om objektet har exakt samma värden för egenskaperna x, y, width och height som det här Rectangle-objektet. Annars false.

Relaterade API-element

inflate

()metod 
public function inflate(dx:Number, dy:Number):void

Språkversion: ActionScript 3.0
Körningsmiljöversioner: AIR 1.0, Flash Player 9, Flash Player 9, Flash Lite 4

Ökar storleken på objektet Rectangle med den angivna mängden, i pixlar. Rectangle-objektets mittpunkt ändras inte. Dess storlek ökar åt vänster och höger med värdet dx och uppåt och nedåt med värdet dy.

Parametrar

dx:Number — Det värde som ska läggas till till höger och vänster om Rectangle-objektet. Följande ekvation används för att beräkna rektangelns nya bredd och position:
    x -= dx;
    width += 2 * dx;
    
 
dy:Number — Det värde som ska läggas till ovanför och nedanför Rectangle-objektet. Följande ekvation används för att beräkna rektangelns nya höjd och position:
    y -= dy;
    height += 2 * dy;
    

Relaterade API-element

inflatePoint

()metod 
public function inflatePoint(point:Point):void

Språkversion: ActionScript 3.0
Körningsmiljöversioner: AIR 1.0, Flash Player 9, Flash Lite 4

Ökar Rectangle-objektets storlek. Metoden liknar metoden Rectangle.inflate() förutom att den tar ett Point-objekt som parameter.

I följande två kodexempel ges samma resultat:

     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)
     

Parametrar

point:Point — Egenskapen x för det här Point-objektet används för att öka Rectangle-objektets vågräta dimension. Egenskapen y används för att öka Rectangle-objektets lodräta dimension.

Relaterade API-element

intersection

()metod 
public function intersection(toIntersect:Rectangle):Rectangle

Språkversion: ActionScript 3.0
Körningsmiljöversioner: AIR 1.0, Flash Player 9, Flash Lite 4

Om det Rectangle-objekt som anges av parametern toIntersect överlappar det här Rectangle-objektet, returneras det överlappande området som ett Rectangle-objekt. Om rektanglarna inte överlappar returnerar metoden ett tomt Rectangle-objekt med egenskaperna inställda på 0.

Den resulterande överlappande rektangeln.

Parametrar

toIntersect:Rectangle — Rectangle-objektet att jämföra med för att se om det överlappar det här Rectangle-objektet.

Returnerar
Rectangle — Ett Rectangle-objekt som är lika med det överlappande området. Om rektanglarna inte överlappar returnerar metoden ett tomt Rectangle-objekt, det vill säga en rektangel med egenskaperna x, y, width och height inställda på 0.

intersects

()metod 
public function intersects(toIntersect:Rectangle):Boolean

Språkversion: ActionScript 3.0
Körningsmiljöversioner: AIR 1.0, Flash Player 9, Flash Lite 4

Fastställer om det objekt som anges av parametern toIntersect överlappar det här Rectangle-objektet. Med den här metoden kontrolleras egenskaperna x, y, width och height i det angivna Rectangle-objektet för att se om det överlappar det här Rectangle-objektet.

Parametrar

toIntersect:Rectangle — Det Rectangle-objekt som ska jämföras med det här Rectangle-objektet.

Returnerar
Boolean — Returnerar true om det angivna objektet överlappar det här Rectangle-objektet. Annars returneras false.

Relaterade API-element

isEmpty

()metod 
public function isEmpty():Boolean

Språkversion: ActionScript 3.0
Körningsmiljöversioner: AIR 1.0, Flash Player 9, Flash Lite 4

Avgör om det här Rectangle-objektet är tomt.

Returnerar
Boolean — Värdet true om Rectangle-objektets bredd eller höjd är mindre än eller lika med 0, annars false.

offset

()metod 
public function offset(dx:Number, dy:Number):void

Språkversion: ActionScript 3.0
Körningsmiljöversioner: AIR 1.0, Flash Player 9, Flash Lite 4

Justerar positionen för Rectangle-objektet, som avgörs av dess övre vänstra hörn, med de värden som anges.

Parametrar

dx:Number — Flyttar värdet x för Rectangle-objektet med den angivna mängden.
 
dy:Number — Flyttar värdet y för Rectangle-objektet med den angivna mängden.

offsetPoint

()metod 
public function offsetPoint(point:Point):void

Språkversion: ActionScript 3.0
Körningsmiljöversioner: AIR 1.0, Flash Player 9, Flash Lite 4

Justerar Rectangle-objektets placering med ett punktobjekt som parameter. Metoden liknar metoden Rectangle.offset() förutom att den tar ett Point-objekt som parameter.

Parametrar

point:Point — Ett Point-objekt som används för att förskjuta det här Rectangle-objektet.

Relaterade API-element

setEmpty

()metod 
public function setEmpty():void

Språkversion: ActionScript 3.0
Körningsmiljöversioner: AIR 1.0, Flash Player 9, Flash Lite 4

Ställer in alla egenskaper i Rectangle-objektet på 0. Ett Rectangle-objekt är tomt om dess bredd eller höjd är minde än eller lika med 0.

Med den här metoderna ställs värdena för egenskaperna x, y, width och height in på 0.

Relaterade API-element

setTo

()metod 
public function setTo(xa:Number, ya:Number, widtha:Number, heighta:Number):void

Språkversion: ActionScript 3.0
Körningsmiljöversioner: Flash Player 11, AIR 3.0, Flash Lite 4

Tilldelar rektangelmedlemmarna det angivna värdet

Parametrar

xa:Number — värdet som ska tilldelas rektangeln.
 
ya:Number
 
widtha:Number
 
heighta:Number

toString

()metod 
public function toString():String

Språkversion: ActionScript 3.0
Körningsmiljöversioner: AIR 1.0, Flash Player 9, Flash Lite 4

Skapar och returnerar en sträng som listar de vågräta och lodräta positionerna och bredden och höjden för Rectangle-objektet.

Returnerar
String — En sträng där värdet för följande egenskaper i Rectangle-objektet listas: x, y, width och height.

Relaterade API-element

union

()metod 
public function union(toUnion:Rectangle):Rectangle

Språkversion: ActionScript 3.0
Körningsmiljöversioner: AIR 1.0, Flash Player 9, Flash Lite 4

Lägger ihop två rektanglar för att skapa ett nytt Rectangle-objekt genom att fylla i det vågräta och lodräta utrymmet mellan de två rektanglarna.

Den resulterande föreningsrektangeln.

Obs! Metoden union() ignorerar rektanglar med 0 som värde för höjd eller bredd, t.ex. var rect2:Rectangle = new Rectangle(300,300,50,0);

Parametrar

toUnion:Rectangle — Ett Rectangle-objekt som ska läggas ihop med det här Rectangle-objektet.

Returnerar
Rectangle — Ett nytt Rectangle-objekt som är en förening av de två rektanglarna.
RectangleExample.as

I följande exempel används RectangleExample-klassen för att skapa tre nya Rectangle-objekt vid olika x, y-koordinater och med olika höjder och bredder. Sedan används metoden trace() för att bekräfta att Rectangle-instanserna har skapats. Därpå kopplas en boolesk variabel isContained till resultatet av anropet till metoden containsRect(), som fastställer att den andra rektangeln inte helt omfattar den tredje.
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 ]Varför på engelska?
Innehåll i Referenshandbok för ActionScript 3.0 i Adobe Flash-plattformen är på engelska

Det är inte alla delar av Referenshandbok för ActionScript 3.0 i Adobe Flash-plattformen som översätts till alla språk. Om ett språkelement inte översätts visas det på engelska. Klassen ga.controls.HelpBox översätts till exempel inte till något språk. I den svenska versionen av referenshandboken visas därför klassen ga.controls.HelpBox på engelska.