rs3.properties.material.constitutiveModel.jointOption.PlaneOrientationBase module#

class rs3.properties.material.constitutiveModel.jointOption.PlaneOrientationBase.PlaneOrientationBase(client: Client, materialId: str, objectId: str)#

Bases: _ProxyObject

getPlaneOrientationDefinedBy() → PlaneOrientationType#
setPlaneOrientationDefinedBy(planarDirectionType: PlaneOrientationType)#
getVector() → tuple[float, float, float]#
Returns:

A 3D vector (x, y, z) representing the direction in model coordinates.

Return type:

tuple[float, float, float]

setVector(value: tuple[float, float, float])#
Parameters:

NormalDirection (tuple[float, float, float]) – A 3D vector (x, y, z) representing the normal direction in model coordinates.

getTrendPlunge() → tuple[float, float]#

Retrieve the orientation in trend-plunge format.

Returns:

  • 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).

Return type:

tuple[float, float]

setTrendPlunge(trend: float, plunge: float)#

Set the orientation in trend-plunge format.

Parameters:

  • 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).

getDipDipDirection() → tuple[float, float]#

Retrieve the orientation in dip-dip direction format.

Returns:

  • 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).

Return type:

tuple[float, float]

setDipDipDirection(dip: float, dipDirection: float)#

Set the orientation in dip-dip direction format.

Parameters:

  • 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).