Packageaway3d.core.clip
Classpublic class Clipping
SubclassesRectangleClipping

Base clipping class for no clipping.

Public Properties
 PropertyDefined by
  maxX : Number = 1000000
Maximum allowed x value for primitives
Clipping
  maxY : Number = 1000000
Maximum allowed y value for primitives
Clipping
  minX : Number = -1000000
Minimum allowed x value for primitives
Clipping
  minY : Number = -1000000
Minimum allowed y value for primitives
Clipping
Public Methods
 MethodDefined by
  
Returns a rectangle clipping object representing the bounding box of the clipping object.
Clipping
  
check(pri:DrawPrimitive):Boolean
Checks a drawing primitive for clipping.
Clipping
  
rect(minX:Number, minY:Number, maxX:Number, maxY:Number):Boolean
Checks a bounding rectangle for clipping.
Clipping
  
screen(container:Sprite):Clipping
Returns a rectangle clipping object initilised with the edges of the flash movie as the clipping bounds.
Clipping
Property detail
maxXproperty
public var maxX:Number = 1000000

Maximum allowed x value for primitives

maxYproperty 
public var maxY:Number = 1000000

Maximum allowed y value for primitives

minXproperty 
public var minX:Number = -1000000

Minimum allowed x value for primitives

minYproperty 
public var minY:Number = -1000000

Minimum allowed y value for primitives

Method detail
asRectangleClipping()method
public function asRectangleClipping():RectangleClipping

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

Returns
RectangleClipping
check()method 
public 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 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.
screen()method 
public function screen(container:Sprite):Clipping

Returns a rectangle clipping object initilised with the edges of the flash movie as the clipping bounds.

Parameters
container:Sprite

Returns
Clipping
Wiki link
Click to go to the wiki page for ####WIKI####

Code examples

Comments