RS3Scripting 4.42.0__py3-none-any.whl

rs3/properties/material/constitutiveModel/jointOption/BartonBandis.py

@@ -0,0 +1,109 @@
+# Generated by RPCBinder in RFC_Common.
+from rs3._client import Client
+from ._PropertyAccessor import PropertyAccessor
+from rs3._proxyObject import _ProxyObject
+from rs3.properties.IPropertyGroupAccessors import IPropertyGroupAccessors
+from rs3.properties.stageFactors.IStageFactorBase import IStageFactorBase
+import rs3.generatedFiles.MaterialJointStageFactorService_pb2_grpc as MaterialJointStageFactorService_pb2_grpc
+class BartonBandisBase(_ProxyObject, IPropertyGroupAccessors):
+    def __init__(self, client: Client, id: str):
+        super().__init__(client, id)
+        self._propertyAccessor = PropertyAccessor(client, id)
+    def getDilationAngle(self) -> float:
+        return self._propertyAccessor.getDoubleProperty("DilationAngle")
+    def setDilationAngle(self, value: float):
+        self._propertyAccessor.setDoubleProperty("DilationAngle", value)
+    def getJCS(self) -> float:
+        return self._propertyAccessor.getDoubleProperty("JCS")
+    def setJCS(self, value: float):
+        self._propertyAccessor.setDoubleProperty("JCS", value)
+    def getJRC(self) -> float:
+        return self._propertyAccessor.getDoubleProperty("JRC")
+    def setJRC(self, value: float):
+        self._propertyAccessor.setDoubleProperty("JRC", value)
+    def getResidualFrictionAngle(self) -> float:
+        return self._propertyAccessor.getDoubleProperty("residFric")
+    def setResidualFrictionAngle(self, value: float):
+        self._propertyAccessor.setDoubleProperty("residFric", value)
+    def getResidualStrength(self) -> bool:
+        return self._propertyAccessor.getBoolValue("residStrength")
+    def setResidualStrength(self, value: bool):
+        self._propertyAccessor.setBoolValue("residStrength", value)
+    def getProperties(self):
+        return {
+            "DilationAngle": self.getDilationAngle(),
+            "JCS": self.getJCS(),
+            "JRC": self.getJRC(),
+            "ResidualFrictionAngle": self.getResidualFrictionAngle(),
+            "ResidualStrength": self.getResidualStrength(),
+        }
+    def setProperties(self, DilationAngle: float = None, JCS: float = None, JRC: float = None, ResidualFrictionAngle: float = None, ResidualStrength: bool = None):
+        if DilationAngle is not None:
+            self.setDilationAngle(DilationAngle)
+        if JCS is not None:
+            self.setJCS(JCS)
+        if JRC is not None:
+            self.setJRC(JRC)
+        if ResidualFrictionAngle is not None:
+            self.setResidualFrictionAngle(ResidualFrictionAngle)
+        if ResidualStrength is not None:
+            self.setResidualStrength(ResidualStrength)
+class BartonBandisStageFactorBase(IStageFactorBase):
+    def __init__(self, id : str, stageFactorID : str, client : Client):
+        super().__init__(id, stageFactorID, client, MaterialJointStageFactorService_pb2_grpc.MaterialJointStageFactorServiceStub(client.channel))
+    def getDilationAngleFactor(self) -> float:
+        return self._stageFactorPropertyAccessor.getDoubleProperty("DilationAngle")
+    def getJCSFactor(self) -> float:
+        return self._stageFactorPropertyAccessor.getDoubleProperty("BartonBandis_JCS")
+    def getJRCFactor(self) -> float:
+        return self._stageFactorPropertyAccessor.getDoubleProperty("BartonBandis_JRC")
+    def getFrictionAngleFactor(self) -> float:
+        return self._stageFactorPropertyAccessor.getDoubleProperty("BartonBandis_FrictionAngle")
+class BartonBandisDefinedStageFactorBase(BartonBandisStageFactorBase):
+    def setDilationAngleFactor(self, value: float):
+        self._stageFactorPropertyAccessor.setDoubleProperty("DilationAngle", value)
+    def setJCSFactor(self, value: float):
+        self._stageFactorPropertyAccessor.setDoubleProperty("BartonBandis_JCS", value)
+    def setJRCFactor(self, value: float):
+        self._stageFactorPropertyAccessor.setDoubleProperty("BartonBandis_JRC", value)
+    def setFrictionAngleFactor(self, value: float):
+        self._stageFactorPropertyAccessor.setDoubleProperty("BartonBandis_FrictionAngle", value)
+
+################ Code below this line will not be overridden ################
+from rs3.properties.material.constitutiveModel.jointOption.PlaneOrientationBase import PlaneOrientationBase
+from rs3.properties.stageFactors.StageFactorInterfaces import AbsoluteStageFactorInterface
+from rs3.properties.material.constitutiveModel.jointOption._PropertyAccessor import JointOptionStageFactorPropertyAccessor
+
+class BartonBandisStageFactor(BartonBandisStageFactorBase):
+    def __init__(self, id : str, stageFactorID : str, client : Client, materialId : str):
+        self._client = client
+        self._objectId = stageFactorID
+        self.parentID = id
+        self._materialID = materialId
+        self._stub = MaterialJointStageFactorService_pb2_grpc.MaterialJointStageFactorServiceStub(client.channel)
+        self._stageFactorPropertyAccessor = JointOptionStageFactorPropertyAccessor(id, stageFactorID, client, self._stub,  self._materialID)
+
+class BartonBandisDefinedStageFactor(BartonBandisDefinedStageFactorBase):
+    def __init__(self, id : str, stageFactorID : str, client : Client, materialId : str):
+        self._client = client
+        self._objectId = stageFactorID
+        self.parentID = id
+        self._materialID = materialId
+        self._stub = MaterialJointStageFactorService_pb2_grpc.MaterialJointStageFactorServiceStub(client.channel)
+        self._stageFactorPropertyAccessor = JointOptionStageFactorPropertyAccessor(id, stageFactorID, client, self._stub,  self._materialID)
+
+class BartonBandis(BartonBandisBase, PlaneOrientationBase):
+    """
+    Example:
+        See :ref:`joint_control_examples`.
+        
+    """
+    def __init__(self, client: Client, materialId : str, jointId: str):
+        PlaneOrientationBase.__init__(self, client, materialId, jointId)
+        self._client = client
+        self._objectId = jointId
+        self._materialId = materialId
+        self._propertyAccessor = PropertyAccessor(client, materialId, jointId)
+        self.StageFactorInterface = AbsoluteStageFactorInterface[BartonBandisDefinedStageFactor, BartonBandisStageFactor](jointId, client, BartonBandisDefinedStageFactor, BartonBandisStageFactor, True, materialId)
+        
+

