| ... | ... | @@ -19,12 +19,17 @@ The hand tracking component inherits directly from the oculus hand component. Th |
|
|
|
| FGrabSystemEvent | GrabSuccess | This event dispatcher gets called if the grab was successful and we have actually grabbed an actor. |
|
|
|
|
| FGrabSystemEvent | ReleaseSuccess | This event dispatcher gets called if the release was successful and we have actually released an actor. |
|
|
|
|
| FForceRelease | ForceReleaseEvent | This event dispatcher gets called when the function force release is called on this hand and the force release was successful. The event returns the force released actor. |
|
|
|
|
| bool | bSpawnLocomotionComponent | If true locomotion will be available at runtime |
|
|
|
|
| FHTLocomotionParameters | LocomotionParameters | The locomotion parameters passed down to the locomotion component when spawned |
|
|
|
|
| bool | bLaserPointerEnabled | Should this hand auto-spawn for you a laser pointer you can use with widgets and objects that implement a pinchable or selectable interface |
|
|
|
|
| TSubclassOf\<AHTLaserPointerBase\> | LaserPointerClass | The laser pointer class that is used to spawn the laser pointer at runtime |
|
|
|
|
| FLaserPointerParameters | LaserPointerParameters | The laser pointer parameters get applied on the laser pointer when spawned at runtime. |
|
|
|
|
| TArray\<TSubclassOf\<AActor\>\> | PinchActorsToIgnore | A list of actor classes to ignore when trying to detect physical pinching with the primary or secondary pinch collisions |
|
|
|
|
| bool | bPrimaryPinchEnabled | Should the physical primary pinch be enabled on this component? |
|
|
|
|
| TEnumAsByte\<ECollisionChannel\> | PrimaryCollisionChannel | The collision channel for the primary pinch collision |
|
|
|
|
| float | PrimaryPinchCollisionSize | The size of the collision to detect the primary pinch on objects. This size is used to set a box component X and Y box extent values.To visualise what the final box component looks like enable the draw debug property in the Debugging section. |
|
|
|
|
| bool | bSecondaryPinchEnabled | Should the physical secondary pinch be enabled on this component? |
|
|
|
|
| TEnumAsByte\<ECollisionChannel\> | SecondaryCollisionChannel | The collision channel for the secondary pinch collision |
|
|
|
|
| float | SecondaryPinchCollisionSize | The size of the collision to detect the secondary pinch on objects. This size is used to set a box component X and Y box extent values.To visualise what the final box component looks like enable the draw debug property in the Debugging section. |
|
|
|
|
| bool | bEnableOutline | Should the outline be enabled on this hand? |
|
|
|
|
| UMaterialInterface* | OutlineMaterial | The outline is generated by overlapping a second hand on top of the main one. To achieve the outline effect we need a special material that flipsthe hand mesh normals and makes the outline hands slightly bigger than the main hand (using the WorldPositionOffset) . You can replace the defaultmaterial and create your own, however, the material used for the outline should follow the same principles as the M_Outline material. |
|
| ... | ... | @@ -50,8 +55,11 @@ The hand tracking component inherits directly from the oculus hand component. Th |
|
|
|
|
|
|
|
<details><summary>Expand</summary>
|
|
|
|
|
|
|
|
### Initialise
|
|
|
|
If the hand tracking component was set to not auto-initialise you can use this function to manually initialise it.
|
|
|
|
|
|
|
|
### UpdateSkeletalMesh
|
|
|
|
Updates the skeletal mesh of the hand tracking component. This internally also updates the outline skeletal mesh if the outline is valid.
|
|
|
|
Updates the skeletal mesh of the hand tracking component. This internally also updates the outline skeletal. mesh if the outline is valid.
|
|
|
|
|
|
|
|
| Parameter | Type | Tooltip |
|
|
|
|
| ------ | ------ | ------ |
|
| ... | ... | @@ -69,7 +77,7 @@ Get the laser pointer of the specified hand from the specified actor. The actor |
|
|
|
|
|
|
|
| Parameter | Type | Tooltip |
|
|
|
|
| ------ | ------ | ------ |
|
|
|
|
| Actor | AActor* | The actor that will contain the hands on which to find the laser pointer |
|
|
|
|
| Actor | AActor* | The actor that will contain the hands on which to find the laser pointer. |
|
|
|
|
| Hand | EHTHandType | The hand we want the laser pointer of. |
|
|
|
|
| Return | AHTLaserPointerBase* | Returns the laser pointer instance. |
|
|
|
|
|
| ... | ... | @@ -78,13 +86,10 @@ Get the grab component of the specified hand from the specified actor. The actor |
|
|
|
|
|
|
|
| Parameter | Type | Tooltip |
|
|
|
|
| ------ | ------ | ------ |
|
|
|
|
| Actor | AActor* | The actor that will contain the hands on which to find the grab component |
|
|
|
|
| Actor | AActor* | The actor that will contain the hands on which to find the grab component. |
|
|
|
|
| Hand | EHTHandType | The hand we want the grab component of. |
|
|
|
|
| Return | UHTGrabComponent* | Returns the grab component instance. |
|
|
|
|
|
|
|
|
### Initialise
|
|
|
|
If the hand tracking component was set to not auto-initialise you can use this function to manually initialise it.
|
|
|
|
|
|
|
|
### GetHandTrackingOutline
|
|
|
|
Return the hand tracking outline component instance. Can be null.
|
|
|
|
|
| ... | ... | @@ -97,21 +102,21 @@ Enable and disable the hand outline. |
|
|
|
|
|
|
|
| Parameter | Type | Tooltip |
|
|
|
|
| ------ | ------ | ------ |
|
|
|
|
| bNewEnabled | bool | The enabled state. True means enabled, false means disabled |
|
|
|
|
| bNewEnabled | bool | The enabled state. True means enabled, false means disabled. |
|
|
|
|
|
|
|
|
### SetOutlineColour
|
|
|
|
Set the hand outline colour
|
|
|
|
Set the hand outline colour.
|
|
|
|
|
|
|
|
| Parameter | Type | Tooltip |
|
|
|
|
| ------ | ------ | ------ |
|
|
|
|
| NewColour | FLinearColor | The new colour for the outline |
|
|
|
|
| NewColour | FLinearColor | The new colour for the outline. |
|
|
|
|
|
|
|
|
### SetOutlineSize
|
|
|
|
Set the hand outline size
|
|
|
|
Set the hand outline size.
|
|
|
|
|
|
|
|
| Parameter | Type | Tooltip |
|
|
|
|
| ------ | ------ | ------ |
|
|
|
|
| NewSize | float | The new size for the outline |
|
|
|
|
| NewSize | float | The new size for the outline. |
|
|
|
|
|
|
|
|
### UpdatePrimaryPinchCollisionChannel
|
|
|
|
Update the primary pinch collision channel.
|
| ... | ... | @@ -141,8 +146,29 @@ Returns the secondary pinch collision. |
|
|
|
| ------ | ------ | ------ |
|
|
|
|
| Return | UBoxComponent* | The secondary pinch box component. |
|
|
|
|
|
|
|
|
### GetMostRecentHandPose
|
|
|
|
Get the most recent hand pose from the grabbing system.
|
|
|
|
|
|
|
|
| Parameter | Type | Tooltip |
|
|
|
|
| ------ | ------ | ------ |
|
|
|
|
| Return | UHTPoseAsset* | The anim sequence used as a hand pose. |
|
|
|
|
|
|
|
|
### GetGrabComponent
|
|
|
|
Get the grab component spawned at runtime. Can return nullptr/Not Valid.
|
|
|
|
|
|
|
|
| Parameter | Type | Tooltip |
|
|
|
|
| ------ | ------ | ------ |
|
|
|
|
| Return | UHTGrabComponent* | The grab component. |
|
|
|
|
|
|
|
|
### GetDirectTouchInteractionComponent
|
|
|
|
Get the direct touch interaction component spawned by the hand. If not enabled it will return nullptr.
|
|
|
|
|
|
|
|
| Parameter | Type | Tooltip |
|
|
|
|
| ------ | ------ | ------ |
|
|
|
|
| Return | UHTDirectTouchInteractionComponent* | The direct touch interaction component |
|
|
|
|
|
|
|
|
### GetHand
|
|
|
|
Get the hand of this hand tracking component
|
|
|
|
Get the hand of this hand tracking component.
|
|
|
|
|
|
|
|
| Parameter | Type | Tooltip |
|
|
|
|
| ------ | ------ | ------ |
|
| ... | ... | @@ -175,35 +201,35 @@ Return the index interaction collision of this hand tracking component. |
|
|
|
|
|
|
|
| Parameter | Type | Tooltip |
|
|
|
|
| ------ | ------ | ------ |
|
|
|
|
| Return | class | The sphere component collision used to interact with your finger |
|
|
|
|
| Return | class | The sphere component collision used to interact with your finger. |
|
|
|
|
|
|
|
|
### GetMostRecentHandPose
|
|
|
|
Get the most recent hand pose from the grabbing system
|
|
|
|
### SetEnableHandTracking
|
|
|
|
Enable or disable hand tracking on this hand.
|
|
|
|
|
|
|
|
| Parameter | Type | Tooltip |
|
|
|
|
| ------ | ------ | ------ |
|
|
|
|
| Return | UHTPoseAsset* | The anim sequence used as a hand pose |
|
|
|
|
| bEnabled | bool | The new enable state. |
|
|
|
|
|
|
|
|
### GetGrabComponent
|
|
|
|
Get the grab component spawned at runtime. Can return nullptr/Not Valid.
|
|
|
|
### GetUsesCustomHandMesh
|
|
|
|
Return whether this component uses a custom hand skeletal mesh.
|
|
|
|
|
|
|
|
| Parameter | Type | Tooltip |
|
|
|
|
| ------ | ------ | ------ |
|
|
|
|
| Return | UHTGrabComponent* | The grab component. |
|
|
|
|
| Return | bool | True if this component uses a custom hand mesh otherwise false. |
|
|
|
|
|
|
|
|
### SetEnableHandTracking
|
|
|
|
Enable or disable hand tracking on this hand.
|
|
|
|
### GetHandInitialised
|
|
|
|
Returns whether or not the hand has been initialised yet.
|
|
|
|
|
|
|
|
| Parameter | Type | Tooltip |
|
|
|
|
| ------ | ------ | ------ |
|
|
|
|
| bEnabled | bool | The new enable state |
|
|
|
|
| Return | bool | The initialised state. |
|
|
|
|
|
|
|
|
### GetUsesCustomHandMesh
|
|
|
|
Return whether this component uses a custom hand skeletal mesh.
|
|
|
|
### GetLocomotionComponent
|
|
|
|
Return the locomotion component if spawned.
|
|
|
|
|
|
|
|
| Parameter | Type | Tooltip |
|
|
|
|
| ------ | ------ | ------ |
|
|
|
|
| Return | bool | True if this component uses a custom hand mesh otherwise false. |
|
|
|
|
| Return | UHTLocomotionComponent* | The locomotion component. |
|
|
|
|
|
|
|
|
|
|
|
|
</details>
|
| ... | ... | |
