Interface Overview
Assets Workflow
Settings and Preferences
Working With Projects
Adjusting Node Parameters
Setting Up Materials
Setting Up Properties
Landscape Tool
Sandworm (Experimental)
Using Editor Tools for Specific Tasks
Extending Editor Functionality
Built-in Node Types
Light Sources
World Objects
Sound Objects
Pathfinding Objects
Setting Up Development Environment
Usage Examples
UUSL (Unified UNIGINE Shader Language)
File Formats
Rebuilding the Engine Tools
Double Precision Coordinates
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

Unigine::FieldSpacer Class

Header: #include <UnigineFields.h>
Inherits: Field

This class allows you to create and modify field spacer objects.

See Also#

  • A FieldSpacer class to edit spacer fields by using C++ API
  • A set of samples located in the data/samples/fields/ folder:
    • spacer_00
    • spacer_01
    • spacer_02

FieldSpacer Class


static FieldSpacerPtr create ( const Math::vec3 & size ) #

Creates a new field spacer of the specified size:
  • If the field spacer is of an ellipse shape, its radius values along the axes must be specified.
  • Otherwise, dimensions of the cube must be specified.


  • const Math::vec3 & size - A size of the field spacer along X, Y and Z axes in units.

void setAttenuation ( float attenuation ) #

Sets an attenuation factor value for the Field Spacer.


  • float attenuation - A new attenuation factor value. If a too small value is provided, 1E-6 will be used instead.

float getAttenuation ( ) const#

Returns the current attenuation factor for the Field Spacer.

Return value

The attenuation factor value.

void setEllipse ( bool ellipse ) #

Transforms a cube-shaped field spacer into an ellipse-shaped one or vice versa.


  • bool ellipse - true for the ellipse-shaped Field Spacer, false for the field spacer in a form of a cube.

bool isEllipse ( ) const#

Returns the value indicating if the field spacer is of an ellipse shape.

Return value

true if the Field Spacer is of an ellipse shape; otherwise, false.

void setSize ( const Math::vec3 & size ) #

Sets a size for the field spacer:
  • If the field spacer is of an ellipse shape, its radius values along the axes must be set.
  • Otherwise, dimensions of the cube must be set.


  • const Math::vec3 & size - Size of the field spacer along the X, Y, and Z axes to be set in units. If a negative value is provided, 0 will be used instead.

Math::vec3 getSize ( ) const#

Returns the size of the Field Spacer:
  • If the field spacer is of an ellipse shape, its radius values along the axes will be returned.
  • Otherwise, dimensions of the cube will be returned.

Return value

Size of the Field Spacer in units.

static int type ( ) #

Returns the type of the object.

Return value

FieldSpacer type identifier.
Last update: 2020-06-16