PieceOverlay class
Builds a map of pieces in a board arrangement, according to size and orientation, using pieceSet to determine the piece widgets.
- Inheritance
-
- Object
- DiagnosticableTree
- Widget
- StatelessWidget
- PieceOverlay
Constructors
-
PieceOverlay({Key? key, BoardSize size = BoardSize.standard, int orientation = Squares.white, required Map<
int, String> pieces, required PieceSet pieceSet, double opacity = Squares.defaultPremovePieceOpacity}) -
const
- PieceOverlay.single({BoardSize size = BoardSize.standard, int orientation = Squares.white, required PieceSet pieceSet, double opacity = Squares.defaultPremovePieceOpacity, required int square, required String piece})
-
Creates a
PieceOverlay
with a singlepiece
, drawn atsquare
.factory
Properties
- hashCode → int
-
The hash code for this object.
no setterinherited
- key → Key?
-
Controls how one widget replaces another widget in the tree.
finalinherited
- opacity → double
-
Opacity of the pieces.
final
- orientation → int
-
Determines which way around the board is facing.
0 (white) will place the white pieces at the bottom,
and 1 will place the black pieces there.
You likely want to take this from
BoardState.orientation
.final -
pieces
→ Map<
int, String> -
Pieces to draw on the board, at the indices specified by their keys.
final
- pieceSet → PieceSet
-
The set of widgets to use for pieces.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- size → BoardSize
-
Dimensions of the board.
final
Methods
-
build(
BuildContext context) → Widget -
Describes the part of the user interface represented by this widget.
override
-
createElement(
) → StatelessElement -
Creates a StatelessElement to manage this widget's location in the tree.
inherited
-
debugDescribeChildren(
) → List< DiagnosticsNode> -
Returns a list of DiagnosticsNode objects describing this node's
children.
inherited
-
debugFillProperties(
DiagnosticPropertiesBuilder properties) → void -
Add additional properties associated with the node.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toDiagnosticsNode(
{String? name, DiagnosticsTreeStyle? style}) → DiagnosticsNode -
Returns a debug representation of the object that is used by debugging
tools and by DiagnosticsNode.toStringDeep.
inherited
-
toString(
{DiagnosticLevel minLevel = DiagnosticLevel.info}) → String -
A string representation of this object.
inherited
-
toStringDeep(
{String prefixLineOne = '', String? prefixOtherLines, DiagnosticLevel minLevel = DiagnosticLevel.debug}) → String -
Returns a string representation of this node and its descendants.
inherited
-
toStringShallow(
{String joiner = ', ', DiagnosticLevel minLevel = DiagnosticLevel.debug}) → String -
Returns a one-line detailed description of the object.
inherited
-
toStringShort(
) → String -
A short, textual description of this widget.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited