PlaneX Class Reference

Plane perpendicular to the x-axis. More...

#include <CSGSurface.hpp>

Inheritance diagram for PlaneX:

Collaboration diagram for PlaneX:

Public Member Functions
	PlaneX (const pugi::xml_node &planex_node) noexcept
	Constructs a PlaneX from a planex node of an XML document. More...
Real	Distance (const Point &origin, const Direction &direction) const noexcept override
	Returns the distance from a given origin Point to the PlaneX along a given Direction. More...
bool	Contains (const Point &p) const noexcept override
	Implements CSGSurface method. More...
Public Member Functions inherited from CSGSurface
virtual	~CSGSurface () noexcept
	Virtual destructor (C++ Core Guidelines C.127)
virtual bool	Contains (const Point &p) const noexcept=0
	Returns true if Point is in the "negative" side of the (open) surface. A point on the surface or outside is considered to be on the "positive" side. More...
virtual Real	Distance (const Point &origin, const Direction &direction) const noexcept=0
	Return the distance from a given origin Point to the CSGSurface along a given Direction. More...

Additional Inherited Members
Static Public Member Functions inherited from CSGSurface
static std::unique_ptr< const CSGSurface >	Create (const pugi::xml_node &root, const std::string &name)
	Factory method to create new CSGSurface from an XML document. More...
Public Attributes inherited from CSGSurface
const std::string	name
	Unique, user-defined identifier (C++ Core Guidelines C.131)
Protected Member Functions inherited from CSGSurface
	CSGSurface (const pugi::xml_node &surface_node) noexcept
	Constructs a CSGSurface from a surface node of an XML document. More...
Static Protected Member Functions inherited from CSGSurface
static Real	SolveQuadratic (Real a, Real b, Real c) noexcept
	Specialized form of quadratic equation solver. More...

Detailed Description

Plane perpendicular to the x-axis.

Todo:

Add arbitrary Plane object which can be defined by a single Point

Constructor & Destructor Documentation

PlaneX()

PlaneX::PlaneX ( const pugi::xml_node &  planex_node )

noexcept

Constructs a PlaneX from a planex node of an XML document.

Parameters

planex_node

The requested planex node in the XML document

Member Function Documentation

Contains()

bool PlaneX::Contains ( const Point &  p ) const

overridevirtualnoexcept

Implements CSGSurface method.

Implements CSGSurface.

Distance()

Real PlaneX::Distance ( const Point &  origin, const Direction &  direction  ) const

overridevirtualnoexcept

Returns the distance from a given origin Point to the PlaneX along a given Direction.

Implements CSGSurface.

---

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

• /Users/atumulak/Developer/minimc/src/CSGSurface.hpp