InProgressStrokesView

Added in 1.0.0

Kotlin |Java

@UiThread
class InProgressStrokesView : FrameLayout

kotlin.Any
↳	android.view.View
	↳	android.view.ViewGroup
		↳	android.widget.FrameLayout
			↳	androidx.ink.authoring.InProgressStrokesView

Displays in-progress ink strokes as MotionEvent user inputs are provided to it.

For a Jetpack Compose equivalent which also provides a default input handler, see androidx.ink.authoring.compose.InProgressStrokes instead.

The visual styles of strokes are highly customizable by passing the appropriate Brush to startStroke, but if that declarative style specification is not rich enough and instead some more detailed programmatic logic is necessary, consider using InProgressShapesView instead.

Summary

Public constructors
`InProgressStrokesView( context: Context, attrs: AttributeSet?, defStyleAttr: @AttrRes Int )`

Public functions
`Unit`	`addFinishedStrokesListener(listener: InProgressStrokesFinishedListener)` Add a listener to be notified when strokes are finished.
`Boolean`	`addToStroke(event: MotionEvent, pointerId: Int, prediction: MotionEvent?)` Add `event` data for `pointerId` to the corresponding in-progress stroke, if present.
`Unit`	`addToStroke( inputs: StrokeInputBatch, strokeId: InProgressStrokeId, prediction: StrokeInputBatch )` Add input data from a `StrokeInputBatch` to an existing stroke.
`Unit`	`addToStroke( event: MotionEvent, pointerId: Int, strokeId: InProgressStrokeId, prediction: MotionEvent? )` Add input data, from a particular pointer within a `MotionEvent`, to an existing stroke.
`Boolean`	`cancelStroke(event: MotionEvent, pointerId: Int)` Cancel the corresponding in-progress stroke with `event` data for `pointerId`, if present.
`Unit`	`cancelStroke(strokeId: InProgressStrokeId, event: MotionEvent?)` Cancel the building of a stroke.
`Unit`	`cancelUnfinishedStrokes()` Cancel all in-progress strokes.
`Unit`	`clearFinishedStrokesListeners()` Removes all listeners that had previously been added with `addFinishedStrokesListener`.
`Unit`	`eagerInit()` Eagerly initialize rather than waiting for the first stroke to be drawn.
`Boolean`	`finishStroke(event: MotionEvent, pointerId: Int)` Finish the corresponding in-progress stroke with `event` data for `pointerId`, if present.
`Unit`	`finishStroke(input: StrokeInput, strokeId: InProgressStrokeId)` Complete the building of a stroke, with the last input data coming from a `StrokeInput`.
`Unit`	`finishStroke( event: MotionEvent, pointerId: Int, strokeId: InProgressStrokeId )` Complete the building of a stroke, with the last input data coming from a particular pointer of a `MotionEvent`.
`Map<InProgressStrokeId, Stroke>`	`getFinishedStrokes()` Returns all the finished strokes that are still being rendered by this view, with map iteration order in the z-order that the strokes are being rendered, from back to front.
`Boolean`	`hasUnfinishedStrokes()` Returns true if there are any in-progress strokes.
`Unit`	`removeFinishedStrokes(strokeIds: Set<InProgressStrokeId>)` Stop this view from rendering the strokes with the given IDs.
`Unit`	`removeFinishedStrokesListener( listener: InProgressStrokesFinishedListener )` Removes a listener that had previously been added with `addFinishedStrokesListener`.
`InProgressStrokeId`	`startStroke( input: StrokeInput, brush: Brush, strokeToViewTransform: Matrix )` Start building a stroke with the provided `input`.
`InProgressStrokeId`	`startStroke( event: MotionEvent, pointerId: Int, brush: Brush, motionEventToWorldTransform: Matrix, strokeToWorldTransform: Matrix )` Start building a stroke using a particular pointer within a `MotionEvent`.

Protected functions
`open Unit`	`onAttachedToWindow()`
`open Unit`	`onDetachedFromWindow()`

Public properties
`CountingIdlingResource?`	`@VisibleForTesting inProgressStrokeCounter` Allows a test to easily wait until all in-progress strokes are completed and handed off.
`Path?`	`maskPath` Denote an area of this `InProgressStrokesView` where no ink should be visible.
`Matrix`	`motionEventToViewTransform` The transform matrix to convert `MotionEvent` coordinates, as passed to `startStroke`, `addToStroke`, and `finishStroke`, into coordinates of this `InProgressStrokesView` for rendering.
`TextureBitmapStore`	`textureBitmapStore` `TextureBitmapStore` used to create the `CanvasStrokeRenderer`.

Inherited functions

From android.widget.FrameLayout

`Boolean`	`checkLayoutParams(p: ViewGroup.LayoutParams)`
`FrameLayout.LayoutParams`	`generateDefaultLayoutParams()`
`FrameLayout.LayoutParams`	`generateLayoutParams(attrs: AttributeSet)`
`ViewGroup.LayoutParams`	`generateLayoutParams(lp: ViewGroup.LayoutParams)`
`Unit`	`onLayout(changed: Boolean, left: Int, top: Int, right: Int, bottom: Int)`
`Unit`	`onMeasure(widthMeasureSpec: Int, heightMeasureSpec: Int)`
`Boolean`	`shouldDelayChildPressedState()`

From android.view.View

