CGAL 5.1 - dD Spatial Searching
CGAL::Plane_separator< FT > Class Template Reference

#include <CGAL/Plane_separator.h>

Definition

template<typename FT>
class CGAL::Plane_separator< FT >

The class Plane_separator implements a plane separator, i.e., a hyperplane that is used to separate two half spaces.

This hyperplane is defined by a cutting dimension d and a cutting value v as xd=v, where v denotes the dth coordinate value.

Is Model Of:
SpatialSeparator

Related Functions

(Note that these are not member functions.)

template<class FT >
std::ostream & operator<< (std::ostream &os, Plane_separator< FT > s)
 Inserts the plane separator s in the output stream os and returns os. More...
 

Creation

 Plane_separator (int d, FT v)
 Constructs a separator that separates two half spaces by a hyperplane defined by xd=v, where v denotes the dth coordinate value. More...
 
 Plane_separator (Plane_separator< FT > p)
 Copy constructor. More...
 

Operations

void set_cutting_dimension (int d)
 Sets the cutting dimension to d. More...
 
void set_cutting_value (FT v)
 Sets the cutting value to v. More...
 
int cutting_dimension () const
 Returns the number of the cutting dimension. More...
 
FT cutting_value () const
 Returns the cutting value. More...
 
Plane_separator< FT > operator= (Plane_separator< FT > s2)
 Assignment operator. More...
 

Constructor & Destructor Documentation

◆ Plane_separator() [1/2]

template<typename FT >
CGAL::Plane_separator< FT >::Plane_separator ( int  d,
FT  v 
)

Constructs a separator that separates two half spaces by a hyperplane defined by xd=v, where v denotes the dth coordinate value.

◆ Plane_separator() [2/2]

template<typename FT >
CGAL::Plane_separator< FT >::Plane_separator ( Plane_separator< FT >  p)

Copy constructor.

Member Function Documentation

◆ cutting_dimension()

template<typename FT >
int CGAL::Plane_separator< FT >::cutting_dimension ( ) const

Returns the number of the cutting dimension.

◆ cutting_value()

template<typename FT >
FT CGAL::Plane_separator< FT >::cutting_value ( ) const

Returns the cutting value.

◆ operator=()

template<typename FT >
Plane_separator<FT> CGAL::Plane_separator< FT >::operator= ( Plane_separator< FT >  s2)

Assignment operator.

◆ set_cutting_dimension()

template<typename FT >
void CGAL::Plane_separator< FT >::set_cutting_dimension ( int  d)

Sets the cutting dimension to d.

◆ set_cutting_value()

template<typename FT >
void CGAL::Plane_separator< FT >::set_cutting_value ( FT  v)

Sets the cutting value to v.

Friends And Related Function Documentation

◆ operator<<()

template<class FT >
std::ostream & operator<< ( std::ostream &  os,
Plane_separator< FT >  s 
)
related

Inserts the plane separator s in the output stream os and returns os.