Packageaway3d.core.clip
Classpublic class RectangleClipping
InheritanceRectangleClipping Inheritance Clipping

Rectangle clipping

Public Properties
 PropertyDefined by
 InheritedmaxX : Number = 1000000
Maximum allowed x value for primitives
Clipping
 InheritedmaxY : Number = 1000000
Maximum allowed y value for primitives
Clipping
 InheritedminX : Number = -1000000
Minimum allowed x value for primitives
Clipping
 InheritedminY : Number = -1000000
Minimum allowed y value for primitives
Clipping
Public Methods
 MethodDefined by
  
RectangleClipping
(minX:Number = -1000000, minY:Number = -1000000, maxX:Number = 1000000, maxY:Number = 1000000)
RectangleClipping
  
Returns a rectangle clipping object representing the bounding box of the clipping object.
RectangleClipping
  
check(pri:DrawPrimitive):Boolean
Checks a drawing primitive for clipping.
RectangleClipping
  
rect(minX:Number, minY:Number, maxX:Number, maxY:Number):Boolean
Checks a bounding rectangle for clipping.
RectangleClipping
 Inherited
screen(container:Sprite):Clipping
Returns a rectangle clipping object initilised with the edges of the flash movie as the clipping bounds.
Clipping
  
toString():String
Used to trace the values of a rectangle clipping object.
RectangleClipping
Constructor detail
RectangleClipping()constructor
public function RectangleClipping(minX:Number = -1000000, minY:Number = -1000000, maxX:Number = 1000000, maxY:Number = 1000000)Parameters
minX:Number (default = -1000000)
 
minY:Number (default = -1000000)
 
maxX:Number (default = 1000000)
 
maxY:Number (default = 1000000)
####INIT####
Method detail
asRectangleClipping()method
public override function asRectangleClipping():RectangleClipping

Returns a rectangle clipping object representing the bounding box of the clipping object.

Returns
RectangleClipping
check()method 
public override function check(pri:DrawPrimitive):Boolean

Checks a drawing primitive for clipping.

Parameters
pri:DrawPrimitive — The drawing primitive being checked.

Returns
Boolean — The clipping result - false for clipped, true for non-clipped.
rect()method 
public override function rect(minX:Number, minY:Number, maxX:Number, maxY:Number):Boolean

Checks a bounding rectangle for clipping.

Parameters
minX:Number — The x value for the left side of the rectangle.
 
minY:Number — The y value for the top side of the rectangle.
 
maxX:Number — The x value for the right side of the rectangle.
 
maxY:Number — The y value for the bottom side of the rectangle.

Returns
Boolean — The clipping result - false for clipped, true for non-clipped.
toString()method 
public function toString():String

Used to trace the values of a rectangle clipping object.

Returns
String — A string representation of the rectangle clipping object.
Wiki link
Click to go to the wiki page for ####WIKI####

Code examples

Comments