Spatial variables: Difference between revisions

Latest revision as of 09:07, 10 May 2025

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

Spatial variables allow for sampling values and references from points in global space. The values sampled can transition from one value to another as the sample point moves through physical space in relation to spatial variables. They are mainly used via components, but there are ProtoFlux nodes for sampling them as well, in the spatial variables category. Currently there are just two shapes that can be used with spatial variables: box and sphere.

Types of spatial variables

Constant Reference Box/Sphere
Constant Value Box/Sphere
Gradient Value Box
Texture3D Box
Vertex Value Box
Start End Value Sphere

Types of spatial variable drivers/samplers

Value
Boolean
Reference
Type
Min Max Value
Numeric Value

Sampling

Reference variables:

sampled in order of highest explicit priority, then highest blend and then highest ReferenceID

Value Variables:

Each spatial variable shape supports blend distance - blend weight is calculated based on the distance from the "outer shell" of the shape
Blend weight is used for proportional blending and priority computation

Usage

Create a spatial variable from one of the types listed above.
Create a driver/sampler (or multiple) from one of the types listed above. It will sample the value from inside of the shape.

It's that simple! Now, when the sampler is inside of the spatial variable's range, it should output a value.

@@ Line 1: / Line 1: @@
-{{ stub }}{{ upcoming }}
+{{ stub }}
-'''Spatial variables''' are a feature first implemented by Frooxius for setting up audio reverb zones. They allow for sampling values and references from points in global space. They are mainly used via components, but there are ProtoFlux nodes for sampling them as well. Currently there are just two shapes that can be used with spatial variables: box and sphere.
+'''Spatial variables''' allow for sampling [[Value Type|values]] and [[Reference Type|references]] from points in [[Slot transforms|global space]]. The values sampled can transition from one value to another as the sample point moves through physical space in relation to spatial variables. They are mainly used via [[Component|components]], but there are [[ProtoFlux]] nodes for sampling them as well, in the [[:Category:ProtoFlux:Variables:Spatial|spatial variables category]]. Currently there are just two shapes that can be used with spatial variables: box and sphere.
+== Types of spatial variables ==
+* Constant Reference Box/Sphere
+* Constant Value Box/Sphere
+* Gradient Value Box
+* Texture3D Box
+* Vertex Value Box
+* Start End Value Sphere
-Types of spatial variables:
+== Types of spatial variable drivers/samplers ==
+* Value
+* Boolean
+* Reference
+* Type
+* Min Max Value
+* Numeric Value
-- Constant Reference Box/Sphere
+== Sampling ==
+Reference variables:
+* sampled in order of highest explicit priority, then highest blend and then highest ReferenceID
+Value Variables:
+* Each spatial variable shape supports blend distance - blend weight is calculated based on the distance from the "outer shell" of the shape
+* Blend weight is used for proportional blending and priority computation
-- Constant Value Box/Sphere
+== Usage ==
+# Create a spatial variable from [[#Types of spatial variables|one of the types listed above]].
+# Create a driver/sampler (or multiple) from [[#Types of spatial variable drivers/samplers|one of the types listed above]]. It will sample the value from inside of the shape.
+It's that simple! Now, when the sampler is inside of the spatial variable's range, it should output a value.
-- Gradient Value Box
+== See Also ==
+* [[Spatial Variable Standards]]
-- Texture3D Box
+* [[:Category:Components:Data:Spatial]]
+* [[:Category:ProtoFlux:Variables:Spatial]]
-- Vertex Value Box
-- Start End Value Sphere
-Types of spatial variable drivers/samplers:
-- Value
-- Boolean
-- Reference
-- Type
-- Min Max Value
-- Numeric Value
-Usage:
-First you create one of the types of spatial variables listed above, then you can create one of the types of samplers which will sample the value/reference from points inside of the shape.