`Unit`	`addFocusables(views: ArrayList<View>, direction: Int)`
`Unit`	`addOnAttachStateChangeListener( listener: View.OnAttachStateChangeListener )`
`Unit`	`addOnLayoutChangeListener(listener: View.OnLayoutChangeListener)`
`Unit`	`addOnUnhandledKeyEventListener( listener: View.OnUnhandledKeyEventListener )`
`ViewPropertyAnimator`	`animate()`
`Unit`	`announceForAccessibility(text: CharSequence)`
`Unit`	`autofill(value: AutofillValue)`
`Unit`	`autofill(values: SparseArray<AutofillValue>)`
`Boolean`	`awakenScrollBars()`
`Boolean`	`awakenScrollBars(startDelay: Int)`
`Boolean`	`awakenScrollBars(startDelay: Int, invalidate: Boolean)`
`Unit`	`bringToFront()`
`Unit`	`buildDrawingCache()`
`Unit`	`buildDrawingCache(autoScale: Boolean)`
`Unit`	`buildLayer()`
`Boolean`	`callOnClick()`
`open Boolean`	`canResolveLayoutDirection()`
`open Boolean`	`canResolveTextAlignment()`
`open Boolean`	`canResolveTextDirection()`
`Boolean`	`canScrollHorizontally(direction: Int)`
`Boolean`	`canScrollVertically(direction: Int)`
`Unit`	`cancelDragAndDrop()`
`Unit`	`cancelLongPress()`
`Unit`	`cancelPendingInputEvents()`
`Boolean`	`checkInputConnectionProxy(view: View)`
`Unit`	`clearAnimation()`
`Unit`	`clearPendingCredentialRequest()`
`Unit`	`clearViewTranslationCallback()`
`Int`	`computeHorizontalScrollExtent()`
`Int`	`computeHorizontalScrollOffset()`
`Int`	`computeHorizontalScrollRange()`
`Unit`	`computeScroll()`
`WindowInsets`	`computeSystemWindowInsets(in: WindowInsets, outLocalInsets: Rect)`
`Int`	`computeVerticalScrollExtent()`
`Int`	`computeVerticalScrollOffset()`
`Int`	`computeVerticalScrollRange()`
`AccessibilityNodeInfo`	`createAccessibilityNodeInfo()`
`open Unit`	`createContextMenu(menu: ContextMenu)`
`Unit`	`destroyDrawingCache()`
`Boolean`	`dispatchGenericMotionEvent(event: MotionEvent)`
`Boolean`	`dispatchNestedFling(velocityX: Float, velocityY: Float, consumed: Boolean)`
`Boolean`	`dispatchNestedPreFling(velocityX: Float, velocityY: Float)`
`Boolean`	`dispatchNestedPrePerformAccessibilityAction( action: Int, arguments: Bundle? )`
`Boolean`	`dispatchNestedPreScroll( dx: Int, dy: Int, consumed: IntArray?, offsetInWindow: IntArray? )`
`Boolean`	`dispatchNestedScroll( dxConsumed: Int, dyConsumed: Int, dxUnconsumed: Int, dyUnconsumed: Int, offsetInWindow: IntArray? )`
`Boolean`	`dispatchPopulateAccessibilityEvent(event: AccessibilityEvent)`
`Unit`	`draw(canvas: Canvas)`
`Unit`	`drawableHotspotChanged(x: Float, y: Float)`
`OnBackInvokedDispatcher?`	`findOnBackInvokedDispatcher()`
`T`	`<T : View> findViewById(id: Int)`
`T`	`<T : View> findViewWithTag(tag: Any)`
`Boolean`	`fitSystemWindows(insets: Rect)`
`View`	`focusSearch(direction: Int)`
`Unit`	`forceHasOverlappingRendering(hasOverlappingRendering: Boolean)`
`Unit`	`forceLayout()`
`Unit`	`generateDisplayHash( hashAlgorithm: String, bounds: Rect?, executor: Executor, callback: DisplayHashResultCallback )`
`IntArray`	`getAttributeResolutionStack(attribute: Int)`
`Boolean`	`getClipBounds(outRect: Rect)`
`Bitmap`	`getDrawingCache(autoScale: Boolean)`
`Unit`	`getDrawingRect(outRect: Rect)`
`ArrayList<View>`	`getFocusables(direction: Int)`
`Unit`	`getFocusedRect(r: Rect)`
`Boolean`	`getGlobalVisibleRect(r: Rect)`
`Boolean`	`getGlobalVisibleRect(r: Rect, globalOffset: Point)`
`Unit`	`getHitRect(outRect: Rect)`
`open Int`	`@ViewDebug.ExportedProperty(category = "layout", mapping = [@ViewDebug.IntToString(from = 0, to = "RESOLVED_DIRECTION_LTR"), @ViewDebug.IntToString(from = 1, to = "RESOLVED_DIRECTION_RTL")]) getLayoutDirection()`
`Boolean`	`getLocalVisibleRect(r: Rect)`
`Unit`	`getLocationInSurface(location: IntArray)`
`Unit`	`getLocationInWindow(outLocation: IntArray)`
`Unit`	`getLocationOnScreen(outLocation: IntArray)`
`ViewParent`	`getParent()`
`open ViewParent`	`getParentForAccessibility()`
`Any`	`getTag(key: Int)`
`open Int`	`@ViewDebug.ExportedProperty(category = "text", mapping = [@ViewDebug.IntToString(from = 0, to = "INHERIT"), @ViewDebug.IntToString(from = 1, to = "GRAVITY"), @ViewDebug.IntToString(from = 2, to = "TEXT_START"), @ViewDebug.IntToString(from = 3, to = "TEXT_END"), @ViewDebug.IntToString(from = 4, to = "CENTER"), @ViewDebug.IntToString(from = 5, to = "VIEW_START"), @ViewDebug.IntToString(from = 6, to = "VIEW_END")]) getTextAlignment()`
`open Int`	@ViewDebug.ExportedProperty(category = "text", mapping = [@ViewDebug.IntToString(from = 0, to = "INHERIT"), @ViewDebug.IntToString(from = 1, to = "FIRST_STRONG"), @ViewDebug.IntToString(from = 2, to = "ANY_RTL"), @ViewDebug.IntToString(from = 3, to = "LTR"), @ViewDebug.IntToString(from = 4, to = "RTL"), @ViewDebug.IntToString(from = 5, to = "LOCALE"), @ViewDebug.IntToString(from = 6, to = "FIRST_STRONG_LTR"), @ViewDebug.IntToString(from = 7, to = "FIRST_STRONG_RTL")]) getTextDirection()
`Unit`	`getWindowVisibleDisplayFrame(outRect: Rect)`
`Boolean`	`hasExplicitFocusable()`
`Boolean`	`hasFocusable()`
`Boolean`	`hasNestedScrollingParent()`
`Boolean`	`hasOnClickListeners()`
`Boolean`	`hasOnLongClickListeners()`
`Boolean`	`hasOverlappingRendering()`
`Boolean`	`hasPointerCapture()`
`Boolean`	`hasWindowFocus()`
`Unit`	`invalidate()`
`Unit`	`invalidate(dirty: Rect)`
`Unit`	`invalidate(l: Int, t: Int, r: Int, b: Int)`
`Unit`	`invalidateDrawable(drawable: Drawable)`
`Unit`	`invalidateOutline()`
`open Boolean`	`isLayoutDirectionResolved()`
`open Boolean`	`isLayoutRequested()`
`open Boolean`	`isTextAlignmentResolved()`
`open Boolean`	`isTextDirectionResolved()`
`Boolean`	`isVisibleToUserForAutofill(virtualId: Int)`
`open View`	`keyboardNavigationClusterSearch(currentCluster: View, direction: Int)`
`Unit`	`measure(widthMeasureSpec: Int, heightMeasureSpec: Int)`
`Unit`	`offsetLeftAndRight(offset: Int)`
`Unit`	`offsetTopAndBottom(offset: Int)`
`Unit`	`onAnimationEnd()`
`Unit`	`onAnimationStart()`
`WindowInsets`	`onApplyWindowInsets(insets: WindowInsets)`
`Unit`	`onCancelPendingInputEvents()`
`Boolean`	`onCapturedPointerEvent(event: MotionEvent)`
`Boolean`	`onCheckIsTextEditor()`
`Unit`	`onConfigurationChanged(newConfig: Configuration)`
`Unit`	`onCreateContextMenu(menu: ContextMenu)`
`InputConnection`	`onCreateInputConnection(outAttrs: EditorInfo)`
`Unit`	`onCreateViewTranslationRequest( supportedFormats: IntArray, requestsCollector: Consumer<ViewTranslationRequest> )`
`Unit`	`onCreateVirtualViewTranslationRequests( virtualIds: LongArray, supportedFormats: IntArray, requestsCollector: Consumer<ViewTranslationRequest> )`
`Unit`	`onDisplayHint(hint: Int)`
`Boolean`	`onDragEvent(event: DragEvent)`
`Unit`	`onDraw(canvas: Canvas)`
`Unit`	`onDrawForeground(canvas: Canvas)`
`Unit`	`onDrawScrollBars(canvas: Canvas)`
`Boolean`	`onFilterTouchEventForSecurity(event: MotionEvent)`
`Unit`	`onFinishInflate()`
`Unit`	`onFinishTemporaryDetach()`
`Unit`	`onFocusChanged( gainFocus: Boolean, direction: Int, previouslyFocusedRect: Rect? )`
`Boolean`	`onGenericMotionEvent(event: MotionEvent)`
`Unit`	`onHoverChanged(hovered: Boolean)`
`Boolean`	`onHoverEvent(event: MotionEvent)`
`Unit`	`onInitializeAccessibilityEvent(event: AccessibilityEvent)`
`Unit`	`onInitializeAccessibilityNodeInfo(info: AccessibilityNodeInfo)`
`Boolean`	`onKeyDown(keyCode: Int, event: KeyEvent)`
`Boolean`	`onKeyLongPress(keyCode: Int, event: KeyEvent)`
`Boolean`	`onKeyMultiple(keyCode: Int, repeatCount: Int, event: KeyEvent)`
`Boolean`	`onKeyPreIme(keyCode: Int, event: KeyEvent)`
`Boolean`	`onKeyShortcut(keyCode: Int, event: KeyEvent)`
`Boolean`	`onKeyUp(keyCode: Int, event: KeyEvent)`
`Unit`	`onOverScrolled( scrollX: Int, scrollY: Int, clampedX: Boolean, clampedY: Boolean )`
`Unit`	`onPointerCaptureChange(hasCapture: Boolean)`
`Unit`	`onPopulateAccessibilityEvent(event: AccessibilityEvent)`
`Unit`	`onProvideAutofillStructure(structure: ViewStructure, flags: Int)`
`Unit`	`onProvideAutofillVirtualStructure(structure: ViewStructure, flags: Int)`
`Unit`	`onProvideContentCaptureStructure(structure: ViewStructure, flags: Int)`
`Unit`	`onProvideStructure(structure: ViewStructure)`
`Unit`	`onProvideVirtualStructure(structure: ViewStructure)`
`ContentInfo?`	`onReceiveContent(payload: ContentInfo)`
`Unit`	`onRestoreInstanceState(state: Parcelable)`
`Unit`	`onRtlPropertiesChanged(layoutDirection: Int)`
`Parcelable?`	`onSaveInstanceState()`
`Unit`	`onScreenStateChanged(screenState: Int)`
`Unit`	`onScrollCaptureSearch( localVisibleRect: Rect, windowOffset: Point, targets: Consumer<ScrollCaptureTarget> )`
`Unit`	`onScrollChanged(l: Int, t: Int, oldl: Int, oldt: Int)`
`Boolean`	`onSetAlpha(alpha: Int)`
`Unit`	`onSizeChanged(w: Int, h: Int, oldw: Int, oldh: Int)`
`Unit`	`onStartTemporaryDetach()`
`Boolean`	`onTouchEvent(event: MotionEvent)`
`Boolean`	`onTrackballEvent(event: MotionEvent)`
`Unit`	`onViewTranslationResponse(response: ViewTranslationResponse)`
`Unit`	`onVirtualViewTranslationResponses( response: LongSparseArray<ViewTranslationResponse> )`
`Unit`	`onVisibilityAggregated(isVisible: Boolean)`
`Unit`	`onVisibilityChanged(changedView: View, visibility: Int)`
`Unit`	`onWindowFocusChanged(hasWindowFocus: Boolean)`
`Unit`	`onWindowSystemUiVisibilityChanged(visible: Int)`
`Unit`	`onWindowVisibilityChanged(visibility: Int)`
`Boolean`	`overScrollBy( deltaX: Int, deltaY: Int, scrollX: Int, scrollY: Int, scrollRangeX: Int, scrollRangeY: Int, maxOverScrollX: Int, maxOverScrollY: Int, isTouchEvent: Boolean )`
`Boolean`	`performAccessibilityAction(action: Int, arguments: Bundle?)`
`Boolean`	`performClick()`
`Boolean`	`performContextClick()`
`Boolean`	`performContextClick(x: Float, y: Float)`
`Boolean`	`performHapticFeedback(feedbackConstant: Int)`
`Boolean`	`performHapticFeedback(request: HapticFeedbackRequest)`
`Boolean`	`performHapticFeedback(feedbackConstant: Int, flags: Int)`
`Boolean`	`performLongClick()`
`Boolean`	`performLongClick(x: Float, y: Float)`
`ContentInfo?`	`performReceiveContent(payload: ContentInfo)`
`Unit`	`playSoundEffect(soundConstant: Int)`
`Boolean`	`post(action: Runnable)`
`Boolean`	`postDelayed(action: Runnable, delayMillis: Long)`
`Unit`	`postInvalidate()`
`Unit`	`postInvalidate(left: Int, top: Int, right: Int, bottom: Int)`
`Unit`	`postInvalidateDelayed(delayMilliseconds: Long)`
`Unit`	`postInvalidateDelayed( delayMilliseconds: Long, left: Int, top: Int, right: Int, bottom: Int )`
`Unit`	`postInvalidateOnAnimation()`
`Unit`	`postInvalidateOnAnimation(left: Int, top: Int, right: Int, bottom: Int)`
`Unit`	`postOnAnimation(action: Runnable)`
`Unit`	`postOnAnimationDelayed(action: Runnable, delayMillis: Long)`
`Unit`	`refreshDrawableState()`
`Unit`	`releasePointerCapture()`
`Boolean`	`removeCallbacks(action: Runnable)`
`Unit`	`removeOnAttachStateChangeListener( listener: View.OnAttachStateChangeListener )`
`Unit`	`removeOnLayoutChangeListener(listener: View.OnLayoutChangeListener)`
`Unit`	`removeOnUnhandledKeyEventListener( listener: View.OnUnhandledKeyEventListener )`
`Unit`	`reportAppJankStats(appJankStats: AppJankStats)`
`Unit`	`requestApplyInsets()`
`open Unit`	`requestFitSystemWindows()` This function is deprecated. Deprecated in Java
`Boolean`	`requestFocus()`
`Boolean`	`requestFocus(direction: Int)`
`Boolean`	`requestFocusFromTouch()`
`open Unit`	`requestLayout()`
`Unit`	`requestPointerCapture()`
`Unit`	`requestPointerCapture(mode: Int)`
`Boolean`	`requestRectangleOnScreen(rectangle: Rect)`
`Boolean`	`requestRectangleOnScreen(rectangle: Rect, immediate: Boolean)`
`Boolean`	`requestRectangleOnScreen(rectangle: Rect, immediate: Boolean, source: Int)`
`Unit`	`requestUnbufferedDispatch(event: MotionEvent)`
`Unit`	`requestUnbufferedDispatch(source: Int)`
`T`	`<T : View> requireViewById(id: Int)`
`Unit`	`resetPivot()`
`Unit`	`restoreHierarchyState(container: SparseArray<Parcelable>)`
`Unit`	`saveAttributeDataForStyleable( context: Context, styleable: IntArray, attrs: AttributeSet?, t: TypedArray, defStyleAttr: Int, defStyleRes: Int )`
`Unit`	`saveHierarchyState(container: SparseArray<Parcelable>)`
`Unit`	`scheduleDrawable(who: Drawable, what: Runnable, when: Long)`
`Unit`	`scrollBy(x: Int, y: Int)`
`Unit`	`scrollTo(x: Int, y: Int)`
`Unit`	`sendAccessibilityEvent(eventType: Int)`
`Unit`	`sendAccessibilityEventUnchecked(event: AccessibilityEvent)`
`Unit`	`setAccessibilityDataSensitive(accessibilityDataSensitive: Int)`
`Unit`	`setAllowClickWhenDisabled(clickableWhenDisabled: Boolean)`
`Unit`	`setAllowedHandwritingDelegatePackage(allowedPackageName: String?)`
`Unit`	`setAllowedHandwritingDelegatorPackage(allowedPackageName: String?)`
`Unit`	`setAutofillHints(vararg autofillHints: String)`
`Unit`	`setBackgroundColor(color: Int)`
`Unit`	`setBackgroundDrawable(background: Drawable)`
`Unit`	`setBackgroundResource(resid: Int)`
`Unit`	`setFadingEdgeLength(length: Int)`
`Unit`	`setHandwritingBoundsOffsets( offsetLeft: Float, offsetTop: Float, offsetRight: Float, offsetBottom: Float )`
`Unit`	`setHasTransientState(hasTransientState: Boolean)`
`Unit`	`setIsCredential(isCredential: Boolean)`
`Unit`	`setIsHandwritingDelegate(isHandwritingDelegate: Boolean)`
`Unit`	`setLayerPaint(paint: Paint?)`
`Unit`	`setLayerType(layerType: Int, paint: Paint?)`
`Unit`	`setLeftTopRightBottom(left: Int, top: Int, right: Int, bottom: Int)`
`Unit`	`setMeasuredDimension(measuredWidth: Int, measuredHeight: Int)`
`Unit`	`setOnApplyWindowInsetsListener( listener: View.OnApplyWindowInsetsListener )`
`Unit`	`setOnCapturedPointerListener(l: View.OnCapturedPointerListener)`
`Unit`	`setOnClickListener(l: View.OnClickListener?)`
`Unit`	`setOnContextClickListener(l: View.OnContextClickListener?)`
`Unit`	`setOnCreateContextMenuListener(l: View.OnCreateContextMenuListener)`
`Unit`	`setOnDragListener(l: View.OnDragListener)`
`Unit`	`setOnGenericMotionListener(l: View.OnGenericMotionListener)`
`Unit`	`setOnHoverListener(l: View.OnHoverListener)`
`Unit`	`setOnKeyListener(l: View.OnKeyListener)`
`Unit`	`setOnLongClickListener(l: View.OnLongClickListener?)`
`Unit`	`setOnReceiveContentListener( mimeTypes: Array<String>?, listener: OnReceiveContentListener? )`
`Unit`	`setOnScrollChangeListener(l: View.OnScrollChangeListener)`
`Unit`	`setOnSystemUiVisibilityChangeListener( l: View.OnSystemUiVisibilityChangeListener )`
`Unit`	`setOnTouchListener(l: View.OnTouchListener)`
`Unit`	`setPadding(left: Int, top: Int, right: Int, bottom: Int)`
`Unit`	`setPaddingRelative(start: Int, top: Int, end: Int, bottom: Int)`
`Unit`	`setPendingCredentialRequest( request: GetCredentialRequest, callback: OutcomeReceiver<GetCredentialResponse, GetCredentialException> )`
`Unit`	`setRenderEffect(renderEffect: RenderEffect?)`
`Unit`	`setScrollCaptureCallback(callback: ScrollCaptureCallback?)`
`Unit`	`setScrollIndicators(indicators: Int, mask: Int)`
`Unit`	`setTag(key: Int, tag: Any)`
`Unit`	`setTransitionVisibility(visibility: Int)`
`Unit`	`setViewTranslationCallback(callback: ViewTranslationCallback)`
`Unit`	`setWillNotCacheDrawing(willNotCacheDrawing: Boolean)`
`Unit`	`setWillNotDraw(willNotDraw: Boolean)`
`Boolean`	`showContextMenu()`
`Boolean`	`showContextMenu(x: Float, y: Float)`
`ActionMode`	`startActionMode(callback: ActionMode.Callback)`
`ActionMode`	`startActionMode(callback: ActionMode.Callback, type: Int)`
`Unit`	`startAnimation(animation: Animation)`
`Boolean`	`startDrag( data: ClipData, shadowBuilder: View.DragShadowBuilder, myLocalState: Any, flags: Int )`
`Boolean`	`startDragAndDrop( data: ClipData, shadowBuilder: View.DragShadowBuilder, myLocalState: Any, flags: Int )`
`Boolean`	`startNestedScroll(axes: Int)`
`Unit`	`stopNestedScroll()`
`open String`	`toString()`
`Unit`	`transformMatrixToGlobal(matrix: Matrix)`
`Unit`	`transformMatrixToLocal(matrix: Matrix)`
`Unit`	`unscheduleDrawable(who: Drawable)`
`Unit`	`unscheduleDrawable(who: Drawable, what: Runnable)`
`Unit`	`updateDragShadow(shadowBuilder: View.DragShadowBuilder)`
`Boolean`	`verifyDrawable(who: Drawable)`
`Boolean`	`willNotCacheDrawing()`
`Boolean`	`willNotDraw()`

