API reference

ShapeRecognizerActiveState Class

Extends MonoBehaviour
Implements IActiveState
Used during hand pose detection to compare the current state of a hand's fingers to the state required by a given shape.
The shape's required state is defined in a <cref="ShapeRecognizer" />. If the two match, this state becomes active.

Protected Fields

FingerFeatureStateProvider : IFingerFeatureStateProvider
Signature
IFingerFeatureStateProvider FingerFeatureStateProvider

Properties

Active : bool
[Get]
Evaluates the current state of the component and returns whether it is active.
The logic for determining the active state is defined by the implementing class. This method is typically used in interaction scripts to check whether a certain condition is met before triggering an event or action. For example implementations, please refer to HandActiveState.Active and ActiveStateGroup.Active.
Signature
bool Active
Hand : IHand
[Get]
Signature
IHand Hand
Handedness : Handedness
[Get]
Signature
Handedness Handedness
Shapes : IReadOnlyList< ShapeRecognizer >
[Get]
Signature
IReadOnlyList<ShapeRecognizer> Shapes

Protected Methods

Awake ()
Signature
virtual void Awake()
Returns
void
Start ()
Signature
virtual void Start()
Returns
void

Methods

InjectAllShapeRecognizerActiveState ( hand , fingerFeatureStateProvider , shapes )
Signature
void InjectAllShapeRecognizerActiveState(IHand hand, IFingerFeatureStateProvider fingerFeatureStateProvider, ShapeRecognizer[] shapes)
Parameters
hand: IHand
fingerFeatureStateProvider: IFingerFeatureStateProvider
shapes: ShapeRecognizer[]
Returns
void
InjectFingerFeatureStateProvider ( fingerFeatureStateProvider )
Signature
void InjectFingerFeatureStateProvider(IFingerFeatureStateProvider fingerFeatureStateProvider)
Parameters
fingerFeatureStateProvider: IFingerFeatureStateProvider
Returns
void
InjectHand ( hand )
Signature
void InjectHand(IHand hand)
Parameters
hand: IHand
Returns
void
InjectShapes ( shapes )
Signature
void InjectShapes(ShapeRecognizer[] shapes)
Parameters
shapes: ShapeRecognizer[]
Returns
void