UnigineEditor
Interface Overview
Assets Workflow
Settings and Preferences
Adjusting Node Parameters
Setting Up Materials
Setting Up Properties
Landscape Tool
Using Editor Tools for Specific Tasks
FAQ
Programming
Fundamentals
Setting Up Development Environment
Usage Examples
UnigineScript
C++
C#
UUSL (Unified UNIGINE Shader Language)
File Formats
Rebuilding the Engine and Tools
GUI
Double Precision Coordinates
API
Containers
Common Functionality
Controls-Related Classes
Engine-Related Classes
Filesystem Functionality
GUI-Related Classes
Math Functionality
Node-Related Classes
Networking Functionality
Pathfinding-Related Classes
Physics-Related Classes
Plugins-Related Classes
CIGI Client Plugin
Rendering-Related Classes

Unigine::ObjectWaterGlobal Class

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

Interface for object water global handling. A water object represents infinitely spread water (global water) with auto-tessellation (wireframe of the water object is not scaled - regardless of the camera position it stays the same) and the underwater mode. This type is suitable to represent boundless ocean while not overloading the GPU.

However, it cannot have a body assigned, and thus does not provide proper physical interaction with scene objects. Also it is limited to a single water level. It means that the filling level of water always remains the same. So, if you need to create, for example, mountain lakes or water flows with height difference, you should use a water mesh.

See Also#

A UnigineScript API sample <UnigineSDK>/data/samples/objects/water_00

ObjectWaterGlobal Class

Members


static ObjectWaterGlobalPtr create ( ) #

Constructor. Creates a new global water object.

static Ptr<ObjectWaterGlobal> cast ( const Ptr<Object> & base ) #

Casts an ObjectWaterGlobal out of the Object instance.

Arguments

  • const Ptr<Object> & base - Pointer to Object.

Return value

Pointer to ObjectWaterGlobal.

static Ptr<ObjectWaterGlobal> cast ( const Ptr<Node> & node ) #

Casts an ObjectWaterGlobal out of the Node instance.

Arguments

  • const Ptr<Node> & node - Pointer to Node.

Return value

Pointer to ObjectWaterGlobal.

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

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

Arguments

  • const Math::Vec3 & position - Point position coordinates.

Return value

Height offset of the point.

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

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

Arguments

  • const Math::Vec3 & position - Normal vector.

Return value

Normal vector.

void setOctaveCurrentOffset ( int index, const Math::vec3 & offset ) #

Sets new offset for an octave (heightmap sample) with given index. Global Water object can have up to 3 octaves.

Arguments

  • int index - The index of the octave (a heightmap sample).
  • const Math::vec3 & offset - An offset vector.

Math::vec3 getOctaveCurrentOffset ( int index ) #

Returns an offset vector for an octave (heightmap sample) with given index. Global Water object can have up to 3 octaves.

Arguments

Return value

An offset vector.

int getPhysicsFieldMask ( ) #

Returns the FieldHeight physics mask of the assigned material on the Global Water.

Return value

The FieldHeight physics mask.

int getVisualFieldMask ( ) #

Returns the FieldHeight visual mask of the assigned material on the Global Water.

Return value

The FieldHeight visual mask.

int getWaterFieldHeightInteraction ( ) #

Checks if the assigned material on the Global Water object has enabled FieldHeight interaction option.

Return value

1 if the FieldHeight interaction option is enabled, otherwise, 0.

float getWaterLevel ( ) #

Returns the average Z coordinate of the water object.

Return value

The Z coordinate value.

float getWaterLevelMax ( ) #

Returns the maximum Z coordinate of the water object.

Return value

The Z coordinate value.

float getWaterLevelMin ( ) #

Returns the minimum Z coordinate of the water object.

Return value

The Z coordinate value.

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

Returns the maximum Z coordinate value of the water object including bounds of additional fields of other objects that affected Global Water heights in a given position.

Arguments

  • const Math::Vec3 & position - A position vector of additional fields.

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

Returns the minimum Z coordinate value of the water object including bounds of additional fields of other objects that affected Global Water heights in a given position.

Arguments

  • const Math::Vec3 & position - A position vector of additional fields.

void setWaterTime ( float time ) #

Sets water time value for water synchronization.

Arguments

  • float time - Water time value.

float getWaterTime ( ) #

Returns water time value for water synchronization.

Return value

Water time value.

int getWorldIntersection ( const Math::Vec3 & wp0, const Math::Vec3 & wp1, Math::vec3 * ret_point, Math::vec3 * ret_normal, Math::vec4 * ret_texcoord ) #

Searches for intersections with given line.

Arguments

  • const Math::Vec3 & wp0 - The line's start point coordinates.
  • const Math::Vec3 & wp1 - The line's end point coordinates.
  • Math::vec3 * ret_point - Intersection point coordinates.
  • Math::vec3 * ret_normal - Normal vector of the intersection point.
  • Math::vec4 * ret_texcoord - Texture coordinates of the intersection point (vec4, where vec4.xy is for the first (0) UV channel, vec4.zw is for the second (1) UV channel).

Return value

1 if intersections are found; otherwise, 0.

static int type ( ) #

Returns the type of the object.

Return value

ObjectWaterGlobal type identifier.
Last update: 2019-08-16