From android.view.ViewGroup

`Unit`	`addChildrenForAccessibility(outChildren: ArrayList<View>)`
`Unit`	`addExtraDataToAccessibilityNodeInfo( info: AccessibilityNodeInfo, extraDataKey: String, arguments: Bundle? )`
`Unit`	`addFocusables(views: ArrayList<View>, direction: Int, focusableMode: Int)`
`Unit`	`addKeyboardNavigationClusters( views: MutableCollection<View>, direction: Int )`
`Boolean`	`addStatesFromChildren()`
`Unit`	`addTouchables(views: ArrayList<View>)`
`Unit`	`addView(child: View)`
`Unit`	`addView(child: View, index: Int)`
`Unit`	`addView(child: View, params: ViewGroup.LayoutParams)`
`Unit`	`addView(child: View, index: Int, params: ViewGroup.LayoutParams)`
`Unit`	`addView(child: View, width: Int, height: Int)`
`Boolean`	`addViewInLayout(child: View, index: Int, params: ViewGroup.LayoutParams)`
`Boolean`	`addViewInLayout( child: View, index: Int, params: ViewGroup.LayoutParams, preventRequestLayout: Boolean )`
`Unit`	`attachLayoutAnimationParameters( child: View, params: ViewGroup.LayoutParams, index: Int, count: Int )`
`Unit`	`attachViewToParent(child: View, index: Int, params: ViewGroup.LayoutParams)`
`Unit`	`bringChildToFront(child: View)`
`Boolean`	`canAnimate()`
`Unit`	`childDrawableStateChanged(child: View)`
`Unit`	`childHasTransientStateChanged( child: View, childHasTransientState: Boolean )`
`Unit`	`cleanupLayoutState(child: View)`
`Unit`	`clearChildFocus(child: View)`
`Unit`	`clearDisappearingChildren()`
`Unit`	`clearFocus()`
`Unit`	`debug(depth: Int)`
`Unit`	`detachAllViewsFromParent()`
`Unit`	`detachViewFromParent(child: View)`
`Unit`	`detachViewFromParent(index: Int)`
`Unit`	`detachViewsFromParent(start: Int, count: Int)`
`WindowInsets`	`dispatchApplyWindowInsets(insets: WindowInsets)`
`Boolean`	`dispatchCapturedPointerEvent(event: MotionEvent)`
`Unit`	`dispatchConfigurationChanged(newConfig: Configuration)`
`Unit`	`dispatchCreateViewTranslationRequest( viewIds: MutableMap<AutofillId, LongArray>, supportedFormats: IntArray, capability: TranslationCapability, requests: MutableList<ViewTranslationRequest> )`
`Unit`	`dispatchDisplayHint(hint: Int)`
`Boolean`	`dispatchDragEvent(event: DragEvent)`
`Unit`	`dispatchDraw(canvas: Canvas)`
`Unit`	`dispatchDrawableHotspotChanged(x: Float, y: Float)`
`Unit`	`dispatchFinishTemporaryDetach()`
`Unit`	`dispatchFreezeSelfOnly(container: SparseArray<Parcelable>)`
`Boolean`	`dispatchGenericFocusedEvent(event: MotionEvent)`
`Boolean`	`dispatchGenericPointerEvent(event: MotionEvent)`
`Boolean`	`dispatchHoverEvent(event: MotionEvent)`
`Boolean`	`dispatchKeyEvent(event: KeyEvent)`
`Boolean`	`dispatchKeyEventPreIme(event: KeyEvent)`
`Boolean`	`dispatchKeyShortcutEvent(event: KeyEvent)`
`Unit`	`dispatchPointerCaptureChanged(hasCapture: Boolean)`
`Unit`	`dispatchProvideAutofillStructure(structure: ViewStructure, flags: Int)`
`Unit`	`dispatchProvideStructure(structure: ViewStructure)`
`Unit`	`dispatchRestoreInstanceState(container: SparseArray<Parcelable>)`
`Unit`	`dispatchSaveInstanceState(container: SparseArray<Parcelable>)`
`Unit`	`dispatchScrollCaptureSearch( localVisibleRect: Rect, windowOffset: Point, targets: Consumer<ScrollCaptureTarget> )`
`Unit`	`dispatchSetActivated(activated: Boolean)`
`Unit`	`dispatchSetPressed(pressed: Boolean)`
`Unit`	`dispatchSetSelected(selected: Boolean)`
`Unit`	`dispatchStartTemporaryDetach()`
`Unit`	`dispatchSystemUiVisibilityChanged(visible: Int)`
`Unit`	`dispatchThawSelfOnly(container: SparseArray<Parcelable>)`
`Boolean`	`dispatchTouchEvent(ev: MotionEvent)`
`Boolean`	`dispatchTrackballEvent(event: MotionEvent)`
`Boolean`	`dispatchUnhandledMove(focused: View, direction: Int)`
`Unit`	`dispatchVisibilityChanged(changedView: View, visibility: Int)`
`Unit`	`dispatchWindowFocusChanged(hasFocus: Boolean)`
`Unit`	`dispatchWindowInsetsAnimationEnd(animation: WindowInsetsAnimation)`
`Unit`	`dispatchWindowInsetsAnimationPrepare(animation: WindowInsetsAnimation)`
`WindowInsets`	`dispatchWindowInsetsAnimationProgress( insets: WindowInsets, runningAnimations: MutableList<WindowInsetsAnimation> )`
`WindowInsetsAnimation.Bounds`	`dispatchWindowInsetsAnimationStart( animation: WindowInsetsAnimation, bounds: WindowInsetsAnimation.Bounds )`
`Unit`	`dispatchWindowSystemUiVisiblityChanged(visible: Int)`
`Unit`	`dispatchWindowVisibilityChanged(visibility: Int)`
`Boolean`	`drawChild(canvas: Canvas, child: View, drawingTime: Long)`
`Unit`	`drawableStateChanged()`
`Unit`	`endViewTransition(view: View)`
`View`	`findFocus()`
`OnBackInvokedDispatcher?`	`findOnBackInvokedDispatcherForChild(child: View, requester: View)`
`Unit`	`findViewsWithText( outViews: ArrayList<View>, text: CharSequence, flags: Int )`
`View`	`focusSearch(focused: View, direction: Int)`
`Unit`	`focusableViewAvailable(v: View)`
`Boolean`	`gatherTransparentRegion(region: Region?)`
`View`	`getChildAt(index: Int)`
`Int`	`getChildDrawingOrder(drawingPosition: Int)`
`Int`	`getChildDrawingOrder(childCount: Int, drawingPosition: Int)`
`Boolean`	`getChildStaticTransformation(child: View, t: Transformation)`
`Boolean`	`getChildVisibleRect(child: View, r: Rect, offset: Point)`
`Boolean`	`hasFocus()`
`Boolean`	`hasTransientState()`
`Int`	`indexOfChild(child: View)`
`Unit`	`invalidateChild(child: View, dirty: Rect)`
`ViewParent`	`invalidateChildInParent(location: IntArray, dirty: Rect)`
`Unit`	`jumpDrawablesToCurrentState()`
`Unit`	`layout(l: Int, t: Int, r: Int, b: Int)`
`Unit`	`measureChild( child: View, parentWidthMeasureSpec: Int, parentHeightMeasureSpec: Int )`
`Unit`	`measureChildWithMargins( child: View, parentWidthMeasureSpec: Int, widthUsed: Int, parentHeightMeasureSpec: Int, heightUsed: Int )`
`Unit`	`measureChildren(widthMeasureSpec: Int, heightMeasureSpec: Int)`
`Unit`	`notifySubtreeAccessibilityStateChanged( child: View, source: View, changeType: Int )`
`Unit`	`offsetDescendantRectToMyCoords(descendant: View, rect: Rect)`
`Unit`	`offsetRectIntoDescendantCoords(descendant: View, rect: Rect)`
`IntArray`	`onCreateDrawableState(extraSpace: Int)`
`Unit`	`onDescendantInvalidated(child: View, target: View)`
`Boolean`	`onInterceptHoverEvent(event: MotionEvent)`
`Boolean`	`onInterceptTouchEvent(ev: MotionEvent)`
`Boolean`	`onNestedFling( target: View, velocityX: Float, velocityY: Float, consumed: Boolean )`
`Boolean`	`onNestedPreFling(target: View, velocityX: Float, velocityY: Float)`
`Boolean`	`onNestedPrePerformAccessibilityAction( target: View, action: Int, args: Bundle? )`
`Unit`	`onNestedPreScroll(target: View, dx: Int, dy: Int, consumed: IntArray)`
`Unit`	`onNestedScroll( target: View, dxConsumed: Int, dyConsumed: Int, dxUnconsumed: Int, dyUnconsumed: Int )`
`Unit`	`onNestedScrollAccepted(child: View, target: View, axes: Int)`
`Boolean`	`onRequestFocusInDescendants(direction: Int, previouslyFocusedRect: Rect)`
`Boolean`	`onRequestSendAccessibilityEvent(child: View, event: AccessibilityEvent)`
`PointerIcon`	`onResolvePointerIcon(event: MotionEvent, pointerIndex: Int)`
`Boolean`	`onStartNestedScroll(child: View, target: View, nestedScrollAxes: Int)`
`Unit`	`onStopNestedScroll(child: View)`
`Unit`	`onViewAdded(child: View)`
`Unit`	`onViewRemoved(child: View)`
`Unit`	`propagateRequestedFrameRate(frameRate: Float, forceOverride: Boolean)`
`Unit`	`recomputeViewAttributes(child: View)`
`Unit`	`removeAllViews()`
`Unit`	`removeAllViewsInLayout()`
`Unit`	`removeDetachedView(child: View, animate: Boolean)`
`Unit`	`removeView(view: View)`
`Unit`	`removeViewAt(index: Int)`
`Unit`	`removeViewInLayout(view: View)`
`Unit`	`removeViews(start: Int, count: Int)`
`Unit`	`removeViewsInLayout(start: Int, count: Int)`
`Unit`	`requestChildFocus(child: View, focused: View)`
`Boolean`	`requestChildRectangleOnScreen( child: View, rectangle: Rect, immediate: Boolean )`
`Unit`	`requestDisallowInterceptTouchEvent(disallowIntercept: Boolean)`
`Boolean`	`requestFocus(direction: Int, previouslyFocusedRect: Rect)`
`Boolean`	`requestSendAccessibilityEvent(child: View, event: AccessibilityEvent)`
`Unit`	`requestTransparentRegion(child: View)`
`Boolean`	`restoreDefaultFocus()`
`Unit`	`scheduleLayoutAnimation()`
`Unit`	`setAddStatesFromChildren(addsStates: Boolean)`
`Unit`	`setChildrenDrawingCacheEnabled(enabled: Boolean)`
`Unit`	`setOnHierarchyChangeListener( listener: ViewGroup.OnHierarchyChangeListener )`
`Unit`	`setStaticTransformationsEnabled(enabled: Boolean)`
`Unit`	`setWindowInsetsAnimationCallback( callback: WindowInsetsAnimation.Callback? )`
`Boolean`	`showContextMenuForChild(originalView: View)`
`Boolean`	`showContextMenuForChild(originalView: View, x: Float, y: Float)`
`ActionMode`	`startActionModeForChild( originalView: View, callback: ActionMode.Callback )`
`ActionMode`	`startActionModeForChild( originalView: View, callback: ActionMode.Callback, type: Int )`
`Unit`	`startLayoutAnimation()`
`Unit`	`startViewTransition(view: View)`
`Unit`	`suppressLayout(suppress: Boolean)`
`Unit`	`updateViewLayout(view: View, params: ViewGroup.LayoutParams)`

