Unigine::FieldSpacer Class

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.

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.

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 ( ) const#

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 Field Spacer:

• 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 Field Spacer.

Return value

Attenuation factor value.

void setEllipse ( bool ellipse ) #

Transforms a cube-shaped Field Spacer into an ellipse-shaped one or vice versa.

Arguments

• bool ellipse - true for the ellipse-shaped Field Spacer, false for the Field Spacer in a form of a cube.

bool isEllipse ( ) const#

Returns the value indicating if the field spacer is of an ellipse shape.

Return value

true if the Field Spacer is of an ellipse shape; otherwise, false.

void setSize ( const Math::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

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

Math::vec3 getSize ( ) const#

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.