FieldShoreline Class

FieldShoreline Class

Members

---

FieldShoreline cast(Node node)

Casts a FieldShoreline out of the Node instance.

Arguments

• Node node - Node class instance

Return value

FieldShoreline class instance.

FieldShoreline cast(Field base)

Casts a FieldShoreline out of the Field instance.

Arguments

• Field base - Field class instance

Return value

FieldShoreline class instance.

void setImageTexture(Texture texture)

Sets the given texture from Texture instance for FieldShoreline.

Arguments

• Texture texture - Texture instance.

Texture getImageTexture()

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

Return value

int setImageTextureImage(Image image)

Sets the given image as the shoreline texture of FieldShoreline

Arguments

• Image image - Image instance with shoreline texture for FieldShoreline.

int getImageTextureImage(Image image)

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

Arguments

• 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(string name)

Sets the path to the FieldShoreline's shoreline texture.

Arguments

• string name - Path to shoreline texture.

string getImageTextureName()

Returns the path to the FieldShoreline's shoreline texture.

Return value

Path to shoreline texture.

void setSize(vec3 size)

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

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

Arguments

• 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 (512.0f, 512.0f, 512.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()