jet::PointSimpleListSearcher2 Class Reference

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

#include <jet/point_simple_list_searcher2.h>

Inheritance diagram for jet::PointSimpleListSearcher2:

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

Public Member Functions
	PointSimpleListSearcher2 ()
	Default constructor. More...
	PointSimpleListSearcher2 (const PointSimpleListSearcher2 &other)
	Copy constructor. More...
void	build (const ConstArrayAccessor1< Vector2D > &points) override
	Builds internal structure for given points list. More...
void	forEachNearbyPoint (const Vector2D &origin, double radius, const ForEachNearbyPointFunc &callback) const override
bool	hasNearbyPoint (const Vector2D &origin, double radius) const override
PointNeighborSearcher2Ptr	clone () const override
	Creates a new instance of the object with same properties than original. More...
PointSimpleListSearcher2 &	operator= (const PointSimpleListSearcher2 &other)
	Assignment operator. More...
void	set (const PointSimpleListSearcher2 &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::PointNeighborSearcher2
	PointNeighborSearcher2 ()
	Default constructor. More...
virtual	~PointNeighborSearcher2 ()
	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 PointSimpleListSearcher2. More...

Additional Inherited Members
Public Types inherited from jet::PointNeighborSearcher2
typedef std::function< void(size_t, const Vector2D &)>	ForEachNearbyPointFunc

Detailed Description

Simple ad-hoc 2-D point searcher.

This class implements 2-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

PointSimpleListSearcher2() [1/2]

jet::PointSimpleListSearcher2::PointSimpleListSearcher2

(

)

Default constructor.

PointSimpleListSearcher2() [2/2]

jet::PointSimpleListSearcher2::PointSimpleListSearcher2

(

const PointSimpleListSearcher2 &

other

)

Copy constructor.

Member Function Documentation

build()

void jet::PointSimpleListSearcher2::build ( const ConstArrayAccessor1< Vector2D > &  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]

points

The points to search.

Implements jet::PointNeighborSearcher2.

builder()

static Builder jet::PointSimpleListSearcher2::builder ( )

static

Returns builder fox PointSimpleListSearcher2.

clone()

PointNeighborSearcher2Ptr jet::PointSimpleListSearcher2::clone ( ) const

overridevirtual

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

Returns

Copy of this object.

Implements jet::PointNeighborSearcher2.

deserialize()

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

overridevirtual

Deserializes the neighbor searcher from the buffer.

Implements jet::Serializable.

forEachNearbyPoint()

void jet::PointSimpleListSearcher2::forEachNearbyPoint ( const Vector2D &  origin, double  radius, const ForEachNearbyPointFunc &  callback  ) const

overridevirtual

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

Parameters

[in]	origin	The origin position.
[in]	radius	The search radius.
[in]	callback	The callback function.

Implements jet::PointNeighborSearcher2.

hasNearbyPoint()

bool jet::PointSimpleListSearcher2::hasNearbyPoint ( const Vector2D &  origin, double  radius  ) const

overridevirtual

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

Parameters

[in]	origin	The origin.
[in]	radius	The radius.

Returns

True if has nearby point, false otherwise.

Implements jet::PointNeighborSearcher2.

operator=()

PointSimpleListSearcher2& jet::PointSimpleListSearcher2::operator=

(

const PointSimpleListSearcher2 &

other

)

Assignment operator.

serialize()

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

overridevirtual

Serializes the neighbor searcher into the buffer.

Implements jet::Serializable.

set()

void jet::PointSimpleListSearcher2::set

(

const PointSimpleListSearcher2 &

other

)

Copy from the other instance.

---

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

• jet/point_simple_list_searcher2.h