Unigine::ObjectWaterMesh Class

Header:	#include <UnigineObjects.h>
Inherits from:	Object

Interface for object water mesh handling. The water mesh can have four sine waves. The object is used to create small water basins such as ponds, lakes and so on. ObjectWaterMesh has physics support, so it can have a body assigned, therefore, it can interact with other scene objects.

Methods:

Name	Description View: Sort by:
*create*	Constructor.
setFieldMask	Sets a field mask specifying the area of the Field node to be applied.
getFieldMask	Returns the mask specifying the area of the applied Field node.
setMeshName	Sets a name for the water mesh.
getMeshName	Returns the name of the current water mesh.
getHeight	Returns a height offset of a given point relatively to the water mesh surface.
setMesh	Allows for reinitialization of the water mesh object: copies a given mesh into the current water mesh.
getMesh	Copies the current water mesh into the received mesh.
setMeshName	Sets a new name for the water mesh and forces loading of the mesh with the new name for the current water mesh.
getNormal	Returns the normal vector of a given point (used to orient objects along the waves normals).
setWave	Sets parameters for one of four simulated water waves.
getWave	Returns parameters of one of four simulated water waves.
setWaveAngle	Sets direction (angle of spreading) for a given wave: If 0 is specified, the wave spreads along the Y axis and is parallel to the X axis.
getWaveAngle	Returns direction (angle of spreading) of a given wave.
setWaveHeight	Sets the distance between the highest and the lowest peaks for the given wave.
getWaveHeight	Returns the distance between the highest and the lowest peaks for the given wave.
setWaveLength	Sets the distance between successive crests for the given wave.
getWaveLength	Returns the distance between successive crests of the given wave.
setWaveSpeed	Sets a speed for a given wave.
getWaveSpeed	Returns the speed of a given wave.
loadMesh	Loads a mesh for the current water mesh from the file.
saveMesh	Saves the object water mesh into a file.
type	Returns the type of the node.

ObjectWaterMesh Class

Members

static ObjectWaterMeshPtr create ( ) #

Constructor. Creates a new water mesh object.

static ObjectWaterMeshPtr create ( const Ptr<Mesh> & mesh ) #

Constructor. Creates a new water mesh object.

Arguments

const Ptr<Mesh> & mesh - The mesh smart pointer.

static ObjectWaterMeshPtr create ( const char * path ) #

Constructor. Creates a new water mesh object from a specified file.

Arguments

const char * path - Path to the water mesh.

void setFieldMask ( int mask ) #

Sets a field mask specifying the area of the Field node to be applied.

Arguments

int mask - An integer value, each bit of which is used to set a mask.

int getFieldMask ( ) #

Returns the mask specifying the area of the applied Field node.

Return value

The integer value, each bit of which sets a mask.

float getHeight ( const Math::Vec3 & position ) #

Returns a height offset of a given point relatively to the water mesh surface.

Arguments

const Math::Vec3 & position - The point position coordinates.

Return value

Height offset of the point.

int setMesh ( const Ptr<Mesh> & mesh ) #

Allows for reinitialization of the water mesh object: copies a given mesh into the current water mesh.

Source code (C++)

// create an empty decal mesh
ObjectWaterMeshPtr waterMesh = ObjectWaterMesh::create();
// create a mesh
MeshPtr mesh = Mesh::create("lake.mesh");
// copy the mesh into the water mesh
waterMesh->setMesh(mesh);

Arguments

const Ptr<Mesh> & mesh - The mesh smart pointer.

Return value

1 if the mesh is copied successfully; otherwise, 0.

int getMesh ( const Ptr<Mesh> & mesh ) #

Copies the current water mesh into the received mesh.

Source code (C++)

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

Arguments

const Ptr<Mesh> & mesh - The received mesh smart pointer.

Return value

1 if the mesh is copied successfully; otherwise, 0.

void setMeshName ( const char * name ) #

Sets a name for the water mesh.

Arguments

const char * name - The water mesh name.

int setMeshName ( const char * path, int force_load = 0 ) #

Sets a new name for the water mesh and forces loading of the mesh with the new name for the current water mesh.

Arguments

const char * path - A new name to be set for the water mesh.
int 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

1 if :

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.

