rs3.properties.groundwater.WaterGrid module#

class rs3.properties.groundwater.WaterGrid.WaterGridProperty(client: Client, waterSurfaceID: str, projectID: str)#

Bases: _ProxyObject

Edit a pore water pressure defined by locations.

Examples

See Water Grid Script Examples.

setName(name)#
getName() → str#
setColor(*args)#

Sets the RGBA color for the object.

Raises:

ValueError – If inputs are invalid or out of range.

Notes

Accepted formats:

  • setColor(red, green, blue)

  • setColor(red, green, blue, alpha)

  • setColor(“#RRGGBB”)

  • setColor(“#RRGGBBAA”)

  • setColor(ColorType.Rose)

  • setColor(0xE1E4FF) # Integer COLORREF

getColor() → tuple[int, int, int, int]#

Retrieves the RGBA color of the object.

Returns:

A tuple of four integers representing the red, green, blue, and alpha components of the object’s color, each in the range [0, 255].

Return type:

tuple[int, int, int, int]

setIs3D(value: bool)#
getIs3D() → bool#
set2DPlaneType(plane2DType: WaterGridPlane2DType)#
get2DPlaneType() → WaterGridPlane2DType#
setInterpolationMethod(interpolationMethod: WaterGridInterpolationMethodType)#
getInterpolationMethod() → WaterGridInterpolationMethodType#
setWaterGridPointSetType(type: WaterGridPointSetType)#
getWaterGridPointSetType() → WaterGridPointSetType#
setWaterGridPoints(value: list[tuple[float, float, float, float]])#

Set water grid point values.

Parameters:

value (list[tuple[float, float, float, float]]) –

A list of water grid points defined as (x, y, z, value).

Important: - The coordinates must always be provided as 3D (x, y, z), regardless of whether the water grid is defined as 2D or 3D. - For 2D grids, the unused coordinate must still be supplied (typically set to 0.0).

The meaning of value depends on the water grid point set type: - Pore pressure - Pressure head - Total head

The interpretation is determined by the configured water grid type.

getWaterGridPoints() → list[tuple[float, float, float, float]]#

Retrieve water grid point values.

Returns:

A list of water grid points in the format (x, y, z, value).

Important: - Coordinates are always returned in 3D format. - The returned value represents pore pressure, pressure head, or total head, depending on the water grid point set type.

Return type:

list[tuple[float, float, float, float]]