Shared Types
This module contains the constants and structs related to shared types.
Constants
The following are the constants that the Interhaptics extension defines. All of them are defined as an enum.
Structs
The Interhaptics extension also defines a Struct:
Articles
INTERHAPTICS_OPERATOR
Interhaptics Constant INTERHAPTICS_OPERATOR
This enum represents operators used in the haptic body mapping. The possible values are:
| Member | Description |
|---|---|
| MINUS | Represents a minus operator (-1) |
| NEUTRAL | Represents a neutral operator (0) |
| PLUS | Represents a plus operator (1) |
INTERHAPTICS_LATERAL_FLAG
Interhaptics Constant INTERHAPTICS_LATERAL_FLAG
This enum represents the lateral position of a body part. The possible values are:
| Member | Description |
|---|---|
| UnknownPosition | Represents an unknown position. (-1) |
| GLOBAL | Represents the global position. (0) |
| RIGHT | Represents the right position. (1) |
| LEFT | Represents the left position. (2) |
| CENTER | Represents the center position. (3) |
INTERHAPTICS_GROUP_ID
Interhaptics Constant INTERHAPTICS_GROUP_ID
The GroupID enum represents the group IDs for different body parts. Each group has a unique ID assigned to it for grouping purposes. The following are some of the groups and their corresponding IDs:
| Member | Description |
|---|---|
| UNKNOWN | Represents an unknown group. ID -1 |
| ALL | Represents all body parts. ID 0 |
| TOP | Represents the top portion of the body. ID 100 |
| DOWN | Represents the lower portion of the body. ID 101 |
| ARM | Represents the arm group. ID 200 |
| HEAD | Represents the head group. ID 201 |
| CHEST | Represents the chest group. ID 202 |
| WAIST | Represents the waist group. ID 203 |
| LEG | Represents the leg group. ID 204 |
| UPPER_ARM | Represents the upper arm group. ID 300 |
| LOWER_ARM | Represents the lower arm group. ID 301 |
| HAND | Represents the hand group. ID 302 |
| SKULL | Represents the skull group. ID 303 |
| NECK | Represents the neck group. ID 304 |
| UPPER_LEG | Represents the upper leg group. ID 305 |
| LOWER_LEG | Represents the lower leg group. ID 306 |
| FOOT | Represents the foot group. ID 307 |
| PALM | Represents the palm group. ID 400 |
| FINGER | Represents the finger group. ID 401 |
| SOLE | Represents the sole group. ID 402 |
| TOE | Represents the toe group. ID 403 |
| THUMB | Represents the thumb group. ID 500 |
| INDEX | Represents the index finger group. ID 501 |
| MIDDLE | Represents the middle finger group. ID 502 |
| RING | Represents the ring finger group. ID 503 |
| PINKY | Represents the pinky finger group. ID 504 |
| HALLUX | Represents the hallux group. ID 505 |
| INDEX_TOE | Represents the index toe group. ID 506 |
| MIDDLE_TOE | Represents the middle toe group. ID 507 |
| RING_TOE | Represents the ring toe group. ID 508 |
| PINKY_TOE | Represents the pinky toe group. ID 509 |
| FIRST | Represents the first segment group. ID 600 |
| SECOND | Represents the second segment group. ID 601 |
| THIRD | Represents the third segment group. ID 602 |
Interhaptics_CommandData
Interhaptics Constant Interhaptics_CommandData
This structure represents an instruction that is useful for finding the body part to render. It contains the following members:
This struct is referenced by the following functions:
- interhaptics_add_target_to_event
- interhaptics_remove_target_from_event
- interhaptics_update_event_positions
- interhaptics_set_target_intensity
| Member | Type | Description |
|---|---|---|
| Sign | Any | {constant.INTERHAPTICS_OPERATOR} Represents the sign of the operation (+/-) of type Operator. |
| Group | Any | {constant.INTERHAPTICS_GROUP_ID} Represents the group targeted of type INTERHAPTICS_GROUP_ID. |
| Side | Any | {constant.INTERHAPTICS_LATERAL_FLAG} Represents the side targeted of type INTERHAPTICS_LATERAL_FLAG. |