ObjectWaterGlobal Class
Warning
The scope of applications for UnigineScript is limited to implementing materials-related logic (material expressions, scriptable materials, brush materials). Do not use UnigineScript as a language for application logic, please consider C#/C++ instead, as these APIs are the preferred ones. Availability of new Engine features in UnigineScipt (beyond its scope of applications) is not guaranteed, as the current level of support assumes only fixing critical issues.
| 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 ObjectWaterGlobal ( ) #
Constructor. Creates a new global water object.float getHeight ( Vec3 position ) #
Returns a height offset of a given point relatively to the water surface.Arguments
- Vec3 position - Point position coordinates.
Return value
Height offset of the point.vec3 getNormal ( Vec3 position ) #
Returns a normal vector of a given point (to orient objects along the waves normals).Arguments
- Vec3 position - Normal vector.
Return value
Normal vector.void setOctaveCurrentOffset ( int index, 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).
- vec3 offset - An offset vector.
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
- int index - The index of the octave (a heightmap sample).
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 ( 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
- Vec3 position - A position vector of additional fields.
float getWaterProceduralLevelMin ( 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
- 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.static int type ( ) #
Last update:
2020-07-31
Help improve this article
Was this article helpful?
(or select a word/phrase and press Ctrl+Enter)