WaterNode.EnableUnderwaterEffect Property

WaterNodeEnableUnderwaterEffect Property

Gets or sets a value indicating whether an underwater effect should be displayed if the camera is underwater.

Namespace: DigitalRune.Graphics.SceneGraph
Assembly: DigitalRune.Graphics (in DigitalRune.Graphics.dll) Version: 1.2.0.0 (1.2.1.14562)

Syntax

C++

Copy

public bool EnableUnderwaterEffect { get; set; }

Public Property EnableUnderwaterEffect As Boolean
	Get
	Set

public:
property bool EnableUnderwaterEffect {
	bool get ();
	void set (bool value);
}

member EnableUnderwaterEffect : bool with get, set

Property Value

Type: Boolean
if an underwater effect is displayed when the camera is underwater; otherwise, . The default value is .

Remarks

Set this property to if the player can dive into the water. If this value is , the objects under the water surface are rendered normally when the camera peeks under the water surface. To check if an object is underwater, use the IsUnderwater(Vector3F) method.

Reference

WaterNode Class

DigitalRune.Graphics.SceneGraph Namespace