Component:TorsoHapticPointMapper: Difference between revisions

From Resonite Wiki
Automated: create new component page
 
add link to haptics page
 
(One intermediate revision by the same user not shown)
Line 3: Line 3:
|Name=Torso Haptic Point Mapper
|Name=Torso Haptic Point Mapper
}}
}}
{{stub}}
The '''TorsoHapticPointMapper''' component is used to tell the game the size of an Avatar's torso and its bones in order for the game to know where to place haptic point samplers so they better match the size and positions of the body.
 
The area makes up a 3d trapezoid with thickness, with a parallel front and back, and top and bottom, but a non parallel left and right.
 
This works as part of the game's robust [[Haptics]] system.


== Usage ==
== Fields ==
{{Table ComponentFields
{{Table ComponentFields
|Priority|Int|
|Priority|Int| The priority of this Mapper over other mappers.
|ShowDebugVisuals|Bool|
|ShowDebugVisuals|Bool| Whether to show the area and haptic point Debug visuals.
|BoneChain|{{RootFieldType|SyncRefList`1|[[Type:Slot|Slot]]}}|TypeAdv2=true|
|BoneChain|{{RootFieldType|SyncRefList`1|[[Type:Slot|Slot]]}}|TypeAdv2=true| A list of bones that make up the center spine of the avatar. (Hips, Spine(s), Chest, upper chest)
|NormalizedStart|Float|
|NormalizedStart|Float| Where in the chain does the haptics mapping start?
|NormalizedEnd|Float|
|NormalizedEnd|Float| Where in the chain does the haptics mapping end?
|LowerWidth|Float|
|LowerWidth|Float| The width of the lower spine.
|UpperWidth|Float|
|UpperWidth|Float| The width of the upper spine.
|FrontOffset|Float|
|FrontOffset|Float| How far the front side is from the spine bones.
|BackOffset|Float|
|BackOffset|Float| How far the back side is from the spine bones.
}}
}}


== Behavior ==
== Usage ==
{{stub}}


== Examples ==
== Examples ==
Attached to the chest of an avatar set up with the [[Avatar Creator]] in order for the avatar to handle mapping haptics to its surface correctly for things like haptics vests or giggle pucks.


== See Also ==
== See Also ==
Line 26: Line 32:
[[Category:Components:Input:Haptics{{#translation:}}|Torso Haptic Point Mapper]]
[[Category:Components:Input:Haptics{{#translation:}}|Torso Haptic Point Mapper]]
[[Category:Components{{#translation:}}|Torso Haptic Point Mapper]]
[[Category:Components{{#translation:}}|Torso Haptic Point Mapper]]
[[Category:ComponentStubs]]

Latest revision as of 20:19, 7 February 2025

Component image 
Torso Haptic Point Mapper component as seen in the Scene Inspector

The TorsoHapticPointMapper component is used to tell the game the size of an Avatar's torso and its bones in order for the game to know where to place haptic point samplers so they better match the size and positions of the body.

The area makes up a 3d trapezoid with thickness, with a parallel front and back, and top and bottom, but a non parallel left and right.

This works as part of the game's robust Haptics system.

Fields

Fields
Name Type Description
persistent Bool Determines whether or not this item will be saved to the server.
UpdateOrder Int Controls the order in which this component is updated.
Enabled Bool Controls whether or not this component is enabled. Some components stop their functionality when this field is disabled, but some don't.
Priority Int The priority of this Mapper over other mappers.
ShowDebugVisuals Bool Whether to show the area and haptic point Debug visuals.
BoneChain list of Slot A list of bones that make up the center spine of the avatar. (Hips, Spine(s), Chest, upper chest)
NormalizedStart Float Where in the chain does the haptics mapping start?
NormalizedEnd Float Where in the chain does the haptics mapping end?
LowerWidth Float The width of the lower spine.
UpperWidth Float The width of the upper spine.
FrontOffset Float How far the front side is from the spine bones.
BackOffset Float How far the back side is from the spine bones.

Usage

This article or section is a Stub. You can help the Resonite Wiki by expanding it.

Examples

Attached to the chest of an avatar set up with the Avatar Creator in order for the avatar to handle mapping haptics to its surface correctly for things like haptics vests or giggle pucks.

See Also