This page has been translated automatically.
Click here to view the original English version instead.
Getting Started
What's Inside?
Project Workflow
Basic Tutorial: Importing FBX Model
Hardware Requirements
Principles of Operation
Virtual World Structure
World Management
Rendering
Rendering Sequence
Scattering
HDR Rendering
Temporal Anti-Aliasing
Alpha Blending
Postprocessing
Hiding Shading Artifacts with AppBorder Plugin
Physics
Shapes
Collision Detection
Joints
Simulation of Physics
Bit Masking
File System
SDK Browser
Projects
Licenses
Add-Ons
ARTTRACK Add-On
Game Framework Add-On
Kinect2 Add-On
LVC Game Add-On
Perception Neuron Add-On
Tutorials Content Add-On
Vegetation Add-On
VRPN Add-On
UnigineEditor
Overview
Controls
Managing Worlds
Scene Navigation
Setting Up Cameras
Importing Nodes
Selecting and Positioning Nodes
Organizing Nodes
Exporting Nodes
Rendering Settings
Camera Effects
Setting Up Materials
Setting Up Properties
Setting Up Physics
Terrain Editor
Terrain Grabber
System Menu
Video Grabber
Mask Editor
Tools Panel
LUT Generation Tool
Plugins
Collada Import Plugin
OpenFlight Import Plugin
Importing Large Populated Areas with City Import Plugin
Making Environment Look Realistic with Randomizer Plugin
Exporting Nodes with Node Export Plugin
Baking Meshes into One Mesh with Mesh Combiner Plugin
Creating Large Terrains with Landscape Plugin
Interface Plugin
Making Custom Editor Plugins
Tools
Plugins for 3D Editors
Plugins for 3ds Max
Plugins for Maya
Performance Profiling Tools
Performance Profiler
Microprofile
ResourceEditor
MeshViewer
NormalCombiner
NormalMapper
AmbientMapper
AlphaMapper
ImageDDS
ImageTTF
USC Interpreter
Archiver
Resource
MeshImport
Upgrade Script
Built-in Node Types
Nodes
Node
Node Reference
Dummy Node
Layer
Pivot
Trigger
Objects
Dummy Object
Static Mesh
Skinned Mesh
Dynamic Mesh
Mesh Cluster
Mesh Clutter
Text Object
Sky
Effects
Particle System
Fields
Field Spacer
Field Animation
Field Height
Field Shoreline
Decals
Projected Decal
Orthographic Decal
Mesh Decal
Light Sources
Light Sources Parameters
Omni Light
Projected Light
World Light
Environment Probe
Geodetics
Geodetic Pivot
World Objects
World Layer
Sector
Portal
World Trigger
World Cluster
World Clutter
Switcher
World Expression
Sound Objects
Sound Source
Sound Reverb
Pathfinding Objects
Players
Player Actor
Player Dummy
Player Persecutor
Player Spectator
Programming
Fundamentals
Programming Overview
Engine Architecture
Typical Architecture of a Unigine-Based Application
Memory Management
Matrix Transformations
Setting Up Development Environment
Windows Development Environment
Linux Development Environment
OS X Development Environment
UnigineScript
Creating UnigineScript Application
Adding Scripts to the Project
Script Debugging
High-Level Systems
UnigineScript Basic Utilities
Unigine::Schemer
Unigine::Skinner
Input System
Character System
KeyLine System
Dialogs Script
Cache Files
C++
Creating C++ Application
Creating C++ Plugin
C#
Creating C# Application
C# API Reference
UUSL (Unified UNIGINE Shader Language)
UUSL Keywords
UUSL Common Intrinsic Functions
UUSL GBuffer Structure
UUSL Data Structure
UUSL Parameters
UUSL Textures
UUSL Semantics
UUSL Tessellation
Creating of Custom Shader for Deferred Rendering Pass
Creating of Custom Shader for Forward Rendering Pass
Creating of Custom Shader for Post-Processing
File Formats
Mesh File Formats
Material File Format
Startup Command-Line Options
Console
Configuration File
Rebuilding the Engine and Tools
Rebuild in Windows via Visual Studio
Rebuild in OS X via Xcode
Semi-automatic Compilation with Build Script
Manual Compilation with SCons
Preprocessor Macros for Rebuilding the Engine
Rebuild Qt Libraries
Protecting Your Data with a Password
GUI
RC Files
Skin Layout
Usage Example
Double Precision Coordinates
Usage
Performance Analyzer
How to Generate Shaders Cache
API
Containers
Container Functions
ArrayVector Class
Map Class
Set Class
Common Functionality
Async Class
Atomiclock Class
Blob Class
CallbackBase Class
Checksum Class
Compress Class
ConsoleVariableFloat Class
ConsoleVariableInt Class
ConsoleVariableString Class
Expression Class
ExternClass Class
FunctionBase Class
Image Class
Iterator Class
Interpreter Class
Json Class
Log Class
OS Functions
Path Class
Plugin Class
Property Class
Ptr Class
Reflection Class
RegExp Class
Resource Class
Stream Class
String Class
System Functions
Thread Class
Timer Class
TypeInfo Class
Unigine Namespace Items
Xml Class
Variable Class
Controls-Related Classes
Controls Class
ControlsApp Class
ControlsDummy Class
ControlsJoystick Class
ControlsSixAxis
ControlsXPad360 Class
Engine-Related Classes
App Class
Config Class
Console Class
Editor Class
Engine Class
EngineEditor Class
EnginePtr Class
EngineWorld Class
engine.system Functions
EnginePlugins Class
Game Class
GameIntersection Class
Memory Class
Profiler Class
Properties Class
Sound Class
Sounds Class
Splash Class
Visualizer Class
World Class
Filesystem Functionality
Dir Class
File Class
Filesystem Class
Package Class
GUI-Related Classes
Gui Class
UserInterface Class
Widget Class
WidgetButton Class
WidgetCanvas Class
WidgetCheckBox Class
WidgetComboBox Class
WidgetDialog Class
WidgetDialogColor Class
WidgetDialogFile Class
WidgetDialogImage Class
WidgetDialogMessage Class
WidgetEditLine Class
WidgetEditText Class
WidgetExternBase Class
WidgetExtern Class
WidgetGridBox Class
WidgetGroupBox Class
WidgetHBox Class
WidgetHPaned Class
WidgetIcon Class
WidgetLabel Class
WidgetListBox Class
WidgetManipulator Class
WidgetManipulatorRotator Class
WidgetManipulatorScaler Class
WidgetManipulatorTranslator Class
WidgetMenuBar Class
WidgetMenuBox Class
WidgetScroll Class
WidgetScrollBox Class
WidgetSlider Class
WidgetSpacer Class
WidgetSpinBox Class
WidgetSprite Class
WidgetSpriteNode Class
WidgetSpriteShader Class
WidgetSpriteVideo Class
WidgetSpriteViewport Class
WidgetTabBox Class
WidgetTreeBox Class
WidgetVBox Class
WidgetVPaned Class
WidgetWindow Class
Math Functionality
Geometry Class
Math Common Functions
Math Exponential Functions
Math Matrix Functions
Math Random Functions
Math Trigonometrical Functions
bvec4 Class
dmat4 Class
dvec2 Class
dvec3 Class
dvec4 Class
half Class
hvec2 Class
hvec3 Class
hvec4 Class
ivec2 Class
ivec3 Class
ivec4 Class
mat2 Class
mat3 Class
mat4 Class
quat Class
vec2 Class
vec3 Class
vec4 Class
Node-Related Classes
Node Class
NodeDummy Class
NodeExtern Class
NodeExternBase Class
NodeLayer Class
NodePivot Class
NodeReference Class
NodeTrigger Class
Networking Functionality
Socket Class
Pathfinding-Related Classes
Navigation Class
NavigationMesh Class
NavigationSector Class
Obstacle Class
ObstacleBox Class
ObstacleCapsule Class
ObstacleSphere Class
PathRoute Class
PathRouteIntersection Class
Physics-Related Classes
Physics Class
PhysicsIntersection Class
PhysicsIntersectionNormal Class
Plugins-Related Classes
AutodeskImport Class
ColladaImport Class
OpenFlightImport Class
engine.border Functions
engine.grabber Functions
engine.kinect Functions
engine.oculus Functions
engine.projection Functions
engine.surround Functions
engine.vive Functions
engine.wall Functions
Rendering-Related Classes
Camera Class
Ffp Class
Material Class
Materials Class
Mesh Class
Render Class
Renderer Class
RenderState Class
Shader Class
Texture Class
TextureRender Class
Viewport Class
Content Creation
Content Pipeline
3D Models Requirements
Art Assets Conversion
Content Optimization
Materials
Hierarchy and Inheritance
Custom Materials
Tutorials
Adding Morph Targets
Setting Up Object LODs
Adding Sun, Sky and Clouds
Adding Impostors to Clutters
Unigine Demos
Migrating to UNIGINE 2.3
API Migration
Console Migration
Table of Contents
Warning! This version of documentation is OUTDATED, as it describes an older SDK version! Please switch to the documentation for the latest SDK version.
Warning! This version of documentation describes an old SDK version which is no longer supported! Please upgrade to the latest SDK version.

