A widget that clips its child using a path.

Calls a callback on a delegate whenever the widget is to be painted. The callback returns a path and the widget prevents the child from painting outside the path.

Clipping to a path is expensive. Certain shapes have more optimized widgets:

  • To clip to a rectangle, consider ClipRect.
  • To clip to an oval or circle, consider ClipOval.
  • To clip to a rounded rectangle, consider ClipRRect.
Inheritance

Constructors

ClipPath({Key key, CustomClipper<Path> clipper, Widget child })

Creates a path clip.

Properties

clipper → CustomClipper<Path>

If non-null, determines which clip to use.

read-only
child → Widget

The widget below this widget in the tree.

read-only, inherited
hashCode → int

Get a hash code for this object.

read-only, inherited
key → Key

Controls how one widget replaces another widget in the tree.

read-only, inherited
runtimeType → Type

A representation of the runtime type of the object.

read-only, inherited

Operators

operator ==(other) → bool

The equality operator.

inherited

Methods

createRenderObject(BuildContext context) → RenderClipPath

Creates an instance of the RenderObject class that this RenderObjectWidget represents, using the configuration described by this RenderObjectWidget.

didUnmountRenderObject(RenderClipPath 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.

updateRenderObject(BuildContext context, RenderClipPath 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.

createElement() → SingleChildRenderObjectElement

RenderObjectWidgets always inflate to a RenderObjectElement subclass.

inherited
debugFillDescription(List<String> description) → void

Add additional information to the given description for use by toString.

inherited
noSuchMethod(Invocation invocation) → dynamic

Invoked when a non-existent method or property is accessed.

inherited
toString() → String

Returns a string representation of this object.

inherited
toStringShort() → String

A short, textual description of this widget.

inherited