API reference
API reference
Select your platform
No SDKs available
No versions available

ShapeRecognizer Class

Extends ScriptableObject
Asset characterizing a "hand shape" which can be recognized.
Despite its name, this type does not actively recognize anything but merely stores the data, in the form of per-finger FingerFeatureConfigLists, which is needed for a ShapeRecognizerActiveState to perform the calculations needed to determine whether the described hand shape has been recognized or not. In this sense, ShapeRecognizer might be thought of as a definition or descriptor of a hand shape.

Fields

The list of FingerFeatureConfigs which must be satisfied for the thumb to be acceptable for recognition by this ShapeRecognizer.
For an overview of the role of this list in shape recognition, see the remarks on FingerFeatureConfigList.
The list of FingerFeatureConfigs which must be satisfied for the index finger to be acceptable for recognition by this ShapeRecognizer.
For an overview of the role of this list in shape recognition, see the remarks on FingerFeatureConfigList.
The list of FingerFeatureConfigs which must be satisfied for the middle finger to be acceptable for recognition by this ShapeRecognizer.
For an overview of the role of this list in shape recognition, see the remarks on FingerFeatureConfigList.
The list of FingerFeatureConfigs which must be satisfied for the ring finger to be acceptable for recognition by this ShapeRecognizer.
For an overview of the role of this list in shape recognition, see the remarks on FingerFeatureConfigList.
The list of FingerFeatureConfigs which must be satisfied for the pinky finger to be acceptable for recognition by this ShapeRecognizer.
For an overview of the role of this list in shape recognition, see the remarks on FingerFeatureConfigList.
The human-readable name assigned to this hand shape.

Member Functions

Retrieves the list of FingerFeatureConfigs which must be satisfied for the provided finger to be acceptable for recognition by this ShapeRecognizer.
This is a equivalent to calling ThumbFeatureConfigs/IndexFeatureConfigs/etc. for the finger in question.
Parameters
finger
The finger for which to retrieve the list of required FingerFeatureConfigs.
Returns
The list of required FingerFeatureConfigs for finger .
Enumerates the required FingerFeatureConfigs for each finger in this ShapeRecognizer.
This is a convenience method equivalent to calling GetFingerFeatureConfigs(HandFinger) for every finger in turn.
Returns
An iterator exposing, in turn, each finger and its associated FingerFeatureConfigs as a tuple.
Sets the FingerFeatureConfigs for all fingers for a dynamically instantiated ShapeRecognizer.
This method exists to support Interaction SDK's dependency injection pattern and is not needed for typical Unity Editor-based usage.
Sets the FingerFeatureConfigs for the thumb for a dynamically instantiated ShapeRecognizer.
This method exists to support Interaction SDK's dependency injection pattern and is not needed for typical Unity Editor-based usage.
Sets the FingerFeatureConfigs for the index finger for a dynamically instantiated ShapeRecognizer.
This method exists to support Interaction SDK's dependency injection pattern and is not needed for typical Unity Editor-based usage.
Sets the FingerFeatureConfigs for the middle finger for a dynamically instantiated ShapeRecognizer.
This method exists to support Interaction SDK's dependency injection pattern and is not needed for typical Unity Editor-based usage.
Sets the FingerFeatureConfigs for the ring finger for a dynamically instantiated ShapeRecognizer.
This method exists to support Interaction SDK's dependency injection pattern and is not needed for typical Unity Editor-based usage.
Sets the FingerFeatureConfigs for the pinky finger for a dynamically instantiated ShapeRecognizer.
This method exists to support Interaction SDK's dependency injection pattern and is not needed for typical Unity Editor-based usage.
Sets the ShapeName for a dynamically instantiated ShapeRecognizer.
This method exists to support Interaction SDK's dependency injection pattern and is not needed for typical Unity Editor-based usage.
Did you find this page helpful?
Thumbs up icon
Thumbs down icon