From android.view.ViewParent

Boolean

requestChildRectangleOnScreen(
    child: View,
    rectangle: Rect,
    immediate: Boolean,
    source: Int
)

Inherited properties

From android.widget.FrameLayout

`open CharSequence`	`accessibilityClassName`
`open Boolean`	`considerGoneChildrenWhenMeasuring`
`open Boolean`	`measureAllChildren`

From android.view.View

`open View.AccessibilityDelegate`	`accessibilityDelegate`
`open Int`	`accessibilityLiveRegion`
`open AccessibilityNodeProvider`	`accessibilityNodeProvider`
`open CharSequence?`	`accessibilityPaneTitle`
`open Int`	`accessibilityTraversalAfter`
`open Int`	`accessibilityTraversalBefore`
`open String?`	`allowedHandwritingDelegatePackageName`
`open String?`	`allowedHandwritingDelegatorPackageName`
`open Float`	`alpha`
`open Animation`	`animation`
`open Matrix?`	`animationMatrix`
`open IBinder`	`applicationWindowToken`
`open MutableMap<Int, Int>`	`attributeSourceResourceMap`
`open Array<String>?`	`autofillHints`
`AutofillId`	`autofillId`
`open Int`	`autofillType`
`open AutofillValue?`	`autofillValue`
`open Drawable`	`background`
`open BlendMode?`	`backgroundTintBlendMode`
`open ColorStateList?`	`backgroundTintList`
`open PorterDuff.Mode?`	`backgroundTintMode`
`open Int`	`baseline`
`Int`	`bottom`
`open Float`	`bottomFadingEdgeStrength`
`open Int`	`bottomPaddingOffset`
`open Float`	`cameraDistance`
`open Rect`	`clipBounds`
`Boolean`	`clipToOutline`
`ContentCaptureSession?`	`contentCaptureSession`
`open CharSequence`	`contentDescription`
`Int`	`contentSensitivity`
`Context`	`context`
`open ContextMenu.ContextMenuInfo`	`contextMenuInfo`
`Boolean`	`defaultFocusHighlightEnabled`
`open Display`	`display`
`IntArray`	`drawableState`
`open Bitmap`	`drawingCache`
`open Int`	`drawingCacheBackgroundColor`
`open Int`	`drawingCacheQuality`
`open Long`	`drawingTime`
`open Float`	`elevation`
`open Int`	`explicitStyle`
`open Boolean`	`filterTouchesWhenObscured`
`open Boolean`	`fitsSystemWindows`
`open Int`	`focusable`
`open Drawable`	`foreground`
`open Int`	`foregroundGravity`
`open BlendMode?`	`foregroundTintBlendMode`
`open ColorStateList?`	`foregroundTintList`
`open PorterDuff.Mode?`	`foregroundTintMode`
`open Float`	`frameContentVelocity`
`open Handler`	`handler`
`open Float`	`handwritingBoundsOffsetBottom`
`open Float`	`handwritingBoundsOffsetLeft`
`open Float`	`handwritingBoundsOffsetRight`
`open Float`	`handwritingBoundsOffsetTop`
`open Int`	`handwritingDelegateFlags`
`open Runnable?`	`handwritingDelegatorCallback`
`Boolean`	`hasOverlappingRendering`
`Int`	`height`
`open Int`	`horizontalFadingEdgeLength`
`open Int`	`horizontalScrollbarHeight`
`open Drawable?`	`horizontalScrollbarThumbDrawable`
`open Drawable?`	`horizontalScrollbarTrackDrawable`
`open Int`	`id`
`open Int`	`importantForAccessibility`
`open Int`	`importantForAutofill`
`open Int`	`importantForContentCapture`
`open Boolean`	`isAccessibilityDataSensitive`
`open Boolean`	`isAccessibilityFocused`
`open Boolean`	`isAccessibilityHeading`
`open Boolean`	`isActivated`
`open Boolean`	`isAttachedToWindow`
`open Boolean`	`isAutoHandwritingEnabled`
`open Boolean`	`isClickable`
`Boolean`	`isContentSensitive`
`open Boolean`	`isContextClickable`
`open Boolean`	`isCredential`
`open Boolean`	`isDirty`
`open Boolean`	`isDrawingCacheEnabled`
`open Boolean`	`isDuplicateParentStateEnabled`
`open Boolean`	`isEnabled`
`Boolean`	`isFocusable`
`Boolean`	`isFocusableInTouchMode`
`open Boolean`	`isFocused`
`Boolean`	`isFocusedByDefault`
`open Boolean`	`isForceDarkAllowed`
`open Boolean`	`isHandwritingDelegate`
`open Boolean`	`isHapticFeedbackEnabled`
`open Boolean`	`isHardwareAccelerated`
`open Boolean`	`isHorizontalFadingEdgeEnabled`
`open Boolean`	`isHorizontalScrollBarEnabled`
`open Boolean`	`isHovered`
`open Boolean`	`isImportantForAccessibility`
`Boolean`	`isImportantForAutofill`
`Boolean`	`isImportantForContentCapture`
`open Boolean`	`isInEditMode`
`open Boolean`	`isInLayout`
`open Boolean`	`isInTouchMode`
`Boolean`	`isKeyboardNavigationCluster`
`open Boolean`	`isLaidOut`
`open Boolean`	`isLayoutDirectionResolved`
`open Boolean`	`isLayoutRequested`
`open Boolean`	`isLongClickable`
`open Boolean`	`isNestedScrollingEnabled`
`open Boolean`	`isOpaque`
`open Boolean`	`isPaddingOffsetRequired`
`open Boolean`	`isPaddingRelative`
`open Boolean`	`isPivotSet`
`Boolean`	`isPreferKeepClear`
`open Boolean`	`isPressed`
`open Boolean`	`isSaveEnabled`
`open Boolean`	`isSaveFromParentEnabled`
`open Boolean`	`isScreenReaderFocusable`
`open Boolean`	`isScrollContainer`
`open Boolean`	`isScrollbarFadingEnabled`
`open Boolean`	`isSelected`
`Boolean`	`isShowingLayoutBounds`
`open Boolean`	`isShown`
`open Boolean`	`isSoundEffectsEnabled`
`Boolean`	`isTemporarilyDetached`
`open Boolean`	`isTextAlignmentResolved`
`open Boolean`	`isTextDirectionResolved`
`open Boolean`	`isVerticalFadingEdgeEnabled`
`open Boolean`	`isVerticalScrollBarEnabled`
`open Boolean`	`keepScreenOn`
`open KeyEvent.DispatcherState`	`keyDispatcherState`
`open Int`	`labelFor`
`open Int`	`layerType`
`open Int`	`layoutDirection`
`open ViewGroup.LayoutParams`	`layoutParams`
`Int`	`left`
`open Float`	`leftFadingEdgeStrength`
`open Int`	`leftPaddingOffset`
`open Matrix`	`matrix`
`Int`	`measuredHeight`
`Int`	`measuredHeightAndState`
`Int`	`measuredState`
`Int`	`measuredWidth`
`Int`	`measuredWidthAndState`
`open Int`	`minimumHeight`
`open Int`	`minimumWidth`
`open Int`	`nextClusterForwardId`
`open Int`	`nextFocusDownId`
`open Int`	`nextFocusForwardId`
`open Int`	`nextFocusLeftId`
`open Int`	`nextFocusRightId`
`open Int`	`nextFocusUpId`
`open View.OnFocusChangeListener`	`onFocusChangeListener`
`open Int`	`outlineAmbientShadowColor`
`open ViewOutlineProvider`	`outlineProvider`
`open Int`	`outlineSpotShadowColor`
`open Int`	`overScrollMode`
`open Int`	`paddingBottom`
`open Int`	`paddingEnd`
`open Int`	`paddingLeft`
`open Int`	`paddingRight`
`open Int`	`paddingStart`
`open Int`	`paddingTop`
`final ViewParent`	`parent`
`open ViewParent`	`parentForAccessibility`
`OutcomeReceiver<GetCredentialResponse, GetCredentialException>?`	`pendingCredentialCallback`
`GetCredentialRequest?`	`pendingCredentialRequest`
`open Float`	`pivotX`
`open Float`	`pivotY`
`open PointerIcon`	`pointerIcon`
`MutableList<Rect>`	`preferKeepClearRects`
`open Array<String>?`	`receiveContentMimeTypes`
`open Float`	`requestedFrameRate`
`open Resources`	`resources`
`Boolean`	`revealOnFocusHint`
`Int`	`right`
`open Float`	`rightFadingEdgeStrength`
`open Int`	`rightPaddingOffset`
`open AttachedSurfaceControl?`	`rootSurfaceControl`
`open View`	`rootView`
`open WindowInsets`	`rootWindowInsets`
`open Float`	`rotation`
`open Float`	`rotationX`
`open Float`	`rotationY`
`open Float`	`scaleX`
`open Float`	`scaleY`
`open Int`	`scrollBarDefaultDelayBeforeFade`
`open Int`	`scrollBarFadeDuration`
`open Int`	`scrollBarSize`
`open Int`	`scrollBarStyle`
`open Int`	`scrollCaptureHint`
`open Int`	`scrollIndicators`
`Int`	`scrollX`
`Int`	`scrollY`
`open Int`	`solidColor`
`open Int`	`sourceLayoutResId`
`CharSequence?`	`stateDescription`
`open StateListAnimator`	`stateListAnimator`
`open Int`	`suggestedMinimumHeight`
`open Int`	`suggestedMinimumWidth`
`open CharSequence?`	`supplementalDescription`
`open MutableList<Rect>`	`systemGestureExclusionRects`
`open Int`	`systemUiVisibility`
`open Any`	`tag`
`open Int`	`textAlignment`
`open Int`	`textDirection`
`open CharSequence?`	`tooltipText`
`Int`	`top`
`open Float`	`topFadingEdgeStrength`
`open Int`	`topPaddingOffset`
`open TouchDelegate`	`touchDelegate`
`open ArrayList<View>`	`touchables`
`open Float`	`transitionAlpha`
`open String`	`transitionName`
`open Float`	`translationX`
`open Float`	`translationY`
`open Float`	`translationZ`
`open Long`	`uniqueDrawingId`
`open Int`	`verticalFadingEdgeLength`
`open Int`	`verticalScrollbarPosition`
`open Drawable?`	`verticalScrollbarThumbDrawable`
`open Drawable?`	`verticalScrollbarTrackDrawable`
`open Int`	`verticalScrollbarWidth`
`open ViewTranslationResponse?`	`viewTranslationResponse`
`open ViewTreeObserver`	`viewTreeObserver`
`open Int`	`visibility`
`Int`	`width`
`open Int`	`windowAttachCount`
`open WindowId`	`windowId`
`open WindowInsetsController?`	`windowInsetsController`
`open Int`	`windowSystemUiVisibility`
`open IBinder`	`windowToken`
`open Int`	`windowVisibility`
`open Float`	`x`
`open Float`	`y`
`open Float`	`z`