rs3/properties/material/constitutiveModel/jointOption/MaterialJoint.py

@@ -0,0 +1,48 @@
+# Generated by RPCBinder in RFC_Common.
+from rs3._client import Client
+from ._PropertyAccessor import PropertyAccessor
+from rs3._proxyObject import _ProxyObject
+from rs3.properties.IPropertyGroupAccessors import IPropertyGroupAccessors
+class MaterialJointBase(_ProxyObject, IPropertyGroupAccessors):
+    def __init__(self, client: Client, id: str):
+        super().__init__(client, id)
+        self._propertyAccessor = PropertyAccessor(client, id)
+    def getUseStageFactors(self) -> bool:
+        return self._propertyAccessor.getBoolValue("UseStageFactors")
+    def setUseStageFactors(self, value: bool):
+        self._propertyAccessor.setBoolValue("UseStageFactors", value)
+    def getProperties(self):
+        return {
+            "UseStageFactors": self.getUseStageFactors(),
+        }
+    def setProperties(self, UseStageFactors: bool = None):
+        if UseStageFactors is not None:
+            self.setUseStageFactors(UseStageFactors)
+
+################ Code below this line will not be overridden ################
+from rs3.properties.material.constitutiveModel.jointOption.MohrCoulomb import MohrCoulomb
+from rs3.properties.material.constitutiveModel.jointOption.BartonBandis import BartonBandis
+from rs3.properties.material.constitutiveModel.jointOption.SimpleHyperbolic import SimpleHyperbolic
+import rs3.generatedFiles.MaterialStrengthService_pb2_grpc as MaterialStrengthService_pb2_grpc
+from ._PropertyAccessor import MaterialJointPropertyAccessor
+from rs3.properties.PropertyEnums import *
+class MaterialJoint(MaterialJointBase):
+    """
+    Example:
+        See :ref:`joint_control_examples`.
+        
+    """
+    def __init__(self, client: Client, materialId : str, jointId: str):
+        self._client = client
+        self._objectId = jointId
+        self._materialId = materialId
+        self._propertyAccessor = MaterialJointPropertyAccessor(client, materialId, jointId)
+        self._stub = MaterialStrengthService_pb2_grpc.MaterialStrengthServiceStub(client.channel)        
+        self.MohrCoulomb = MohrCoulomb(client, materialId, jointId)
+        self.BartonBandis = BartonBandis(client, materialId, jointId)
+        self.SimpleHyperbolic = SimpleHyperbolic(client, materialId, jointId)
+        
+    def getSlipCriterion(self) -> MaterialJointSlipCriterionType:
+        return self._propertyAccessor.getEnumValue("SlipCriterionType", MaterialJointSlipCriterionType)
+    def setSlipCriterion(self, StiffnessType : MaterialJointSlipCriterionType):
+        self._propertyAccessor.setEnumValue("SlipCriterionType", StiffnessType.value)

rs3/properties/material/constitutiveModel/jointOption/MaterialJointOptions.py

