Component:BoxTexture3D SpatialVariable: Difference between revisions

From Resonite Wiki
Automated: create new component page
 
add info
 
Line 3: Line 3:
|Name=Box Texture 3D Spatial Variable
|Name=Box Texture 3D Spatial Variable
}}
}}
The '''Box Texture 3D Spatial Variable''' component
The '''Box Texture 3D Spatial Variable''' component is specifically for colorX spatial variables. This is a box spatial variable that provides colorX [[spatial variables]] sampled from a [[Type:Texture3D|Texture3D]].
{{stub}}


== Fields ==
== Fields ==
{{Table ComponentFields
{{Table ComponentFields
|VariableName|String|
|VariableName|String| {{SpatialVariables_VariableName}}
|Priority|Int|
|Priority|Int| {{SpatialVariables_Priority}}
|Size|Float3|
|Size|Float3| the size of the box in which variable samplers can sample from this within.
|BlendDistance|Float|
|BlendDistance|Float| {{SpatialVariables_BlendDistance}}
|BlendDistanceMode|SpatialVariableBlendDistanceMode|
|BlendDistanceMode|SpatialVariableBlendDistanceMode| {{SpatialVariables_BlendDistanceMode}}
|Texture|{{RootFieldType|AssetRef`1|[[Type:Texture3D|Texture3D]]}}|TypeAdv5=true|
|Texture|{{RootFieldType|AssetRef`1|[[Type:Texture3D|Texture3D]]}}|TypeAdv5=true| The texture to use and sample from in 3D space. Must have <code>IsReadable</code> enabled!
|UseNormalizedCoordinates|Bool|
|UseNormalizedCoordinates|Bool| When enabled, this will squish/stretch the texture with the box.
|Scale|Float3|
|Scale|Float3| The scale of the texture in 3D space.
|Offset|Float3|
|Offset|Float3| The offset of the texture in 3D space from the slot this component is on.
|WrapU|WrapMode|
|WrapU|WrapMode| How to wrap the texture along the X axis.
|WrapV|WrapMode|
|WrapV|WrapMode| How to wrap the texture along the Y axis.
|WrapW|WrapMode|
|WrapW|WrapMode| How to wrap the texture along the Z axis.
}}
}}


== Usage ==
== Usage ==
Attach to a slot and provide a size, 3d texture, and a variable name in order for this to function.


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


== See Also ==
== See Also ==
* [[Spatial variables]]


[[Category:Components:Data:Spatial:Box Variables{{#translation:}}|Box Texture 3D Spatial Variable]]
[[Category:Components:Data:Spatial:Box Variables{{#translation:}}|Box Texture 3D Spatial Variable]]
[[Category:Components{{#translation:}}|Box Texture 3D Spatial Variable]]
[[Category:Components{{#translation:}}|Box Texture 3D Spatial Variable]]
[[Category:ComponentStubs]]

Latest revision as of 06:40, 9 May 2025

Component image 
File:BoxTexture3D SpatialVariableComponent.png
Box Texture 3D Spatial Variable component as seen in the Scene Inspector

The Box Texture 3D Spatial Variable component is specifically for colorX spatial variables. This is a box spatial variable that provides colorX spatial variables sampled from a Texture3D.

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.
VariableName String The name of the variable this has within it's field of influence for the Spatial variables system.
Priority Int The priority this spatial variable has other others overlapping in the same space for the Spatial variables system.
Size Float3 the size of the box in which variable samplers can sample from this within.
BlendDistance Float How the gradient for this variable within it's volume determines the sampled value for the Spatial variables system.
BlendDistanceMode SpatialVariableBlendDistanceMode The mode used for blending the value with other variables for the Spatial variables system.
Texture Texture3D The texture to use and sample from in 3D space. Must have IsReadable enabled!
UseNormalizedCoordinates Bool When enabled, this will squish/stretch the texture with the box.
Scale Float3 The scale of the texture in 3D space.
Offset Float3 The offset of the texture in 3D space from the slot this component is on.
WrapU WrapMode How to wrap the texture along the X axis.
WrapV WrapMode How to wrap the texture along the Y axis.
WrapW WrapMode How to wrap the texture along the Z axis.

Usage

Attach to a slot and provide a size, 3d texture, and a variable name in order for this to function.

Examples

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

See Also