CubbyFlow::PointGenerator3 Class Reference

Abstract base class for 3-D point generator. More...

#include <Core/PointGenerator/PointGenerator3.hpp>

Inheritance diagram for CubbyFlow::PointGenerator3:

Public Member Functions
	PointGenerator3 ()=default
	Default constructor. More...
	PointGenerator3 (const PointGenerator3 &)=default
	Default copy constructor. More...
	PointGenerator3 (PointGenerator3 &&) noexcept=default
	Default move constructor. More...
virtual	~PointGenerator3 ()=default
	Default virtual destructor. More...
PointGenerator3 &	operator= (const PointGenerator3 &)=default
	Default copy assignment operator. More...
PointGenerator3 &	operator= (PointGenerator3 &&) noexcept=default
	Default move assignment operator. More...
void	Generate (const BoundingBox3D &boundingBox, double spacing, Array1< Vector3D > *points) const
virtual void	ForEachPoint (const BoundingBox3D &boundingBox, double spacing, const std::function< bool(const Vector3D &)> &callback) const =0
	Iterates every point within the bounding box with specified point pattern and invokes the callback function. More...

Detailed Description

Abstract base class for 3-D point generator.

This class provides interface for 3-D point generator. For given bounding box and point spacing, the inherited classes generates points with specified pattern.

Constructor & Destructor Documentation

PointGenerator3() [1/3]

CubbyFlow::PointGenerator3::PointGenerator3 ( )

default

Default constructor.

PointGenerator3() [2/3]

CubbyFlow::PointGenerator3::PointGenerator3 ( const PointGenerator3 &  )

default

Default copy constructor.

PointGenerator3() [3/3]

CubbyFlow::PointGenerator3::PointGenerator3 ( PointGenerator3 &&  )

defaultnoexcept

Default move constructor.

~PointGenerator3()

virtual CubbyFlow::PointGenerator3::~PointGenerator3 ( )

virtualdefault

Default virtual destructor.

Member Function Documentation

ForEachPoint()

virtual void CubbyFlow::PointGenerator3::ForEachPoint ( const BoundingBox3D &  boundingBox, double  spacing, const std::function< bool(const Vector3D &)> &  callback  ) const

pure virtual

Iterates every point within the bounding box with specified point pattern and invokes the callback function.

This function iterates every point within the bounding box and invokes the callback function. The position of the point is specified by the actual implementation. The suggested spacing between the points are given by spacing. The input parameter of the callback function is the position of the point and the return value tells whether the iteration should stop or not.

Implemented in CubbyFlow::BccLatticePointGenerator, and CubbyFlow::GridPointGenerator3.

Generate()

void CubbyFlow::PointGenerator3::Generate	(	const BoundingBox3D &	boundingBox,
		double	spacing,
		Array1< Vector3D > *	points
	)		const

Generates points to output array points inside given boundingBox with target point spacing.

operator=() [1/2]

PointGenerator3& CubbyFlow::PointGenerator3::operator= ( const PointGenerator3 &  )

default

Default copy assignment operator.

operator=() [2/2]

PointGenerator3& CubbyFlow::PointGenerator3::operator= ( PointGenerator3 &&  )

defaultnoexcept

Default move assignment operator.

---

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

• Core/PointGenerator/PointGenerator3.hpp