SpriteAnimationGroupComponent<T> class
- Inheritance
-
- Mixed-in types
-
- Available extensions
Constructors
-
SpriteAnimationGroupComponent({Map<T, SpriteAnimation>? animations, T? current, Map<T, bool>? removeOnFinish, Paint? paint, Vector2? position, Vector2? size, Vector2? scale, double? angle, Anchor? anchor, int? priority})
-
Creates a component with an empty animation which can be set later
-
SpriteAnimationGroupComponent.fromFrameData(Image image, Map<T, SpriteAnimationData> data, {T? current, Map<T, bool>? removeOnFinish, Paint? paint, Vector2? position, Vector2? size, Vector2? scale, double? angle, Anchor? anchor, int? priority})
-
Creates a SpriteAnimationGroupComponent from a
size, an image and
data.
Check SpriteAnimationData for more info on the available options.
Properties
-
absoluteAngle
→ double
-
The resulting angle after all the ancestors and the components own angle
has been applied.
no setterinherited
-
absoluteCenter
→ Vector2
-
The absolute center of the component.
no setterinherited
-
absolutePosition
→ Vector2
-
The anchor's position in absolute (world) coordinates.
no setterinherited
-
absoluteScale
→ Vector2
-
The resulting scale after all the ancestors and the components own scale
has been applied.
no setterinherited
-
absoluteScaledSize
→ Vector2
-
The resulting size after all the ancestors and the components own scale
has been applied.
no setterinherited
-
absoluteTopLeftPosition
→ Vector2
-
The absolute top left position regardless of whether it is a child or not.
no setterinherited
-
anchor
↔ Anchor
-
Anchor point for this component. An anchor point describes a point
within the rectangle of size size. This point is considered to
be the logical "center" of the component. This can be visualized
as the point where Flame "grabs" the component. All transforms
occur around this point: the position is where the anchor point
will end up after the component is translated; the rotation and
scaling also happen around this anchor point.
getter/setter pairinherited
-
angle
↔ double
-
Rotation angle (in radians) of the component. The component will be
rotated around its anchor point in the clockwise direction if the
angle is positive, or counterclockwise if the angle is negative.
getter/setter pairinherited
-
animation
→ SpriteAnimation?
-
no setter
-
animations
↔ Map<T, SpriteAnimation>?
-
Map with the available states for this animation group
getter/setter pair
-
center
↔ Vector2
-
The position of the center of the component's bounding rectangle
in the parent's coordinates.
getter/setter pairinherited
-
children
→ ComponentSet
-
The children of the current component.
no setterinherited
-
current
↔ T?
-
Key with the current playing animation
getter/setter pair
-
debugColor
↔ Color
-
The color that the debug output should be rendered with.
getter/setter pairinherited
-
debugCoordinatesPrecision
→ int?
-
How many decimal digits to print when displaying coordinates in the
debug mode. Setting this to null will suppress all coordinates from
the output.
no setterinherited
-
debugMode
↔ bool
-
Returns whether this Component is in debug mode or not.
When a child is added to the Component it gets the same debugMode as
its parent has when it is prepared.
getter/setter pairinherited
-
debugPaint
→ Paint
-
The debugColor represented as a Paint object.
no setterinherited
-
debugTextPaint
→ TextPaint
-
Returns a TextPaint object with the debugColor set as color for the
text.
no setterinherited
-
hasChildren
→ bool
-
no setterinherited
-
hashCode
→ int
-
The hash code for this object.
no setterinherited
-
hasPendingLifecycleEvents
→ bool
-
no setterinherited
-
height
↔ double
-
The height of the component in local coordinates. Note that the object
may visually appear larger or smaller due to application of scale.
getter/setter pairinherited
-
isLoaded
→ bool
-
Whether this component has completed its onLoad step.
no setterinherited
-
isMounted
→ bool
-
Whether this component is currently added to a component tree.
no setterinherited
-
lifecycle
→ _LifecycleManager
-
no setterinherited
-
loaded
→ Future<void>
-
A future that will complete once this component has finished loading.
no setterinherited
-
mounted
→ Future<void>
-
A future that will complete once the component is mounted on its parent
no setterinherited
-
paint
↔ Paint
-
getter/setter pairinherited
-
parent
→ Component?
-
The current parent of the component, or null if there is none.
no setterinherited
-
position
↔ NotifyingVector2
-
The position of this component's anchor on the screen.
getter/setter pairinherited
-
positionType
↔ PositionType
-
What coordinate system this component should respect (i.e. should it
observe camera, viewport, or use the raw canvas).
getter/setter pairinherited
-
priority
↔ int
-
Render priority of this component. This allows you to control the order in
which your components are rendered.
getter/setter pairinherited
-
removeOnFinish
→ Map<T, bool>
-
Map with the mapping each state to the flag removeOnFinish
final
-
runtimeType
→ Type
-
A representation of the runtime type of the object.
no setterinherited
-
scale
↔ NotifyingVector2
-
The scale factor of this component. The scale can be different along
the X and Y dimensions. A scale greater than 1 makes the component
bigger, and less than 1 smaller. The scale can also be negative,
which results in a mirror reflection along the corresponding axis.
getter/setter pairinherited
-
scaledSize
→ Vector2
-
The "physical" size of the component. This is the size of the
component as seen from the parent's perspective, and it is equal to
size * scale. This is a computed property and cannot be
modified by the user.
no setterinherited
-
shouldRemove
↔ bool
-
Whether this component should be removed or not.
getter/setter pairinherited
-
size
↔ NotifyingVector2
-
The logical size of the component. The game assumes that this is the
approximate size of the object that will be drawn on the screen.
This size will therefore be used for collision detection and tap
handling.
getter/setter pairinherited
-
topLeftPosition
↔ Vector2
-
The top-left corner's position in the parent's coordinates.
getter/setter pairinherited
-
transform
→ Transform2D
-
finalinherited
-
transformMatrix
→ Matrix4
-
The total transformation matrix for the component. This matrix combines
translation, rotation and scale transforms into a single entity. The
matrix is cached and gets recalculated only as necessary.
no setterinherited
-
width
↔ double
-
The width of the component in local coordinates. Note that the object
may visually appear larger or smaller due to application of scale.
getter/setter pairinherited
-
x
↔ double
-
X position of this component's anchor on the screen.
getter/setter pairinherited
-
y
↔ double
-
Y position of this component's anchor on the screen.
getter/setter pairinherited
Methods
-
absolutePositionOf(Vector2 point)
→ Vector2
-
Convert local coordinates of a point
point inside the component
into the global (world) coordinate space.
inherited
-
absolutePositionOfAnchor(Anchor anchor)
→ Vector2
-
Similar to absolutePositionOf(), but applies to any anchor
point within the component.
inherited
-
absoluteToLocal(Vector2 point)
→ Vector2
-
Transform
point from the global (world) coordinate space into the
local coordinates. This function is the inverse of
absolutePositionOf().
inherited
-
add(Component component)
→ Future<void>?
-
Schedules
component to be added as a child to this component.
inherited
-
addAll(Iterable<Component> components)
→ Future<void>
-
A convenience method to add multiple children at once.
inherited
-
addToParent(Component parent)
→ Future<void>?
-
Adds this component to the provided
parent (see add for details).
inherited
-
ancestors({bool includeSelf = false})
→ Iterable<Component>
-
An iterator producing this component's parent, then its parent's parent,
then the great-grand-parent, and so on, until it reaches a component
without a parent.
inherited
-
changeParent(Component newParent)
→ void
-
Changes the current parent for another parent and prepares the tree under
the new root.
inherited
-
changePriorityWithoutResorting(int priority)
→ void
-
Usually this is not something that the user would want to call since the
component list isn't re-ordered when it is called.
See FlameGame.changePriority instead.
inherited
-
contains(Component c)
→ bool
-
Whether the children list contains the given component.
inherited
-
containsPoint(Vector2 point)
→ bool
-
Test whether the
point (given in global coordinates) lies within this
component. The top and the left borders of the component are inclusive,
while the bottom and the right borders are exclusive.
inherited
-
createComponentSet()
→ ComponentSet
-
This method creates the children container for the current component.
Override this method if you need to have a custom ComponentSet within
a particular class.
inherited
-
deletePaint(Object paintId)
→ void
-
Removes a paint from the collection.
inherited
-
descendants({bool includeSelf = false, bool reversed = false})
→ Iterable<Component>
-
Recursively enumerates all nested children.
inherited
-
distance(PositionComponent other)
→ double
-
Measure the distance (in parent's coordinate space) between this
component's anchor and the
other component's anchor.
inherited
-
eventPosition(PositionInfo info)
→ Vector2
-
inherited
-
findGame()
→ Game?
-
inherited
-
findParent<T extends Component>()
→ T?
-
Returns the closest parent further up the hierarchy that satisfies type=T,
or null if no such parent can be found.
inherited
-
firstChild<T extends Component>()
→ T?
-
Returns the first child that matches the given type
T.
inherited
-
flipHorizontally()
→ void
-
Flip the component horizontally around its anchor point.
inherited
-
flipHorizontallyAroundCenter()
→ void
-
Flip the component horizontally around its center line.
inherited
-
flipVertically()
→ void
-
Flip the component vertically around its anchor point.
inherited
-
flipVerticallyAroundCenter()
→ void
-
Flip the component vertically around its center line.
inherited
-
getAlpha({Object? paintId})
→ int
-
Returns the current opacity.
inherited
-
getOpacity({Object? paintId})
→ double
-
Returns the current opacity.
inherited
-
getPaint([Object? paintId])
→ Paint
-
Gets a paint from the collection.
inherited
-
handleResize(Vector2 size)
→ void
-
inherited
-
lastChild<T extends Component>()
→ T?
-
Returns the last child that matches the given type
T.
inherited
-
makeOpaque({Object? paintId})
→ void
-
Manipulate the paint to make it fully opaque.
inherited
-
makeTransparent({Object? paintId})
→ void
-
Manipulate the paint to make it fully transparent.
inherited
-
noSuchMethod(Invocation invocation)
→ dynamic
-
Invoked when a nonexistent method or property is accessed.
inherited
-
onGameResize(Vector2 size)
→ void
-
Called whenever the size of the top-level Canvas changes.
inherited
-
onLoad()
→ Future<void>?
-
Late initialization method for Component.
inherited
-
onMount()
→ void
-
Called when the component is added to its parent.
inherited
-
onRemove()
→ void
-
Called right before the component is removed from the game.
inherited
-
positionOf(Vector2 point)
→ Vector2
-
Convert local coordinates of a point
point inside the component
into the parent's coordinate space.
inherited
-
positionOfAnchor(Anchor anchor)
→ Vector2
-
Similar to positionOf(), but applies to any anchor point within
the component.
inherited
-
processPendingLifecycleEvents()
→ void
-
Attempt to resolve any pending lifecycle events on this component.
inherited
-
propagateToChildren<T extends Component>(bool handler(T), {bool includeSelf = false})
→ bool
-
This method first calls the passed handler on the leaves in the tree,
the children without any children of their own.
Then it continues through all other children. The propagation continues
until the handler returns false, which means "do not continue", or when
the handler has been called with all children.
inherited
-
remove(Component component)
→ void
-
Removes a component from the component tree, calling onRemove for it and
its children.
inherited
-
removeAll(Iterable<Component> components)
→ void
-
Removes all the children in the list and calls onRemove for all of them
and their children.
inherited
-
removeFromParent()
→ void
-
Remove the component from its parent in the next tick.
inherited
-
render(Canvas canvas)
→ void
-
override
-
renderDebugMode(Canvas canvas)
→ void
-
inherited
-
renderTree(Canvas canvas)
→ void
-
inherited
-
reorderChildren()
→ void
-
Call this if any of this component's children priorities have changed
at runtime.
inherited
-
setAlpha(int alpha, {Object? paintId})
→ void
-
Changes the opacity of the paint.
inherited
-
setByRect(Rect rect)
→ void
-
Mutates position and size using the provided
rect as basis.
This is a relative rect, same definition that toRect use
(therefore both methods are compatible,
i.e. setByRect ∘ toRect = identity).
inherited
-
setColor(Color color, {Object? paintId})
→ void
-
Shortcut for changing the color of the paint.
inherited
-
setMounted()
→ void
-
inherited
-
setOpacity(double opacity, {Object? paintId})
→ void
-
Changes the opacity of the paint.
inherited
-
setPaint(Object paintId, Paint paint)
→ void
-
Sets a paint on the collection.
inherited
-
tint(Color color, {Object? paintId})
→ void
-
Applies a color filter to the paint which will make
things rendered with the paint looking like it was
tinted with the given color.
inherited
-
toAbsoluteRect()
→ Rect
-
The bounding rectangle of the component in global coordinate space.
inherited
-
toLocal(Vector2 point)
→ Vector2
-
Transform
point from the parent's coordinate space into the local
coordinates. This function is the inverse of positionOf().
inherited
-
toRect()
→ Rect
-
Returns the bounding rectangle for this component.
inherited
-
toString()
→ String
-
A string representation of this object.
inherited
-
update(double dt)
→ void
-
This method is called periodically by the game engine to request that your
component updates itself.
override
-
updateTree(double dt)
→ void
-
This method traverses the component tree and calls update on all its
children according to their priority order, relative to the
priority of the direct siblings, not the children or the ancestors.
inherited
