Table of Contents

Class LocalProceduralBiome

Namespace
Pinwheel.Vista
Assembly
Pinwheel.Vista.Runtime.dll
[ExecuteInEditMode]
[AddComponentMenu("Vista/Local Procedural Biome")]
[HelpURL("https://docs.google.com/document/d/1zRDVjqaGY2kh4VXFut91oiyVCUex0OV5lTUzzCSwxcY/edit#heading=h.4rhryfmtelm8")]
public class LocalProceduralBiome : MonoBehaviour, IProceduralBiome, IBiome, ISerializationCallbackReceiver
Inheritance
Object
Component
Behaviour
MonoBehaviour
LocalProceduralBiome
Implements
ISerializationCallbackReceiver
Inherited Members
MonoBehaviour.IsInvoking()
MonoBehaviour.CancelInvoke()
MonoBehaviour.StopCoroutine(Coroutine)
MonoBehaviour.StopAllCoroutines()
MonoBehaviour.useGUILayout
MonoBehaviour.runInEditMode
Behaviour.enabled
Behaviour.isActiveAndEnabled
Component.GetComponent<T>()
Component.TryGetComponent<T>(out T)
Component.GetComponentInChildren<T>()
Component.GetComponentsInChildren<T>()
Component.GetComponentInParent<T>()
Component.GetComponentsInParent<T>()
Component.GetComponents<T>()
Component.transform
Component.gameObject
Component.tag
Object.GetInstanceID()
Object.GetHashCode()
Object.Instantiate(Object, Vector3, Quaternion)
Object.Instantiate(Object, Vector3, Quaternion, Transform)
Object.Instantiate(Object)
Object.Instantiate(Object, Transform)
Object.Instantiate<T>(T)
Object.Instantiate<T>(T, Vector3, Quaternion)
Object.Instantiate<T>(T, Vector3, Quaternion, Transform)
Object.Instantiate<T>(T, Transform)
Object.Destroy(Object)
Object.DestroyImmediate(Object)
Object.DontDestroyOnLoad(Object)
Object.DestroyObject(Object)
Object.FindObjectsOfType<T>()
Object.FindObjectsByType<T>(FindObjectsSortMode)
Object.FindObjectsByType<T>(FindObjectsInactive, FindObjectsSortMode)
Object.FindObjectOfType<T>()
Object.FindFirstObjectByType<T>()
Object.FindAnyObjectByType<T>()
Object.FindFirstObjectByType<T>(FindObjectsInactive)
Object.FindAnyObjectByType<T>(FindObjectsInactive)
Object.ToString()
Object.name
Object.hideFlags
Extension Methods

Properties

allInstances

Gets the currently enabled local procedural biomes tracked by the runtime.

anchors

Gets or sets the polygon vertices that define the core biome shape in biome-local space.

baseResolution

Gets or sets the base graph resolution used when generating the biome cache in the biome's own bounds.

biomeMaskAdjustments

Gets or sets per-pixel adjustments applied to the generated base biome mask.

biomeMaskGraph

Gets or sets an optional post-process graph that refines the generated biome mask.

biomeMaskResolution

Gets or sets the resolution of the base biome mask and the editable biome-mask adjustment texture.

blendOptions

Gets or sets the per-output blending policy used when this biome overlaps others.

cleanUpMode

Gets or sets when cached biome data should be released.

dataMask

Gets or sets which output categories should be generated and cached for this biome.

falloffAnchors

Gets the derived falloff polygon vertices in biome-local space.

falloffDirection

Gets or sets whether the falloff region expands outside the anchor polygon or shrinks inward.

falloffDistance

Gets or sets the distance used to build the falloff polygon from anchors.

order

Gets or sets the sort order used when multiple local biomes overlap the same tile.

positionInputs

Gets or sets custom position-buffer inputs exposed to the terrain graph for this biome.

propertyOverrides

Gets or sets exposed-property overrides applied when the terrain graph is cloned for this biome.

seed

Gets or sets the random seed forwarded into terrain graph generation for this biome.

shouldCollectSceneHeight

Gets or sets whether the biome should capture a scene height texture and expose it to the terrain graph.

space

Gets or sets the simulation space passed to the terrain graph and biome mask graph.

terrainGraph

Gets or sets the terrain graph that generates this biome's cached outputs.

textureInputs

Gets or sets custom texture inputs exposed to the terrain graph for this biome.

updateCounter

Gets or sets the biome change stamp used by the manager to detect invalidated state.

worldBounds

Gets the biome bounds in world space.

Methods

CalculateWorldBounds()

Calculates the biome's world-space bounding box from its authored polygon.

CleanUp()

Releases the cached biome data owned by this biome.

CreateInstanceInScene(VistaManager)

Creates a new biome GameObject in the current scene and optionally parents it to a manager.

IsOverlap(Bounds)

Tests whether the biome's effective polygon overlaps a world-space rectangular area.

OnAfterDeserialize()

Receives Unity's deserialization callback.

OnAfterVMGenerate()

Called by the manager after tile generation finishes.

OnBeforeSerialize()

Ensures the biome instance has a persistent GUID before serialization.

OnBeforeVMGenerate()

Called by the manager before tile generation begins.

OnDisable()
OnEnable()
OnGraphChanged(GraphAsset)
RecalculateFalloffAnchors()

Rebuilds the falloff polygon from the current anchor polygon, falloff distance, and falloff direction.

RenderSceneHeightMap()

Renders the current scene height inside this biome's world bounds into a temporary texture.

RequestData(Bounds, int, int)

Requests biome data for a target tile by remapping this biome's cached outputs into the requested bounds.

Reset()

Restores the biome to Vista's default local-biome configuration.