| Package | com.pblabs.rendering2D |
| Class | public class SpriteSheetRenderer |
| Inheritance | SpriteSheetRenderer  BitmapRenderer DisplayObjectRenderer AnimatedComponent EntityComponent Object |
| 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 | |
| bitmapData : BitmapData | BitmapRenderer | |
| 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 | |
| directionReference : PropertyReference | SpriteSheetRenderer | ||
| displayObject : DisplayObject [override] | BitmapRenderer | |
| 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 | |
| modifiers : Array
Array with BitmapData modifiers that will be applied
| BitmapRenderer | |
| mouseEnabled : Boolean | BitmapRenderer | |
| 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 | |
| smoothing : Boolean | BitmapRenderer | |
| snapToNearestPixels : Boolean = true
if set this to false, positions will be handeled with numbers insteed of integers
makes slow movement smoother for example
| DisplayObjectRenderer | |
| spriteIndex : int = 0 | SpriteSheetRenderer | ||
| spriteSheet : SpriteContainerComponent | SpriteSheetRenderer | ||
| 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 | |
| Method | Defined By | ||
|---|---|---|---|
| drawPixels(objectToScreen:Matrix, renderTarget:BitmapData):void | BitmapRenderer | |
| isPixelPathActive(objectToScreen:Matrix):Boolean | BitmapRenderer | |
onFrame(elapsed:Number):void [override] | SpriteSheetRenderer | ||
| pointOccupied(worldPosition:Point, mask:ObjectType):Boolean [override] | BitmapRenderer | |
|
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 | |
dataModified():void [override] | SpriteSheetRenderer | ||
getCurrentFrame():BitmapData | SpriteSheetRenderer | ||
modify(data:BitmapData):BitmapData [override] | SpriteSheetRenderer | ||
| 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 | |
| directionReference | property |
Hide Inherited Public Properties
Show Inherited Public Propertiespublic var directionReference:PropertyReference| spriteIndex | property |
public var spriteIndex:int = 0| spriteSheet | property |
public var spriteSheet:SpriteContainerComponent| dataModified | () | method |
override protected function dataModified():void| getCurrentFrame | () | method |
protected function getCurrentFrame():BitmapDataReturnsBitmapData |
| modify | () | method |
override protected function modify(data:BitmapData):BitmapDataParameters
data:BitmapData |
BitmapData |
| onFrame | () | method |
override public function onFrame(elapsed:Number):voidParameters
elapsed:Number |