# PolygonRayIntersection<T extends ShapeHitbox> mixin

Used to add the rayIntersection method to RectangleHitbox and PolygonHitbox, used by the raytracing and raycasting methods.

Superclass Constraints
Mixin Applications

## Properties

shrinkToBounds bool
finalinherited
manuallyPositioned bool
finalinherited
vertices
no setterinherited
renderShape bool
getter/setter pairinherited
isSolid bool
Whether the shape is solid or hollow.
getter/setter pairinherited
transform
finalinherited
nativeAngle
The angle where this component is looking at when it is in the default state, i.e. when angle is equal to zero. For example, a nativeAngle of 0 implies up/north direction pi/2 implies right/east direction pi implies down/south direction -pi/2 implies left/west direction
getter/setter pairinherited
decorator
The decorator is used to apply visual effects to a component.
getter/setter pairinherited
transformMatrix
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
position
The position of this component's anchor on the screen.
getter/setter pairinherited
x
X position of this component's anchor on the screen.
getter/setter pairinherited
y
Y position of this component's anchor on the screen.
getter/setter pairinherited
angle
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
scale
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
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
size
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
width
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
height
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
scaledSize
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
absoluteScaledSize
The resulting size after all the ancestors and the components own scale has been applied.
no setterinherited
absoluteAngle
The resulting angle after all the ancestors and the components own angle has been applied.
no setterinherited
absoluteScale
The resulting scale after all the ancestors and the components own scale has been applied.
no setterinherited
topLeftPosition
The top-left corner's position in the parent's coordinates.
getter/setter pairinherited
center
The position of the center of the component's bounding rectangle in the parent's coordinates.
getter/setter pairinherited
absolutePosition
The anchor's position in absolute (world) coordinates.
no setterinherited
absoluteTopLeftPosition
The absolute top left position regardless of whether it is a child or not.
no setterinherited
absoluteCenter
The absolute center of the component.
no setterinherited
isFlippedHorizontally bool
Whether it is currently flipped horizontally.
no setterinherited
isFlippedVertically bool
Whether it is currently flipped vertically.
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
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.
getter/setter pairinherited
debugColor
The color that the debug output should be rendered with.
getter/setter pairinherited
Whether the component is currently executing its onLoad step.
no setterinherited
Whether this component has completed its onLoad step.
no setterinherited
isMounting bool
no setterinherited
isMounted bool
Whether this component is currently added to a component tree.
no setterinherited
isRemoving bool
Whether the component is scheduled to be removed.
no setterinherited
isRemoved bool
Whether the component has been removed. Originally this flag is `false`, but it becomes `true` after the component was mounted and then removed from its parent. The flag becomes `false` again when the component is mounted to a new parent.
no setterinherited
no setterinherited
mounted Future<void>
A future that will complete once the component is mounted on its parent.
no setterinherited
removed Future<void>
A future that completes when this component is removed from its parent.
no setterinherited
parent
Who owns this component in the component tree.
getter/setter pairinherited
children
The children components of this component.
no setterinherited
hasChildren bool
no setterinherited
priority int
Render priority of this component. This allows you to control the order in which your components are rendered.
getter/setter pairinherited
debugPaint
The debugColor represented as a Paint object.
no setterinherited
debugTextPaint
Returns a TextPaint object with the debugColor set as color for the text.
no setterinherited
hashCode int
The hash code for this object.
no setterinherited
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
paint
getter/setter pairinherited
paintLayersInternal List<Paint>?
getter/setter pairinherited
paintLayers List<Paint>
List of paints to use (in order) during render.
getter/setter pairinherited
hasPaintLayers bool
Whether there are any paint layers defined for the component.
no setterinherited
opacity
getter/setter pairinherited

## Methods