@@ -0,0 +1,32 @@
+from rs3._client import Client
+from rs3._proxyObject import _ProxyObject
+from rs3.properties.material.constitutiveModel.jointOption.MaterialJoint import MaterialJoint
+import rs3.generatedFiles.MaterialJointService_pb2_grpc as MaterialJointService_pb2_grpc
+import rs3.generatedFiles.MaterialJointService_pb2 as MaterialJointService_pb2
+import rs3.generatedFiles.MaterialDataService_pb2_grpc as MaterialDataService_pb2_grpc
+from ._PropertyAccessor import BasePropertyAccessor
+class MaterialJointOptions(_ProxyObject):
+    """
+    Define material joint properites.
+    
+    Example:
+        See :ref:`joint_control_examples`.
+    """
+    def __init__(self, client: Client, id: str):
+        super().__init__(client, id)
+        self._stub = MaterialJointService_pb2_grpc.MaterialJointServiceStub(client.channel)
+        self._materialDataService = MaterialDataService_pb2_grpc.MaterialDataServiceStub(self._client.channel)
+        self._propertyAccessor = BasePropertyAccessor(client, self._objectId, self._materialDataService)
+    
+    def getJoint(self, jointIndex: int) -> MaterialJoint:
+        """
+        Get joint of the joint material. jointIndex can be 0, 1, and 2.
+        """
+        request = MaterialJointService_pb2.GetJointRequest(objectId=self._objectId,jointIndex=jointIndex)
+        result : MaterialJointService_pb2.GetJointResponse = self._client.callFunction(self._stub.GetJoint, request)
+        return MaterialJoint(self._client, self._objectId, result.jointId)
+    
+    def setNumberOfJoint(self, value: int):
+        self._propertyAccessor.setIntProperty("JointsCount", value)
+    def getNumberOfJoint(self) -> int:
+        return self._propertyAccessor.getIntProperty("JointsCount")

rs3/properties/material/constitutiveModel/jointOption/MohrCoulomb.py

