Packageaway3d.core.clip
Classpublic class Clipping
InheritanceClipping Inheritance flash.events.EventDispatcher
SubclassesFrustumClipping, NearfieldClipping, RectangleClipping

Base clipping class for no clipping.

Public Properties
 PropertyDefined by
  maxX : Number
Maximum allowed x value for primitives
Clipping
  maxY : Number
Maximum allowed y value for primitives
Clipping
  maxZ : Number
Maximum allowed z value for primitives
Clipping
  minX : Number
Minimum allowed x value for primitives
Clipping
  minY : Number
Minimum allowed y value for primitives
Clipping
  minZ : Number
Minimum allowed z value for primitives
Clipping
  objectCulling : Boolean
Clipping
  view : View3D
Clipping
Protected Properties
 PropertyDefined by
  ini : Init
Clipping
Public Methods
 MethodDefined by
  
Clipping
(init:Object = null)
Creates a new Clipping object.
Clipping
  
addOnClippingUpdate(listener:Function):void
Default method for adding a clippingUpdated event listener
Clipping
  
addOnScreenUpdate(listener:Function):void
Default method for adding a screenUpdated event listener
Clipping
  
checkElements(mesh:Mesh, clippedFaceVOs:Array, clippedSegmentVOs:Array, clippedBillboards:Array, clippedVertices:Array, clippedCommands:Array, clippedIndices:Array, startIndices:Array):void
Clipping
  
Checks a drawing primitive for clipping.
Clipping
  
clone(object:Clipping = null):Clipping
Clipping
  
rect(minX:Number, minY:Number, maxX:Number, maxY:Number):Boolean
Checks a bounding rectangle for clipping.
Clipping
  
removeOnClippingUpdate(listener:Function):void
Default method for removing a clippingUpdated event listener
Clipping
  
removeOnScreenUpdate(listener:Function):void
Default method for removing a screenUpdated event listener
Clipping
  
screen(container:Sprite, _loaderWidth:Number, _loaderHeight:Number):Clipping
Returns a 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.
Clipping
Property detail
iniproperty
protected var ini:Init
maxXproperty 
maxX:Number  [read-write]

Maximum allowed x value for primitives

Implementation
    public function get maxX():Number
    public function set maxX(value:Number):void
maxYproperty 
maxY:Number  [read-write]

Maximum allowed y value for primitives

Implementation
    public function get maxY():Number
    public function set maxY(value:Number):void
maxZproperty 
maxZ:Number  [read-write]

Maximum allowed z value for primitives

Implementation
    public function get maxZ():Number
    public function set maxZ(value:Number):void
minXproperty 
minX:Number  [read-write]

Minimum allowed x value for primitives

Implementation
    public function get minX():Number
    public function set minX(value:Number):void
minYproperty 
minY:Number  [read-write]

Minimum allowed y value for primitives

Implementation
    public function get minY():Number
    public function set minY(value:Number):void
minZproperty 
minZ:Number  [read-write]

Minimum allowed z value for primitives

Implementation
    public function get minZ():Number
    public function set minZ(value:Number):void
objectCullingproperty 
objectCulling:Boolean  [read-write]
Implementation
    public function get objectCulling():Boolean
    public function set objectCulling(value:Boolean):void
viewproperty 
view:View3D  [read-write]
Implementation
    public function get view():View3D
    public function set view(value:View3D):void
Constructor detail
Clipping()constructor
public function Clipping(init:Object = null)
Parameters
init:Object (default = null) — [optional] An initialisation object for specifying default instance properties.
Init Parameters
 minX:Number (default = -Infinity)
 minY:Number (default = -Infinity)
 minZ:Number (default = -Infinity)
 maxX:Number (default = Infinity)
 maxY:Number (default = Infinity)
 maxZ:Number (default = Infinity)
Method detail
addOnClippingUpdate()method
public function addOnClippingUpdate(listener:Function):void

Default method for adding a clippingUpdated event listener

Parameters
listener:Function — The listener function
addOnScreenUpdate()method 
public function addOnScreenUpdate(listener:Function):void

Default method for adding a screenUpdated event listener

Parameters
listener:Function — The listener function
checkElements()method 
public function checkElements(mesh:Mesh, clippedFaceVOs:Array, clippedSegmentVOs:Array, clippedBillboards:Array, clippedVertices:Array, clippedCommands:Array, clippedIndices:Array, startIndices:Array):void
Parameters
mesh:Mesh
 
clippedFaceVOs:Array
 
clippedSegmentVOs:Array
 
clippedBillboards:Array
 
clippedVertices:Array
 
clippedCommands:Array
 
clippedIndices:Array
 
startIndices:Array
checkPrimitive()method 
public function checkPrimitive(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.
clone()method 
public function clone(object:Clipping = null):Clipping
Parameters
object:Clipping (default = null)

Returns
Clipping
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.
removeOnClippingUpdate()method 
public function removeOnClippingUpdate(listener:Function):void

Default method for removing a clippingUpdated event listener

Parameters
listener:Function — The listener function
removeOnScreenUpdate()method 
public function removeOnScreenUpdate(listener:Function):void

Default method for removing a screenUpdated event listener

Parameters
listener:Function — The listener function
screen()method 
public function screen(container:Sprite, _loaderWidth:Number, _loaderHeight:Number):Clipping

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

Parameters
container:Sprite
 
_loaderWidth:Number
 
_loaderHeight:Number

Returns
Clipping
toString()method 
public override 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 'away3d.core.clip.Clipping'

Code examples
There are currently no examples for this class

Comments
No comments found
Please leave a comment

Please leave a comment

security image