UnigineScript
The Language
Core Library
Engine Library
Node-Related Classes
GUI-Related Classes
Plugins Library
High-Level Systems
Samples
C++ API
API Reference
Integration Samples
Usage Examples
C++ Plugins
Content Creation
Materials
Unigine Material Library
Tutorials

FieldSpacer Class

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

FieldSpacer Class

This class inherits from Field

Members


FieldSpacer (vec3 size)

Creates a new Field Spacer of the specified size.

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.

Return value

Attenuation factor value.

vec3 getSize ()

Returns the size of the Field Spacer.

Return value

The size of the Field Spacer in units.

int isEllipse ()

Returns a 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.

Arguments

  • float attenuation - Attenuation factor value.

void setEllipse (int ellipse)

Sets a cubical Field Spacer into an ellipse shaped one.

Arguments

  • int ellipse - 1 for ellipse shaped Field Spacer, 0 - for cubical one.

void setSize (vec3 size)

Sets a size for the Field Spacer.

Arguments

  • vec3 size - A size of the Field Spacer along X, Y and Z axes in units.
Last update: 2017-07-03