API reference
API reference
Select your platform
No SDKs available
No versions available

IClippedSurface Interface

An IClippedSurface is a specific type of ISurfacePatch in which the ISurface for both the patch itself and its ISurfacePatch.BackingSurface is the same, but where the solutions to spatial queries against the ISurfacePatch itself are constrained by spatial constraints characterized as TClippers.
The canonical (and most instructive) example of a TClipper is BoundsClipper, which confines solutions to spatial queries against an ISurface to an allowable region within certain spatial bounds; results outside of these bounds will either be rejected outright (for example, for ISurface.Raycast(in UnityEngine.Ray, out SurfaceHit, float) queries) or "clamped" to within the acceptable region (for example, for ISurface.ClosestSurfacePoint(in UnityEngine.Vector3, out SurfaceHit, float) queries). In this way, an IClippedSurface can be thought of as a larger surface which has been trimmed down or "clipped" to a subsection.
Others
TClipper
A type of "trimming" mechanism used to constrain the allowable region of an ISurface

Member Functions

Retrieves the list of "clipper" constraints which are used to confine the ISurfacePatch.BackingSurface to a specific allowable region which serves as the base ISurface of the ISurfacePatch.
As a colloquial example, if the backing surface were defined as a plane with origin v, and GetClippers returned a constraint which mandated, "Only points within 10cm world space of _v_ are considered part of the surface," then the ISurfacePatch itself would be defined as the region of the backing surface which lies within 10cm of v in world space.
Returns
The list of TClipper s which define the ISurfacePatch as a subset of its ISurfacePatch.BackingSurface.
Did you find this page helpful?
Thumbs up icon
Thumbs down icon