@@ -0,0 +1,142 @@
+# Generated by RPCBinder in RFC_Common.
+from rs3._client import Client
+from ._PropertyAccessor import PropertyAccessor
+from rs3._proxyObject import _ProxyObject
+from rs3.properties.IPropertyGroupAccessors import IPropertyGroupAccessors
+from rs3.properties.stageFactors.IStageFactorBase import IStageFactorBase
+import rs3.generatedFiles.MaterialJointStageFactorService_pb2_grpc as MaterialJointStageFactorService_pb2_grpc
+class MohrCoulombBase(_ProxyObject, IPropertyGroupAccessors):
+    def __init__(self, client: Client, id: str):
+        super().__init__(client, id)
+        self._propertyAccessor = PropertyAccessor(client, id)
+    def getDilationAngle(self) -> float:
+        return self._propertyAccessor.getDoubleProperty("DilationAngle")
+    def setDilationAngle(self, value: float):
+        self._propertyAccessor.setDoubleProperty("DilationAngle", value)
+    def getTensileStrength(self) -> float:
+        return self._propertyAccessor.getDoubleProperty("tensileStrength")
+    def setTensileStrength(self, value: float):
+        self._propertyAccessor.setDoubleProperty("tensileStrength", value)
+    def getCohesion(self) -> float:
+        return self._propertyAccessor.getDoubleProperty("peakCohe")
+    def setCohesion(self, value: float):
+        self._propertyAccessor.setDoubleProperty("peakCohe", value)
+    def getFrictionAngle(self) -> float:
+        return self._propertyAccessor.getDoubleProperty("peakFric")
+    def setFrictionAngle(self, value: float):
+        self._propertyAccessor.setDoubleProperty("peakFric", value)
+    def getResidualStrength(self) -> bool:
+        return self._propertyAccessor.getBoolValue("resid")
+    def setResidualStrength(self, value: bool):
+        self._propertyAccessor.setBoolValue("resid", value)
+    def getResidualTensileStrength(self) -> float:
+        return self._propertyAccessor.getDoubleProperty("residTensile")
+    def setResidualTensileStrength(self, value: float):
+        self._propertyAccessor.setDoubleProperty("residTensile", value)
+    def getResidualFrictionAngle(self) -> float:
+        return self._propertyAccessor.getDoubleProperty("residFric")
+    def setResidualFrictionAngle(self, value: float):
+        self._propertyAccessor.setDoubleProperty("residFric", value)
+    def getResidualCohesion(self) -> float:
+        return self._propertyAccessor.getDoubleProperty("residCohe")
+    def setResidualCohesion(self, value: float):
+        self._propertyAccessor.setDoubleProperty("residCohe", value)
+    def getProperties(self):
+        return {
+            "DilationAngle": self.getDilationAngle(),
+            "TensileStrength": self.getTensileStrength(),
+            "Cohesion": self.getCohesion(),
+            "FrictionAngle": self.getFrictionAngle(),
+            "ResidualStrength": self.getResidualStrength(),
+            "ResidualTensileStrength": self.getResidualTensileStrength(),
+            "ResidualFrictionAngle": self.getResidualFrictionAngle(),
+            "ResidualCohesion": self.getResidualCohesion(),
+        }
+    def setProperties(self, DilationAngle: float = None, TensileStrength: float = None, Cohesion: float = None, FrictionAngle: float = None, ResidualStrength: bool = None, ResidualTensileStrength: float = None, ResidualFrictionAngle: float = None, ResidualCohesion: float = None):
+        if DilationAngle is not None:
+            self.setDilationAngle(DilationAngle)
+        if TensileStrength is not None:
+            self.setTensileStrength(TensileStrength)
+        if Cohesion is not None:
+            self.setCohesion(Cohesion)
+        if FrictionAngle is not None:
+            self.setFrictionAngle(FrictionAngle)
+        if ResidualStrength is not None:
+            self.setResidualStrength(ResidualStrength)
+        if ResidualTensileStrength is not None:
+            self.setResidualTensileStrength(ResidualTensileStrength)
+        if ResidualFrictionAngle is not None:
+            self.setResidualFrictionAngle(ResidualFrictionAngle)
+        if ResidualCohesion is not None:
+            self.setResidualCohesion(ResidualCohesion)
+class MohrCoulombStageFactorBase(IStageFactorBase):
+    def __init__(self, id : str, stageFactorID : str, client : Client):
+        super().__init__(id, stageFactorID, client, MaterialJointStageFactorService_pb2_grpc.MaterialJointStageFactorServiceStub(client.channel))
+    def getDilationAngleFactor(self) -> float:
+        return self._stageFactorPropertyAccessor.getDoubleProperty("DilationAngle")
+    def getTensileStrengthFactor(self) -> float:
+        return self._stageFactorPropertyAccessor.getDoubleProperty("MohrCoulomb_TensileStrength")
+    def getCohesionFactor(self) -> float:
+        return self._stageFactorPropertyAccessor.getDoubleProperty("MohrCoulomb_CohesionPeak")
+    def getFrictionAngleFactor(self) -> float:
+        return self._stageFactorPropertyAccessor.getDoubleProperty("MohrCoulomb_FrictionAnglePeak")
+    def getResidualTensileStrengthFactor(self) -> float:
+        return self._stageFactorPropertyAccessor.getDoubleProperty("MohrCoulomb_TensileStrengthResidual")
+    def getResidualFrictionAngleFactor(self) -> float:
+        return self._stageFactorPropertyAccessor.getDoubleProperty("MohrCoulomb_FrictionAngleResidual")
+    def getResidualCohesionFactor(self) -> float:
+        return self._stageFactorPropertyAccessor.getDoubleProperty("MohrCoulomb_CohesionResidual")
+class MohrCoulombDefinedStageFactorBase(MohrCoulombStageFactorBase):
+    def setDilationAngleFactor(self, value: float):
+        self._stageFactorPropertyAccessor.setDoubleProperty("DilationAngle", value)
+    def setTensileStrengthFactor(self, value: float):
+        self._stageFactorPropertyAccessor.setDoubleProperty("MohrCoulomb_TensileStrength", value)
+    def setCohesionFactor(self, value: float):
+        self._stageFactorPropertyAccessor.setDoubleProperty("MohrCoulomb_CohesionPeak", value)
+    def setFrictionAngleFactor(self, value: float):
+        self._stageFactorPropertyAccessor.setDoubleProperty("MohrCoulomb_FrictionAnglePeak", value)
+    def setResidualTensileStrengthFactor(self, value: float):
+        self._stageFactorPropertyAccessor.setDoubleProperty("MohrCoulomb_TensileStrengthResidual", value)
+    def setResidualFrictionAngleFactor(self, value: float):
+        self._stageFactorPropertyAccessor.setDoubleProperty("MohrCoulomb_FrictionAngleResidual", value)
+    def setResidualCohesionFactor(self, value: float):
+        self._stageFactorPropertyAccessor.setDoubleProperty("MohrCoulomb_CohesionResidual", value)
+
+################ Code below this line will not be overridden ################
+from rs3.properties.material.constitutiveModel.jointOption.PlaneOrientationBase import PlaneOrientationBase
+from rs3.properties.stageFactors.StageFactorInterfaces import AbsoluteStageFactorInterface
+from rs3.properties.material.constitutiveModel.jointOption._PropertyAccessor import JointOptionStageFactorPropertyAccessor
+
+class MohrCoulombStageFactor(MohrCoulombStageFactorBase):
+    def __init__(self, id : str, stageFactorID : str, client : Client, materialId : str):
+        self._client = client
+        self._objectId = stageFactorID
+        self.parentID = id
+        self._materialID = materialId
+        self._stub = MaterialJointStageFactorService_pb2_grpc.MaterialJointStageFactorServiceStub(client.channel)
+        self._stageFactorPropertyAccessor = JointOptionStageFactorPropertyAccessor(id, stageFactorID, client, self._stub, self._materialID)
+
+class MohrCoulombDefinedStageFactor(MohrCoulombDefinedStageFactorBase):
+    def __init__(self, id : str, stageFactorID : str, client : Client, materialId : str):
+        self._client = client
+        self._objectId = stageFactorID
+        self.parentID = id
+        self._materialID = materialId
+        self._stub = MaterialJointStageFactorService_pb2_grpc.MaterialJointStageFactorServiceStub(client.channel)
+        self._stageFactorPropertyAccessor = JointOptionStageFactorPropertyAccessor(id, stageFactorID, client, self._stub, self._materialID)
+
+class MohrCoulomb(MohrCoulombBase, PlaneOrientationBase):
+    """
+    Example:
+        See :ref:`joint_control_examples`.
+        
+    """
+    def __init__(self, client: Client, materialId : str, jointId: str):
+        PlaneOrientationBase.__init__(self, client, materialId, jointId)
+        self._client = client
+        self._objectId = jointId
+        self._materialID = materialId
+        self._propertyAccessor = PropertyAccessor(client, materialId, jointId)
+        self.StageFactorInterface = AbsoluteStageFactorInterface[MohrCoulombDefinedStageFactor, MohrCoulombStageFactor](jointId, client, MohrCoulombDefinedStageFactor, MohrCoulombStageFactor, True, materialId)
+        
+    

