voro::wall_list Class Reference

A class for storing a list of pointers to walls. More...

#include <container.hh>

Inheritance diagram for voro::wall_list:

Public Member Functions
	wall_list ()
	wall_list (const wall_list &Other)=delete
wall_list &	operator= (const wall_list &Other)=delete
	wall_list (wall_list &&Other) noexcept
wall_list &	operator= (wall_list &&Other)
	~wall_list ()
void	add_wall (wall *w)
void	add_wall (wall &w)
void	add_wall (wall_list &wl)
bool	point_inside_walls (double x, double y, double z) const
template<class c_class >
bool	apply_walls (c_class &c, double x, double y, double z) const
void	deallocate ()

Public Attributes
wall **	walls
wall **	wep

Protected Member Functions
void	increase_wall_memory ()

Protected Attributes
wall **	wel
int	current_wall_size

Detailed Description

A class for storing a list of pointers to walls.

This class stores a list of pointers to wall classes. It contains several simple routines that make use of the wall classes (such as telling whether a given position is inside all of the walls or not). It can be used by itself, but also forms part of container_base, for associating walls with this class.

Constructor & Destructor Documentation

wall_list() [1/3]

voro::wall_list::wall_list

(

)

The wall_list constructor sets up an array of pointers to wall classes.

wall_list() [2/3]

voro::wall_list::wall_list ( const wall_list &  Other )

delete

wall_list() [3/3]

voro::wall_list::wall_list ( wall_list &&  Other )

inlinenoexcept

~wall_list()

voro::wall_list::~wall_list

(

)

The wall_list destructor frees the array of pointers to the wall classes.

Member Function Documentation

add_wall() [1/3]

void voro::wall_list::add_wall ( wall &  w )

inline

Adds a wall to the list.

Parameters

[in]

w

a reference to the wall to add.

add_wall() [2/3]

void voro::wall_list::add_wall ( wall *  w )

inline

Adds a wall to the list.

Parameters

[in]

w

the wall to add.

add_wall() [3/3]

void voro::wall_list::add_wall

(

wall_list &

wl

)

Adds all of the walls on another wall_list to this class.

Parameters

[in]

wl

a reference to the wall class.

apply_walls()

template<class c_class >

bool voro::wall_list::apply_walls ( c_class &  c, double  x, double  y, double  z  ) const

inline

Cuts a Voronoi cell by all of the walls currently on the list.

Parameters

[in]	c	a reference to the Voronoi cell class.
[in]	(x,y,z)	the position of the cell.

Returns

True if the cell still exists, false if the cell is deleted.

deallocate()

void voro::wall_list::deallocate

(

)

Deallocates all of the wall classes pointed to by the wall_list.

increase_wall_memory()

void voro::wall_list::increase_wall_memory ( )

protected

Increases the memory allocation for the walls array.

operator=() [1/2]

wall_list & voro::wall_list::operator= ( const wall_list &  Other )

delete

operator=() [2/2]

wall_list & voro::wall_list::operator= ( wall_list &&  Other )

inline

point_inside_walls()

bool voro::wall_list::point_inside_walls ( double  x, double  y, double  z  ) const

inline

Determines whether a given position is inside all of the walls on the list.

Parameters

[in]

(x,y,z)

the position to test.

Returns

True if it is inside, false if it is outside.

Member Data Documentation

current_wall_size

int voro::wall_list::current_wall_size

protected

The current amount of memory allocated for walls.

walls

wall** voro::wall_list::walls

An array holding pointers to wall objects.

wel

wall** voro::wall_list::wel

protected

A pointer to the limit of the walls array, used to determine when array is full.

wep

wall** voro::wall_list::wep

A pointer to the next free position to add a wall pointer.

---

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

• Engine/Source/Runtime/Experimental/Voronoi/Private/voro++/src/container.hh
• Engine/Source/Runtime/Experimental/Voronoi/Private/voro++/src/container.cc