Component:CylindricalDistanceHapticFilter: Difference between revisions

From Resonite Wiki
add haptics page link
add info
 
Line 3: Line 3:
|Name=Cylindrical Distance Haptic Filter
|Name=Cylindrical Distance Haptic Filter
}}
}}
{{stub}}
The '''CylindricalDistanceHapticFilter''' component filters haptic device influences multiplicatively depending on their position within a range of 2 cylinders. One being an inner and one being an outer. Both of them are invisible though. This component works when used with a [[Component:HapticVolume]].


This works as part of the game's robust [[Haptics]] system.
This works as part of the game's robust [[Haptics]] system.
Line 9: Line 9:
== Fields ==
== Fields ==
{{Table ComponentFields
{{Table ComponentFields
|StartRadius|Float|
|StartRadius|Float| The starting radius of the intensity gradient based on distance from the cylinders center line from end to end.
|EndRadius|Float|
|EndRadius|Float| The ending radius of the intensity gradient based on distance from the cylinders center line from end to end.
|StartRadiusIntensity|Float|
|StartRadiusIntensity|Float| The starting intensity of the intensity gradient based on distance from the cylinders center line from end to end.
|EndRadiusIntensity|Float|
|EndRadiusIntensity|Float| The ending intensity of the intensity gradient based on distance from the cylinders center line from end to end.
|RadiusPower|Float|
|RadiusPower|Float| The amplification of the intensity gradient based on distance from the cylinders center line from end to end.
|StartAxisOffset|Float|
|StartAxisOffset|Float| Used to define the distance from the cylinder end cap to start the intensity gradient.
|EndAxisOffset|Float|
|EndAxisOffset|Float| Used to define the distance from the cylinder end cap to end the intensity gradient.
|StartAxisIntensity|Float|
|StartAxisIntensity|Float| The starting intensity value for the intensity gradient based on the distance to the cylinder cap.
|EndAxisIntensity|Float|
|EndAxisIntensity|Float| The ending intensity value for the intensity gradient based on the distance to the cylinder cap.
|AxisPower|Float|
|AxisPower|Float| How much to amplify the intensity of the intensity gradient based on the distance to the cylinder cap.
}}
}}


== Usage ==
== Usage ==
Attach to a slot with a valid and working [[Component:HapticVolume]] to add to the list of multiplicative haptic filters.


== Examples ==
== Examples ==
{{stub}}


== See Also ==
== See Also ==
Line 29: Line 31:
[[Category:Components:Input:Haptics:Filters{{#translation:}}|Cylindrical Distance Haptic Filter]]
[[Category:Components:Input:Haptics:Filters{{#translation:}}|Cylindrical Distance Haptic Filter]]
[[Category:Components{{#translation:}}|Cylindrical Distance Haptic Filter]]
[[Category:Components{{#translation:}}|Cylindrical Distance Haptic Filter]]
[[Category:ComponentStubs]]

Latest revision as of 21:01, 7 February 2025

Component image 
Cylindrical Distance Haptic Filter component as seen in the Scene Inspector

The CylindricalDistanceHapticFilter component filters haptic device influences multiplicatively depending on their position within a range of 2 cylinders. One being an inner and one being an outer. Both of them are invisible though. This component works when used with a Component:HapticVolume.

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.
StartRadius Float The starting radius of the intensity gradient based on distance from the cylinders center line from end to end.
EndRadius Float The ending radius of the intensity gradient based on distance from the cylinders center line from end to end.
StartRadiusIntensity Float The starting intensity of the intensity gradient based on distance from the cylinders center line from end to end.
EndRadiusIntensity Float The ending intensity of the intensity gradient based on distance from the cylinders center line from end to end.
RadiusPower Float The amplification of the intensity gradient based on distance from the cylinders center line from end to end.
StartAxisOffset Float Used to define the distance from the cylinder end cap to start the intensity gradient.
EndAxisOffset Float Used to define the distance from the cylinder end cap to end the intensity gradient.
StartAxisIntensity Float The starting intensity value for the intensity gradient based on the distance to the cylinder cap.
EndAxisIntensity Float The ending intensity value for the intensity gradient based on the distance to the cylinder cap.
AxisPower Float How much to amplify the intensity of the intensity gradient based on the distance to the cylinder cap.

Usage

Attach to a slot with a valid and working Component:HapticVolume to add to the list of multiplicative haptic filters.

Examples

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


See Also