Packagecom.pblabs.box2D
Classpublic class Box2DManagerComponent
InheritanceBox2DManagerComponent Inheritance EntityComponent Inheritance Object
Implements ITickedObject, ISpatialManager2D


Public Properties
 PropertyDefined By
  allowSleep : Boolean
Box2DManagerComponent
  gravity : Point
Box2DManagerComponent
  inverseScale : Number
[read-only]
Box2DManagerComponent
 InheritedisRegistered : Boolean
[read-only] Whether or not the component is currently registered with an entity.
EntityComponent
 Inheritedname : String
[read-only] The name given to the component when it is added to an entity.
EntityComponent
 Inheritedowner : IEntity
A reference to the entity that this component currently belongs to.
EntityComponent
  scale : Number
Box2DManagerComponent
  world : b2World
[read-only]
Box2DManagerComponent
  worldBounds : Rectangle
Box2DManagerComponent
Protected Properties
 PropertyDefined By
  _allowSleep : Boolean = true
Box2DManagerComponent
  _gravity : Point
Box2DManagerComponent
  _otherItems : BasicSpatialManager2D
Box2DManagerComponent
  _scale : Number = 30
Box2DManagerComponent
  _world : b2World = null
Box2DManagerComponent
  _worldBounds : Rectangle
Box2DManagerComponent
Public Methods
 MethodDefined By
  
add(bodyDef:b2BodyDef, thisArg:* = null, completedCallback:Function = null):void
Box2DManagerComponent
  
addSpatialObject(object:ISpatialObject2D):void
Box2DManagerComponent
  
castRay(start:Point, end:Point, mask:ObjectType, result:RayHitInfo):Boolean
Box2DManagerComponent
  
getObjectsUnderPoint(worldPosition:Point, results:Array, mask:ObjectType = null):Boolean
Return all the spatial objects under a given point.
Box2DManagerComponent
  
onInterpolateTick(factor:Number):void
Box2DManagerComponent
  
onTick(tickRate:Number):void
Box2DManagerComponent
  
queryCircle(center:Point, radius:Number, mask:ObjectType, results:Array):Boolean
Box2DManagerComponent
  
queryRectangle(box:Rectangle, mask:ObjectType, results:Array):Boolean
Box2DManagerComponent
 Inherited
register(owner:IEntity, name:String):void
Registers the component with an entity.
EntityComponent
  
remove(body:b2Body):void
Box2DManagerComponent
  
removeSpatialObject(object:ISpatialObject2D):void
Box2DManagerComponent
 Inherited
reset():void
This is called by an entity on all of its components any time a component is added or removed.
EntityComponent
  
setDebugDrawer(drawer:b2DebugDraw):void
Box2DManagerComponent
 Inherited
unregister():void
Unregisters the component from an entity.
EntityComponent
Protected Methods
 MethodDefined By
  
onAdd():void
[override]
Box2DManagerComponent
  
onRemove():void
[override]
Box2DManagerComponent
 Inherited
onReset():void
This is called anytime a component is added or removed from the owner entity.
EntityComponent
Property Detail
_allowSleepproperty
protected var _allowSleep:Boolean = true

_gravityproperty 
protected var _gravity:Point

_otherItemsproperty 
protected var _otherItems:BasicSpatialManager2D

_scaleproperty 
protected var _scale:Number = 30

_worldproperty 
protected var _world:b2World = null

_worldBoundsproperty 
protected var _worldBounds:Rectangle

allowSleepproperty 
allowSleep:Boolean


Implementation
    public function get allowSleep():Boolean
    public function set allowSleep(value:Boolean):void
gravityproperty 
gravity:Point


Implementation
    public function get gravity():Point
    public function set gravity(value:Point):void
inverseScaleproperty 
inverseScale:Number  [read-only]


Implementation
    public function get inverseScale():Number
scaleproperty 
scale:Number


Implementation
    public function get scale():Number
    public function set scale(value:Number):void
worldproperty 
world:b2World  [read-only]


Implementation
    public function get world():b2World
worldBoundsproperty 
worldBounds:Rectangle


Implementation
    public function get worldBounds():Rectangle
    public function set worldBounds(value:Rectangle):void
Method Detail
add()method
public function add(bodyDef:b2BodyDef, thisArg:* = null, completedCallback:Function = null):void

Parameters

bodyDef:b2BodyDef
 
thisArg:* (default = null)
 
completedCallback:Function (default = null)

addSpatialObject()method 
public function addSpatialObject(object:ISpatialObject2D):void

Parameters

object:ISpatialObject2D

castRay()method 
public function castRay(start:Point, end:Point, mask:ObjectType, result:RayHitInfo):Boolean

Parameters

start:Point
 
end:Point
 
mask:ObjectType
 
result:RayHitInfo

Returns
Boolean
getObjectsUnderPoint()method 
public function getObjectsUnderPoint(worldPosition:Point, results:Array, mask:ObjectType = null):Boolean

Return all the spatial objects under a given point. Objects can optionally implement pixel-level collision checking.

Parameters

worldPosition:Point — Point in worldspace to check.
 
results:Array — An array into which ISpatialObject2Ds are added based on what is under point.
 
mask:ObjectType (default = null) — Only consider objects that match this ObjectType. Null uses all types.

Returns
Boolean — Found something under point or not.
onAdd()method 
override protected function onAdd():void

onInterpolateTick()method 
public function onInterpolateTick(factor:Number):void

Parameters

factor:Number

onRemove()method 
override protected function onRemove():void

onTick()method 
public function onTick(tickRate:Number):void

Parameters

tickRate:Number

queryCircle()method 
public function queryCircle(center:Point, radius:Number, mask:ObjectType, results:Array):Boolean

Parameters

center:Point
 
radius:Number
 
mask:ObjectType
 
results:Array

Returns
Boolean
queryRectangle()method 
public function queryRectangle(box:Rectangle, mask:ObjectType, results:Array):Boolean

Parameters

box:Rectangle
 
mask:ObjectType
 
results:Array

Returns
Boolean
remove()method 
public function remove(body:b2Body):void

Parameters

body:b2Body

removeSpatialObject()method 
public function removeSpatialObject(object:ISpatialObject2D):void

Parameters

object:ISpatialObject2D

setDebugDrawer()method 
public function setDebugDrawer(drawer:b2DebugDraw):void

Parameters

drawer:b2DebugDraw




ZaaBuild is powered by ZaaLabs, Ltd. -- http://www.zaalabs.com

Tue Dec 28 2010, 08:58 PM Z