From android.view.ViewGroup

`open Int`	`childCount`
`open Boolean`	`clipChildren`
`open Boolean`	`clipToPadding`
`open Int`	`descendantFocusability`
`open View`	`focusedChild`
`open Boolean`	`isAlwaysDrawnWithCacheEnabled`
`open Boolean`	`isAnimationCacheEnabled`
`open Boolean`	`isChildrenDrawingOrderEnabled`
`open Boolean`	`isChildrenDrawnWithCacheEnabled`
`open Boolean`	`isLayoutSuppressed`
`open Boolean`	`isMotionEventSplittingEnabled`
`open Boolean`	`isTransitionGroup`
`open LayoutAnimationController`	`layoutAnimation`
`open Animation.AnimationListener`	`layoutAnimationListener`
`open Int`	`layoutMode`
`open LayoutTransition`	`layoutTransition`
`open Int`	`nestedScrollAxes`
`open ViewGroupOverlay`	`overlay`
`open Int`	`persistentDrawingCache`
`open Boolean`	`touchscreenBlocksFocus`

Public constructors

InProgressStrokesView

Added in 1.0.0

InProgressStrokesView(
    context: Context,
    attrs: AttributeSet? = null,
    defStyleAttr: @AttrRes Int = 0
)

Public functions

addFinishedStrokesListener

