Information about the nature and positioning of a face of the solid. More...

#include <bayeux/geomtools/face_info.h>

Inheritance diagram for geomtools::face_info:

Public Member Functions
	face_info ()
	Default constructor. More...

	~face_info ()
	Destructor. More...

bool	is_valid () const
	Check the validity. More...

bool	has_identifier () const
	Check if a face identifier is available. More...

bool	has_face () const
	Check if a face is available. More...

bool	has_positioning () const
	Check if a positioning is available. More...

bool	has_label () const
	Check if a label is available. More...

void	set_face_ref (i_shape_2d *)
	Set the 2D face handle. More...

void	set_face (const face_handle_type &)
	Set the 2D face handle. More...

template<class Shape2D >
Shape2D &	add_face ()
	Set the 2D face with explicit type. More...

void	reset_face ()
	Reset the face. More...

const i_shape_2d &	get_face_ref () const
	Return the face. More...

i_shape_2d &	grab_face_ref ()
	Return the face (mutable) More...

void	set_identifier (const face_identifier &)
	Set the face identifier. More...

const face_identifier &	get_identifier () const
	Return the face identifier. More...

face_identifier &	grab_identifier ()
	Return the face identifier (mutable) More...

void	reset_identifier ()
	Reset the face identifier. More...

const placement &	get_positioning () const
	Return the face positioning. More...

placement &	grab_positioning ()
	Return the face positioning (mutable) More...

void	set_identity_positioning ()
	Force face positioning to identity. More...

void	reset_positioning ()
	Reset face positioning. More...

const std::string &	get_label () const
	Return the face label. More...

void	set_label (const std::string &)
	Set face label. More...

void	reset_label ()
	Reset face label. More...

template<class Shape2D >
bool	is_a () const
	Check the explicit type of the face. More...

template<class Shape2D >
const Shape2D &	get_face () const
	Return a the explicitely typed face. More...

template<class Shape2D >
Shape2D &	grab_face ()
	Return a the explicitely typed face (mutable) More...

void	reset ()
	Reset. More...

virtual void	tree_dump (std::ostream &out_=std::clog, const std::string &title_="", const std::string &indent_="", bool inherit_=false) const
	Smart print. More...

Public Member Functions inherited from datatools::i_tree_dumpable
	i_tree_dumpable ()
	Constructor. More...

virtual	~i_tree_dumpable ()
	Destructor. More...

virtual void	print_tree (std::ostream &out_=std::clog, const boost::property_tree::ptree &options_=empty_options()) const
	Main new interface method for printing. More...

void	print_tree_json (std::ostream &out_=std::clog, const std::string &json_options_="") const
	Printing with jsonized options. More...

void	print_tree_json (std::ostream &out_=std::clog, const char *json_options_=nullptr) const
	Printing with jsonized options. More...

void	tree_dump_id (const int out_type_=OSTREAM_CLOG, const std::string &title_="", const std::string &indent_="", const bool inherit_=false) const

void	tree_print_id (const int out_type_=OSTREAM_CLOG, const std::string &title_="") const

void	smart_print_id (const int out_type_=OSTREAM_CLOG, const std::string &title_="", const std::string &indent_="") const

Additional Inherited Members
Public Types inherited from datatools::i_tree_dumpable
enum	ostream_type { OSTREAM_COUT = 1, OSTREAM_CERR = 2, OSTREAM_CLOG = 3 }
	Enumeration for standard output streams. More...

Static Public Member Functions inherited from datatools::i_tree_dumpable
static const boost::property_tree::ptree &	empty_options ()

static boost::property_tree::ptree	make_base_print_options (const std::string &title_, const std::string &indent_="", const bool inherit_=false)

static std::ostream &	last_skip_tag (std::ostream &out_)

static std::ostream &	skip_tag (std::ostream &out_)

static std::ostream &	last_tag (std::ostream &out_)

static std::ostream &	tag (std::ostream &out_)

Detailed Description

Information about the nature and positioning of a face of the solid.

Constructor & Destructor Documentation

◆ face_info()

geomtools::face_info::face_info ( )

Default constructor.

