Unigine::FieldSpacer Class

FieldSpacer Class

Members

static FieldSpacerPtr create ( const Math::vec3 & 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 ) #

Arguments

• float attenuation - A new attenuation factor value. If a too small value is provided, 1E-6 will be used instead.

float getAttenuation ( ) const#

Return value

void setEllipse ( bool ellipse ) #

Arguments

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

bool isEllipse ( ) const#

Return value

void setSize ( const Math::vec3 & size ) #

• 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#

• 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

static int type ( ) #

Return value