UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
voro::wall Class Referenceabstract

Pure virtual class from which wall objects are derived. More...

#include <container.hh>

+ Inheritance diagram for voro::wall:

Public Member Functions

virtual ~wall ()
 
virtual bool point_inside (double x, double y, double z) const =0
 
virtual bool cut_cell (voronoicell &c, double x, double y, double z) const =0
 
virtual bool cut_cell (voronoicell_neighbor &c, double x, double y, double z) const =0
 

Detailed Description

Pure virtual class from which wall objects are derived.

This is a pure virtual class for a generic wall object. A wall object can be specified by deriving a new class from this and specifying the functions.

Constructor & Destructor Documentation

◆ ~wall()

virtual voro::wall::~wall ( )
inlinevirtual

Member Function Documentation

◆ cut_cell() [1/2]

virtual bool voro::wall::cut_cell ( voronoicell c,
double  x,
double  y,
double  z 
) const
pure virtual

A pure virtual function for cutting a cell without neighbor-tracking with a wall.

Implemented in voro::wall_sphere, voro::wall_plane, voro::wall_cylinder, and voro::wall_cone.

◆ cut_cell() [2/2]

virtual bool voro::wall::cut_cell ( voronoicell_neighbor c,
double  x,
double  y,
double  z 
) const
pure virtual

A pure virtual function for cutting a cell with neighbor-tracking enabled with a wall.

Implemented in voro::wall_sphere, voro::wall_plane, voro::wall_cylinder, and voro::wall_cone.

◆ point_inside()

virtual bool voro::wall::point_inside ( double  x,
double  y,
double  z 
) const
pure virtual

A pure virtual function for testing whether a point is inside the wall object.

Implemented in voro::wall_sphere, voro::wall_plane, voro::wall_cylinder, and voro::wall_cone.


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