absolutePositionOf(Vector2 point)
Convert local coordinates of a point `point` inside the component into the global (world) coordinate space.
inherited
absolutePositionOfAnchor(Anchor anchor)
Similar to absolutePositionOf(), but applies to any anchor point within the component.
inherited
absoluteToLocal(Vector2 point)
Transform `point` from the global (world) coordinate space into the local coordinates. This function is the inverse of absolutePositionOf().
inherited
Schedules `component` to be added as a child to this component.
inherited
A convenience method to add multiple children at once.
inherited
Adds this component as a child of `parent` (see add for details).
inherited
ancestors({bool includeSelf = false})
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
angleTo(Vector2 target)
Returns the angle formed by component's orientation vector and a vector starting at component's absolute position and ending at `target`. This angle is measured in clockwise direction. `target` should be in absolute/world coordinate system.
inherited
componentsAtPoint(Vector2 point, [List<Vector2>? nestedPoints])
An iterable of descendant components intersecting the given point. The `point` is in the local coordinate space.
inherited
contains() bool
Whether the children list contains the given component.
inherited
containsLocalPoint(Vector2 point) bool
Test whether the `point` (given in local 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
containsPoint(Vector2 point) bool
Checks whether the polygon contains the `point`. Note: The polygon needs to be convex for this to work.
inherited
createComponentSet()
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})
Recursively enumerates all nested children.
inherited
distance(PositionComponent other)
Measure the distance (in parent's coordinate space) between this component's anchor and the `other` component's anchor.
inherited
findGame() FlameGame<World>?
Fetches the nearest FlameGame ancestor to the component.
inherited
findParent<T extends Component>({bool includeSelf = false}) → T?
Returns the closest parent further up the hierarchy that satisfies type=T, or null if no such parent can be found.
inherited
findRootGame() FlameGame<World>?
Fetches the root FlameGame ancestor to the component.
inherited
firstChild<T extends Component>() → T?
Returns the first child that matches the given type `T`, or null if there are no such children.
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({ paintId}) int
Returns the current opacity.
inherited
getEdge(int i, {required vertices})
inherited
getOpacity({ paintId})
Returns the current opacity.
inherited
getPaint([ paintId])
Gets a paint from the collection.
inherited
getVertex(int i, {List<Vector2>? vertices})
inherited
globalVertices() List<Vector2>
gives back the shape vectors multiplied by the size and scale
inherited
inherited
handleLifecycleEventMove(Component newParent) → LifecycleEventStatus
inherited
handleLifecycleEventRemove(Component parent) → LifecycleEventStatus
inherited
handleResize(Vector2 size) → void
inherited
lastChild<T extends Component>() → T?
Returns the last child that matches the given type `T`, or null if there are no such children.
inherited
localToParent(Vector2 point)
inherited
lookAt(Vector2 target) → void
Rotates/snaps the component to look at the `target`.
inherited
makeOpaque({ paintId}) → void
Manipulate the paint to make it fully opaque.
inherited
makeTransparent({ 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
onChildrenChanged(Component child, ) → void
This method will be invoked from lifecycle if `child` has been added to or removed from its parent children list.
inherited
onGameResize(Vector2 size) → void
Called whenever the size of the top-level Canvas changes.
inherited
Late initialization method for Component.
inherited
onMount() → void
Called when the component is added to its parent.
inherited
onParentResize(Vector2 maxSize) → void
Called whenever the parent of this component changes size; and also once before onMount.
inherited
onRemove() → void
Called right before the component is removed from the game.
inherited
opacityProviderOf(Object paintId)
Creates an OpacityProvider for given `paintId` and can be used as `target` for OpacityEffect.
inherited
opacityProviderOfList({List<>? paintIds, bool includeLayers = true})
Creates an OpacityProvider for given list of `paintIds` and can be used as `target` for OpacityEffect.
inherited
parentToLocal(Vector2 point)
inherited
positionOf(Vector2 point)
Convert local coordinates of a point `point` inside the component into the parent's coordinate space.
inherited
positionOfAnchor(Anchor anchor)
Similar to positionOf(), but applies to any anchor point within the component.
inherited
possibleIntersectionVertices(Rect? rect)
Return all vertices as `LineSegment`s that intersect `rect`, if `rect` is null return all vertices as `LineSegment`s.
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
rayIntersection(Ray2 ray, { out})
Returns whether the RaycastResult if the `ray` intersects the polygon.
refreshVertices({required newVertices, bool? shrinkToBoundsOverride}) → void
inherited
remove(Component component) → void
Removes a component from the component tree.
inherited
removeAll( 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
removeWhere(bool test(Component component)) → void
Removes all the children for which the `test` function returns true.
inherited
render(Canvas canvas) → void
inherited
renderDebugMode(Canvas canvas) → void
inherited
renderTree(Canvas canvas) → void
inherited
setAlpha(int alpha, { 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, { paintId}) → void
Shortcut for changing the color of the paint.
inherited
setMounted() → void
inherited
setOpacity(double opacity, { 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, { 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)
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()
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.
inherited
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

## Operators

operator ==(Object other) bool
The equality operator.
inherited