Unigine::FieldHeight Class

Header:	#include <UnigineFields.h>
Inherits:	Field

List of functions:

This class is used to create and modify a field height. The field is applied to global water and specifies areas where height of waves should be changed.

NoticeThe maximum number of the rendered FieldHeight objects per frame/bit mask is 8.

Creating a Height Field

Notice
					When creating a FieldHeight object you should specify a heightmap texture for it as this object doesn't have any default texture.
				

Source code (C++)

// create a new instance of the FieldHeight class and set its transformation
FieldHeightPtr height = FieldHeight::create();
height->setTransform(Mat4(1));
// set the size of the field
height->setSize(vec3(4096.0f, 4096.0f, 512.0f));
// set the heightmap texture
height->setImageTextureName("unigine_project/textures/fh_static.png");

To add the FieldHeight object to UnigineEditor, add the following code:

Source code (C++)

// release ownership of the FieldHeight class
height->release();
// add the FieldHeight to the list of editor nodes
Editor *editor = Editor::get();
editor->addNode(height->getNode());

FieldHeight Class

Members

static FieldHeightPtr create()

The default constructor. Creates a FieldHeight instance with the default size vec3(1.0f, 1.0f, 1.0f).

NoticeBy default, a heightmap texture is empty. Specify it after creating the FieldHeight by using an apropriate function.

Ptr<FieldHeight> cast(const Ptr<Field> & base)

Casts a FieldHeight out of the Field instance.

Arguments

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

Return value

Pointer to FieldHeight.

Ptr<FieldHeight> cast(const Ptr<Node> & node)

Casts a FieldHeight out of the Node instance.

Arguments

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

Return value

Pointer to FieldHeight.

void setAttenuation(float attenuation)

Sets the FieldHeight's attenuation factor value. The attenuation factor indicates the rate of FiledHeight influence attenuation from the center of the object to its edges. By default the attenuation factor is set to 1.0f.

Arguments

float attenuation - Attenuation factor. The higher the value, the less FieldHeight's heights will have influence on the Global Water's object heights.

float getAttenuation()

Returns the FieldHeight's attenuation factor value. The attenuation factor indicates the rate of FiledHeight influence attenuation from the center of the object to its edges.

Return value

Attenuation factor. The higher the value, the less FieldHeight's heights will have influence on the Global Water's object heights. The default value is 1.0f.

void setImageTexture(const Ptr<Texture> & texture)

Sets the given texture from the Texture instance for the FieldHeight.

Arguments

const Ptr<Texture> & texture - Texture instance.

Texture getImageTexture()

Returns the heightmap texture (from GPU) and saves it into the given Texture instance.

Return value

Texture instance into which the texture will be saved.

int setImageTextureImage(const Ptr<Image> & image)

Sets the given image as the heightmap texture of the FieldHeight.

Arguments

const Ptr<Image> & image - Image instance with heightmap for FieldHeight.

Return value

1 if the texture is set successfully; otherwise, 0.

int getImageTextureImage(const Ptr<Image> & image)

Grabs the texture for the FieldHeight (already loaded to GPU) and saves it into the given Image instance.

Arguments

const Ptr<Image> & image - Image instance into which the texture will be saved.

Return value

1 if the texture has been grabbed successfully; otherwise, 0.

void setImageTextureName(const char * name)

Sets the path to the FieldHeight's heightmap texture.

Arguments

const char * name - Path to the heightmap texture.

const char * getImageTextureName()

Returns the path to the FieldHeight's heightmap texture.

Return value

Path to the heightmap texture.

void setPower(float power)

Sets the FieldHeight's power value. The power is a multiplier for loaded heightmap texture values. By default the power is set to 1.0f.

Arguments

float power - Power value. The higher the value, the more FieldHeight's heights will have influence on the Global Water's object heights.

float getPower()

Returns the FieldHeight's power value. The power is a multiplier for loaded heightmap texture values.

Return value

Power value. The higher the value, the more FieldHeight's heights will have influence on the Global Water's object heights. The default value is 1.0f.

void setSize(const Math::vec3 & size)

Sets the vec3 size vector of the FieldHeight's object. By default, the size is (1.0f, 1.0f, 1.0f).

Arguments

const Math::vec3 & size - Size vector (x,y,z), where:
- x value is length of the FieldHeight along X axis (in units),
- y value is length of the FieldHeight along Y axis (in units),
- z value is length of the FieldHeight along Z axis (in units).

vec3 getSize()

Returns the vec3 size vector of the FieldHeight's object.

Return value

Size vector (x,y,z), where:

x value is length of the FieldHeight along X axis (in units),
y value is length of the FieldHeight along Y axis (in units),
z value is length of the FieldHeight along Z axis (in units).

The default value is (1.0f, 1.0f, 1.0f).

int type()

Returns the type of the object.

Return value

FieldHeight type identifier.

Last update: 2017-07-03

Help improve this article

Was this article helpful?

Report a problem related to this article

(or select a word/phrase and press Ctrl+Enter)