Field Height

In This Article:

A field height is an object, specifying global water areas where height should be changed (for wakefields, water disturbance, etc.).

Global water object has heightmap for waves and FieldHeight has its own heightmap. Inside the field, the heightmap of the global water is gradually changing from the center of the field height object.

Notice
A field height object will affect water only if the FieldHeight interaction option is enabled on the States tab of the water_global_base material.

FieldHeight objects work fine with particle systems and decal objects.

Water disturbance near the buoy is made by using FieldHeight object.
Notice
The maximum amount of the rendered field heights per frame/bit mask — 8.

See also

  • A FieldHeight class to create a FieldHeight object by using C++, C# or UnigineScript API.

Adding Field Height

To add a height field in the world via UnigineEditor, do the following:

  1. On the Menu bar, choose Create -> Effect -> Field Height.

  2. Place the height field in the world so that it intersects Global Water object.
    Notice
    Make sure that the FieldHeight interaction option is enabled for water_global_base material.
  3. Go to the FieldHeight node's Field tab and set up necessary parameters.
Notice
After adding a FieldHeight object to the scene, you can't see any changes of the global water object because FieldHeight object doesn't have any default heightmap texture.

Setting Up Field Height

On the Field tab of the Nodes panel, the following parameters of the height field can be adjusted:

Setting Bit Masks

Field A field mask. A bit mask that specifies an area of the height field to be applied to water. The height field will be applied to water only if they have matching masks.
Viewport A viewport mask. A bit mask for rendering the height field into the current viewport. For the height field to be rendered into the viewport, its mask should match the camera viewport mask.

Setting Height Parameters

Size Size of the height field along the axes in units.
Atten An attenuation factor indicating how much global water object's heights gradually changing from the center of the height field.
  • The higher the value, the less FieldHeight's heights will have influence on the Global Water's object heights.
Power Power parameter is a multiplier for FieldHeight's heightmap texture values.
  • The higher the value, the more FieldHeight's heights will have influence on the Global Water's object heights.
Texture Heightmap R8 (1-channeled) texture. Heightmap texture is used to create an additional height displacement for water surface.
Last update: 2017-07-03
Build: ()