rs3.properties.groundwater.WaterByLocation module#

class rs3.properties.groundwater.WaterByLocation.WaterByLocationProperty(client: Client, waterSurfaceID: str, projectID: str)#

Bases: _ProxyObject

Edit water surface defined by locations.

Examples

See Water By Location 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]

setInterpolationMethod(interpolationMethod: GroundwaterInterpolationMethodType)#
getInterpolationMethod() → GroundwaterInterpolationMethodType#
setResolutionMethod(resolutionMethod: GroundwaterResolutionMethodType)#
getResolutionMethod() → GroundwaterResolutionMethodType#
setIsExtrapolate(value: bool)#
getIsExtrapolate() → bool#
setWaterSurfaceLocation(value: list[tuple[float, float, float]])#

Each water surface is defined by at least 3 points to form a surface

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

Each water surface is defined by at least 3 points to form a surface