Class/Object

com.spark3d.geometryObjects

ShellEnvelope

Related Docs: object ShellEnvelope | package geometryObjects

Permalink

class ShellEnvelope extends Shape3D with Serializable

Defines a shell of 3D coordinate space. Shell here is made by a difference of of two two concentric spheres. This can be used to define a bounding box of a geometryObject

An Shell Envelope can be uniquely defined based on the center and its outer and inner radius.

Linear Supertypes
Serializable, Serializable, Shape3D, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ShellEnvelope
  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 ShellEnvelope(env: ShellEnvelope)

    Permalink

    Clones the existing shell Envelope

    Clones the existing shell Envelope

    env

    shell Envelope to be cloned

  2. new ShellEnvelope(p: Point3D, radius: Double)

    Permalink

    Creates a shell Envelope defined with a center coordinates, and a radius.

    Creates a shell Envelope defined with a center coordinates, and a radius. This would correspond to a Sphere basically.

    radius

    inner radius of the Envelope

  3. new ShellEnvelope(x: Double, y: Double, z: Double, radius: Double)

    Permalink

    Creates a shell Envelope defined with a center coordinates, and a radius.

    Creates a shell Envelope defined with a center coordinates, and a radius. This would correspond to a Sphere basically.

    x

    x-coordinate of the center of the sphere Envelope

    y

    y-coordinate of the center of the sphere Envelope

    z

    z-coordinate of the center of the sphere Envelope

    radius

    inner radius of the Envelope

  4. new ShellEnvelope(x: Double, y: Double, z: Double, innerRadius: Double, outerRadius: Double)

    Permalink

    Creates a shell Envelope defined with a center coordinates, inner and outer radius.

    Creates a shell Envelope defined with a center coordinates, inner and outer radius.

    x

    x-coordinate of the center of the sphere Envelope

    y

    y-coordinate of the center of the sphere Envelope

    z

    z-coordinate of the center of the sphere Envelope

    innerRadius

    inner radius of the Envelope

    outerRadius

    outer radius of the Envelope

  5. new ShellEnvelope()

    Permalink

    Creates a null shell Envelope.

  6. new ShellEnvelope(center: Point3D, innerRadius: Double, outerRadius: Double)

    Permalink

    center

    coordinates of the center of the shell Envelope

    innerRadius

    inner radius of the shell Envelope

    outerRadius

    outer radius of the shell Envelope

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

    coordinates of the center of the shell Envelope

    coordinates of the center of the shell Envelope

    Definition Classes
    ShellEnvelopeShape3D
  6. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  7. def contains(spr: ShellEnvelope): Boolean

    Permalink

    Checks if the region of the input shell Envelope is contained by this shell Envelope

    Checks if the region of the input shell Envelope is contained by this shell Envelope

    spr

    the shell Envelope for which the containment is to be checked

    returns

    true if the shell Envelope completely contains the input shell Envelope

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  10. def expandBy(delta: Double): Unit

    Permalink

    Expand shell Envelope by given distance.

    Expand shell Envelope by given distance. This will increase both inner and outer radius by input distance.

    delta

    the distance to expand the shell Envelope

  11. def expandInnerRadius(delta: Double): Unit

    Permalink

    Expand the inner radius of the shell by given distance.

    Expand the inner radius of the shell by given distance. If inner radius becomes greater than the outer radius after this we set the shell Envelope to null

    delta

    the distance to expand the inner radius of the shell Envelope by

  12. def expandOuterRadius(delta: Double): Unit

    Permalink

    Expand the outer radius of the shell by given distance.

    Expand the outer radius of the shell by given distance.

    delta

    the distance to expand the outer radius of the shell Envelope by

  13. def expandToInclude(spr: ShellEnvelope): Unit

    Permalink

    Expands the shell Envelope so that it includes the other shell Envelope.

    Expands the shell Envelope so that it includes the other shell Envelope. The Envelopes have to be concentric. Either inner or outer or both radii will be expanded based on following criteria -

    Expand inner radius-

    • When the outer and inner radii of the input shell Envelope are strictly less than the outer and inner radii of this shell Envelope sphere and inner radius of the inout sphere is less

    Expand outer radius-

    • When the outer radius of the input shell Envelope is greater than or equal to this shell Envelope. We add a small buffer of 0.1 to the outer radius in this case to ensure that the outer radii of the two shell Envelopes are not equal for consistency in onion Partitioning code. Expansion here can be both positive and negative. Expand both radio -
    • Condition for the epansion of the outer radius and when the inner radius of the input shell Envelope is strictly less than than the inner radius of this shell Envelope
    spr

    the shell Envelope to be included

  14. def expandToInclude(p: Point3D): Unit

    Permalink

    Expands the shell Envelope so that it contains the given Point.

    Expands the shell Envelope so that it contains the given Point. This will expand the only the inner or outer radius based on which side of the shell the point belongs. The point is considered to be in the shell if its distance to center is greater than or equal to the innerRadius and less than the outerRadius (while doing OnionPartitioning similar convention is followed). So if we are expanding the outer radius, a small buffer of 0.1 is added to ensure that point lies inside of the sphere defined by the outerRadius and not onto it. Expansion here can be both positive and negative.

    p

    the Point to expand to include

  15. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  16. def getArea(): Double

    Permalink

    Returns the area of the shell Envelope.

    Returns the area of the shell Envelope.

    returns

    the area of the shell envelope, 0.0 if it is null

  17. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  18. def getEnvelope: BoxEnvelope

    Permalink

    Get the bounding box of the Sphere

    Get the bounding box of the Sphere

    returns

    bounding box (Cuboid) of the Sphere

    Definition Classes
    ShellEnvelopeShape3D
  19. 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
  20. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  21. var innerRadius: Double

    Permalink

    inner radius of the shell Envelope

  22. def intersects(spr: ShellEnvelope): Boolean

    Permalink

    Checks if the region of the input shell Envelope intersects the region of this shell Envelope.

    Checks if the region of the input shell Envelope intersects the region of this shell Envelope. The case where one shell Envelope lies completely within the another shell Envelope is considered as non-intersecting.

    spr

    the shell Envelope with which the intersection is being checked

    returns

    true if the one shell Envelope intersects the other

  23. def isEqual(spr: ShellEnvelope): Boolean

    Permalink

    Checks if the two shell Envelopes are equal.

    Checks if the two shell Envelopes are equal.

    spr

    input sphere Envelope for which the equality is to be checked

    returns

    true if the two sphere Envelopes are equal

  24. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  25. def isNull(): Boolean

    Permalink

    Returns if this is a null shell envelope.

    Returns if this is a null shell envelope.

    returns

    if this shell Envelope is null (empty Geometry) or not

  26. def isPointInShell(p: Point3D): Boolean

    Permalink

    Check whether a point belong to a shell Envelope.

    Check whether a point belong to a shell Envelope. If a point lies on the sphere defined by inner radius (not outer radius), it is considered to be belonging to the shell for the consistency with the onion partitioning code.

    p

    the point for which the containment is to be checked

    returns

    true if the shell Envelope contains the point

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

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

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

    Permalink
    Definition Classes
    AnyRef
  30. var outerRadius: Double

    Permalink

    outer radius of the shell Envelope

  31. def setToNull: Unit

    Permalink

    Sets this shell Envelope to a null.

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

    Permalink
    Definition Classes
    AnyRef
  33. 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
  34. def toString(): String

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

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

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

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

Inherited from Serializable

Inherited from Serializable

Inherited from Shape3D

Inherited from AnyRef

Inherited from Any

Ungrouped