TheAutopilot (talk | contribs) added a few variable categories and recommendations |
TheAutopilot (talk | contribs) added example values for physical properties |
||
| Line 42: | Line 42: | ||
|float | |float | ||
|K | |K | ||
|temperature | |temperature (0K = -273.15°C, 273.15K = 0°C) | ||
Typical temperatures for reference: | |||
- Freezing water: 273.15K (=0°C) | |||
- Boiling water (sea level): 373.15K (=100°C) | |||
- Igniting wood: 553-613K (=280-340°C) | |||
- Igniting gasoline: 493-733K (=220-460°C) | |||
- Igniting propane: 743K (=470°C) | |||
- Wood flame (air): 1300K (=1027°K) | |||
- Gasoline flame: 1299K (=1026°C) | |||
- Propane flame (air): 1473-1973K (=1200-1700°C) | |||
|Default: 288.15 K (= 15°C) | |Default: 288.15 K (= 15°C) | ||
| | | | ||
|TheAutopilot, 2025 | |TheAutopilot, 2025 | ||
|- | |- | ||
| Line 51: | Line 60: | ||
|Pa | |Pa | ||
|pressure | |pressure | ||
Typical pressures for reference: | |||
- sea level: 101325 Pa | |||
- exponential decrease by 50% per 5400m altitude | |||
- every 1m under water: add 9810 Pa | |||
|Default: 101325 Pa | |Default: 101325 Pa | ||
| | | | ||
Revision as of 01:10, 10 May 2025
Spatial Variables are a powerful feature allowing you to define location-dependent values. To support seamless interaction between independently developed objects it is necessary to follow standards for naming, types, content and sampling of spatial variables.
This article collects several community-proposed standards made with the goal that other users - instead of creating their own - reuse them for compatibility with other creations.
Recommendations
To avoid the risk of naming conflicts it is recommended to follow the naming standard "Prefix.Variable" where a shared prefix groups related variables together.
Using CamelCase would make all future proposals consistent to the existing ones.
Official Variables
The following variables are defaults used by FrooxEngine:
| Variable | Type | Interpretation | Sampling Recommendation | Notes | Proposed by/when |
|---|---|---|---|---|---|
| Resonite.Audio.Filters | AudioDSP_Effect | audio effects like reverb that are in effect in an area | Sample via the ReferenceSpatialVariableCollector | Official by Resonite. | Frooxius, 2025 |
Physical Quantities
Temperature, pressure and other values can vary greatly between different locations. (i.e. temperature within fire vs. temperature of an ice cube)
| Variable | Type | Unit | Interpretation | Sampling Recommendation | Notes | Proposed by/when |
|---|---|---|---|---|---|---|
| Physics.Temperature | float | K | temperature (0K = -273.15°C, 273.15K = 0°C)
Typical temperatures for reference: - Freezing water: 273.15K (=0°C) - Boiling water (sea level): 373.15K (=100°C) - Igniting wood: 553-613K (=280-340°C) - Igniting gasoline: 493-733K (=220-460°C) - Igniting propane: 743K (=470°C) - Wood flame (air): 1300K (=1027°K) - Gasoline flame: 1299K (=1026°C) - Propane flame (air): 1473-1973K (=1200-1700°C) |
Default: 288.15 K (= 15°C) | TheAutopilot, 2025 | |
| Physics.Pressure | float | Pa | pressure
Typical pressures for reference: - sea level: 101325 Pa - exponential decrease by 50% per 5400m altitude - every 1m under water: add 9810 Pa |
Default: 101325 Pa | TheAutopilot, 2025 | |
| Physics.Gravity | float3 | m/s² | global acceleration due to gravity | Default: [0;-9.81;0] m/s² | TheAutopilot, 2025 | |
| Physics.Force | float3 | N | global force applied to all objects within the field | Default: [0;0;0] N | TheAutopilot, 2025 | |
| Physics.Density | float | kg/m³ | density of the gas/liquid/solid at the sampled position | Default: 1.225 kg/m³ (air) | TheAutopilot, 2025 | |
| Physics.Velocity | float3 | m/s | global velocity of the gas or liquid at the sampled position | Default: [0;0;0] m/s | TheAutopilot, 2025 |
Logical Properties
| Variable | Type | Interpretation | Sampling Recommendation | Notes | Proposed by/when |
|---|---|---|---|---|---|