Unigine::FieldShoreline Class

FieldShoreline Class

Members

---

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

Casts the Node pointer to the FieldShoreline pointer.

Arguments

• const Ptr<Node> & node - Node smart pointer.

Return value

FieldShoreline smart pointer.

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

Casts the Field pointer to the FieldShoreline pointer.

Arguments

• const Ptr<Field> & base - Field smart pointer.

Return value

FieldShoreline smart pointer.

void setImageTexture(const Ptr<Texture> & texture)

Sets the given texture from Texture instance for FieldShoreline.

Arguments

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

Ptr<Texture> getImageTexture()

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

Return value

int setImageTextureImage(const Ptr<Image> & image)

Sets the given image as the shoreline texture of FieldShoreline

Arguments

• const Ptr<Image> & image - Image instance with shoreline texture for FieldShoreline.

int getImageTextureImage(const Ptr<Image> & image)

Grabs the texture for FieldShoreline (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 FieldShoreline's shoreline texture.

Arguments

• const char * name - Path to shoreline texture.

const char * getImageTextureName()

Returns the path to the FieldShoreline's shoreline texture.

Return value

Path to shoreline texture.

void setSize(const Math::vec3 & size)

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

The default value is (512.0f, 512.0f, 512.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)

Math::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()