Packageaway3d.core.clip
Classpublic class Clipping
InheritanceClipping Inheritance flash.events.EventDispatcher
Subclasses FrustumClipping, 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:Vector.<FaceVO>, clippedSegmentVOs:Vector.<SegmentVO>, clippedSpriteVOs:Vector.<SpriteVO>, clippedVertices:Vector.<Vertex>, clippedVerts:Vector.<Number>, clippedIndices:Vector.<int>, startIndices:Vector.<int>):void
Clipping
  
checkPrimitive(renderer:Renderer, priIndex:uint):Boolean
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
[override] Used to trace the values of a rectangle clipping object.
Clipping
Property Detail
iniproperty
protected var ini:Init

maxXproperty 
maxX:Number

Maximum allowed x value for primitives


Implementation
    public function get maxX():Number
    public function set maxX(value:Number):void
maxYproperty 
maxY:Number

Maximum allowed y value for primitives


Implementation
    public function get maxY():Number
    public function set maxY(value:Number):void
maxZproperty 
maxZ:Number

Maximum allowed z value for primitives


Implementation
    public function get maxZ():Number
    public function set maxZ(value:Number):void
minXproperty 
minX:Number

Minimum allowed x value for primitives


Implementation
    public function get minX():Number
    public function set minX(value:Number):void
minYproperty 
minY:Number

Minimum allowed y value for primitives


Implementation
    public function get minY():Number
    public function set minY(value:Number):void
minZproperty 
minZ:Number

Minimum allowed z value for primitives


Implementation
    public function get minZ():Number
    public function set minZ(value:Number):void
objectCullingproperty 
objectCulling:Boolean


Implementation
    public function get objectCulling():Boolean
    public function set objectCulling(value:Boolean):void
viewproperty 
view:View3D


Implementation
    public function get view():View3D
    public function set view(value:View3D):void
Constructor Detail
Clipping()Constructor
public function Clipping(init:Object = null)

Creates a new Clipping object.

Parameters
init:Object (default = null) — [optional] An initialisation object for specifying default instance properties.
####INIT####
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:Vector.<FaceVO>, clippedSegmentVOs:Vector.<SegmentVO>, clippedSpriteVOs:Vector.<SpriteVO>, clippedVertices:Vector.<Vertex>, clippedVerts:Vector.<Number>, clippedIndices:Vector.<int>, startIndices:Vector.<int>):void

Parameters

mesh:Mesh
 
clippedFaceVOs:Vector.<FaceVO>
 
clippedSegmentVOs:Vector.<SegmentVO>
 
clippedSpriteVOs:Vector.<SpriteVO>
 
clippedVertices:Vector.<Vertex>
 
clippedVerts:Vector.<Number>
 
clippedIndices:Vector.<int>
 
startIndices:Vector.<int>

checkPrimitive()method 
public function checkPrimitive(renderer:Renderer, priIndex:uint):Boolean

Checks a drawing primitive for clipping.

Parameters

renderer:Renderer — The drawing primitive being checked.
 
priIndex:uint

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 
override public function toString():String

Used to trace the values of a rectangle clipping object.

Returns
String — A string representation of the rectangle clipping object.




Tue Jun 7 2011, 11:27 PM +01:00