rs3.properties.material.Material module#

class rs3.properties.material.Material.MaterialProperty(client: Client, materialID: str)#

Bases: _ProxyObject

Define material properties.

Variables:

  • Standard (Standard) – Reference object for modifying property.

  • Geosynthetic (Geosynthetic) – Reference object for modifying property.

  • ReinforcedConcrete (ReinforcedConcrete) – Reference object for modifying property.

Examples: - Material Initial Conditions Script Examples. - Material Constitutive Models Script Examples. - Material Hydraulic Script Examples. - Material Datum Script Examples. - Material Stage Factors Script Examples.

getMaterialName() → str#
setMaterialName(name)#
setMaterialColor(*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

getMaterialColor() → 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]