Class ProximityFilter


  • public class ProximityFilter
    extends java.lang.Object
    this class is used for fetching frame pairs using some proximity filtering strategy.

    The proximity filter is statefull and in the simplest case its an iterator over a set of frame pairs.

    The filter implementations should support early existing, to reduce computations.
    • Constructor Summary

      Constructors 
      Constructor Description
      ProximityFilter​(long cPtr, boolean cMemoryOwn)  
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void delete()  
      FramePair front()
      if there are any more possibly colliding framepairs since last
      call to update then this will return true, else false will be returned.
      FramePair frontAndPop()
      returns the current front and pops it afterwards
      static long getCPtr​(ProximityFilter obj)  
      boolean isEmpty()
      if there are any more possibly colliding framepairs since last
      call to update then this will return true, else false will be returned.
      void pop()
      pop the current front.
      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • ProximityFilter

        public ProximityFilter​(long cPtr,
                               boolean cMemoryOwn)
    • Method Detail

      • delete

        public void delete()
      • pop

        public void pop()
        pop the current front.
      • frontAndPop

        public FramePair frontAndPop()
        returns the current front and pops it afterwards
        Returns:
        the current front element
      • front

        public FramePair front()
        if there are any more possibly colliding framepairs since last
        call to update then this will return true, else false will be returned.
      • isEmpty

        public boolean isEmpty()
        if there are any more possibly colliding framepairs since last
        call to update then this will return true, else false will be returned.