Spatial variables: Difference between revisions

From Resonite Wiki
Spatial variables have been released
Rework spatial variables page
Line 1: Line 1:
{{ stub }}
{{ 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 values and references from points in global space. They are mainly used via [[Component|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.


== 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
== Usage ==
 
# Create a spatial variable from [[#Types of spatial variables|one of the types listed above]].
- Constant Value Box/Sphere
# 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
 
- Texture3D Box
 
- 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.

Revision as of 02:12, 9 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. 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.

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

Usage

  1. Create a spatial variable from one of the types listed above.
  2. 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.