rs3/properties/material/constitutiveModel/jointOption/PlaneOrientationBase.py

@@ -0,0 +1,92 @@
+from rs3._proxyObject import _ProxyObject
+from rs3._client import Client
+from ._PropertyAccessor import PropertyAccessor
+import rs3.generatedFiles.MaterialJointSetSlipCriterionService_pb2_grpc as MaterialJointSetSlipCriterionService_pb2_grpc
+import rs3.generatedFiles.MaterialJointSetSlipCriterionService_pb2 as MaterialJointSetSlipCriterionService_pb2
+import rs3.generatedFiles.CommonMessages_pb2 as CommonMessages_pb2
+from rs3.properties.PropertyEnums import *
+
+class PlaneOrientationBase(_ProxyObject):
+    def __init__(self, client: Client, materialId: str, objectId : str):
+        super().__init__(client, objectId)
+        self._stub = MaterialJointSetSlipCriterionService_pb2_grpc.MaterialJointSetSlipCriterionServiceStub(client.channel)
+        self._propertyAccessor = PropertyAccessor(client, materialId, objectId)
+        self._materialId = materialId
+        
+    def getPlaneOrientationDefinedBy(self) -> PlaneOrientationType:
+        return self._propertyAccessor.getEnumValue("SelectedDirectionType", PlaneOrientationType)
+    def setPlaneOrientationDefinedBy(self, planarDirectionType: PlaneOrientationType):
+        return self._propertyAccessor.setEnumValue("SelectedDirectionType", planarDirectionType.value)
+    
+    def getVector(self) -> tuple[float, float, float]:
+        """
+        Returns:
+            tuple[float, float, float]:
+                A 3D vector `(x, y, z)` representing the direction in model coordinates.
+        """
+        request = MaterialJointSetSlipCriterionService_pb2.GetJointOptionVectorPropertyRequest(materialId=self._materialId, objectId=self._objectId)
+        response : MaterialJointSetSlipCriterionService_pb2.GetJointOptionVectorPropertyResponse = self._client.callFunction(self._stub.GetJointOptionVectorProperty, request)
+        return (response.value.x, response.value.y, response.value.z)
+    def setVector(self, value : tuple[float, float, float]):
+        """
+        Args:
+            NormalDirection (tuple[float, float, float]):
+                A 3D vector `(x, y, z)` representing the normal direction in model coordinates.
+        """
+        vector = CommonMessages_pb2.Vector3D(x=value[0], y=value[1], z=value[2])
+        request = MaterialJointSetSlipCriterionService_pb2.SetJointOptionVectorPropertyRequest(materialId=self._materialId, objectId=self._objectId, value=vector)
+        self._client.callFunction(self._stub.SetJointOptionVectorProperty, request)
+        
+    def getTrendPlunge(self) -> tuple[float, float]:
+        """
+        Retrieve the orientation in trend-plunge format.
+
+        Returns:
+            tuple[float, float]:
+                - trend (float): The compass direction of the horizontal projection of the line (in degrees).
+                - plunge (float): The angle between the line and the horizontal plane (in degrees).
+        """
+        request = MaterialJointSetSlipCriterionService_pb2.GetJointOptionTrendPlungePropertyRequest(materialId=self._materialId, objectId=self._objectId)
+        response : MaterialJointSetSlipCriterionService_pb2.GetJointOptionTrendPlungePropertyResponse = self._client.callFunction(self._stub.GetJointOptionTrendPlungeProperty, request)
+        return (response.trend, response.plunge)
+    def setTrendPlunge(self, trend : float, plunge : float):
+        """
+        Set the orientation in trend-plunge format.
+
+        Args:
+            trend (float):
+                The compass direction of the horizontal projection of the line (in degrees).
+            plunge (float):
+                The angle between the line and the horizontal plane (in degrees).
+        """
+        request = MaterialJointSetSlipCriterionService_pb2.SetJointOptionTrendPlungePropertyRequest(materialId=self._materialId, objectId=self._objectId, trend=trend, plunge=plunge)
+        self._client.callFunction(self._stub.SetJointOptionTrendPlungeProperty, request)
+        
+    def getDipDipDirection(self) -> tuple[float, float]:
+        """
+        Retrieve the orientation in dip-dip direction format.
+
+        Returns:
+            tuple[float, float]:
+                - dip (float): The angle between the plane and the horizontal plane (in degrees).
+                - dipDirection (float): The compass direction in which the plane is dipping (in degrees).
+
+        """
+        request = MaterialJointSetSlipCriterionService_pb2.GetJointOptionDipDipDirectionPropertyRequest(materialId=self._materialId, objectId=self._objectId)
+        response : MaterialJointSetSlipCriterionService_pb2.GetJointOptionDipDipDirectionPropertyResponse = self._client.callFunction(self._stub.GetJointOptionDipDipDirectionProperty, request)
+        return (response.dip, response.dipDirection)
+    def setDipDipDirection(self, dip : float, dipDirection : float):
+        """
+        Set the orientation in dip-dip direction format.
+
+        Args:
+            dip (float):
+                The angle between the plane and the horizontal plane (in degrees).
+            dipDirection (float):
+                The compass direction in which the plane is dipping (in degrees).
+
+        """
+        request = MaterialJointSetSlipCriterionService_pb2.SetJointOptionDipDipDirectionPropertyRequest(materialId=self._materialId, objectId=self._objectId, dip=dip, dipDirection=dipDirection)
+        self._client.callFunction(self._stub.SetJointOptionDipDipDirectionProperty, request)
+        
+                