In other cases, 0.

const char * getMeshName ( ) #

Returns the name of the current water mesh.

Return value

The mesh name.

Math::vec3 getNormal ( const Math::Vec3 & position ) #

Returns the normal vector of a given point (used to orient objects along the waves normals).

Arguments

const Math::Vec3 & position - The point position coordinates.

Return value

Normal vector.

void setWave ( int num, const Math::vec4 & wave ) #

Sets parameters for one of four simulated water waves.

Arguments

int num - Wave number in range [0;3].
const Math::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.

Math::vec4 getWave ( int num ) #

Returns parameters of one of four simulated water waves.

Arguments

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

Return value

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.

void setWaveAngle ( int num, float angle ) #

Sets direction (angle of spreading) for a given wave:

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 ) #

Returns direction (angle of spreading) of a given wave.

Arguments

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

Return value

Angle, in degrees.

void setWaveHeight ( int num, float height ) #

Sets the distance between the highest and the lowest peaks for the given wave. It sets the wave form along with the setWaveLength() function. The higher the value is, the higher the waves are.

Arguments

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

float getWaveHeight ( int num ) #

Returns the distance between the highest and the lowest peaks for the given wave.

Arguments

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

Return value

Height, in units.

void setWaveLength ( int num, float length ) #

Sets the distance between successive crests for the given wave. The higher the length value is, the broader the waves are.

Arguments

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

float getWaveLength ( int num ) #

Returns the distance between successive crests of the given wave.

Arguments

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

Return value

Length, in units.

void setWaveSpeed ( int num, float speed ) #

Sets a speed for a given wave. The higher the value, the faster waves follow each other.

Arguments

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

float getWaveSpeed ( int num ) #

Returns the speed of a given wave.

Arguments

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

Return value

Speed, in units per second.

int loadMesh ( const char * path ) #

Loads a mesh for the current water mesh from the file. This function doesn't change the mesh name.

Arguments

const char * path - The name of the mesh file.

Return value

1 if the mesh is loaded successfully; otherwise, 0.

int saveMesh ( const char * path ) #

Saves the object water mesh into a file.

Arguments

const char * path - A name of the file.

Return value

1 if the mesh is saved successfully; otherwise, 0.

static int type ( ) #

Returns the type of the node.

Return value

Object type identifier.

Last update: 2021-04-29

Help improve this article

Was this article helpful?

Report a problem related to this article

(or select a word/phrase and press Ctrl+Enter)

Unigine::ObjectWaterMesh Class

See Also#

Methods:

ObjectWaterMesh Class

Members

static ObjectWaterMeshPtr create ( ) #

static ObjectWaterMeshPtr create ( const Ptr<Mesh> & mesh ) #

Arguments

static ObjectWaterMeshPtr create ( const char * path ) #

Arguments

void setFieldMask ( int mask ) #

Arguments

int getFieldMask ( ) #

Return value

float getHeight ( const Math::Vec3 & position ) #

Arguments

Return value

int setMesh ( const Ptr<Mesh> & mesh ) #

Arguments

Return value

int getMesh ( const Ptr<Mesh> & mesh ) #

Arguments

Return value

void setMeshName ( const char * name ) #

Arguments

int setMeshName ( const char * path, int force_load = 0 ) #

Arguments

Return value

const char * getMeshName ( ) #

Return value

Math::vec3 getNormal ( const Math::Vec3 & position ) #

Arguments

Return value

void setWave ( int num, const Math::vec4 & wave ) #

Arguments

Math::vec4 getWave ( int num ) #

Arguments

Return value

void setWaveAngle ( int num, float angle ) #

Arguments

float getWaveAngle ( int num ) #

Arguments

Return value

void setWaveHeight ( int num, float height ) #

Arguments

float getWaveHeight ( int num ) #

Arguments

Return value

void setWaveLength ( int num, float length ) #

Arguments

float getWaveLength ( int num ) #

Arguments

Return value

void setWaveSpeed ( int num, float speed ) #

Arguments

float getWaveSpeed ( int num ) #

Arguments

Return value

int loadMesh ( const char * path ) #

Arguments

Return value

int saveMesh ( const char * path ) #

Arguments

Return value

static int type ( ) #

Return value