jet::PointKdTreeSearcher2 Class Reference

KdTree-based 2-D point searcher. More...

#include <jet/point_kdtree_searcher2.h>

Inheritance diagram for jet::PointKdTreeSearcher2:

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

Public Member Functions
	PointKdTreeSearcher2 ()
	Constructs an empty kD-tree instance. More...
	PointKdTreeSearcher2 (const PointKdTreeSearcher2 &other)
	Copy constructor. More...
void	build (const ConstArrayAccessor1< Vector2D > &points) override
	Builds internal acceleration 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...
PointKdTreeSearcher2 &	operator= (const PointKdTreeSearcher2 &other)
	Assignment operator. More...
void	set (const PointKdTreeSearcher2 &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 PointKdTreeSearcher2. More...

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

Detailed Description

KdTree-based 2-D point searcher.

This class implements 2-D point searcher by using KdTree for its internal acceleration data structure.

Constructor & Destructor Documentation

PointKdTreeSearcher2() [1/2]

jet::PointKdTreeSearcher2::PointKdTreeSearcher2

(

)

Constructs an empty kD-tree instance.

PointKdTreeSearcher2() [2/2]

jet::PointKdTreeSearcher2::PointKdTreeSearcher2

(

const PointKdTreeSearcher2 &

other

)

Copy constructor.

Member Function Documentation

build()

void jet::PointKdTreeSearcher2::build ( const ConstArrayAccessor1< Vector2D > &  points )

overridevirtual

Builds internal acceleration structure for given points list.

Implements jet::PointNeighborSearcher2.

builder()

static Builder jet::PointKdTreeSearcher2::builder ( )

static

Returns builder fox PointKdTreeSearcher2.

clone()

PointNeighborSearcher2Ptr jet::PointKdTreeSearcher2::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::PointKdTreeSearcher2::deserialize ( const std::vector< uint8_t > &  buffer )

overridevirtual

Deserializes the neighbor searcher from the buffer.

Implements jet::Serializable.

forEachNearbyPoint()

void jet::PointKdTreeSearcher2::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::PointKdTreeSearcher2::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=()

PointKdTreeSearcher2& jet::PointKdTreeSearcher2::operator=

(

const PointKdTreeSearcher2 &

other

)

Assignment operator.

serialize()

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

overridevirtual

Serializes the neighbor searcher into the buffer.

Implements jet::Serializable.

set()

void jet::PointKdTreeSearcher2::set

(

const PointKdTreeSearcher2 &

other

)

Copy from the other instance.

---

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

• jet/point_kdtree_searcher2.h