Class

edu.berkeley.ce.sparkrocks

Face

Related Doc: package sparkrocks

Permalink

case class Face(normalVec: Array[Double], distance: Double, phi: Double, cohesion: Double) extends Serializable with Product

A simple data structure to represent the face of a rock block.

normalVec

The normal vector to the face. The individual vector components can be accessed as 'a', 'b', and 'c'. Assumed to be a unit vector.

distance

The distance from the face to the center of the rock block. Accessed as 'd'.

phi

The friction angle (phi) of the face.

cohesion

The cohesion of the face.

Annotations
@SerialVersionUID()
Linear Supertypes
Product, Equals, Serializable, Serializable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Face
  2. Product
  3. Equals
  4. Serializable
  5. Serializable
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Face(normalVec: Array[Double], distance: Double, phi: Double, cohesion: Double)

    Permalink

    Create a new rock face.

    Create a new rock face.

    normalVec

    The normal vector to the face. The individual vector components can be accessed as 'a', 'b', and 'c'. Assumed to be a unit vector.

    distance

    The distance from the face to the center of the rock block. Accessed as 'd'.

    phi

    The friction angle (phi) of the face.

    cohesion

    The cohesion of the face.

Value Members

  1. final def !=(arg0: Any): Boolean

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  4. val a: Double

    Permalink
  5. def applyTolerance: Face

    Permalink

    Checks if each of the parameters of a face is approximately 0.0 and, if so, sets it to 0.0.

  6. def approximateEquals(inputFace: Face, tolerance: Double = NumericUtils.EPSILON): Boolean

    Permalink

    Compare this face and input face for approximate equality within specified tolerance

    Compare this face and input face for approximate equality within specified tolerance

    inputFace

    Input face

    tolerance

    Tolerance for difference between face parameters. Defaults to NumericUtils.EPSILON

    returns

    True if faces are equal, otherwise false

  7. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  8. val b: Double

    Permalink
  9. val c: Double

    Permalink
  10. def clone(): AnyRef

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

    Permalink

    The cohesion of the face.

  12. val d: Double

    Permalink
  13. val distance: Double

    Permalink

    The distance from the face to the center of the rock block.

    The distance from the face to the center of the rock block. Accessed as 'd'.

  14. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  15. def equals(obj: Any): Boolean

    Permalink
    Definition Classes
    Face → Equals → AnyRef → Any
  16. def finalize(): Unit

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

    Permalink
    Definition Classes
    AnyRef → Any
  18. def hashCode(): Int

    Permalink
    Definition Classes
    Face → AnyRef → Any
  19. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  20. def isSharedWith(inputFace: Face, tolerance: Double = NumericUtils.EPSILON): Boolean

    Permalink

    Compares this face with input face and determines whether faces are shared.

    Compares this face with input face and determines whether faces are shared. Shared faces will have equal and opposite distances from local origin as well as normal vectors in opposite directions

    inputFace

    Input face

    tolerance

    Tolerance for difference between compared values. Defaults to EPSILON.

    returns

    True if faces are shared, false otherwise

  21. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  22. val normalVec: Array[Double]

    Permalink

    The normal vector to the face.

    The normal vector to the face. The individual vector components can be accessed as 'a', 'b', and 'c'. Assumed to be a unit vector.

  23. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  24. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  25. val phi: Double

    Permalink

    The friction angle (phi) of the face.

  26. def roundToTolerance(decimalPlaces: Int = 6): Face

    Permalink

    Rounds the components of a face's normal vector to the specified number of decimal places, which defaults to 6.

    Rounds the components of a face's normal vector to the specified number of decimal places, which defaults to 6.

    decimalPlaces

    The number of decimal places to round to.

    returns

    A new face with a rounded normal vector.

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

    Permalink
    Definition Classes
    AnyRef
  28. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from Product

Inherited from Equals

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped