Class SunTerrainLayer

Inheritance
object
HexTerrainLayer
SunTerrainLayer
Implements
Inherited Members
Namespace: Fwt.HexTerrains.Suns.Data
Assembly: fwt.hexterrains.dll
Syntax
public class SunTerrainLayer : HexTerrainLayer, IDisposable, ISerializableTerrainLayer

Fields

SunSettings

Declaration
public SunSettings SunSettings
Field Value
Type Description
SunSettings

TargetLayers

Declaration
public List<SunTargetLayerSettings> TargetLayers
Field Value
Type Description
List<SunTargetLayerSettings>

Properties

DayProgress

Declaration
public virtual float DayProgress { get; set; }
Property Value
Type Description
float

SunPosition

Declaration
public virtual float2 SunPosition { get; set; }
Property Value
Type Description
float2

YearProgress

Declaration
public virtual float YearProgress { get; set; }
Property Value
Type Description
float

Methods

ApplySunHeat(GeoPlastLayerGroup, SunTargetLayerSettings, float, JobHandle)

Declaration
public virtual JobHandle ApplySunHeat(GeoPlastLayerGroup geoPlastLayers, SunTargetLayerSettings targetLayerSettings, float deltaTime, JobHandle dependency)
Parameters
Type Name Description
GeoPlastLayerGroup geoPlastLayers
SunTargetLayerSettings targetLayerSettings
float deltaTime
JobHandle dependency
Returns
Type Description
JobHandle

Cleanup()

Every frame there is a cleanup stage. This function is called. Usually used to clean the dirty flags.

Declaration
public override void Cleanup()
Overrides

CleanupAsync(JobHandle)

Async version of Cleanup() Cleanup() Difference between regular Cleanup() is that it schedules jobs that clean up data layers, so you don't have to wait for the results and can continue working. Every frame there is a cleanup stage. This function is called. Usually used to clean the dirty flags.

Declaration
public override JobHandle CleanupAsync(JobHandle dependency)
Parameters
Type Name Description
JobHandle dependency
Returns
Type Description
JobHandle
Overrides

DeserializeLayer(BinaryReader, HexTerrainSettings)

Requests a deserialization of the layer data. Returns false if the layer does not support deserialization.

Declaration
public bool DeserializeLayer(BinaryReader reader, HexTerrainSettings terrainSettings)
Parameters
Type Name Description
BinaryReader reader

binary reader to deserialize data from
HexTerrainSettings terrainSettings

deserialized terrain settings (layer was serialized with this settings)
Returns
Type Description
bool

Dispose()

Disposes all allocated native memory.

Declaration
public override void Dispose()
Overrides

Init(HexTerrainSettings)

Initializes/Reinitializes the area data.

Declaration
public override void Init(HexTerrainSettings settings)
Parameters
Type Name Description
HexTerrainSettings settings

new terrain settings
Overrides

Init<TInitArgs>(HexTerrainSettings, TInitArgs)

Initializes the terrain system using the specified settings and initialization arguments.

Declaration
public override void Init<TInitArgs>(HexTerrainSettings settings, TInitArgs initArgs)
Parameters
Type Name Description
HexTerrainSettings settings

The configuration settings to apply when initializing the terrain system. Cannot be null.
TInitArgs initArgs

Additional arguments required for initialization. The expected type and usage depend on the implementation.
Type Parameters
Name Description
TInitArgs

The type of the initialization arguments to be used during terrain system setup.
Overrides

MoveTheSun(HexTerrainSimulationTimer)

Declaration
public virtual void MoveTheSun(HexTerrainSimulationTimer simulationTimer)
Parameters
Type Name Description
HexTerrainSimulationTimer simulationTimer

SerializeLayer(BinaryWriter)

Requests a serialization of the layer data. Returns false if the layer does not support serialization.

Declaration
public bool SerializeLayer(BinaryWriter writer)
Parameters
Type Name Description
BinaryWriter writer

binary writer to serialize data by
Returns
Type Description
bool

True if serialized, false if not serialized/not supported/not implemented

SetAllDirty(bool)

Sets all data layers dirty value. If isDirty is true, all data layers will be marked as dirty and will be recalculated on the next frame. If isDirty is false, all data layers will be marked as clean and will not be recalculated on the next frame.

Declaration
public override void SetAllDirty(bool isDirty)
Parameters
Type Name Description
bool isDirty
Overrides

Simulate(GeoPlastLayerGroup, HexTerrainSimulationTimer, JobHandle)

Declaration
public JobHandle Simulate(GeoPlastLayerGroup geoPlastLayers, HexTerrainSimulationTimer simulationTimer, JobHandle dependency)
Parameters
Type Name Description
GeoPlastLayerGroup geoPlastLayers
HexTerrainSimulationTimer simulationTimer
JobHandle dependency
Returns
Type Description
JobHandle

Implements

Extension Methods