| Package | com.pblabs.rendering2D |
| Class | public class DisplayObjectRenderer |
| Inheritance | DisplayObjectRenderer  AnimatedComponent EntityComponent Object |
| Subclasses | BitmapRenderer, Box2DDebugComponent, MovieClipRenderer, SimpleShapeRenderer |
The various other renderers inherit from DisplayObjectRenderer, and rely on it for basic functionality.
Normally, the DisplayObjectRenderer tries to update itself every frame. However, you can suppress this by setting registerForUpdates to false, in which case you will have to call onFrame()/updateTransform() manually if you change something.
See also
| Property | Defined By | ||
|---|---|---|---|
| alpha : Number
Transparency, 0 being completely transparent and 1 being opaque. | DisplayObjectRenderer | ||
| alphaProperty : PropertyReference
If set, alpha is gotten from this property every frame. | DisplayObjectRenderer | ||
| blendMode : String
Blend mode, using strings from flash.display.BlendMode
| DisplayObjectRenderer | ||
| blendModeProperty : PropertyReference
If set, blend mode is gotten from this property every frame. | DisplayObjectRenderer | ||
| displayObject : DisplayObject
The displayObject which this DisplayObjectRenderer will draw. | DisplayObjectRenderer | ||
 | isRegistered : Boolean [read-only]
