Package gov.nih.mipav.model.structures

Class Voro.wall_plane

java.lang.Object
gov.nih.mipav.model.structures.Voro.wall
gov.nih.mipav.model.structures.Voro.wall_plane
Enclosing class:
Voro
class Voro.wall_plane extends Voro.wall
\brief A class representing a plane wall object. This class represents a single plane wall object.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    private double
    ac
     
    private int
    w_id
     
    private double
    xc
     
    private double
    yc
     
    private double
    zc
     

  • Constructor Summary

    Constructors
    Constructor
    Description
    wall_plane(double xc_, double yc_, double zc_, double ac_, int w_id_)
    Constructs a plane wall object.

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    cut_cell(Voro.voronoicell_neighbor c, double x, double y, double z)
    A pure virtual function for cutting a cell with neighbor-tracking enabled with a wall.
    boolean
    cut_cell(Voro.voronoicell c, double x, double y, double z)
    A pure virtual function for cutting a cell without neighbor-tracking with a wall.
    boolean
    cut_cell_base(Voro.voronoicell_neighbor c, double x, double y, double z)
     
    boolean
    cut_cell_base(Voro.voronoicell c, double x, double y, double z)
    Cuts a cell by the plane wall object.
    void
    delete()
     
    boolean
    point_inside(double x, double y, double z)
    Tests to see whether a point is inside the plane wall object.[ \return True if the point is inside, false if the point is outside.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Field Details

    • w_id

      private int w_id

    • xc

      private double xc

    • yc

      private double yc

    • zc

      private double zc

    • ac

      private double ac

  • Constructor Details

    • wall_plane

      public wall_plane(double xc_, double yc_, double zc_, double ac_, int w_id_)
      Constructs a plane wall object. \param[in] (xc_,yc_,zc_) a normal vector to the plane. \param[in] ac_ a displacement along the normal vector. \param[in] w_id_ an ID number to associate with the wall for neighbor tracking.

  • Method Details

    • delete

      public void delete()
      Specified by:
      delete in class Voro.wall

    • point_inside

      public boolean point_inside(double x, double y, double z)
      Tests to see whether a point is inside the plane wall object.[ \return True if the point is inside, false if the point is outside.
      Specified by:
      point_inside in class Voro.wall

    • cut_cell_base

      public boolean cut_cell_base(Voro.voronoicell c, double x, double y, double z)
      Cuts a cell by the plane wall object. \param[in,out] c the Voronoi cell to be cut. \param[in] (x,y,z) the location of the Voronoi cell. \return True if the cell still exists, false if the cell is deleted.

    • cut_cell_base

      public boolean cut_cell_base(Voro.voronoicell_neighbor c, double x, double y, double z)

    • cut_cell

      public boolean cut_cell(Voro.voronoicell c, double x, double y, double z)
      Description copied from class: Voro.wall
      A pure virtual function for cutting a cell without neighbor-tracking with a wall.
      Specified by:
      cut_cell in class Voro.wall

    • cut_cell

      public boolean cut_cell(Voro.voronoicell_neighbor c, double x, double y, double z)
      Description copied from class: Voro.wall
      A pure virtual function for cutting a cell with neighbor-tracking enabled with a wall.
      Specified by:
      cut_cell in class Voro.wall