Unigine.ObjectWaterMesh Class

ObjectWaterMesh Class

Properties

int FieldMask#

Members

ObjectWaterMesh ( ) #

ObjectWaterMesh ( Mesh mesh ) #

Arguments

• Mesh mesh - Mesh instance.

ObjectWaterMesh ( string path ) #

Arguments

• string path - Path to the water mesh.

float GetHeight ( vec3 position ) #

Arguments

• vec3 position - The point position coordinates.

Return value

int SetMesh ( Mesh mesh ) #

ObjectWaterMesh waterMesh = new ObjectWaterMesh();
// create a mesh
Mesh mesh = new Mesh("lake.mesh");
// copy the mesh into the water mesh
waterMesh.setMesh(mesh);

Arguments

• Mesh mesh - Mesh.

Return value

int GetMesh ( Mesh mesh ) #

// a water mesh from which geometry will be obtained
ObjectWaterMesh waterMesh = new ObjectWaterMesh("lake.mesh");
// create a new mesh
Mesh mesh = new Mesh();
// copy geometry to the created mesh
if (waterMesh.getMesh(mesh) == 1) {
	// do something with the obtained mesh
}
else {
	Log.Error("Failed to copy a mesh\n");
}

Arguments

• Mesh mesh - Received mesh.

Return value

int SetMeshName ( string path, bool force_load = 0 ) #

Arguments

• string path - A new name to be set for the water mesh.
• bool force_load - Force flag.
  • If 1 is specified, the mesh with the new name will be loaded immediately from the file specified as the first argument for this function.
  • If 0 is specified, only the mesh name will be updated.

Return value

• The current mesh name coincides the new name.
• The mesh with the new name has been loaded successfully.
• The force flag is set to 0.

string GetMeshName ( ) #

Return value

vec3 GetNormal ( vec3 position ) #

Arguments

• vec3 position - The point position coordinates.

Return value

void SetWave ( int num, vec4 wave ) #

Arguments

• int num - Wave number in range [0;3].
• vec4 wave - Wave parameters:
  • The X and Y components containing the velocity of the wave.
  • The Z component containing the frequency.
  • The W component containing the amplitude.

vec4 GetWave ( int num ) #

Arguments

• int num - Wave number in range [0;3].

Return value

• The X and Y components containing the velocity of the wave.
• The Z component containing the frequency.
• The W component containing the amplitude.

void SetWaveAngle ( int num, float angle ) #

• If 0 is specified, the wave spreads along the Y axis and is parallel to the X axis.
• If a positive value is specified, the wave direction is slanted counterclockwise relative to its initial spread.
• If a negative value is specified, the wave is rotated clockwise.

Arguments

• int num - Wave number in range [0;3].
• float angle - Angle, in degrees. Both positive and negative values are acceptable.

float GetWaveAngle ( int num ) #

Arguments

• int num - Wave number in range [0;3].

Return value

void SetWaveHeight ( int num, float height ) #

Arguments

• int num - Wave number in range [0;3].
• float height - Height, in units.

float GetWaveHeight ( int num ) #

Arguments

• int num - Wave number in range [0;3].

Return value

void SetWaveLength ( int num, float length ) #

Arguments

• int num - Wave number in range [0;3].
• float length - Length, in units.

float GetWaveLength ( int num ) #

Arguments

• int num - Wave number in range [0;3].

Return value

void SetWaveSpeed ( int num, float speed ) #

Arguments

• int num - Wave number in range [0;3].
• float speed - Speed, in units per second.

float GetWaveSpeed ( int num ) #

Arguments

• int num - Wave number in range [0;3].

Return value

int LoadMesh ( string path ) #

Arguments

• string path - The name of the mesh file.

Return value

int SaveMesh ( string path ) #

Arguments

• string path - A name of the file.

Return value

static int type ( ) #

Return value