Jet  v1.3.3
Classes | Public Member Functions | Static Public Member Functions | List of all members
jet::PointSimpleListSearcher3 Class Referencefinal

Simple ad-hoc 3-D point searcher. More...

#include <jet/point_simple_list_searcher3.h>

Inheritance diagram for jet::PointSimpleListSearcher3:
jet::PointNeighborSearcher3 jet::Serializable

Classes

class  Builder
 Front-end to create PointSimpleListSearcher3 objects step by step. More...
 

Public Member Functions

 PointSimpleListSearcher3 ()
 Default constructor. More...
 
 PointSimpleListSearcher3 (const PointSimpleListSearcher3 &other)
 Copy constructor. More...
 
void build (const ConstArrayAccessor1< Vector3D > &points) override
 Builds internal structure for given points list. More...
 
void forEachNearbyPoint (const Vector3D &origin, double radius, const ForEachNearbyPointFunc &callback) const override
 
bool hasNearbyPoint (const Vector3D &origin, double radius) const override
 
PointNeighborSearcher3Ptr clone () const override
 Creates a new instance of the object with same properties than original. More...
 
PointSimpleListSearcher3operator= (const PointSimpleListSearcher3 &other)
 Assignment operator. More...
 
void set (const PointSimpleListSearcher3 &other)
 Copy from the other instance. More...
 
void serialize (std::vector< uint8_t > *buffer) const override
 Serializes the neighbor searcher into the buffer. More...
 
void deserialize (const std::vector< uint8_t > &buffer) override
 Deserializes the neighbor searcher from the buffer. More...
 
- Public Member Functions inherited from jet::PointNeighborSearcher3
 PointNeighborSearcher3 ()
 Default constructor. More...
 
virtual ~PointNeighborSearcher3 ()
 Destructor. More...
 
virtual std::string typeName () const =0
 Returns the type name of the derived class. More...
 
- Public Member Functions inherited from jet::Serializable
 Serializable ()=default
 
virtual ~Serializable ()=default
 

Static Public Member Functions

static Builder builder ()
 Returns builder fox PointSimpleListSearcher3. More...
 

Additional Inherited Members

- Public Types inherited from jet::PointNeighborSearcher3
typedef std::function< void(size_t, const Vector3D &)> ForEachNearbyPointFunc
 

Detailed Description

Simple ad-hoc 3-D point searcher.

This class implements 3-D point searcher simply by looking up every point in the list. Thus, this class is not ideal for searches involing large number of points, but only for small set of items.

Constructor & Destructor Documentation

◆ PointSimpleListSearcher3() [1/2]

jet::PointSimpleListSearcher3::PointSimpleListSearcher3 ( )

Default constructor.

◆ PointSimpleListSearcher3() [2/2]

jet::PointSimpleListSearcher3::PointSimpleListSearcher3 ( const PointSimpleListSearcher3 other)

Copy constructor.

Member Function Documentation

◆ build()

void jet::PointSimpleListSearcher3::build ( const ConstArrayAccessor1< Vector3D > &  points)
overridevirtual

Builds internal structure for given points list.

For this class, this function simply copies the given point list to the internal list.

Parameters
[in]pointsThe points to search.

Implements jet::PointNeighborSearcher3.

◆ builder()

static Builder jet::PointSimpleListSearcher3::builder ( )
static

Returns builder fox PointSimpleListSearcher3.

◆ clone()

PointNeighborSearcher3Ptr jet::PointSimpleListSearcher3::clone ( ) const
overridevirtual

Creates a new instance of the object with same properties than original.

Returns
Copy of this object.

Implements jet::PointNeighborSearcher3.

◆ deserialize()

void jet::PointSimpleListSearcher3::deserialize ( const std::vector< uint8_t > &  buffer)
overridevirtual

Deserializes the neighbor searcher from the buffer.

Implements jet::Serializable.

◆ forEachNearbyPoint()

void jet::PointSimpleListSearcher3::forEachNearbyPoint ( const Vector3D origin,
double  radius,
const ForEachNearbyPointFunc callback 
) const
overridevirtual

Invokes the callback function for each nearby point around the origin within given radius.

Parameters
[in]originThe origin position.
[in]radiusThe search radius.
[in]callbackThe callback function.

Implements jet::PointNeighborSearcher3.

◆ hasNearbyPoint()

bool jet::PointSimpleListSearcher3::hasNearbyPoint ( const Vector3D origin,
double  radius 
) const
overridevirtual

Returns true if there are any nearby points for given origin within radius.

Parameters
[in]originThe origin.
[in]radiusThe radius.
Returns
True if has nearby point, false otherwise.

Implements jet::PointNeighborSearcher3.

◆ operator=()

PointSimpleListSearcher3& jet::PointSimpleListSearcher3::operator= ( const PointSimpleListSearcher3 other)

Assignment operator.

◆ serialize()

void jet::PointSimpleListSearcher3::serialize ( std::vector< uint8_t > *  buffer) const
overridevirtual

Serializes the neighbor searcher into the buffer.

Implements jet::Serializable.

◆ set()

void jet::PointSimpleListSearcher3::set ( const PointSimpleListSearcher3 other)

Copy from the other instance.


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