Joint

A simple data structure to represent a joint.

normalVec: The normal vector to the joint. The individual vector components can be accessed as 'a', 'b', and 'c'. Assumed to be a unit vector.
localOrigin: The local origin from which the distance is referenced. The individual components are accessed as 'localX', 'localY', and 'localZ'.
center: Cartesian coordinates for the center of the joint. The individual components can be accessed as 'centerX', 'centerY', and 'centerZ'.
phi: The joint's friction angle (phi).
cohesion: The cohesion along the joint
shape: A list of lines specifying the shape of the joint. Each item is a 3-tuple. The first two items specify the line, while the last gives the distance of the line from the joint's center in the local coordinate system.
dipAngleParam: An optional parameter that can be used to specify the dip angle for the joint. This avoids recalculation of a known dip angle.
dipDirectionParam: An optional parameter that can be used to specify the dip direction for the joint. This avoids recalculation of a known dip direction.
boundingSphereParam: An optional parameter that can be used to specify the bounding sphere for the joint, if it is known. This prevents an expensive recalculation of the bounding sphere.

Annotations: @SerialVersionUID()

Linear Supertypes

Product, Equals, Serializable, Serializable, AnyRef, Any

Instance Constructors

new Joint(normalVec: Array[Double], localOrigin: Array[Double], center: Array[Double], phi: Double, cohesion: Double, shape: Vector[(Array[Double], Double)], dipAngleParam: Option[Double] = None, dipDirectionParam: Option[Double] = None, boundingSphereParam: Option[(Array[Double], Double)] = null)

Create a new joint.
Create a new joint.
normalVec
The normal vector to the joint. The individual vector components can be accessed as 'a', 'b', and 'c'. Assumed to be a unit vector.
localOrigin
The local origin from which the distance is referenced. The individual components are accessed as 'localX', 'localY', and 'localZ'.
center
Cartesian coordinates for the center of the joint. The individual components can be accessed as 'centerX', 'centerY', and 'centerZ'.
phi
The joint's friction angle (phi).
cohesion
The cohesion along the joint
shape
A list of lines specifying the shape of the joint. Each item is a 3-tuple. The first two items specify the line, while the last gives the distance of the line from the joint's center in the local coordinate system.
dipAngleParam
An optional parameter that can be used to specify the dip angle for the joint. This avoids recalculation of a known dip angle.
dipDirectionParam
An optional parameter that can be used to specify the dip direction for the joint. This avoids recalculation of a known dip direction.
boundingSphereParam
An optional parameter that can be used to specify the bounding sphere for the joint, if it is known. This prevents an expensive recalculation of the bounding sphere.

Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
val a: Double
def approximateEquals(inputJoint: Joint, tolerance: Double = NumericUtils.EPSILON): Boolean
final def asInstanceOf[T0]: T0

Definition Classes
Any
val b: Double
val boundingSphere: Option[(Array[Double], Double)]
val boundingSphereParam: Option[(Array[Double], Double)]

An optional parameter that can be used to specify the bounding sphere for the joint, if it is known.
An optional parameter that can be used to specify the bounding sphere for the joint, if it is known. This prevents an expensive recalculation of the bounding sphere.
val c: Double
val center: Array[Double]

Cartesian coordinates for the center of the joint.
Cartesian coordinates for the center of the joint. The individual components can be accessed as 'centerX', 'centerY', and 'centerZ'.
val centerX: Double
val centerY: Double
val centerZ: Double
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
val cohesion: Double

The cohesion along the joint
val d: Double
val dipAngle: Double
val dipAngleParam: Option[Double]

An optional parameter that can be used to specify the dip angle for the joint.
An optional parameter that can be used to specify the dip angle for the joint. This avoids recalculation of a known dip angle.
val dipDirection: Double
val dipDirectionParam: Option[Double]

An optional parameter that can be used to specify the dip direction for the joint.
An optional parameter that can be used to specify the dip direction for the joint. This avoids recalculation of a known dip direction.
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(obj: Any): Boolean

Definition Classes
Joint → Equals → AnyRef → Any
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def globalCoordinates: Seq[(Array[Double], Double)]

Converts lines defining shape of joint from local to global coordinates
Converts lines defining shape of joint from local to global coordinates
returns
A seq of pairs, each representing a plane that specifies a boundary of the joint in the global coordinate space. The first item of each pair is a normal vector for the plane, and the second item is the distance of the plane from the origin.
def hashCode(): Int

Definition Classes
Joint → AnyRef → Any
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
val localOrigin: Array[Double]

The local origin from which the distance is referenced.
The local origin from which the distance is referenced. The individual components are accessed as 'localX', 'localY', and 'localZ'.
val localX: Double
val localY: Double
val localZ: Double
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
val normalVec: Array[Double]

The normal vector to the joint.
The normal vector to the joint. The individual vector components can be accessed as 'a', 'b', and 'c'. Assumed to be a unit vector.
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
val phi: Double

The joint's friction angle (phi).
val shape: Vector[(Array[Double], Double)]

A list of lines specifying the shape of the joint.
A list of lines specifying the shape of the joint. Each item is a 3-tuple. The first two items specify the line, while the last gives the distance of the line from the joint's center in the local coordinate system.
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def updateJoint(blockOrigin: Array[Double]): Joint

Calculates the distances of the joint relative to a new origin
Calculates the distances of the joint relative to a new origin
returns
Distance relative to block origin (new local origin)
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )

Related Docs: object Joint | package sparkrocks

Instance Constructors

new Joint(normalVec: Array[Double], localOrigin: Array[Double], center: Array[Double], phi: Double, cohesion: Double, shape: Vector[(Array[Double], Double)], dipAngleParam: Option[Double] = None, dipDirectionParam: Option[Double] = None, boundingSphereParam: Option[(Array[Double], Double)] = null)

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

val a: Double

def approximateEquals(inputJoint: Joint, tolerance: Double = NumericUtils.EPSILON): Boolean

final def asInstanceOf[T0]: T0

val b: Double

val boundingSphere: Option[(Array[Double], Double)]

val boundingSphereParam: Option[(Array[Double], Double)]

val c: Double

val center: Array[Double]

val centerX: Double

val centerY: Double

val centerZ: Double

def clone(): AnyRef

val cohesion: Double

val d: Double

val dipAngle: Double

val dipAngleParam: Option[Double]

val dipDirection: Double

val dipDirectionParam: Option[Double]

final def eq(arg0: AnyRef): Boolean

def equals(obj: Any): Boolean

def finalize(): Unit

final def getClass(): Class[_]

def globalCoordinates: Seq[(Array[Double], Double)]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

val localOrigin: Array[Double]

val localX: Double

val localY: Double

val localZ: Double

final def ne(arg0: AnyRef): Boolean

val normalVec: Array[Double]

final def notify(): Unit

final def notifyAll(): Unit

val phi: Double

val shape: Vector[(Array[Double], Double)]

final def synchronized[T0](arg0: ⇒ T0): T0

def updateJoint(blockOrigin: Array[Double]): Joint

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

Inherited from Product

Inherited from Equals

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped