PhysicalShapeModifier class
A widget representing a physical layer that clips its children to a path.
Physical layers cast shadows based on an elevation which is nominally in logical pixels, coming vertically out of the rendering surface.
PhysicalModel does the same but only supports shapes that can be expressed as rectangles with rounded corners.
{@tool dartpad} This example shows how to use a PhysicalShape on a centered SizedBox to clip it to a rounded rectangle using a ShapeBorderClipper and give it an orange color along with a shadow.
** See code in examples/api/lib/widgets/basic/physical_shape.0.dart ** {@end-tool}
See also:
- ShapeBorderClipper, which converts a ShapeBorder to a CustomClipper, as needed by this widget.
- Inheritance
-
- Object
- DiagnosticableTree
- Widget
- StatelessWidget
- SingleChildStatelessModifier
- PhysicalShapeModifier
- Available extensions
Constructors
-
PhysicalShapeModifier({Key? key, Widget? child, Key? modifierKey, required CustomClipper<
Path> clipper, Clip clipBehavior = Clip.none, double elevation = 0.0, required Color color, Color shadowColor = const Color(0xFF000000)}) -
Creates a physical model with an arbitrary shape clip.
const
Properties
- clipBehavior → Clip
-
The content will be clipped (or not) according to this option.
final
-
clipper
→ CustomClipper<
Path> -
Determines which clip to use.
final
- color → Color
-
The background color.
final
- elevation → double
-
The z-coordinate relative to the parent at which to place this physical
object.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- key → Key?
-
Controls how one widget replaces another widget in the tree.
finalinherited
- modifierKey → Key?
-
The actual key of the widget, which Modifier wrapped
finalinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- shadowColor → Color
-
When elevation is non zero the color to use for the shadow color.
final
Methods
-
build(
BuildContext context) → Widget -
Describes the part of the user interface represented by this widget.
inherited
-
buildWithChild(
BuildContext context, Widget? child) → Widget -
A build method that receives an extra
childparameter.override -
createElement(
) → SingleChildStatelessElement -
Create a SingleChildStatelessElement
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
-
modified(
) → Modifier -
Available on Widget, provided by the ModifierTransformer extension
Transform normal widget to Modifier -
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, int wrapWidth = 65}) → 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