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

CircleSurface Class

Extends MonoBehaviour
Used for interaction with circular surfaces.
Computes the closest world point on a coordinate plane defined by the X and Y axes of the transform, within a provided radius from the transform’s origin.

Fields

BackingSurface : ISurface
Signature
ISurface Oculus.Interaction.Surfaces.CircleSurface.BackingSurface
Transform : Transform
Signature
Transform Oculus.Interaction.Surfaces.CircleSurface.Transform

Protected Methods

Start ()
Signature
virtual void Oculus.Interaction.Surfaces.CircleSurface.Start()
Returns
void

Methods

ClosestSurfacePoint ( point , hit , maxDistance )
Find the nearest point to the surface.
The arguments and outputs of this operation are in world space.
Signature
bool Oculus.Interaction.Surfaces.CircleSurface.ClosestSurfacePoint(in Vector3 point, out SurfaceHit hit, float maxDistance=0)
Parameters
point: in Vector3  The point, in world space, for which the nearest point on the surface must be found
hit: out SurfaceHit  The returned hit data in world space if a nearest point could be found, default otherwise
maxDistance: float  If greater than zero, maximum distance of check; if zero distance is unconstrained
Returns
bool  True if the racyast hit the surface, false otherwise
InjectAllCircleProximityField ( planeSurface )
Signature
void Oculus.Interaction.Surfaces.CircleSurface.InjectAllCircleProximityField(PlaneSurface planeSurface)
Parameters
planeSurface: PlaneSurface
Returns
void
InjectAllCircleSurface ( planeSurface )
Signature
void Oculus.Interaction.Surfaces.CircleSurface.InjectAllCircleSurface(PlaneSurface planeSurface)
Parameters
planeSurface: PlaneSurface
Returns
void
InjectOptionalRadius ( radius )
Signature
void Oculus.Interaction.Surfaces.CircleSurface.InjectOptionalRadius(float radius)
Parameters
radius: float
Returns
void
InjectPlaneSurface ( planeSurface )
Signature
void Oculus.Interaction.Surfaces.CircleSurface.InjectPlaneSurface(PlaneSurface planeSurface)
Parameters
planeSurface: PlaneSurface
Returns
void
Raycast ( ray , hit , maxDistance )
Raycast to the surface with an optional maximum distance value.
The arguments and outputs of this operation are in world space.
Signature
bool Oculus.Interaction.Surfaces.CircleSurface.Raycast(in Ray ray, out SurfaceHit hit, float maxDistance=0)
Parameters
ray: in Ray  The ray to cast, with position and direction both defined in world space
hit: out SurfaceHit  The returned hit data in world space if the raycast hit the surface, default otherwise
maxDistance: float  If greater than zero, maximum distance of raycast; if zero, distance is unconstrained
Returns
bool  True if the raycast hit the surface, false otherwise