Surface Patch

A SurfacePatch is a portion of a Surface component. It defines the interactable surface of UI elements like buttons or canvases. There are two kinds of SurfacePatch, ClippedPlaneSurface for planes and ClippedCylinderSurface for cylinders. To create a SurfacePatch, crop a surface using a list of Clipper components. Clipper components specify the parts of the surface that are interactable (able to detect interactions).

ClippedPlaneSurface uses a PlaneSurface and takes a list of bounds clippers to crop the surface to a finite poke area. If there are no clippers assigned, the surface area remains infinite.

BoundsClipper clips a PlaneSurface. Each BoundsClipper represents a bounding box, similar to Unity’s BoxCollider.

There are two ways to clip a cylinder. You can manually clip a cylinder using ClippedCylinderSurface, which takes a CylinderSurface and a list of cylinder clippers that crop the cylinder area to the desired size. If you have an existing curved UI panel, you can automatically clip the cylinder to the size of the panel with CanvasCylinder. It clips the surface down to the curved UI panel size at runtime.

CylinderClipper clips a CylinderSurface. Each CylinderClipper represents the parameters of a cylinder segment.