CGAL 5.1 - 3D Boolean Operations on Nef Polyhedra
CGAL::Nef_polyhedron_3< Nef_polyhedronTraits_3, Nef_polyhedronItems_3 >::Volume 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 >::Volume

A volume is a full-dimensional connected point set in \( \mathbb{R}^3\). It is bounded by several shells, i.e. a connected part of the boundary incident to a single volume. An entry element to each shell is provided by the iterator range (shells_begin()/shells_end()). A Shell_entry_iterator is assignable to SFace_handle.

Creation

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

See also
CGAL::Nef_polyhedron_3::SFace

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 Volume_const_handle
 const handle to Volume. More...
 
typedef unspecified_type Shell_entry_const_iterator
 const iterator over the entries to all shells adjacent to a volume. More...
 

Operations

const Markmark () const
 the mark of c . More...
 
Shell_entry_const_iterator shells_begin () const
 const iterator over the entries to all shells adjacent to c . More...
 
Shell_entry_const_iterator shells_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 >::Volume::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 >::Volume::Object_list

list of Object handles.

◆ Shell_entry_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 >::Volume::Shell_entry_const_iterator

const iterator over the entries to all shells adjacent to a volume.

◆ 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 >::Volume::Volume_const_handle

const handle to Volume.

Member Function Documentation

◆ 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 >::Volume::mark ( ) const

the mark of c .

◆ shells_begin()

template<class Nef_polyhedronTraits_3 , class Nef_polyhedronItems_3 = CGAL::Default_items<Nef_polyhedronTraits_3> class Nef_polyhedronMarks = bool>
Shell_entry_const_iterator CGAL::Nef_polyhedron_3< Nef_polyhedronTraits_3, Nef_polyhedronItems_3 >::Volume::shells_begin ( ) const

const iterator over the entries to all shells adjacent to c .

◆ shells_end()

template<class Nef_polyhedronTraits_3 , class Nef_polyhedronItems_3 = CGAL::Default_items<Nef_polyhedronTraits_3> class Nef_polyhedronMarks = bool>
Shell_entry_const_iterator CGAL::Nef_polyhedron_3< Nef_polyhedronTraits_3, Nef_polyhedronItems_3 >::Volume::shells_end ( ) const

past-the-end iterator.