FieldSpacer Class
The scope of applications for UnigineScript is limited to implementing materials-related logic (material expressions, scriptable materials, brush materials). Do not use UnigineScript as a language for application logic, please consider C#/C++ instead, as these APIs are the preferred ones. Availability of new Engine features in UnigineScript (beyond its scope of applications) is not guaranteed, as the current level of support assumes only fixing critical issues.
Inherits from: | 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
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.
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.
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.void setEllipse ( int ellipse ) #
Transforms a cube-shaped field spacer into an ellipse-shaped one or vice versa.Arguments
- int ellipse - 1 for the ellipse-shaped field spacer, 0 for the field spacer in a form of a cube.
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 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 - 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.
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
Size of the Field Spacer in units.static int type ( ) #
Returns the type of the object.Return value
FieldSpacer type identifier.Last update:
2021-12-13
Help improve this article
Was this article helpful?
(or select a word/phrase and press Ctrl+Enter)