CGAL 5.1 - 3D Boolean Operations on Nef Polyhedra
CGAL::Nef_polyhedron_3< Nef_polyhedronTraits_3, Nef_polyhedronItems_3 >::SFace Class Reference

#include <CGAL/Nef_polyhedron_3.h>

Definition

template<class Nef_polyhedronTraits_3, class Nef_polyhedronItems_3 = CGAL::Default_items<Nef_polyhedronTraits_3> class Nef_polyhedronMarks = bool>
class CGAL::Nef_polyhedron_3< Nef_polyhedronTraits_3, Nef_polyhedronItems_3 >::SFace

An sface is described by its boundaries. Figures figureNef3HalfedgeIncidences and figureNef3HalfloopIncidences illustrate the incidences of an sface. An entry item to each boundary cycle can be accessed using the iterator range [sface_cycles_begin(), sface_cycles_end()). Additionally, Nef_polyhedron_S2 provides the macro CGAL_forall_sface_cylces_of. The iterators are of type SFace_cycle_const_iterator and represent either a shalfedge, a shalfloop, or a svertex.

Creation

There is no need for a user to create a SFace explicitly. The class Nef_polyhedron_3<Traits> manages the needed sfaces internally.

See also
CGAL::Nef_polyhedron_3::Vertex
CGAL::Nef_polyhedron_3::Volume

Types

The following types are the same as in Nef_polyhedron_3<Traits>.

typedef unspecified_type Mark
 type of mark. More...
 
typedef unspecified_type Object_list
 list of Object handles. More...
 
typedef unspecified_type Vertex_const_handle
 const handle to Vertex. More...
 
typedef unspecified_type Volume_const_handle
 const handle to Volume. More...
 
typedef unspecified_type SFace_const_handle
 const handle to SFace. More...
 
typedef unspecified_type SFace_cycle_const_iterator
 const iterator over the entries to all sface cycles of a sface. More...
 

Operations

const Markmark () const
 the mark of sf . More...
 
Vertex_const_handle center_vertex () const
 the center vertex of the sphere map sf belongs to. More...
 
Volume_const_handle volume () const
 the volume that corresponds to sf in the 3D incidence structure. More...
 
SFace_cycle_const_iterator sface_cycle_begin () const
 iterator over the entries to all sface cycles of sf . More...
 
SFace_cycle_const_iterator sface_cycle_end () const
 past-the-end iterator. More...
 

Member Typedef Documentation

◆ Mark

template<class Nef_polyhedronTraits_3 , class Nef_polyhedronItems_3 = CGAL::Default_items<Nef_polyhedronTraits_3> class Nef_polyhedronMarks = bool>
typedef unspecified_type CGAL::Nef_polyhedron_3< Nef_polyhedronTraits_3, Nef_polyhedronItems_3 >::SFace::Mark

type of mark.

◆ Object_list

template<class Nef_polyhedronTraits_3 , class Nef_polyhedronItems_3 = CGAL::Default_items<Nef_polyhedronTraits_3> class Nef_polyhedronMarks = bool>
typedef unspecified_type CGAL::Nef_polyhedron_3< Nef_polyhedronTraits_3, Nef_polyhedronItems_3 >::SFace::Object_list

list of Object handles.

◆ SFace_const_handle

template<class Nef_polyhedronTraits_3 , class Nef_polyhedronItems_3 = CGAL::Default_items<Nef_polyhedronTraits_3> class Nef_polyhedronMarks = bool>
typedef unspecified_type CGAL::Nef_polyhedron_3< Nef_polyhedronTraits_3, Nef_polyhedronItems_3 >::SFace::SFace_const_handle

const handle to SFace.

◆ SFace_cycle_const_iterator

template<class Nef_polyhedronTraits_3 , class Nef_polyhedronItems_3 = CGAL::Default_items<Nef_polyhedronTraits_3> class Nef_polyhedronMarks = bool>
typedef unspecified_type CGAL::Nef_polyhedron_3< Nef_polyhedronTraits_3, Nef_polyhedronItems_3 >::SFace::SFace_cycle_const_iterator

const iterator over the entries to all sface cycles of a sface.

◆ Vertex_const_handle

template<class Nef_polyhedronTraits_3 , class Nef_polyhedronItems_3 = CGAL::Default_items<Nef_polyhedronTraits_3> class Nef_polyhedronMarks = bool>
typedef unspecified_type CGAL::Nef_polyhedron_3< Nef_polyhedronTraits_3, Nef_polyhedronItems_3 >::SFace::Vertex_const_handle

const handle to Vertex.

◆ Volume_const_handle

template<class Nef_polyhedronTraits_3 , class Nef_polyhedronItems_3 = CGAL::Default_items<Nef_polyhedronTraits_3> class Nef_polyhedronMarks = bool>
typedef unspecified_type CGAL::Nef_polyhedron_3< Nef_polyhedronTraits_3, Nef_polyhedronItems_3 >::SFace::Volume_const_handle

const handle to Volume.

Member Function Documentation

◆ center_vertex()

template<class Nef_polyhedronTraits_3 , class Nef_polyhedronItems_3 = CGAL::Default_items<Nef_polyhedronTraits_3> class Nef_polyhedronMarks = bool>
Vertex_const_handle CGAL::Nef_polyhedron_3< Nef_polyhedronTraits_3, Nef_polyhedronItems_3 >::SFace::center_vertex ( ) const

the center vertex of the sphere map sf belongs to.

◆ mark()

template<class Nef_polyhedronTraits_3 , class Nef_polyhedronItems_3 = CGAL::Default_items<Nef_polyhedronTraits_3> class Nef_polyhedronMarks = bool>
const Mark& CGAL::Nef_polyhedron_3< Nef_polyhedronTraits_3, Nef_polyhedronItems_3 >::SFace::mark ( ) const

the mark of sf .

◆ sface_cycle_begin()

template<class Nef_polyhedronTraits_3 , class Nef_polyhedronItems_3 = CGAL::Default_items<Nef_polyhedronTraits_3> class Nef_polyhedronMarks = bool>
SFace_cycle_const_iterator CGAL::Nef_polyhedron_3< Nef_polyhedronTraits_3, Nef_polyhedronItems_3 >::SFace::sface_cycle_begin ( ) const

iterator over the entries to all sface cycles of sf .

◆ sface_cycle_end()

template<class Nef_polyhedronTraits_3 , class Nef_polyhedronItems_3 = CGAL::Default_items<Nef_polyhedronTraits_3> class Nef_polyhedronMarks = bool>
SFace_cycle_const_iterator CGAL::Nef_polyhedron_3< Nef_polyhedronTraits_3, Nef_polyhedronItems_3 >::SFace::sface_cycle_end ( ) const

past-the-end iterator.

◆ volume()

template<class Nef_polyhedronTraits_3 , class Nef_polyhedronItems_3 = CGAL::Default_items<Nef_polyhedronTraits_3> class Nef_polyhedronMarks = bool>
Volume_const_handle CGAL::Nef_polyhedron_3< Nef_polyhedronTraits_3, Nef_polyhedronItems_3 >::SFace::volume ( ) const

the volume that corresponds to sf in the 3D incidence structure.