Added in 1.0.0

fun addFinishedStrokesListener(listener: InProgressStrokesFinishedListener): Unit

Add a listener to be notified when strokes are finished. These strokes will continue to be rendered within this view until removeFinishedStrokes is called. All of the strokes that have been delivered to listeners but have not yet been removed with removeFinishedStrokes are available through getFinishedStrokes.

addToStroke

Added in 1.0.0

fun addToStroke(
    event: MotionEvent,
    pointerId: Int,
    prediction: MotionEvent? = null
): Boolean

Add event data for pointerId to the corresponding in-progress stroke, if present. The stroke must have been started with an overload of startStroke that accepts a MotionEvent.

Parameters
`event: MotionEvent`	the next `MotionEvent` as part of a Stroke's input data, typically an ACTION_MOVE.
`pointerId: Int`	the index of the relevant pointer in the `event`. If `pointerId` does not correspond to an in-progress stroke, this call is ignored.
`prediction: MotionEvent? = null`	optional predicted `MotionEvent` containing predicted inputs between event and the time of the next frame, as generated by `androidx.input.motionprediction.MotionEventPredictor.predict`.

Returns
`Boolean`	Whether the pointer corresponds to an in-progress stroke.

addToStroke

Added in 1.0.0

fun addToStroke(
    inputs: StrokeInputBatch,
    strokeId: InProgressStrokeId,
    prediction: StrokeInputBatch = ImmutableStrokeInputBatch.EMPTY
): Unit

