Class CIMWaterFill
Represents a water fill which fills polygonal geometry with animated water.
public class CIMWaterFill : CIMFill
- Inheritance
-
CIMWaterFill
- Inherited Members
Constructors
CIMWaterFill()
public CIMWaterFill()
Properties
Color
Gets or sets the intrinsic color of the water.
public CIMColor Color { get; set; }
Property Value
WaterbodySize
Gets or sets the waterbody size allowing for a range of sizes from small pools to oceans. This property along with wave strength are the parameters which drive the wave appearance.
public WaterbodySize WaterbodySize { get; set; }
Property Value
WaveDirection
Gets or sets the azimuthal bearing for direction of the waves. Only has effect when WasHasDirection is true.
public double WaveDirection { get; set; }
Property Value
WaveHasDirection
Gets or sets a value indicating whether the waves are directionless (false), or if they have a dominant direction (true).
public bool WaveHasDirection { get; set; }
Property Value
WaveStrength
Gets or sets the strength of the waves. This property along with waterbody size are the parameters which drive the wave appearance.
public WaveStrength WaveStrength { get; set; }
Property Value
Methods
FromJson(string, JsonDeserializationSettings)
Reconstructs the CIMWaterFill with a specified state from a JSON encoding.
public static CIMWaterFill FromJson(string json, JsonDeserializationSettings settings = null)
Parameters
jsonstringThe JSON string containing the CIMWaterFill state.
settingsJsonDeserializationSettingsThe JSON deserialization settings.
Returns
ToJson(JsonSerializationSettings)
Creates a JSON encoding of the CIMWaterFill and its current state.
public override string ToJson(JsonSerializationSettings settings = null)
Parameters
settingsJsonSerializationSettingsThe JSON serialization settings.