rs3/properties/material/constitutiveModel/jointOption/SimpleHyperbolic.py

@@ -0,0 +1,112 @@
+# Generated by RPCBinder in RFC_Common.
+from rs3._client import Client
+from ._PropertyAccessor import PropertyAccessor
+from rs3._proxyObject import _ProxyObject
+from rs3.properties.IPropertyGroupAccessors import IPropertyGroupAccessors
+from rs3.properties.stageFactors.IStageFactorBase import IStageFactorBase
+import rs3.generatedFiles.MaterialJointStageFactorService_pb2_grpc as MaterialJointStageFactorService_pb2_grpc
+class SimpleHyperbolicBase(_ProxyObject, IPropertyGroupAccessors):
+    def __init__(self, client: Client, id: str):
+        super().__init__(client, id)
+        self._propertyAccessor = PropertyAccessor(client, id)
+    def getDilationAngle(self) -> float:
+        return self._propertyAccessor.getDoubleProperty("DilationAngle")
+    def setDilationAngle(self, value: float):
+        self._propertyAccessor.setDoubleProperty("DilationAngle", value)
+    def getAdhesion(self) -> float:
+        return self._propertyAccessor.getDoubleProperty("peakAdhesion")
+    def setAdhesion(self, value: float):
+        self._propertyAccessor.setDoubleProperty("peakAdhesion", value)
+    def getFrictionAngle(self) -> float:
+        return self._propertyAccessor.getDoubleProperty("peakFric")
+    def setFrictionAngle(self, value: float):
+        self._propertyAccessor.setDoubleProperty("peakFric", value)
+    def getResidualAdhesion(self) -> float:
+        return self._propertyAccessor.getDoubleProperty("residAdhesion")
+    def setResidualAdhesion(self, value: float):
+        self._propertyAccessor.setDoubleProperty("residAdhesion", value)
+    def getResidualFrictionAngle(self) -> float:
+        return self._propertyAccessor.getDoubleProperty("residFric")
+    def setResidualFrictionAngle(self, value: float):
+        self._propertyAccessor.setDoubleProperty("residFric", value)
+    def getProperties(self):
+        return {
+            "DilationAngle": self.getDilationAngle(),
+            "Adhesion": self.getAdhesion(),
+            "FrictionAngle": self.getFrictionAngle(),
+            "ResidualAdhesion": self.getResidualAdhesion(),
+            "ResidualFrictionAngle": self.getResidualFrictionAngle(),
+        }
+    def setProperties(self, DilationAngle: float = None, Adhesion: float = None, FrictionAngle: float = None, ResidualAdhesion: float = None, ResidualFrictionAngle: float = None):
+        if DilationAngle is not None:
+            self.setDilationAngle(DilationAngle)
+        if Adhesion is not None:
+            self.setAdhesion(Adhesion)
+        if FrictionAngle is not None:
+            self.setFrictionAngle(FrictionAngle)
+        if ResidualAdhesion is not None:
+            self.setResidualAdhesion(ResidualAdhesion)
+        if ResidualFrictionAngle is not None:
+            self.setResidualFrictionAngle(ResidualFrictionAngle)
+class SimpleHyperbolicStageFactorBase(IStageFactorBase):
+    def __init__(self, id : str, stageFactorID : str, client : Client):
+        super().__init__(id, stageFactorID, client, MaterialJointStageFactorService_pb2_grpc.MaterialJointStageFactorServiceStub(client.channel))
+    def getDilationRatioFactor(self) -> float:
+        return self._stageFactorPropertyAccessor.getDoubleProperty("SimpleHyperbolic_DilationRatio")
+    def getAdhesionFactor(self) -> float:
+        return self._stageFactorPropertyAccessor.getDoubleProperty("SimpleHyperbolic_AdhesionPeak")
+    def getFrictionAngleFactor(self) -> float:
+        return self._stageFactorPropertyAccessor.getDoubleProperty("SimpleHyperbolic_FrictionAnglePeak")
+    def getResidualAdhesionFactor(self) -> float:
+        return self._stageFactorPropertyAccessor.getDoubleProperty("SimpleHyperbolic_AdhesionResidual")
+    def getResidualFrictionAngleFactor(self) -> float:
+        return self._stageFactorPropertyAccessor.getDoubleProperty("SimpleHyperbolic_FrictionAngleResidual")
+class SimpleHyperbolicDefinedStageFactorBase(SimpleHyperbolicStageFactorBase):
+    def setDilationRatioFactor(self, value: float):
+        self._stageFactorPropertyAccessor.setDoubleProperty("SimpleHyperbolic_DilationRatio", value)
+    def setAdhesionFactor(self, value: float):
+        self._stageFactorPropertyAccessor.setDoubleProperty("SimpleHyperbolic_AdhesionPeak", value)
+    def setFrictionAngleFactor(self, value: float):
+        self._stageFactorPropertyAccessor.setDoubleProperty("SimpleHyperbolic_FrictionAnglePeak", value)
+    def setResidualAdhesionFactor(self, value: float):
+        self._stageFactorPropertyAccessor.setDoubleProperty("SimpleHyperbolic_AdhesionResidual", value)
+    def setResidualFrictionAngleFactor(self, value: float):
+        self._stageFactorPropertyAccessor.setDoubleProperty("SimpleHyperbolic_FrictionAngleResidual", value)
+
+################ Code below this line will not be overridden ################
+from rs3.properties.material.constitutiveModel.jointOption.PlaneOrientationBase import PlaneOrientationBase
+from rs3.properties.stageFactors.StageFactorInterfaces import AbsoluteStageFactorInterface
+from rs3.properties.material.constitutiveModel.jointOption._PropertyAccessor import JointOptionStageFactorPropertyAccessor
+
+class SimpleHyperbolicStageFactor(SimpleHyperbolicStageFactorBase):
+    def __init__(self, id : str, stageFactorID : str, client : Client, materialId : str):
+        self._client = client
+        self._objectId = stageFactorID
+        self.parentID = id
+        self._materialID = materialId
+        self._stub = MaterialJointStageFactorService_pb2_grpc.MaterialJointStageFactorServiceStub(client.channel)
+        self._stageFactorPropertyAccessor = JointOptionStageFactorPropertyAccessor(id, stageFactorID, client, self._stub,  self._materialID)
+
+class SimpleHyperbolicDefinedStageFactor(SimpleHyperbolicDefinedStageFactorBase):
+    def __init__(self, id : str, stageFactorID : str, client : Client, materialId : str):
+        self._client = client
+        self._objectId = stageFactorID
+        self.parentID = id
+        self._materialID = materialId
+        self._stub = MaterialJointStageFactorService_pb2_grpc.MaterialJointStageFactorServiceStub(client.channel)
+        self._stageFactorPropertyAccessor = JointOptionStageFactorPropertyAccessor(id, stageFactorID, client, self._stub,  self._materialID)
+
+class SimpleHyperbolic(SimpleHyperbolicBase, PlaneOrientationBase):
+    """
+    Example:
+        See :ref:`joint_control_examples`.
+        
+    """
+    def __init__(self, client: Client, materialId : str, jointId: str):
+        PlaneOrientationBase.__init__(self, client, materialId, jointId)
+        self._client = client
+        self._objectId = jointId
+        self._materialId = materialId
+        self._propertyAccessor = PropertyAccessor(client, materialId, jointId)
+        self.StageFactorInterface = AbsoluteStageFactorInterface[SimpleHyperbolicDefinedStageFactor, SimpleHyperbolicStageFactor](jointId, client, SimpleHyperbolicDefinedStageFactor, SimpleHyperbolicStageFactor, True, materialId)
+        

