Unigine.FieldSpacer Class
| 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
Properties
float Attenuation#
The current attenuation factor for the field spacer.
set
Sets an attenuation factor value for the Field Spacer.
set value -
A new attenuation factor value. If a too small value is provided, 1E-6 will be used instead.
vec3 Size#
The size of the field spacer.
set
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.
set value -
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.
bool IsEllipse#
The size of the field spacer.
set
Transforms a cube-shaped field spacer into an ellipse-shaped one or vice versa.
set value -
true for the ellipse-shaped Field Spacer, false for the field spacer in a form of a cube.
Members
static 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.
static int type ( ) #
Returns the type of the object.Return value
FieldSpacer type identifier.Last update:
2020-07-31
Help improve this article
Was this article helpful?
(or select a word/phrase and press Ctrl+Enter)