OculusSampleFramework.RayTool Class Reference

Ray tool used for far-field interactions. More...

Inheritance diagram for OculusSampleFramework.RayTool:
OculusSampleFramework.InteractableTool

Public Member Functions

override void Initialize ()
 
override List< InteractableCollisionInfoGetNextIntersectingObjects ()
 
override void FocusOnInteractable (Interactable focusedInteractable, ColliderZone colliderZone)
 Used to tell the tool to "focus" on a specific object, if focusing is indeed possible given the tool type. More...
 
override void DeFocus ()
 
- Public Member Functions inherited from OculusSampleFramework.InteractableTool
List< InteractableCollisionInfoGetCurrentIntersectingObjects ()
 
KeyValuePair< Interactable, InteractableCollisionInfoGetFirstCurrentCollisionInfo ()
 
void ClearAllCurrentCollisionInfos ()
 
virtual void UpdateCurrentCollisionsBasedOnDepth ()
 For each intersecting interactable, update meta data to indicate deepest collision only. More...
 
virtual void UpdateLatestCollisionData ()
 If our collision information changed per frame, make note of it. Removed, added and remaining objects must get their proper events. More...
 

Properties

override InteractableToolTags ToolTags [get]
 
override ToolInputState ToolInputState [get]
 
override bool IsFarFieldTool [get]
 
override bool EnableState [get, set]
 
- Properties inherited from OculusSampleFramework.InteractableTool
Transform ToolTransform [get]
 
bool IsRightHandedTool [get, set]
 
abstract InteractableToolTags ToolTags [get]
 
abstract ToolInputState ToolInputState [get]
 
abstract bool IsFarFieldTool [get]
 
Vector3 Velocity [get, protected set]
 
Vector3 InteractionPosition [get, protected set]
 Sometimes we want the position of a tool for stuff like pokes. More...
 
abstract bool EnableState [get, set]
 

Additional Inherited Members

- Protected Attributes inherited from OculusSampleFramework.InteractableTool
List< InteractableCollisionInfo_currentIntersectingObjects
 List of objects that intersect tool. More...
 

Detailed Description

Ray tool used for far-field interactions.

Member Function Documentation

◆ DeFocus()

override void OculusSampleFramework.RayTool.DeFocus ( )
virtual

◆ FocusOnInteractable()

override void OculusSampleFramework.RayTool.FocusOnInteractable ( Interactable  focusedInteractable,
ColliderZone  colliderZone 
)
virtual

Used to tell the tool to "focus" on a specific object, if focusing is indeed possible given the tool type.

Parameters
focusedInteractableInteractable to focus.
colliderZoneCollider zone of interactable.

Implements OculusSampleFramework.InteractableTool.

◆ GetNextIntersectingObjects()

override List<InteractableCollisionInfo> OculusSampleFramework.RayTool.GetNextIntersectingObjects ( )
virtual

◆ Initialize()

override void OculusSampleFramework.RayTool.Initialize ( )
virtual

Property Documentation

◆ EnableState

override bool OculusSampleFramework.RayTool.EnableState
getset

◆ IsFarFieldTool

override bool OculusSampleFramework.RayTool.IsFarFieldTool
get

◆ ToolInputState

override ToolInputState OculusSampleFramework.RayTool.ToolInputState
get

◆ ToolTags

override InteractableToolTags OculusSampleFramework.RayTool.ToolTags
get

The documentation for this class was generated from the following file:
  • Oculus/SampleFramework/Core/HandsInteraction/Scripts/Tools/RayTool.cs