PhysicalShape class Null safety

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.

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.
To create a local project with this code sample, run:
flutter create --sample=widgets.PhysicalShape.1 mysample

See also:



PhysicalShape({Key? key, required CustomClipper<Path> clipper, Clip clipBehavior = Clip.none, double elevation = 0.0, required Color color, Color shadowColor = const Color(0xFF000000), Widget? child})
Creates a physical model with an arbitrary shape clip.


child Widget?
The widget below this widget in the tree.
final, inherited
clipBehavior Clip
The content will be clipped (or not) according to this option.
clipper CustomClipper<Path>
Determines which clip to use.
color Color
The background color.
elevation double
The z-coordinate relative to the parent at which to place this physical object.
hashCode int
The hash code for this object.
@nonVirtual, read-only, inherited
key Key?
Controls how one widget replaces another widget in the tree.
final, inherited
runtimeType Type
A representation of the runtime type of the object.
read-only, inherited
shadowColor Color
When elevation is non zero the color to use for the shadow color.


createElement() SingleChildRenderObjectElement
RenderObjectWidgets always inflate to a RenderObjectElement subclass.
createRenderObject(BuildContext context) RenderPhysicalShape
Creates an instance of the RenderObject class that this RenderObjectWidget represents, using the configuration described by this RenderObjectWidget.
debugDescribeChildren() List<DiagnosticsNode>
Returns a list of DiagnosticsNode objects describing this node's children.
@protected, inherited
debugFillProperties(DiagnosticPropertiesBuilder properties) → void
Add additional properties associated with the node.
didUnmountRenderObject(covariant RenderObject renderObject) → void
A render object previously associated with this widget has been removed from the tree. The given RenderObject will be of the same type as returned by this object's createRenderObject.
@protected, inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a non-existent method or property is accessed.
toDiagnosticsNode({String? name, DiagnosticsTreeStyle? style}) DiagnosticsNode
Returns a debug representation of the object that is used by debugging tools and by DiagnosticsNode.toStringDeep.
toString({DiagnosticLevel minLevel =}) String
A string representation of this object.
toStringDeep({String prefixLineOne = '', String? prefixOtherLines, DiagnosticLevel minLevel = DiagnosticLevel.debug}) String
Returns a string representation of this node and its descendants.
toStringShallow({String joiner = ', ', DiagnosticLevel minLevel = DiagnosticLevel.debug}) String
Returns a one-line detailed description of the object.
toStringShort() String
A short, textual description of this widget.
updateRenderObject(BuildContext context, covariant RenderPhysicalShape renderObject) → void
Copies the configuration described by this RenderObjectWidget to the given RenderObject, which will be of the same type as returned by this object's createRenderObject.


operator ==(Object other) bool
The equality operator.
@nonVirtual, inherited