RobWorkProject  23.9.11-
Public Types | Public Member Functions | List of all members
ProximityFilter Class Referenceabstract

this class is used for fetching frame pairs using some proximity filtering strategy. More...

#include <ProximityFilter.hpp>

Public Types

typedef rw::core::Ptr< ProximityFilterPtr
 smart pointer type to this class
 

Public Member Functions

virtual void pop ()=0
 pop the current front.
 
virtual rw::kinematics::FramePair frontAndPop ()=0
 returns the current front and pops it afterwards More...
 
virtual rw::kinematics::FramePair front ()=0
 if there are any more possibly colliding framepairs since last call to update then this will return true, else false will be returned.
 
virtual bool isEmpty ()=0
 if there are any more possibly colliding framepairs since last call to update then this will return true, else false will be returned.
 

Detailed Description

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.

Member Function Documentation

◆ frontAndPop()

virtual rw::kinematics::FramePair frontAndPop ( )
pure virtual

returns the current front and pops it afterwards

Returns
the current front element

The documentation for this class was generated from the following file: