Class

com.spark3d.geometryObjects

Point3D

Related Doc: package geometryObjects

Permalink

class Point3D extends Shape3D with Serializable

Class for describing a point in 3D space. By default, the input coordinates are supposed euclidean, that is (x, y, z). The user can also work with spherical input coordinates (x=r, y=theta, z=phi) by setting the argument isSpherical=true.

Linear Supertypes
Serializable, Serializable, Shape3D, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Point3D
  2. Serializable
  3. Serializable
  4. Shape3D
  5. AnyRef
  6. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Point3D(x: Double, y: Double, z: Double, isSpherical: Boolean)

    Permalink

    x

    : (Double) Input X coordinate in Euclidean space, and R in spherical space.

    y

    : (Double) Input Y coordinate in Euclidean space, and THETA in spherical space.

    z

    : (Double) Input Z coordinate in Euclidean space, and PHI in spherical space.

    isSpherical

    : (Boolean) If true, it assumes that the coordinates of the Point3D are (r, theta, phi). Otherwise, it assumes cartesian coordinates (x, y, z).

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. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  5. val center: Point3D

    Permalink

    The center

    The center

    Definition Classes
    Point3DShape3D
  6. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  7. def distanceTo(p: Point3D): Double

    Permalink

    Returns the distance between the point and another.

    Returns the distance between the point and another. Space is supposed flat (euclidean).

    p

    : (Point3D) Another instance of Point3D

    returns

    (Double) Distance between the two points.

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

    Permalink
    Definition Classes
    AnyRef
  9. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  10. def finalize(): Unit

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

    Permalink
    Definition Classes
    AnyRef → Any
  12. def getCoordinate: List[Double]

    Permalink

    Return the coordinates (x, y, z) of the point.

    Return the coordinates (x, y, z) of the point.

    returns

    (List[Double]) The list of coordinates.

  13. def getEnvelope(): BoxEnvelope

    Permalink

    Get bounding box of this Point3D which will also be a Point3D

    Get bounding box of this Point3D which will also be a Point3D

    returns

    (BoxEnvelope) Cuboid representing the box of the Point3D

    Definition Classes
    Point3DShape3D
  14. def getVolume: Double

    Permalink
  15. def hasCenterCloseTo(p: Point3D, epsilon: Double): Boolean

    Permalink

    Return if the input Point3D is equal this Point3D

    Return if the input Point3D is equal this Point3D

    p

    Point3D for which the comparison has to be done

    returns

    true if the two Point3D centers are within epsilon

    Definition Classes
    Shape3D
  16. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  17. def intersect(otherShape: Shape3D): Boolean

    Permalink

    Methods to determine whether two shapes overlap.

    Methods to determine whether two shapes overlap. Implement different ways for different shapes (Point, Shell, Box available).

    otherShape

    : (Shape3D) An instance of Shape3D (or extension)

    returns

    (Boolean) true if the two objects intersect.

  18. def isEqual(p: Point3D): Boolean

    Permalink

    Return if the input Point3D is equal this Point3D

    Return if the input Point3D is equal this Point3D

    p

    (Point3D) Point3D for which the equality is to be checked

    returns

    (Boolean) true if the two Point3Ds are equal

  19. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  20. val isSpherical: Boolean

    Permalink

    : (Boolean) If true, it assumes that the coordinates of the Point3D are (r, theta, phi).

    : (Boolean) If true, it assumes that the coordinates of the Point3D are (r, theta, phi). Otherwise, it assumes cartesian coordinates (x, y, z).

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

    Permalink
    Definition Classes
    AnyRef
  22. final def notify(): Unit

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

    Permalink
    Definition Classes
    AnyRef
  24. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  25. def toHealpix(nside: Int, thetaphi: Boolean = false): Long

    Permalink

    Compute the healpix index of the geometry center.

    Compute the healpix index of the geometry center. By default, the method considers that this.y = ra, this.z = dec. You can also bypass that, and force this.y = theta, this.z = phi by setting thetaphi = true. We only consider the RING scheme for the moment.

    nside

    : (Int) Resolution of the healpix map.

    thetaphi

    : (Boolean) Convention for your data: this.y = ra, this.z = dec if false, this.y = theta, this.z = phi otherwise. Default is false.

    returns

    (Long) Healpix index of the point for the resolution chosen.

    Definition Classes
    Shape3D
  26. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  27. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  30. val x: Double

    Permalink

    : (Double) Input X coordinate in Euclidean space, and R in spherical space.

  31. val y: Double

    Permalink

    : (Double) Input Y coordinate in Euclidean space, and THETA in spherical space.

  32. val z: Double

    Permalink

    : (Double) Input Z coordinate in Euclidean space, and PHI in spherical space.

Inherited from Serializable

Inherited from Serializable

Inherited from Shape3D

Inherited from AnyRef

Inherited from Any

Ungrouped