GRPLUISliderInteractable Public class

Description

This class represents an interactable slider. It derives from GRPLInteractable, and it contains properties and methods to handle interaction with a hands. It also extends the basic functionality of a Unity Slider component to add hand tracking specific features.

Diagram

  flowchart LR
  classDef interfaceStyle stroke-dasharray: 5 5;
  classDef abstractStyle stroke-width:4px
  subgraph Rhinox.XR.Grapple.It
  Rhinox.XR.Grapple.It.GRPLUISliderInteractable[[GRPLUISliderInteractable]]
  Rhinox.XR.Grapple.It.GRPLInteractable[[GRPLInteractable]]
  class Rhinox.XR.Grapple.It.GRPLInteractable abstractStyle;
  end
Rhinox.XR.Grapple.It.GRPLInteractable --> Rhinox.XR.Grapple.It.GRPLUISliderInteractable

Members

Properties

Public properties

Methods

Protected methods

Public methods

Details

Summary

This class represents an interactable slider. It derives from GRPLInteractable, and it contains properties and methods to handle interaction with a hands. It also extends the basic functionality of a Unity Slider component to add hand tracking specific features.

Remarks

Inheritance

• GRPLInteractable

Constructors

GRPLUISliderInteractable

public GRPLUISliderInteractable()

Methods

Initialize

protected override void Initialize()

Summary

This method initializes the slider’s components and sets its initial values.

GetReferenceTransform

public override Transform GetReferenceTransform()

Summary

This method returns the Transform component of the slider’s handle.

Returns

The Transform component of the slider’s handle.

CheckForInteraction

public override bool CheckForInteraction(RhinoxJoint joint, RhinoxHand hand)

Arguments

Summary

This method checks whether a given RhinoxJoint is interacting with the slider. It returns a boolean value that indicates whether the interaction is successful.

Returns

Whether the interaction is successful

TryGetCurrentInteractJoint

public override bool TryGetCurrentInteractJoint(ICollection<RhinoxJoint> joints, out RhinoxJoint outJoint, RhinoxHand hand)

Arguments

ShouldInteractionCheckStop

public override bool ShouldInteractionCheckStop()

InteractStarted

protected override void InteractStarted()

Properties

SliderValue

public float SliderValue { get; }

Summary

A float property that returns the current value of the slider.

Events

OnValueUpdate

public event Action<GRPLUISliderInteractable, float> OnValueUpdate

Summary

An event that is triggered whenever the slider’s value is updated.

Generated with ModularDoc