This page has been translated automatically.
Video Tutorials
Interface
Essentials
Advanced
How To
UnigineEditor
Interface Overview
Assets Workflow
Settings and Preferences
Working With Projects
Adjusting Node Parameters
Setting Up Materials
Setting Up Properties
Lighting
Landscape Tool
Sandworm
Using Editor Tools for Specific Tasks
Extending Editor Functionality
Built-in Node Types
Nodes
Objects
Decals
Light Sources
Geodetics
World Nodes
Sound Objects
Pathfinding Objects
Players
Programming
Fundamentals
Setting Up Development Environment
Usage Examples
C++
C#
UnigineScript
UUSL (Unified UNIGINE Shader Language)
Plugins
File Formats
Rebuilding the Engine 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
Objects-Related Classes
Networking Functionality
Pathfinding-Related Classes
Physics-Related Classes
Plugins-Related Classes
IG Plugin
CIGIConnector Plugin
Rendering-Related Classes
Content Creation
Content Optimization
Materials
Material Nodes Library
Miscellaneous
Input
Math
Matrix
Textures
Art Samples
Tutorials
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 Spacer

A Field Spacer is an object, specifying geometry areas of grass and water that should not be rendered. Inside the Field Spacer, geometry is cut off gradually starting from the center of the field.

The Field Spacer allows you to dynamically adapt grass and water surface to other objects in the scene. For example:

  • A Field Spacer can be used to specify area under a building and around it where grass should not grow. Moreover, by using the attenuation factor, it is possible to create thinner grass around the building.
  • A Field Spacer can be set for a boat so that water is not rendered inside it.
Notice
A Field Spacer affects grass or water only if the FieldSpacer Interaction flag is set on the States tab of the corresponding material.
Boat without the Field Spacer: water is inside the boat
Boat with the Field Spacer: the Field Spacer cuts water off
Notice
The maximum number of FieldSpacers rendered per frame/bit mask is limited to:
  • 341 (DirectX)
  • 42 (OpenGL)

See also#

  • The FieldSpacer class to manage spacer fields via API
  • A set of samples located in the data/samples/fields/ folder:
    • spacer_00
    • spacer_01
    • spacer_02

Adding Field Spacer#

To add a Field Spacer in the world via UnigineEditor, do the following:

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

  2. Place the spacer field in the world so that it intersects geometry required to be cut off:
    Notice
    Make sure that the Spacer interaction flag is set for materials applied to grass or water.
    • In case of grass, the Field Spacer should intersect the surface, on which grass grows.
    • In case of water, the Field Spacer should intersect the water surface:

If you are going to use the Field Spacer with dynamic objects, it is better to add the field as a child node to this object so that it can correctly affect grass or water geometry.

Editing Field Spacer#

In the Field Spacer section (Parameters window -> Node tab), the following parameters of the Field Spacer can be adjusted:

Setting Form of Spacer#

Ellipse Indicates whether the Field Spacer is ellipsoid-shaped. If unchecked, the Field Spacer has a form of a cube.

Setting Bit Masks#

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

Setting Size and Attenuation#

Size Size of the Field Spacer along the axes in units.
  • If the Ellipse option is unchecked, this is the size of the Field Spacer box along the axes.
  • If the Ellipse option is checked, these are the ellipse radius values along the axes.
Attenuation An attenuation factor indicating how much geometry is cut off gradually starting from the center of the Field Spacer.
  • By the minimum value of 0, all geometry inside the Field Spacer will be rendered.
  • The higher the value, the less geometry will be rendered inside the Field Spacer.
Atten = 5
Atten = 15
Last update: 2021-12-13
Build: ()