Programming
Fundamentials
Setting Up Development Environment
UnigineScript
High-Level Systems
C++
C#
UUSL (Unified UNIGINE Shader Language)
File Formats
Rebuilding the Engine and Tools
GUI
Double Precision Coordinates
API
Core Library
Containers
Engine Classes
Node-Related Classes
Rendering-Related Classes
Physics-Related Classes
Bounds-Related Classes
GUI-Related Classes
Controls-Related Classes
Pathfinding-Related Classes
Utility Classes

FieldSpacer Class

Interface for field spacer handling.

To use this class, include the UnigineFieldSpacer.h file.

FieldSpacer Class

Members


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

Arguments

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

void setSize (const Math::vec3 & size)

Sets a size for the Field Spacer.

Arguments

  • const Math::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.

int isEllipse ()

Returns the size of the Field Spacer.

Return value

1 if the Field Spacer is of an ellipse shape; otherwise, 0.

float getAttenuation ()

Returns the current attenuation factor for the Field Spacer.

Return value

The attenuation factor value.

Math::vec3 getSize ()

Returns the size of the Field Spacer.

Return value

The size of the Field Spacer in units.

void setAttenuation (float attenuation)

Sets an attenuation factor value for the Field Spacer.

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.

Arguments

  • int ellipse - 1 for the ellipse-shaped Field Spacer, 0 for the cubical one.
Last update: 2017-07-03