VRTK Wiki

Scripts for observing lists of action related types.

Base class for all Action types.

Each action has a data-type, like float or GameObject.

• Sources: A list of other Actions which this Action listens to.
• UnityEvents:
  • Activation State Changed
  • Activated
  • Value Changed
  • Deactivated

Action that emits a boolean when all the given actions are `Action.IsActivated`.

• Actions: ActionObservableList of actions which all need to be activated.

Action that emits a boolean when any of the given actions are `Action.IsActivated`.

• Actions: ActionObservableList of actions any of which need to be activated.

Action that receives and emits booleans.

Action that receives and emits floats.

An IProcessable which causes an Action to re-emit it's last value each time the process is run.

Action that receives a SurfaceData current and emits when the current and previous positions exceed the specified distance.

Alternates between emitting its Activated and Deactivated events each time Recieve is called.

Action that recieves and emits Vector2 values.

Sets the sources of a target Action based on a list of other Actions.

The sources of an ActionRegistar are of type `ActionSource` which are a Action/GameObject pair. The GameObject is the one that contains the Action.

The ActionRegistrar also maintains a list of GameObjects called the `SourceLimits`. This is basically a filter. Only the ActionSources that have a GameObject in this list are actually added as sources to the target Action.

• Target: The Action whos sources will be set.
• Sources: A list of ActionSources who's Actions will be set as the sources on the Target action.
• SourceLimits: A list of GameObjects denoting valid parent GameObjects.

Abstract class which references a GameObjectObservableList of objects to (de)activate based on abstract boolean method `ShouldBeActive`.

An IProcessable which applies the action of a list of GameObjectsAssociation causing their associated GameObjects to be (de)activated accordingly.

(De)activates GameObjects based on whether the currently loaded XR device name matches the `XrDeviceNamePattern` regular expression.

• XrDeviceNamePattern: Regular expression to match XR device names.

A MonoBehaviour which allows for customizing the settings of a Raycast at edit time in the inspector. This can be used by the various casting components.

Abstract IProcessable for casting components that result in points along the cast.

Each subclass must implement the `DoCastPoints` method. Hits are filtered through the `TargetValidity` rule.

• Origin: Starting point of the cast.
• PhysicsCast: An optional PhysicsCast to configure the raycast.
• TargetValidity: RuleContainer controlling which hits are valid.
• DestinationPointOverride: Override the destination location point in world space.
• TargetHit: `RaycastHit` of the latest hit, or null.
• IsTargetHitValid: Whether the latest `TargetHit` is valid based on `TargetValidity` rule.
• Points: The points along the most recent cast.
• EventData: The EventData for the latest cast.

A StraightLineCast except that it only checks for hits at the end of the limited-distance raycast. If no hit is detected, the second point returned is `null`.

A PointsCast which performs a raycast from an origin and direction to a maximum distance. It returns two points. The first point is the origin. The second point is either the maximum position of the line, or the location of any collider hit along the way.

A PointsCast which returns the points at the origin, target, and a parabolic arc of points in between.

These attributes are used by other Zinnia components to customize their inspector interface. You probably wont need to use these yourself.