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

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

Properties

Bounds : Bounds
[Get]
The world space axis-aligned bounding box (AABB)
Signature
Bounds Oculus.Interaction.Surfaces.CylinderSurface.Bounds
Cylinder : Cylinder
[Get]
Signature
Cylinder Oculus.Interaction.Surfaces.CylinderSurface.Cylinder
Facing : NormalFacing
[Get][Set]
Signature
NormalFacing Oculus.Interaction.Surfaces.CylinderSurface.Facing
Height : float
[Get][Set]
Signature
float Oculus.Interaction.Surfaces.CylinderSurface.Height
IsValid : bool
[Get]
Signature
bool Oculus.Interaction.Surfaces.CylinderSurface.IsValid
Radius : float
[Get]
Signature
float Oculus.Interaction.Surfaces.CylinderSurface.Radius
Transform : Transform
[Get]
A transform for the surface.
Signature
Transform Oculus.Interaction.Surfaces.CylinderSurface.Transform

Protected Methods

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

Methods

ClosestSurfacePoint ( point , hit , maxDistance )
Find nearest point to surface.
Signature
bool Oculus.Interaction.Surfaces.CylinderSurface.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
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.
Signature
bool Oculus.Interaction.Surfaces.CylinderSurface.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

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.