| OceanWavesGetDisplacement Method |
Gets the surface displacement caused by the water waves.
Namespace: DigitalRune.GraphicsAssembly: DigitalRune.Graphics (in DigitalRune.Graphics.dll) Version: 1.2.0.0 (1.2.1.14562)
Syntax public bool GetDisplacement(
float x,
float z,
out Vector3F displacement,
out Vector3F normal
)
Public Function GetDisplacement (
x As Single,
z As Single,
<OutAttribute> ByRef displacement As Vector3F,
<OutAttribute> ByRef normal As Vector3F
) As Boolean
public:
bool GetDisplacement(
float x,
float z,
[OutAttribute] Vector3F% displacement,
[OutAttribute] Vector3F% normal
)
member GetDisplacement :
x : float32 *
z : float32 *
displacement : Vector3F byref *
normal : Vector3F byref -> bool
Parameters
- x
- Type: SystemSingle
The x position in world space. - z
- Type: SystemSingle
The z position in world space. - displacement
- Type: DigitalRune.Mathematics.AlgebraVector3F
The displacement vector in world space. - normal
- Type: DigitalRune.Mathematics.AlgebraVector3F
The normal vector in world space.
Return Value
Type:
Boolean if successful; otherwise,
if the results are
invalid because the CPU simulation has not been performed.
Exceptions See Also