The SpriteComponent class is a component for use in building a GameEntity. It draws a given SpriteImage (or a single frame from the given SpriteImage).
Works with both Raster and Svg.
| <default> | Takes a cached Raster by reference. (Same as fromRaster() except the frame parameters take a double instead of an int.) |
| fromRaster | Takes a cached Raster by reference. (best practice) |
| fromRasterCache | Takes a cached Raster by filename. |
| fromRasterFile | Takes a raster filename (cached or not). Returns a Future. |
| fromSvg | Takes a cached Svg by reference. (best practice) |
| fromSvgCache | Takes a cached Svg by filename. |
| fromSvgFile | Takes an SVG filename (cached or not). Also takes an optional scale parameter. Returns a Future. |
| debugColor | Color to draw debug-mode information. Default: Color(0xFFFF00FF) magenta. |
| frameHeight * | Read-only. Height of each frame. Default: null, that is, full height of the image. |
| frameLeft * | Read-only. X position of the left edge of the first frame. Default: 0. |
| frameOffset | Read-only. X,Y position of the top/left corner of the first frame. Default: Offset.zero. |
| frameRect | Read-only. Rect of the offset and size of the first frame. Default: Rect.fromLTWH(0, 0, image.width, image.height). |
| frameSize | Read-only. Width and height of each frame. Default: Size(image.width, image.height). |
| frameTop * | Read-only. Y position of the top edge of the first frame. Default: 0. |
| frameWidth * | Read-only. Width of each frame. Default: null, that is, full width of the image. |
| image * | Read-only. Reference to the source SpriteImage object. |
| paint | The Paint to use when drawing the image. |
| pivot * | Pivot point for rotation and anchor point for placement. Default: System.defaultPivot which defaults to Pivot.center. |
* Also is a constructor parameter.
| loaded | Returns whether the image has loaded yet or not. |
| render | Draws the image (or frame from the image), translated by the set Pivot, with the given or set Paint. To execute, call from a GameEnity.update(). |
See the spritesheet example app.
See the svg example app.
See the main example app.
SpriteComponent can also be used as a widget. See the PogoWidget class.