RhinoxGesture Public class
Description
The RhinoxGesture class represents a gesture in the Rhinox XR Grapple module. It contains data related to a gesture, such as the name, finger bend values, joint forward, distance and rotation thresholds, and events that are invoked when the gesture is recognized or unrecognized.
Diagram
flowchart LR
classDef interfaceStyle stroke-dasharray: 5 5;
classDef abstractStyle stroke-width:4px
subgraph Rhinox.XR.Grapple
Rhinox.XR.Grapple.RhinoxGesture[[RhinoxGesture]]
end
Members
Methods
Public methods
| Returns | Name |
|---|---|
void | AddListenerOnRecognized(UnityAction<RhinoxHand> action) |
void | AddListenerOnUnRecognized(UnityAction<RhinoxHand> action) |
bool | Equals(...) |
int | GetHashCode() |
void | InvokeOnRecognized(RhinoxHand hand)Invokes the OnRecognized event with the provided RhinoxHand parameter. |
void | InvokeOnUnRecognized(RhinoxHand hand)Invokes the OnUnrecognized event with the provided RhinoxHand parameter. |
void | RemoveAllListenersOnRecognized()Removes all listeners from the OnRecognized event. |
void | RemoveAllListenersOnUnRecognized()Removes all listeners from the OnUnrecognized event. |
void | RemoveListenerOnRecognized(UnityAction<RhinoxHand> action) |
void | RemoveListenerOnUnRecognized(UnityAction<RhinoxHand> action) |
Public Static methods
| Returns | Name |
|---|---|
bool | operator !=(RhinoxGesture obj1, RhinoxGesture obj2) |
bool | operator ==(RhinoxGesture gestureOne, RhinoxGesture gestureTwo) |
RhinoxGesture | NoGesture()Returns an instance of RhinoxGesture with default values, representing the absence of a gesture. |
Details
Summary
The RhinoxGesture class represents a gesture in the Rhinox XR Grapple module. It contains data related to a gesture, such as the name, finger bend values, joint forward, distance and rotation thresholds, and events that are invoked when the gesture is recognized or unrecognized.
Constructors
RhinoxGesture
public RhinoxGesture()
Methods
AddListenerOnRecognized
public void AddListenerOnRecognized(UnityAction<RhinoxHand> action)
Arguments
| Type | Name | Description |
|---|---|---|
UnityAction<RhinoxHand> | action |
RemoveListenerOnRecognized
public void RemoveListenerOnRecognized(UnityAction<RhinoxHand> action)
Arguments
| Type | Name | Description |
|---|---|---|
UnityAction<RhinoxHand> | action |
RemoveAllListenersOnRecognized
public void RemoveAllListenersOnRecognized()
Summary
Removes all listeners from the OnRecognized event.
InvokeOnRecognized
public void InvokeOnRecognized(RhinoxHand hand)
Arguments
| Type | Name | Description |
|---|---|---|
RhinoxHand | hand |
Summary
Invokes the OnRecognized event with the provided RhinoxHand parameter.
AddListenerOnUnRecognized
public void AddListenerOnUnRecognized(UnityAction<RhinoxHand> action)
Arguments
| Type | Name | Description |
|---|---|---|
UnityAction<RhinoxHand> | action |
RemoveListenerOnUnRecognized
public void RemoveListenerOnUnRecognized(UnityAction<RhinoxHand> action)
Arguments
| Type | Name | Description |
|---|---|---|
UnityAction<RhinoxHand> | action |
RemoveAllListenersOnUnRecognized
public void RemoveAllListenersOnUnRecognized()
Summary
Removes all listeners from the OnUnrecognized event.
InvokeOnUnRecognized
public void InvokeOnUnRecognized(RhinoxHand hand)
Arguments
| Type | Name | Description |
|---|---|---|
RhinoxHand | hand |
Summary
Invokes the OnUnrecognized event with the provided RhinoxHand parameter.
Equals [1/2]
public override bool Equals(object obj)
Arguments
| Type | Name | Description |
|---|---|---|
object | obj |
Remarks
Does not compare the name or events!
GetHashCode
public override int GetHashCode()
Equals [2/2]
public bool Equals(RhinoxGesture other)
Arguments
| Type | Name | Description |
|---|---|---|
RhinoxGesture | other |
Operator ==
public static bool operator ==(RhinoxGesture gestureOne, RhinoxGesture gestureTwo)
Arguments
| Type | Name | Description |
|---|---|---|
RhinoxGesture | gestureOne | |
RhinoxGesture | gestureTwo |
Operator !=
public static bool operator !=(RhinoxGesture obj1, RhinoxGesture obj2)
Arguments
| Type | Name | Description |
|---|---|---|
RhinoxGesture | obj1 | |
RhinoxGesture | obj2 |
NoGesture
public static RhinoxGesture NoGesture()
Summary
Returns an instance of RhinoxGesture with default values, representing the absence of a gesture.
Returns
The empty instance.
Generated with ModularDoc