Unigine::ObjectWaterMesh Class

ObjectWaterMesh Class

Members

static ObjectWaterMeshPtr create ( ) #

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

Arguments

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

static ObjectWaterMeshPtr create ( const char * path ) #

Arguments

• const char * path - Path to the water mesh.

void setFieldMask ( int mask ) #

Arguments

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

int getFieldMask ( ) #

Return value

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

Arguments

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

Return value

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

// 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

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

// 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

void setMeshName ( const char * name ) #

Arguments

• const char * name - The water mesh name.

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

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

• 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.

const char * getMeshName ( ) #

Return value

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

Arguments

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

Return value

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

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

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 ( const char * path ) #

Arguments

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

Return value

int saveMesh ( const char * path ) #

Arguments

• const char * path - A name of the file.

Return value

static int type ( ) #

Return value