ChildVicinity class

The relative position of a child in a TwoDimensionalViewport in relation to other children of the viewport.

While children can be plotted arbitrarily in two dimensional space, the ChildVicinity is used to disambiguate their positions, determining how to traverse the children of the space.

Combined with the RenderTwoDimensionalViewport.mainAxis, each child's vicinity determines its paint order among all of the children.

Implemented types
Annotations

Constructors

ChildVicinity({required int xIndex, required int yIndex})
Creates a reference to a child in a two dimensional plane, with the xIndex and yIndex being relative to other children in the viewport.
const

Properties

hashCode int
The hash code for this object.
no setteroverride
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
xIndex int
The index of the child in the horizontal axis, relative to neighboring children.
final
yIndex int
The index of the child in the vertical axis, relative to neighboring children.
final

Methods

compareTo(ChildVicinity other) int
Compares this object to another object.
override
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() String
A string representation of this object.
override

Operators

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

Constants

invalid → const ChildVicinity
Represents an unassigned child position. The given child may be in the process of moving from one position to another.