| Package | PBLabs.Rendering2D |
| Class | public class BaseRenderComponent |
| Inheritance | BaseRenderComponent  EntityComponent |
| Implements | IDrawable2D |
| Subclasses | Box2DDebugComponent, SimpleShapeRenderComponent, SpriteRenderComponent, SWFRenderComponent |
| Property | Defined by | ||
|---|---|---|---|
 | IsRegistered : Boolean
Whether or not the component is currently registered with an entity.
| EntityComponent | |
| LayerIndex : int
Objects are sorted by layer, and this is the index of this object's layer.
| BaseRenderComponent | ||
| Name : String
The name given to the component when it is added to an entity.
| EntityComponent | |
| Owner : IEntity
A reference to the entity that this component currently belongs to.
| EntityComponent | |
| PositionOffset : Point
An offset to apply to the position retrieved from the PositionReference.
| BaseRenderComponent | ||
| PositionReference : PropertyReference
A reference for the position property on the owner entity.
| BaseRenderComponent | ||
| RenderCacheKey : int | BaseRenderComponent | ||
| RenderPosition : Point [read-only]
Report the center position of this object as used for rendering.
| BaseRenderComponent | ||
| RenderScale : Point [read-only]
| BaseRenderComponent | ||
| RenderSortKey : int
Expose a sort key.
| BaseRenderComponent | ||
| RotationReference : PropertyReference
A reference for the rotation property on the owner entity.
| BaseRenderComponent | ||
| SizeReference : PropertyReference
A reference for the size property on the owner entity.
| BaseRenderComponent | ||
| Method | Defined by | ||
|---|---|---|---|
|
InvalidateRenderCache():void
| BaseRenderComponent | ||
|
OnDraw(manager:IDrawManager2D):void
Callback during rendering to give the object an opportunity to give the
IDrawManager2D stuff to display.
| BaseRenderComponent | ||
|
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 | |
|
Unregister():void
Unregisters the component from an entity.
| EntityComponent | |
| LayerIndex | property |
Hide Inherited Public Properties
Show Inherited Public PropertiesLayerIndex:int [read-write]Objects are sorted by layer, and this is the index of this object's layer.
Implementation public function get LayerIndex():int
public function set LayerIndex(value:int):void
| PositionOffset | property |
public var PositionOffset:PointAn offset to apply to the position retrieved from the PositionReference.
| PositionReference | property |
public var PositionReference:PropertyReferenceA reference for the position property on the owner entity. This should be a point.
| RenderCacheKey | property |
RenderCacheKey:int [read-write]Implementation
public function get RenderCacheKey():int
public function set RenderCacheKey(value:int):void
| RenderPosition | property |
RenderPosition:Point [read-only]Report the center position of this object as used for rendering.
Implementation public function get RenderPosition():Point
| RenderScale | property |
RenderScale:Point [read-only]Implementation
public function get RenderScale():Point
| RenderSortKey | property |
RenderSortKey:int [read-write]Expose a sort key. This integer is used for general sorting logic.
Implementation public function get RenderSortKey():int
public function set RenderSortKey(value:int):void
| RotationReference | property |
public var RotationReference:PropertyReferenceA reference for the rotation property on the owner entity. This should be a Number.
| SizeReference | property |
public var SizeReference:PropertyReferenceA reference for the size property on the owner entity. This should be a point.
| InvalidateRenderCache | () | method |
public function InvalidateRenderCache():void
| OnDraw | () | method |
public function OnDraw(manager:IDrawManager2D):voidCallback during rendering to give the object an opportunity to give the IDrawManager2D stuff to display.
Parametersmanager:IDrawManager2D |