API reference

CylinderSurface Class

Extends MonoBehaviour
Used for interaction with cylindrical surfaces such as a curved UI.

Protected Fields

_started : bool
Signature
bool Oculus.Interaction.Surfaces.CylinderSurface._started

Fields

Cylinder : Cylinder
Signature
Cylinder Oculus.Interaction.Surfaces.CylinderSurface.Cylinder
IsValid : bool
Signature
bool Oculus.Interaction.Surfaces.CylinderSurface.IsValid
Radius : float
Signature
float Oculus.Interaction.Surfaces.CylinderSurface.Radius
Transform : Transform
Signature
Transform Oculus.Interaction.Surfaces.CylinderSurface.Transform

Properties

Bounds : Bounds
[Get]
Signature
Bounds Oculus.Interaction.Surfaces.CylinderSurface.Bounds
Facing : NormalFacing
[Get][Set]
Signature
NormalFacing Oculus.Interaction.Surfaces.CylinderSurface.Facing
Height : float
[Get][Set]
Signature
float Oculus.Interaction.Surfaces.CylinderSurface.Height

Protected Methods

Start ()
Signature
virtual void Oculus.Interaction.Surfaces.CylinderSurface.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.CylinderSurface.ClosestSurfacePoint(in Vector3 point, out SurfaceHit hit, float maxDistance)
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
InjectAllCylinderSurface ( facing , cylinder , height )
Signature
void Oculus.Interaction.Surfaces.CylinderSurface.InjectAllCylinderSurface(NormalFacing facing, Cylinder cylinder, float height)
Parameters
facing: NormalFacing
cylinder: Cylinder
height: float
Returns
void
InjectCylinder ( cylinder )
Signature
void Oculus.Interaction.Surfaces.CylinderSurface.InjectCylinder(Cylinder cylinder)
Parameters
cylinder: Cylinder
Returns
void
InjectHeight ( height )
Signature
void Oculus.Interaction.Surfaces.CylinderSurface.InjectHeight(float height)
Parameters
height: float
Returns
void
InjectNormalFacing ( facing )
Signature
void Oculus.Interaction.Surfaces.CylinderSurface.InjectNormalFacing(NormalFacing facing)
Parameters
facing: NormalFacing
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.CylinderSurface.Raycast(in Ray ray, out SurfaceHit hit, float maxDistance)
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

Inner Enum

NormalFacing Enum

Enumeration Constants

MemberDescription
Any
Raycast hit will register on the outside or inside of the cylinder, whichever is hit first.
In
Raycasts will pass through the outside of the cylinder and hit the inside wall.
Out
Raycast against the outside wall of the cylinder. In this mode, raycasts with an origin inside the cylinder will always fail.