Add input data from a StrokeInputBatch to an existing stroke. The stroke must have been started with an overload of startStroke that accepts a StrokeInput.

Parameters
`inputs: StrokeInputBatch`	The next `StrokeInputBatch` to be added to the stroke.
`strokeId: InProgressStrokeId`	The `InProgressStrokeId` of the stroke to be built upon.
`prediction: StrokeInputBatch = ImmutableStrokeInputBatch.EMPTY`	Predicted `StrokeInputBatch` containing predicted inputs between `inputs` and the time of the next frame. This can technically be empty, but it is strongly recommended for it to be non-empty to achieve the best performance.

addToStroke

Added in 1.0.0

fun addToStroke(
    event: MotionEvent,
    pointerId: Int,
    strokeId: InProgressStrokeId,
    prediction: MotionEvent? = null
): Unit

Add input data, from a particular pointer within a MotionEvent, to an existing stroke. The stroke must have been started with an overload of startStroke that accepts a MotionEvent.

Parameters
`event: MotionEvent`	The next `MotionEvent` as part of a stroke's input data, typically one with `MotionEvent.getActionMasked` of `MotionEvent.ACTION_MOVE`.
`pointerId: Int`	The identifier of the pointer within `event` to be used for inking, as determined by `MotionEvent.getPointerId` and used as an input to `MotionEvent.findPointerIndex`. Note that this is the ID of the pointer, not its index.
`strokeId: InProgressStrokeId`	The `InProgressStrokeId` of the stroke to be built upon.
`prediction: MotionEvent? = null`	Predicted `MotionEvent` containing predicted inputs between `event` and the time of the next frame. This value typically comes from `androidx.input.motionprediction.MotionEventPredictor.predict`. It is technically optional, but it is strongly recommended to achieve the best performance.

cancelStroke

Added in 1.0.0

fun cancelStroke(event: MotionEvent, pointerId: Int): Boolean

Cancel the corresponding in-progress stroke with event data for pointerId, if present. The stroke must have been started with an overload of startStroke that accepts a MotionEvent.

Parameters
`event: MotionEvent`	The `MotionEvent` that led to this cancellation, typically an ACTION_CANCEL.
`pointerId: Int`	the id of the relevant pointer in the `event`.

Returns
`Boolean`	Whether the pointer corresponded to an in-progress stroke.

cancelStroke

Added in 1.0.0

fun cancelStroke(strokeId: InProgressStrokeId, event: MotionEvent? = null): Unit

Cancel the building of a stroke. It will no longer be visible within this InProgressStrokesView, and no completed Stroke object will come through InProgressStrokesFinishedListener.

This is typically done for one of three reasons:

A MotionEvent with MotionEvent.getActionMasked of MotionEvent.ACTION_CANCEL. This tends to be when an entire gesture has been canceled, for example when a parent android.view.View uses android.view.ViewGroup.onInterceptTouchEvent to intercept and handle the gesture itself.
A MotionEvent with MotionEvent.getFlags containing MotionEvent.FLAG_CANCELED. This tends to be when the system has detected an unintentional touch, such as from the user resting their palm on the screen while writing or drawing, after some events from that unintentional pointer have already been delivered.
An app's business logic reinterprets a gesture previously used for inking as something else, and the earlier inking may be seen as unintentional. For example, an app that uses single-pointer gestures for inking and dual-pointer gestures for pan/zoom/rotate will start inking when the first pointer goes down, but when the second pointer goes down it may want to cancel the stroke from the first pointer rather than leave the small ink marks on the screen.

Does nothing if a stroke with the given strokeId is not in progress.

Parameters
`strokeId: InProgressStrokeId`	The `InProgressStrokeId` of the stroke to be canceled.
`event: MotionEvent? = null`	The `MotionEvent` that led to this cancellation, if applicable.

cancelUnfinishedStrokes

Added in 1.0.0

fun cancelUnfinishedStrokes(): Unit

Cancel all in-progress strokes.

clearFinishedStrokesListeners

Added in 1.0.0

fun clearFinishedStrokesListeners(): Unit

Removes all listeners that had previously been added with addFinishedStrokesListener.

eagerInit

Added in 1.0.0

fun eagerInit(): Unit

Eagerly initialize rather than waiting for the first stroke to be drawn. Since initialization can be somewhat heavyweight, doing this as soon as it's likely for the user to start drawing can prevent initialization from introducing latency to the first stroke.

finishStroke

Added in 1.0.0

fun finishStroke(event: MotionEvent, pointerId: Int): Boolean

Finish the corresponding in-progress stroke with event data for pointerId, if present. The stroke must have been started with an overload of startStroke that accepts a MotionEvent.

Parameters
`event: MotionEvent`	the last `MotionEvent` as part of a stroke, typically an ACTION_UP.
`pointerId: Int`	the id of the relevant pointer in the `event`. If `pointerId` does not correspond to an in-progress stroke, this call is ignored.

Returns
`Boolean`	Whether the pointer corresponded to an in-progress stroke.

finishStroke

Added in 1.0.0

fun finishStroke(input: StrokeInput, strokeId: InProgressStrokeId): Unit

Complete the building of a stroke, with the last input data coming from a StrokeInput. The stroke must have been started with an overload of startStroke that accepts a StrokeInput.

Parameters
`input: StrokeInput`	The last `StrokeInput` in the stroke.
`strokeId: InProgressStrokeId`	The `InProgressStrokeId` of the stroke to be finished.

finishStroke

Added in 1.0.0

fun finishStroke(
    event: MotionEvent,
    pointerId: Int,
    strokeId: InProgressStrokeId
): Unit

Complete the building of a stroke, with the last input data coming from a particular pointer of a MotionEvent. The stroke must have been started with an overload of startStroke that accepts a MotionEvent.

When the stroke no longer needs to be rendered by this InProgressStrokesView and can instead be rendered anywhere in the android.view.View hierarchy using CanvasStrokeRenderer, the resulting Stroke object will be passed to the InProgressStrokesFinishedListener instances registered with this InProgressStrokesView using addFinishedStrokesListener.

Does nothing if a stroke with the given strokeId is not in progress.

Parameters
`event: MotionEvent`	The last `MotionEvent` as part of a stroke's input data, typically one with `MotionEvent.getActionMasked` of `MotionEvent.ACTION_UP` or `MotionEvent.ACTION_POINTER_UP`, but can also be other actions.
`pointerId: Int`	The identifier of the pointer within `event` to be used for inking, as determined by `MotionEvent.getPointerId` and used as an input to `MotionEvent.findPointerIndex`. Note that this is the ID of the pointer, not its index.
`strokeId: InProgressStrokeId`	The `InProgressStrokeId` of the stroke to be finished.

getFinishedStrokes

Added in 1.0.0

fun getFinishedStrokes(): Map<InProgressStrokeId, Stroke>

Returns all the finished strokes that are still being rendered by this view, with map iteration order in the z-order that the strokes are being rendered, from back to front. This is the same order that strokes were started with startStroke. The IDs of these strokes should be passed to removeFinishedStrokes when they are handed off to another view.

hasUnfinishedStrokes

Added in 1.0.0

fun hasUnfinishedStrokes(): Boolean

Returns true if there are any in-progress strokes.

