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

PlaneSurface Class

Extends MonoBehaviour

Properties

Bounds : Bounds
[Get]
The world space axis-aligned bounding box (AABB)
Signature
Bounds Oculus.Interaction.Surfaces.PlaneSurface.Bounds
DoubleSided : bool
[Get][Set]
Signature
bool Oculus.Interaction.Surfaces.PlaneSurface.DoubleSided
Facing : NormalFacing
[Get][Set]
Signature
NormalFacing Oculus.Interaction.Surfaces.PlaneSurface.Facing
Normal : Vector3
[Get]
Signature
Vector3 Oculus.Interaction.Surfaces.PlaneSurface.Normal
Transform : Transform
[Get]
A transform for the surface.
Signature
Transform Oculus.Interaction.Surfaces.PlaneSurface.Transform

Methods

ClosestSurfacePoint ( point , hit , maxDistance )
Find nearest point to surface.
Signature
bool Oculus.Interaction.Surfaces.PlaneSurface.ClosestSurfacePoint(in Vector3 point, out SurfaceHit hit, float maxDistance)
Parameters
point: in Vector3
hit: out SurfaceHit  The returned hit data
maxDistance: float  If greater than zero, maximum distance of check
Returns
bool  true if nearest point was found
GetPlane ()
Signature
Plane Oculus.Interaction.Surfaces.PlaneSurface.GetPlane()
Returns
Plane
InjectAllPlaneSurface ( facing , doubleSided )
Signature
void Oculus.Interaction.Surfaces.PlaneSurface.InjectAllPlaneSurface(NormalFacing facing, bool doubleSided)
Parameters
facing: NormalFacing
doubleSided: bool
Returns
void
InjectDoubleSided ( doubleSided )
Signature
void Oculus.Interaction.Surfaces.PlaneSurface.InjectDoubleSided(bool doubleSided)
Parameters
doubleSided: bool
Returns
void
InjectNormalFacing ( facing )
Signature
void Oculus.Interaction.Surfaces.PlaneSurface.InjectNormalFacing(NormalFacing facing)
Parameters
facing: NormalFacing
Returns
void
Raycast ( ray , hit , maxDistance )
Raycast to the surface with an optional maximum distance value.
Signature
bool Oculus.Interaction.Surfaces.PlaneSurface.Raycast(in Ray ray, out SurfaceHit hit, float maxDistance)
Parameters
ray: in Ray  The ray to cast
hit: out SurfaceHit  The returned hit data
maxDistance: float  If greater than zero, maximum distance of raycast
Returns
bool  true if surface was hit

Inner Enum

NormalFacing Enum

Used for interaction with flat surfaces, and acts in much the same way as Unity’s Plane.

Enumeration Constants

MemberDescription
Backward
Normal faces along the transform's negative Z axis.
Forward
Normal faces along the transform's positive Z axis.