Whether or not the component is currently registered with an entity. | EntityComponent | |
| layerIndex : int
In what layer of the scene is this renderer drawn?
| DisplayObjectRenderer | ||
| layerIndexProperty : PropertyReference
If set, the layer index is gotten from this property every frame. | DisplayObjectRenderer | ||
| localBounds : Rectangle [read-only]
| DisplayObjectRenderer | ||
| name : String [read-only]
The name given to the component when it is added to an entity. | EntityComponent | |
| objectMask : ObjectType
The types for this object; used for picking queries primarily. | DisplayObjectRenderer | ||
| owner : IEntity
A reference to the entity that this component currently belongs to. | EntityComponent | |
| position : Point
Position of the renderer in scene space. | DisplayObjectRenderer | ||
| positionOffset : Point
Sets a position offset that will offset the sprite. | DisplayObjectRenderer | ||
| positionProperty : PropertyReference
If set, position is gotten from this property every frame. | DisplayObjectRenderer | ||
| registerForUpdates : Boolean
Set to register/unregister for frame updates. | AnimatedComponent | |
| registrationPoint : Point
The registration point can be used to offset the sprite
so that rotation and scaling work properly. | DisplayObjectRenderer | ||
| registrationPointProperty : PropertyReference
If set, our registration point is gotten from this property every frame. | DisplayObjectRenderer | ||
| renderKey : int = 0
Reference value used for sorting in some scenes. | DisplayObjectRenderer | ||
| renderPosition : Point [read-only]
Where in the scene will this object be rendered?
| DisplayObjectRenderer | ||
| rotation : Number
Rotation in degrees, with 0 being Y+. | DisplayObjectRenderer | ||
| rotationOffset : Number
Rotation offset applied to the child DisplayObject. | DisplayObjectRenderer | ||
| rotationProperty : PropertyReference
If set, rotation is gotten from this property every frame. | DisplayObjectRenderer | ||
| scale : Point
You can scale things on the X and Y axes. | DisplayObjectRenderer | ||
| scaleProperty : PropertyReference
If set, scale is gotten from this property every frame. | DisplayObjectRenderer | ||
| scene : IScene2D
The scene which is responsible for drawing this renderer. | DisplayObjectRenderer | ||
| sceneBounds : Rectangle [read-only]
Our bounds in scene coordinates. | DisplayObjectRenderer | ||
| size : Point
Explicitly set the size. | DisplayObjectRenderer | ||
| sizeProperty : PropertyReference
If set, size is determined by this property every frame. | DisplayObjectRenderer | ||
| snapToNearestPixels : Boolean = true
if set this to false, positions will be handeled with numbers insteed of integers
makes slow movement smoother for example
| DisplayObjectRenderer | ||
| updatePriority : Number = 0.0
The update priority for this component. | AnimatedComponent | |
| worldPosition : Point
Convenience method to allow placing the renderer in world coordinates. | DisplayObjectRenderer | ||
| x : Number
The x value of our scene space position. | DisplayObjectRenderer | ||
| y : Number
The y component of our scene space position. | DisplayObjectRenderer | ||
| zIndex : int
By default, layers are sorted based on the z-index, from small
to large. | DisplayObjectRenderer | ||
| zIndexProperty : PropertyReference
If set, our z-index is gotten from this property every frame. | DisplayObjectRenderer | ||
| Property | Defined By | ||
|---|---|---|---|
| _alpha : Number = 1 | DisplayObjectRenderer | ||
| _blendMode : String = normal | DisplayObjectRenderer | ||
| _displayObject : DisplayObject | DisplayObjectRenderer | ||
| _hitTestDirty : Boolean = true | DisplayObjectRenderer | ||
| _inScene : Boolean = false | DisplayObjectRenderer | ||
| _lastLayerIndex : int = -1 | DisplayObjectRenderer | ||
| _layerIndex : int = 0 | DisplayObjectRenderer | ||
| _layerIndexDirty : Boolean = true | DisplayObjectRenderer | ||
| _position : Point | DisplayObjectRenderer | ||
| _positionOffset : Point | DisplayObjectRenderer | ||
| _registrationPoint : Point | DisplayObjectRenderer | ||
| _rotation : Number = 0 | DisplayObjectRenderer | ||
| _rotationOffset : Number = 0 | DisplayObjectRenderer | ||
| _scale : Point | DisplayObjectRenderer | ||
| _scene : IScene2D | DisplayObjectRenderer | ||
| _size : Point | DisplayObjectRenderer | ||
| _transformDirty : Boolean = true | DisplayObjectRenderer | ||
| _transformMatrix : Matrix | DisplayObjectRenderer | ||
| _zIndex : int = 0 | DisplayObjectRenderer | ||
| _zIndexDirty : Boolean = true | DisplayObjectRenderer | ||
| Method | Defined By | ||
|---|---|---|---|
| DisplayObjectRenderer | |||
onFrame(elapsed:Number):void [override] | DisplayObjectRenderer | ||
pointOccupied(worldPosition:Point, mask:ObjectType):Boolean
Is the rendered object opaque at the request position in screen space?
| DisplayObjectRenderer | ||
|
Registers the component with an entity. | EntityComponent | |
| reset():void
This is called by an entity on all of its components any time a component
is added or removed. | EntityComponent | |
transformObjectToWorld(p:Point):Point
Transform a point from object space to world space. | DisplayObjectRenderer | ||
transformWorldToObject(p:Point):Point
Transform a point from world space to object space. | DisplayObjectRenderer | ||
| unregister():void
Unregisters the component from an entity. | EntityComponent | |
updateTransform(updateProps:Boolean = false):void
Update the object's transform based on its current state. | DisplayObjectRenderer | ||
| Method | Defined By | ||
|---|---|---|---|
addToScene():void | DisplayObjectRenderer | ||
onAdd():void [override] | DisplayObjectRenderer | ||
onRemove():void [override] | DisplayObjectRenderer | ||
| onReset():void
This is called anytime a component is added or removed from the owner entity. | EntityComponent | |
removeFromScene():void | DisplayObjectRenderer | ||
updateProperties():void | DisplayObjectRenderer | ||
| _alpha | property |
Hide Inherited Public Properties
Show Inherited Public Propertiesprotected var _alpha:Number = 1| _blendMode | property |
protected var _blendMode:String = normal| _displayObject | property |
protected var _displayObject:DisplayObject| _hitTestDirty | property |
protected var _hitTestDirty:Boolean = true| _inScene | property |
protected var _inScene:Boolean = false| _lastLayerIndex | property |
protected var _lastLayerIndex:int = -1| _layerIndex | property |
protected var _layerIndex:int = 0| _layerIndexDirty | property |
protected var _layerIndexDirty:Boolean = true| _position | property |
protected var _position:Point| _positionOffset | property |
protected var _positionOffset:Point| _registrationPoint | property |
protected var _registrationPoint:Point| _rotation | property |
protected var _rotation:Number = 0| _rotationOffset | property |
protected var _rotationOffset:Number = 0| _scale | property |
protected var _scale:Point| _scene | property |
protected var _scene:IScene2D| _size | property |
protected var _size:Point| _transformDirty | property |
protected var _transformDirty:Boolean = true| _transformMatrix | property |
protected var _transformMatrix:Matrix| _zIndex | property |
protected var _zIndex:int = 0| _zIndexDirty | property |
protected var _zIndexDirty:Boolean = true| alpha | property |
alpha:NumberTransparency, 0 being completely transparent and 1 being opaque.
public function get alpha():Number public function set alpha(value:Number):void| alphaProperty | property |
public var alphaProperty:PropertyReferenceIf set, alpha is gotten from this property every frame.
| blendMode | property |
blendMode:StringBlend mode, using strings from flash.display.BlendMode
public function get blendMode():String public function set blendMode(value:String):voidSee also
| blendModeProperty | property |
public var blendModeProperty:PropertyReferenceIf set, blend mode is gotten from this property every frame.
| displayObject | property |
displayObject:DisplayObjectThe displayObject which this DisplayObjectRenderer will draw.
public function get displayObject():DisplayObject public function set displayObject(value:DisplayObject):void| layerIndex | property |
layerIndex:intIn what layer of the scene is this renderer drawn?
public function get layerIndex():int public function set layerIndex(value:int):void| layerIndexProperty | property |
public var layerIndexProperty:PropertyReferenceIf set, the layer index is gotten from this property every frame.
| localBounds | property |
localBounds:Rectangle [read-only]
public function get localBounds():Rectangle| objectMask | property |
public var objectMask:ObjectTypeThe types for this object; used for picking queries primarily.
| position | property |
position:PointPosition of the renderer in scene space.
public function get position():Point public function set position(value:Point):voidSee also
| positionOffset | property |
positionOffset:PointSets a position offset that will offset the sprite. Please note: This is unaffected by rotation.
public function get positionOffset():Point public function set positionOffset(value:Point):void| positionProperty | property |
public var positionProperty:PropertyReferenceIf set, position is gotten from this property every frame.
| registrationPoint | property |
registrationPoint:PointThe registration point can be used to offset the sprite so that rotation and scaling work properly.
public function get registrationPoint():Point public function set registrationPoint(value:Point):void| registrationPointProperty | property |
public var registrationPointProperty:PropertyReferenceIf set, our registration point is gotten from this property every frame.
Note that some subclasses override this; for instance, the SpriteSheetRenderer always uses the registrationPoint from the sprite sheet it is rendering.
| renderKey | property |
public var renderKey:int = 0Reference value used for sorting in some scenes.
| renderPosition | property |
renderPosition:Point [read-only] Where in the scene will this object be rendered?
public function get renderPosition():Point| rotation | property |
rotation:NumberRotation in degrees, with 0 being Y+.
public function get rotation():Number public function set rotation(value:Number):void| rotationOffset | property |
rotationOffset:NumberRotation offset applied to the child DisplayObject. Used if, for instance, your art is rotated 90deg off from where you want it.
public function get rotationOffset():Number public function set rotationOffset(value:Number):void| rotationProperty | property |
public var rotationProperty:PropertyReferenceIf set, rotation is gotten from this property every frame.
| scale | property |
scale:PointYou can scale things on the X and Y axes.
public function get scale():Point public function set scale(value:Point):void| scaleProperty | property |
public var scaleProperty:PropertyReferenceIf set, scale is gotten from this property every frame.
| scene | property |
scene:IScene2DThe scene which is responsible for drawing this renderer. Note that you can use the renderer outside of a scene, to control some DisplayObject, by setting displayObject to point to what you want to control, and setting scene to null.
public function get scene():IScene2D public function set scene(value:IScene2D):void| sceneBounds | property |
sceneBounds:Rectangle [read-only] Our bounds in scene coordinates.
public function get sceneBounds():Rectangle| size | property |
size:PointExplicitly set the size. This overrides scale if it is set.
public function get size():Point public function set size(value:Point):void| sizeProperty | property |
public var sizeProperty:PropertyReferenceIf set, size is determined by this property every frame.
| snapToNearestPixels | property |
public var snapToNearestPixels:Boolean = trueif set this to false, positions will be handeled with numbers insteed of integers makes slow movement smoother for example
| worldPosition | property |
worldPosition:PointConvenience method to allow placing the renderer in world coordinates.
public function get worldPosition():Point public function set worldPosition(value:Point):void| x | property |
x:NumberThe x value of our scene space position.
public function get x():Number public function set x(value:Number):void| y | property |
y:NumberThe y component of our scene space position. Used for sorting.
public function get y():Number public function set y(value:Number):void| zIndex | property |
zIndex:intBy default, layers are sorted based on the z-index, from small to large.
public function get zIndex():int public function set zIndex(value:int):void| zIndexProperty | property |
public var zIndexProperty:PropertyReferenceIf set, our z-index is gotten from this property every frame.
| DisplayObjectRenderer | () | Constructor |
public function DisplayObjectRenderer()| addToScene | () | method |
protected function addToScene():void| onAdd | () | method |
override protected function onAdd():void| onFrame | () | method |
override public function onFrame(elapsed:Number):voidParameters
elapsed:Number |
| onRemove | () | method |
override protected function onRemove():void| pointOccupied | () | method |
public function pointOccupied(worldPosition:Point, mask:ObjectType):BooleanIs the rendered object opaque at the request position in screen space?
Parameters
worldPosition:Point — Location in world space we are curious about.
| |
mask:ObjectType |
Boolean — True if object is opaque there.
|
| removeFromScene | () | method |
protected function removeFromScene():void| transformObjectToWorld | () | method |
public function transformObjectToWorld(p:Point):PointTransform a point from object space to world space.
Parameters
p:Point |
Point |
| transformWorldToObject | () | method |
public function transformWorldToObject(p:Point):PointTransform a point from world space to object space.
Parameters
p:Point |
Point |
| updateProperties | () | method |
protected function updateProperties():void| updateTransform | () | method |
public function updateTransform(updateProps:Boolean = false):voidUpdate the object's transform based on its current state. Normally called automatically, but in some cases you might have to force it to update immediately.
Parameters
updateProps:Boolean (default = false) |