removeFinishedStrokes

Added in 1.0.0

fun removeFinishedStrokes(strokeIds: Set<InProgressStrokeId>): Unit

Stop this view from rendering the strokes with the given IDs.

This should be called in the same UI thread run loop (HWUI frame) as when the strokes start being rendered elsewhere in the view hierarchy. This means they are saved in a location where they will be picked up in a view's next call to onDraw, and that view's invalidate method has been called. If these two operations are not done within the same UI thread run loop (usually side by side - see example below), then there will be brief rendering errors - either a visual gap where the stroke is not drawn during a frame, or a double draw where the stroke is drawn twice and translucent strokes appear more opaque than they should.

removeFinishedStrokesListener

Added in 1.0.0

fun removeFinishedStrokesListener(
    listener: InProgressStrokesFinishedListener
): Unit

Removes a listener that had previously been added with addFinishedStrokesListener.

startStroke

Added in 1.0.0

fun startStroke(
    input: StrokeInput,
    brush: Brush,
    strokeToViewTransform: Matrix = IDENTITY_MATRIX
): InProgressStrokeId

Start building a stroke with the provided input. This would typically be followed by many calls to addToStroke, and the sequence would end with a call to either finishStroke or cancelStroke.

In most circumstances, the startStroke overload that accepts a MotionEvent is more convenient. However, this overload using a StrokeInput is available for cases where the input data may not come directly from a MotionEvent, such as receiving events over a network connection. Using this function to start a stroke can only be followed by the StrokeInput variants of addToStroke and finishStroke for the same stroke.

If there is a way to request unbuffered dispatch from the source of the input data used here, equivalent to android.view.View.requestUnbufferedDispatch for unbuffered MotionEvent data, then be sure to request it for optimal performance.

Parameters
`input: StrokeInput`	The `StrokeInput` that started a stroke.
`brush: Brush`	Brush specification for the stroke being started. Note that if stroke coordinate units (the `StrokeInput.x` and `StrokeInput.y` fields of `input`) are scaled to be very different in size than screen pixels, then it is recommended to update the value of `Brush.epsilon` to reflect that.
`strokeToViewTransform: Matrix = IDENTITY_MATRIX`	The `Matrix` that converts stroke coordinates as provided in `input` into the coordinate space of this `InProgressStrokesView` for rendering.

Returns
`InProgressStrokeId`	The `InProgressStrokeId` of the stroke being built, later used to identify which stroke is being updated with `addToStroke` or ended with `finishStroke` or `cancelStroke`.

startStroke

Added in 1.0.0

fun startStroke(
    event: MotionEvent,
    pointerId: Int,
    brush: Brush,
    motionEventToWorldTransform: Matrix = IDENTITY_MATRIX,
    strokeToWorldTransform: Matrix = IDENTITY_MATRIX
): InProgressStrokeId

Start building a stroke using a particular pointer within a MotionEvent. This would typically be followed by many calls to addToStroke, and the sequence would end with a call to either finishStroke or cancelStroke.

In most circumstances, prefer to use this function over startStroke that accepts a StrokeInput. Using this function to start a stroke must only be followed by the MotionEvent variants of addToStroke and finishStroke for the same stroke.

For optimum performance, it is strongly recommended to call android.view.View.requestUnbufferedDispatch using event and the android.view.View that generated event alongside calling this function. When requested this way, unbuffered dispatch mode will automatically end when the gesture is complete.

Parameters
`event: MotionEvent`	The first `MotionEvent` as part of a Stroke's input data, typically one with a `MotionEvent.getActionMasked` value of `MotionEvent.ACTION_DOWN` or `MotionEvent.ACTION_POINTER_DOWN`, but not restricted to those action types.
`pointerId: Int`	The identifier of the pointer within `event` to be used for inking, as determined by `MotionEvent.getPointerId` and used as an input to `MotionEvent.findPointerIndex`. Note that this is the ID of the pointer, not its index.
`brush: Brush`	Brush specification for the stroke being started. Note that the overall scaling factor of `motionEventToWorldTransform` and `strokeToWorldTransform` combined should be related to the value of `Brush.epsilon` - in general, the larger the combined `motionEventToStrokeTransform` scaling factor is, the smaller on screen the stroke units are, so `Brush.epsilon` should be a larger quantity of stroke units to maintain a similar screen size.
`motionEventToWorldTransform: Matrix = IDENTITY_MATRIX`	The matrix that transforms `event` coordinates into the client app's "world" coordinates, which typically is defined by how a client app's document is panned/zoomed/rotated. This defaults to the identity matrix, in which case the world coordinate space is the same as the `MotionEvent` coordinates, but the caller should pass in their own value reflecting a coordinate system that is independent of the device's pixel density (e.g. scaled by 1 / `android.util.DisplayMetrics.density`) and any pan/zoom/rotate gestures that have been applied to the "camera" which portrays the "world" on the device screen. This matrix must be invertible.
`strokeToWorldTransform: Matrix = IDENTITY_MATRIX`	Allows an object-specific (stroke-specific) coordinate space to be defined in relation to the caller's "world" coordinate space. This defaults to the identity matrix, which is typical for many use cases at the time of stroke construction. In typical use cases, stroke coordinates and world coordinates may start to differ from one another after stroke creation as a particular stroke is manipulated within the world, e.g. it may be moved, scaled, or rotated relative to other content within an app's document. This matrix must be invertible.

Returns

Returns
`InProgressStrokeId`	The `InProgressStrokeId` of the stroke being built, later used to identify which stroke is being updated with `addToStroke` or ended with `finishStroke` or `cancelStroke`. Callers that assume strokes map one-to-one with pointers in a gesture (as is typical) can skip storing this return value and use the overrides of `addToStroke`, `finishStroke`, and `cancelStroke` that just take a `MotionEvent` and a `pointerId`.

InProgressStrokeId

The InProgressStrokeId of the stroke being built, later used to identify which stroke is being updated with addToStroke or ended with finishStroke or cancelStroke. Callers that assume strokes map one-to-one with pointers in a gesture (as is typical) can skip storing this return value and use the overrides of addToStroke, finishStroke, and cancelStroke that just take a MotionEvent and a pointerId.

Throws
`IllegalArgumentException`	if `motionEventToWorldTransform` or `strokeToWorldTransform` is not invertible.

Protected functions

onAttachedToWindow

protected open fun onAttachedToWindow(): Unit

onDetachedFromWindow

protected open fun onDetachedFromWindow(): Unit

Public properties

inProgressStrokeCounter

Added in 1.0.0

@VisibleForTesting
var inProgressStrokeCounter: CountingIdlingResource?

Allows a test to easily wait until all in-progress strokes are completed and handed off. There is no reason to set this in non-test code.

maskPath

Added in 1.0.0

var maskPath: Path?

Denote an area of this InProgressStrokesView where no ink should be visible. A value of null indicates that strokes will be visible anywhere they are drawn. This is useful for UI elements that float on top of (in Z order) the drawing surface - without this, a user would be able to draw in-progress ("wet") strokes on top of those UI elements, but then when the stroke is finished, it will appear as a dry stroke underneath of the UI element. If this mask is set to the shape and position of the floating UI element, then the ink will never be rendered in that area, making it appear as if it's being drawn underneath the UI element.

This technique is most convincing when the UI element is opaque. Often there are parts of the UI element that are translucent, such as drop shadows, or anti-aliasing along the edges. The result will look a little different between wet and dry strokes for those cases, but it can be a worthwhile tradeoff compared to the alternative of drawing wet strokes on top of that UI element.

Note that this parameter does not affect the contents of the strokes at all, nor how they appear when drawn in a separate composable after InProgressStrokesFinishedListener.onStrokesFinished is called - just how the strokes appear when they are still in progress in this view.

motionEventToViewTransform

Added in 1.0.0

var motionEventToViewTransform: Matrix

The transform matrix to convert MotionEvent coordinates, as passed to startStroke, addToStroke, and finishStroke, into coordinates of this InProgressStrokesView for rendering. Defaults to the identity matrix, for the recommended case where InProgressStrokesView exactly overlays the android.view.View that has the touch listener from which MotionEvent instances are being forwarded.

textureBitmapStore

Added in 1.0.0

var textureBitmapStore: TextureBitmapStore

TextureBitmapStore used to create the CanvasStrokeRenderer.

By default, this is a no-op implementation that does not load any brush textures. The factory functions are called when the renderer is initialized, so if this will be changed to something that does load and store texture images, it must be set before the first call to startStroke or eagerInit.