Skip to main content Link Menu Expand (external link) Document Search Copy Copied

GRPLTriggerSensor Public class

Description

A simple trigger sensor that detects if a Rhinox hand has entered/exited it.

Diagram 

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

Members

Methods

Public methods

Returns Name
void AddListenerOnSensorEnter(UnityAction action)
A public method that takes a UnityAction parameter and adds it to the OnSensorEnter event’s invocation list.
If the event is null, it instantiates a new UnityEvent.
void AddListenerOnSensorExit(UnityAction action)
A public method that takes a UnityAction parameter and adds it to the OnSensorExit event’s invocation list.
If the event is null, it instantiates a new UnityEvent.
void InvokeOnSensorEnter()
A public method that invokes the OnSensorEnter event.
void InvokeOnSensorExit()
A public method that invokes the OnSensorExit event.
void RemoveAllListenersOnSensorEnter()
A public method that removes all listeners from the OnSensorEnter event’s invocation list.
void RemoveAllListenersOnSensorExit()
A public method that removes all listeners from the OnSensorExit event’s invocation list.
void RemoveListenerOnSensorEnter(UnityAction action)
A public method that removes a UnityAction parameter from the OnSensorEnter event’s invocation list.
void RemoveListenerOnSensorExit(UnityAction action)
A public method that removes a UnityAction parameter from the OnSensorExit event’s invocation list.
void SetIgnoreList(RhinoxJointCapsule[] rhinoxJoinCapsules)
A public method that takes an array of RhinoxJointCapsule objects and sets them to be ignored
from triggering the sensor.

Details

Summary

A simple trigger sensor that detects if a Rhinox hand has entered/exited it.

Remarks

Inheritance

  • MonoBehaviour

Constructors

GRPLTriggerSensor 

public GRPLTriggerSensor()

Methods

SetIgnoreList 

public void SetIgnoreList(RhinoxJointCapsule[] rhinoxJoinCapsules)
Arguments
Type Name Description
RhinoxJointCapsule[] rhinoxJoinCapsules Array of RhinoxJointCapsule gotten from GRPLJointManager
Summary

A public method that takes an array of RhinoxJointCapsule objects and sets them to be ignored from triggering the sensor.

AddListenerOnSensorEnter 

public void AddListenerOnSensorEnter(UnityAction action)
Arguments
Type Name Description
UnityAction action The UnityAction to add.
Summary

A public method that takes a UnityAction parameter and adds it to the OnSensorEnter event’s invocation list. If the event is null, it instantiates a new UnityEvent.

RemoveListenerOnSensorEnter 

public void RemoveListenerOnSensorEnter(UnityAction action)
Arguments
Type Name Description
UnityAction action The UnityAction to remove.
Summary

A public method that removes a UnityAction parameter from the OnSensorEnter event’s invocation list.

RemoveAllListenersOnSensorEnter 

public void RemoveAllListenersOnSensorEnter()
Summary

A public method that removes all listeners from the OnSensorEnter event’s invocation list.

InvokeOnSensorEnter 

public void InvokeOnSensorEnter()
Summary

A public method that invokes the OnSensorEnter event.

AddListenerOnSensorExit 

public void AddListenerOnSensorExit(UnityAction action)
Arguments
Type Name Description
UnityAction action The UnityAction to add.
Summary

A public method that takes a UnityAction parameter and adds it to the OnSensorExit event’s invocation list. If the event is null, it instantiates a new UnityEvent.

RemoveListenerOnSensorExit 

public void RemoveListenerOnSensorExit(UnityAction action)
Arguments
Type Name Description
UnityAction action The UnityAction to remove.
Summary

A public method that removes a UnityAction parameter from the OnSensorExit event’s invocation list.

RemoveAllListenersOnSensorExit 

public void RemoveAllListenersOnSensorExit()
Summary

A public method that removes all listeners from the OnSensorExit event’s invocation list.

InvokeOnSensorExit 

public void InvokeOnSensorExit()
Summary

A public method that invokes the OnSensorExit event.

Generated with ModularDoc