Struct MaterialGeoPlastSettings
Settings of Material GeoPlast, which is a type of GeoPlast that simulates the flow of a material based on its temperature and plast amount. It includes settings for heat flow, vertical flow by temperature, and density by temperature. These settings allow to simulate evaporation/condensation/freezing/melting processes.
Assembly: fwt.hexterrains.dll
Syntax
[Serializable]
public struct MaterialGeoPlastSettings
Fields
DensityByTemperatureSettings
Settings that define how the temperature affects the density of the plast. If TemperatureScalesDensity is true, the plast density will be multiplied by the value from DensityByTemperatureFactorCurve evaluated at the cell temperature. This allows to simulate the effect of hot plast being less dense and more fluid, while cold plast is more dense and less fluid.
Declaration
[Tooltip("Settings that define how the temperature affects the density of the plast. If TemperatureScalesDensity is true, the plast density will be multiplied by the value from DensityByTemperatureFactorCurve evaluated at the cell temperature. This allows to simulate the effect of hot plast being less dense and more fluid, while cold plast is more dense and less fluid.")]
[SerializeField]
public DensityByTemperatureSettings DensityByTemperatureSettings
Field Value
DownFlowByTemperatureSettings
Settings that define the flow depending on the temperature for vertical flow. Vertical flow is a process of plast volume movement between layers.
It is affected by the plast Amount and Temperature of the cell (Temperature is evaluated as Heat / Amount).
The Temperature value used as input for evaluating the FlowMultiplierCurve (it returns values from 0 to 1). The BaseFlow value is multiplied by FlowMultiplierCurve evaluation result and this is the FlowPotential in DOWN flow direction.
Declaration
[Tooltip("Settings that define the flow depending on the temperature for vertical flow. Vertical flow is a process of plast volume movement between layers. \r\n\r\nIt is affected by the plast Amount and Temperature of the cell (Temperature is evaluated as Heat / Amount). \r\n\r\nThe Temperature value used as input for evaluating the FlowMultiplierCurve (it returns values from 0 to 1). The BaseFlow value is multiplied by FlowMultiplierCurve evaluation result and this is the FlowPotential in DOWN flow direction.")]
[SerializeField]
public VerticalFlowByTemperatureSettings DownFlowByTemperatureSettings
Field Value
HeatFlowFrameCycle
Frame Settings of Heat Flow (idependent from the Plast flow). Heat flow is a process of temperature equalization between cells, as well as temperature equalization between GeoPlast layers.
Declaration
[Tooltip("Frame Settings of Heat Flow (idependent from the Plast flow). Heat flow is a process of temperature equalization between cells, as well as temperature equalization between GeoPlast layers.")]
[SerializeField]
public FrameCycleSettings HeatFlowFrameCycle
Field Value
HeatFlowSettings
Settings of the geo plast heat flow (horizontal, up, down).
Declaration
[Tooltip("Settings of the geo plast heat flow (horizontal, up, down).")]
[SerializeField]
public GeoPlastFlowSettings HeatFlowSettings
Field Value
UpFlowByTemperatureSettings
Settings that define the flow depending on the temperature for vertical flow. Vertical flow is a process of plast volume movement between layers.
It is affected by the plast Amount and Temperature of the cell (Temperature is evaluated as Heat / Amount).
The Temperature value used as input for evaluating the FlowMultiplierCurve (it returns values from 0 to 1). The BaseFlow value is multiplied by FlowMultiplierCurve evaluation result and this is the FlowPotential in UP flow direction.
Declaration
[Tooltip("Settings that define the flow depending on the temperature for vertical flow. Vertical flow is a process of plast volume movement between layers. \r\n\r\nIt is affected by the plast Amount and Temperature of the cell (Temperature is evaluated as Heat / Amount). \r\n\r\nThe Temperature value used as input for evaluating the FlowMultiplierCurve (it returns values from 0 to 1). The BaseFlow value is multiplied by FlowMultiplierCurve evaluation result and this is the FlowPotential in UP flow direction.")]
[SerializeField]
public VerticalFlowByTemperatureSettings UpFlowByTemperatureSettings
Field Value
Properties
Default
Declaration
public static MaterialGeoPlastSettings Default { get; }
Property Value
Methods
GetVerticalFlowByTemperatureSettings(FlowDirections)
Returns the VerticalFlowByTemperatureSettings for the given flow direction. If the direction is not Up or Down, it returns the default VerticalFlowByTemperatureSettings.
Declaration
public VerticalFlowByTemperatureSettings GetVerticalFlowByTemperatureSettings(FlowDirections direction)
Parameters
Returns
IsAnyFlowEnabledAndIsSimulationTick(HexTerrainSimulationTimer)
Returns true if any flow is enabled and the current simulation tick is a flow simulation tick.
Declaration
public bool IsAnyFlowEnabledAndIsSimulationTick(HexTerrainSimulationTimer simulationTimer)
Parameters
Returns
Extension Methods