rs3/properties/material/constitutiveModel/jointOption/_PropertyAccessor.py

@@ -0,0 +1,61 @@
+from rs3.properties._PropertyAccessor import PropertyAccessor as BasePropertyAccessor
+import rs3.generatedFiles.CommonMessages_pb2 as CommonMessages_pb2
+import rs3.generatedFiles.MaterialJointSetSlipCriterionService_pb2_grpc as MaterialJointSetSlipCriterionService_pb2_grpc
+import rs3.generatedFiles.MaterialJointSetSlipCriterionService_pb2 as MaterialJointSetSlipCriterionService_pb2
+import rs3.generatedFiles.MaterialJointStageFactorService_pb2_grpc as MaterialJointStageFactorService_pb2_grpc
+import rs3.generatedFiles.MaterialJointStageFactorService_pb2 as MaterialJointStageFactorService_pb2
+import rs3.generatedFiles.MaterialJointService_pb2_grpc as MaterialJointService_pb2_grpc
+import rs3.generatedFiles.MaterialJointService_pb2 as MaterialJointService_pb2
+from rs3._client import Client
+from rs3.properties.PropertyEnums import *
+class PropertyAccessor(BasePropertyAccessor):
+    def __init__(self, client : Client, materialId : str, objectId : str):
+        self._stub = MaterialJointSetSlipCriterionService_pb2_grpc.MaterialJointSetSlipCriterionServiceStub(client.channel)
+        super().__init__(client, objectId, self._stub)
+        self._materialId = materialId
+        
+    def _getProperty(self, propertyName : str) -> CommonMessages_pb2.PropertyValue:
+        request = MaterialJointSetSlipCriterionService_pb2.GetJointPropertyRequest(materialId=self._materialId, objectId=self.objectId, propertyName=propertyName)
+        response : MaterialJointSetSlipCriterionService_pb2.GetJointPropertyResponse = self._client.callFunction(self._stub.GetJointProperty, request)
+        return response.value
+    
+    def _setProperty(self, propertyName : str, value : CommonMessages_pb2.PropertyValue):
+        request = MaterialJointSetSlipCriterionService_pb2.SetJointPropertyRequest(materialId=self._materialId, objectId=self.objectId, 
+                                                                    propertyName=propertyName,
+                                                                    value=value)
+        self._client.callFunction(self._stub.SetJointProperty, request)
+        
+class MaterialJointPropertyAccessor(BasePropertyAccessor):
+    def __init__(self, client : Client, materialId : str, objectId : str):
+        self._stub = MaterialJointService_pb2_grpc.MaterialJointServiceStub(client.channel)
+        super().__init__(client, objectId, self._stub)
+        self._materialId = materialId
+        
+    def _getProperty(self, propertyName : str) -> CommonMessages_pb2.PropertyValue:
+        request = MaterialJointService_pb2.GetJointPropertyRequest(materialId=self._materialId, objectId=self.objectId, propertyName=propertyName)
+        response : MaterialJointService_pb2.GetJointPropertyResponse = self._client.callFunction(self._stub.GetJointProperty, request)
+        return response.value
+    
+    def _setProperty(self, propertyName : str, value : CommonMessages_pb2.PropertyValue):
+        request = MaterialJointService_pb2.SetJointPropertyRequest(materialId=self._materialId, objectId=self.objectId, 
+                                                                    propertyName=propertyName,
+                                                                    value=value)
+        self._client.callFunction(self._stub.SetJointProperty, request)
+        
+class JointOptionStageFactorPropertyAccessor(PropertyAccessor):
+    def __init__(self, parentObjectId: str, stageFactorId : str, client: Client, stub, materialID: str):
+        super().__init__(client, materialID, parentObjectId)
+        self._stub = stub
+        self.stageFactorId = stageFactorId
+        self._materialId = materialID
+        
+    def _getProperty(self, propertyName: str) -> CommonMessages_pb2.PropertyValue:
+        request = MaterialJointStageFactorService_pb2.GetMaterialJointStageFactorPropertyRequest(materialId=self._materialId, jointId=self.objectId, stageFactorId=self.stageFactorId, propertyName=propertyName)
+        response : MaterialJointStageFactorService_pb2.GetMaterialJointStageFactorPropertyResponse = self._client.callFunction(self._stub.GetStageFactorProperty, request)
+        return response.value
+
+    def _setProperty(self, propertyName: str, value: CommonMessages_pb2.PropertyValue):
+        request = MaterialJointStageFactorService_pb2.SetMaterialJointStageFactorPropertyRequest(materialId=self._materialId, jointId=self.objectId, stageFactorId=self.stageFactorId, propertyName=propertyName, value=value)
+        self._client.callFunction(self._stub.SetStageFactorProperty, request)
+    
+    

rs3/properties/material/constitutiveModel/stiffness/BaseStiffness.py

@@ -0,0 +1,11 @@
+from rs3.properties.PropertyEnums import *
+class BaseStiffness():
+    def getUseUnloadingCondition(self) -> bool:
+        return self._basePropertyAccessor.getBoolValue("UseUnloading")
+    def setUseUnloadingCondition(self, value: bool):
+        self._basePropertyAccessor.setBoolValue("UseUnloading", value)
+        
+    def getUnloadingCondition(self) -> UnloadingConditions:
+        return self._basePropertyAccessor.getEnumValue("UnloadingStiffness", UnloadingConditions)  
+    def setUnloadingCondition(self, UnloadingCondition : UnloadingConditions):
+        self._basePropertyAccessor.setEnumValue("UnloadingStiffness", UnloadingCondition.value)