UnigineEditor
Interface Overview
Assets Workflow
Settings and Preferences
Adjusting Node Parameters
Setting Up Materials
Setting Up Properties
Landscape Tool
Using Editor Tools for Specific Tasks
FAQ
Программирование
Fundamentals
Setting Up Development Environment
Usage Examples
UnigineScript
C++
C#
UUSL (Unified UNIGINE Shader Language)
File Formats
Rebuilding the Engine and Tools
GUI
Double Precision Coordinates
API
Containers
Common Functionality
Controls-Related Classes
Engine-Related Classes
Filesystem Functionality
GUI-Related Classes
Math Functionality
Node-Related Classes
Objects-Related Classes
Networking Functionality
Pathfinding-Related Classes
Physics-Related Classes
Plugins-Related Classes
CIGI Client Plugin
Rendering-Related Classes

Unigine::FieldSpacer Class

Header: #include <UnigineFields.h>
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

Members


static FieldSpacerPtr create ( 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.

static Ptr<FieldSpacer> cast ( const Ptr<Node> & node ) #

Casts a FieldSpacer out of the Node instance.

Arguments

  • const Ptr<Node> & node - Pointer to Node.

Return value

Pointer to FieldSpacer.

static Ptr<FieldSpacer> cast ( const Ptr<Field> & base ) #

Casts a FieldSpacer out of the Field instance.

Arguments

  • const Ptr<Field> & base - Pointer to Field.

Return value

Pointer to FieldSpacer.

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.

float getAttenuation ( ) #

Returns the current attenuation factor for the Field Spacer.

Return value

The attenuation factor value.

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.

int isEllipse ( ) #

Returns the size of the Field Spacer.

Return value

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

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.

Math::vec3 getSize ( ) #

Returns the size of the Field Spacer.

Return value

The size of the Field Spacer in units.

static int type ( ) #

Returns the type of the object.

Return value

FieldSpacer type identifier.
Last update: 18.07.2019