rs3.properties.DiscreteFunction module#

class rs3.properties.DiscreteFunction.DiscreteFunction(client: Client, discreteFunctionID: str)#

Bases: _ProxyObject

getName() → str#

setName(name)#

setPointX(value: list[float])#

getPointX() → list[float]#

setPointY(value: list[float])#

getPointY() → list[float]#

setPointZ(value: list[float])#

getPointZ() → list[float]#

setPointC(value: list[float])#

getPointC() → list[float]#

setPointCu(value: list[float])#

getPointCu() → list[float]#

setPointPhi(value: list[float])#

getPointPhi() → list[float]#

setPointModulus(value: list[float])#

getPointModulus() → list[float]#

getDrainageCondition() → DiscreteDrainedMode#

setDrainageCondition(IsDrained: DiscreteDrainedMode)#

getIs3D() → bool#

setIs3D(Is3D: bool)#

getPlane2DType() → Plane2DType#

setPlane2DType(plane2D_type: Plane2DType)#

getHasModulus() → bool#

setHasModulus(hasModulus: bool)#

getResidualStrengthFactor() → float#

setResidualStrengthFactor(residualStrengthFactor: float)#

getTensileStrength() → float#

setTensileStrength(tensileStrength: float)#

getResidualTensileStrength() → float#

setResidualTensileStrength(tensileStrengthResidual: float)#

getInterpolationMethod() → DiscreteFunctionInterpolationMethodType#

setInterpolationMethod(interpolationMethod: DiscreteFunctionInterpolationMethodType)#

setColor(*args)#

Sets the RGBA color for the object.

Notes

Accepted formats:

setColor(red, green, blue)
setColor(red, green, blue, alpha)
setColor(“#RRGGBB”)
setColor(“#RRGGBBAA”)
setColor(ColorType.Rose)
setColor(0xE1E4FF) # Integer COLORREF

Raises:: ValueError – If inputs are invalid or out of range.

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]