Unigine::FieldHeight Class

FieldHeight Class

Members

---

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 FieldHeight's attenuation factor value.

Attenuation factor indicates the rate of FiledHeight influence attenuation from the center of the object to its edges.

The default value is 1.0f.

Arguments

• float attenuation - Attenuation factor.

float getAttenuation()

Returns FieldHeight's attenuation factor value.

Attenuation factor indicates the rate of FiledHeight influence attenuation from the center of the object to its edges.

The default value is 1.0f.

Return value

Attenuation factor.

void setImageTexture(const Ptr<Texture> & texture)

Sets the given texture from Texture instance for FieldHeight.

Arguments

• const Ptr<Texture> & texture - Texture instance.

Texture getImageTexture()

Returns the heightmap texture (from GPU) and saves it into 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 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 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 heightmap texture.

const char * getImageTextureName()

Returns the path to the FieldHeight's heightmap texture.

Return value

Path to heightmap texture.

void setPower(float power)

Sets FieldHeight's power value. Power is a multiplier for loaded heightmap texture values.

The default value is 1.0f.

Arguments

• float power - Power value.

float getPower()

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

The default value is 1.0f.

Return value

Power value.

void setSize(const Math::vec3 & size)

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

The default value 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.

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

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)

int type()