UnigineScript
The Language
Core Library
Engine Library
Node-Related Classes
GUI-Related Classes
Plugins Library
High-Level Systems
Samples
Usage Examples
C++ API
API Reference
Integration Samples
Usage Examples
C++ Plugins
Migration
Migrating to UNIGINE 2.0
C++ API Migration
Migrating from UNIGINE 2.0 to UNIGINE 2.1

FieldSpacer Class

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

See Also

  • A Unigine::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

This class inherits from Field

Members


FieldSpacer (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.

Arguments

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

float getAttenuation ()

Returns the current attenuation factor for the field spacer. This factor indicates how much geometry is cut off gradually starting from the center of the spacer field:
  • 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 spacer field.

Return value

Attenuation factor value.

vec3 getSize ()

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

The size of the field spacer in units.

int isEllipse ()

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

Return value

1 if the field spacer is of an ellipse shape, otherwise - 0.

void setAttenuation (float attenuation)

Sets an attenuation factor value for the field spacer. This factor indicates how much geometry is cut off gradually starting from the center of the spacer field:
  • 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 spacer field.

Arguments

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

void setEllipse (int ellipse)

Transforms a cubical field spacer into an ellipse-shaped one or vise versa.

Arguments

  • int ellipse - 1 for the ellipse-shaped field spacer, 0 for the field spacer in a form of a cube.

void setSize (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.

Arguments

  • vec3 size - A size of the field spacer along the X, Y and Z axes in units. If a negative value is provided, 0 will be used instead.
Last update: 2017-07-03