rs3.properties.joint.Joint module#

class rs3.properties.joint.Joint.JointBase(client: Client, id: str)#

Bases: _ProxyObject, IPropertyGroupAccessors

getInitialJointDeformation() → bool#
setInitialJointDeformation(value: bool)#
getPermeable() → bool#
setPermeable(value: bool)#
getApplySSR() → bool#
setApplySSR(value: bool)#
getApplyPorePressure() → bool#
setApplyPorePressure(value: bool)#
getApplyAdditionalPressureInsideJoint() → bool#
setApplyAdditionalPressureInsideJoint(value: bool)#
getAdditionalPressureInsideJoint() → float#
setAdditionalPressureInsideJoint(value: float)#
getApplyStageFactors() → bool#
setApplyStageFactors(value: bool)#
getProperties()#

Retrieve properties as a dictionary.

setProperties(InitialJointDeformation: bool = None, Permeable: bool = None, ApplySSR: bool = None, ApplyPorePressure: bool = None, ApplyAdditionalPressureInsideJoint: bool = None, AdditionalPressureInsideJoint: float = None, ApplyStageFactors: bool = None)#

Set properties using keyword arguments.

class rs3.properties.joint.Joint.JointStageFactorBase(id: str, stageFactorID: str, client: Client)#

Bases: IStageFactorBase

getAdditionalPressureInsideJointFactor() → float#
getGroundwaterPressureFactor() → float#
class rs3.properties.joint.Joint.JointDefinedStageFactorBase(id: str, stageFactorID: str, client: Client)#

Bases: JointStageFactorBase

setAdditionalPressureInsideJointFactor(value: float)#
setGroundwaterPressureFactor(value: float)#
class rs3.properties.joint.Joint.JointProperty(client: Client, jointID: str)#

Bases: JointBase

Define joint properties.

Variables:

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

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

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

  • GeosyntheticHyperbolic (SwelGeosyntheticHyperboliclex) – Reference object for modifying property.

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

Examples

See Joint Script Examples.

getJointName() → str#
setJointName(name)#
setJointColor(*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

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

getConstitutiveModel() → JointConstitutiveModelTypes#
UI Label:

Failure Criterion

setConstitutiveModel(constitutiveModel: JointConstitutiveModelTypes)#
UI Label:

Failure Criterion

getPiezoID() → str#
setPiezoID(value: str)#
getAdditionalPressureType() → AdditionalPressureType#
setAdditionalPressureType(value: AdditionalPressureType)#