◆ ~face_info()

geomtools::face_info::~face_info ( )

Destructor.

Member Function Documentation

◆ add_face()

template<class Shape2D >

Shape2D& geomtools::face_info::add_face ( )

inline

Set the 2D face with explicit type.

◆ get_face()

template<class Shape2D >

const Shape2D& geomtools::face_info::get_face ( ) const

inline

Return a the explicitely typed face.

◆ get_face_ref()

const i_shape_2d& geomtools::face_info::get_face_ref ( ) const

Return the face.

◆ get_identifier()

const face_identifier& geomtools::face_info::get_identifier ( ) const

Return the face identifier.

◆ get_label()

const std::string& geomtools::face_info::get_label ( ) const

Return the face label.

◆ get_positioning()

const placement& geomtools::face_info::get_positioning ( ) const

Return the face positioning.

◆ grab_face()

template<class Shape2D >

Shape2D& geomtools::face_info::grab_face ( )

inline

Return a the explicitely typed face (mutable)

◆ grab_face_ref()

i_shape_2d& geomtools::face_info::grab_face_ref ( )

Return the face (mutable)

◆ grab_identifier()

face_identifier& geomtools::face_info::grab_identifier ( )

Return the face identifier (mutable)

◆ grab_positioning()

placement& geomtools::face_info::grab_positioning ( )

Return the face positioning (mutable)

◆ has_face()

bool geomtools::face_info::has_face ( ) const

Check if a face is available.

◆ has_identifier()

bool geomtools::face_info::has_identifier ( ) const

Check if a face identifier is available.

◆ has_label()

bool geomtools::face_info::has_label ( ) const

Check if a label is available.

◆ has_positioning()

bool geomtools::face_info::has_positioning ( ) const

Check if a positioning is available.

◆ is_a()

template<class Shape2D >

bool geomtools::face_info::is_a ( ) const

inline

Check the explicit type of the face.

◆ is_valid()

bool geomtools::face_info::is_valid ( ) const

Check the validity.

◆ reset()

void geomtools::face_info::reset ( )

Reset.

◆ reset_face()

void geomtools::face_info::reset_face ( )

Reset the face.

◆ reset_identifier()

void geomtools::face_info::reset_identifier ( )

Reset the face identifier.

◆ reset_label()

void geomtools::face_info::reset_label ( )

Reset face label.

◆ reset_positioning()

void geomtools::face_info::reset_positioning ( )

Reset face positioning.

◆ set_face()

void geomtools::face_info::set_face ( const face_handle_type & )

Set the 2D face handle.

◆ set_face_ref()

void geomtools::face_info::set_face_ref ( i_shape_2d * )

Set the 2D face handle.

◆ set_identifier()

void geomtools::face_info::set_identifier ( const face_identifier & )

Set the face identifier.

◆ set_identity_positioning()

void geomtools::face_info::set_identity_positioning ( )

Force face positioning to identity.

◆ set_label()

void geomtools::face_info::set_label ( const std::string & )

Set face label.

◆ tree_dump()

virtual void geomtools::face_info::tree_dump	(	std::ostream &	out_ = `std::clog`,
		const std::string &	title_ = `""`,
		const std::string &	indent_ = `""`,
		bool	inherit_ = `false`
	)		const

virtual

Smart print.

Reimplemented from datatools::i_tree_dumpable.

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

bayeux/geomtools/face_info.h

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ face_info()

◆ ~face_info()

Member Function Documentation

◆ add_face()

◆ get_face()

◆ get_face_ref()

◆ get_identifier()

◆ get_label()

◆ get_positioning()

◆ grab_face()

◆ grab_face_ref()

◆ grab_identifier()

◆ grab_positioning()

◆ has_face()

◆ has_identifier()

◆ has_label()

◆ has_positioning()

◆ is_a()

◆ is_valid()

◆ reset()

◆ reset_face()

◆ reset_identifier()

◆ reset_label()

◆ reset_positioning()

◆ set_face()

◆ set_face_ref()

◆ set_identifier()

◆ set_identity_positioning()

◆ set_label()

◆ tree_dump()