The abstract base class for all 2D shapes/surfaces. More...

#include <bayeux/geomtools/i_shape_2d.h>

Inheritance diagram for geomtools::i_shape_2d:

Public Types
enum	faces_mask_type { FACE_NONE = face_identifier::FACE_BITS_NONE, FACE_UNIQUE = datatools::bit_mask::bit00, FACE_UP = FACE_UNIQUE, FACE_DOWN = datatools::bit_mask::bit01, FACE_ALL = FACE_UNIQUE }
	The up/down identifier of the face. More...

Public Types inherited from geomtools::i_object_3d
enum	dimensional_type { DIMENSIONAL_0 = 0, DIMENSIONAL_1 = 1, DIMENSIONAL_2 = 2, DIMENSIONAL_3 = 3 }
	Known dimensions. More...

typedef datatools::handle< i_object_3d >	handle_type
	A handle to a 3D object. More...

typedef std::map< std::string, object_entry >	handle_dict_type
	Dictionary of handle of 3D object entries. More...

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...

Public Types inherited from geomtools::i_wires_3d_rendering
enum	wires_rendering_option_type { WR_NONE = 0, WR_BASE_GRID = datatools::bit_mask::bit00, WR_BASE_GRID_LOW_DENSITY = (WR_BASE_GRID << 1), WR_BASE_GRID_HIGH_DENSITY = (WR_BASE_GRID << 2), WR_BASE_GRID_VERY_HIGH_DENSITY = (WR_BASE_GRID << 3), WR_BASE_GRID_HUGE_DENSITY = (WR_BASE_GRID << 4), WR_BASE_LOW_ANGLE_SAMPLING = (WR_BASE_GRID << 5), WR_BASE_HIGH_ANGLE_SAMPLING = (WR_BASE_GRID << 6), WR_BASE_VERY_HIGH_ANGLE_SAMPLING = (WR_BASE_GRID << 7), WR_BASE_HUGE_ANGLE_SAMPLING = (WR_BASE_GRID << 8), WR_BASE_UNUSED_09 = (WR_BASE_GRID << 9), WR_BASE_UNUSED_10 = (WR_BASE_GRID << 10), WR_BASE_UNUSED_11 = (WR_BASE_GRID << 11), WR_BASE_UNUSED_12 = (WR_BASE_GRID << 12), WR_BASE_UNUSED_13 = (WR_BASE_GRID << 13), WR_BASE_BOUNDINGS = (WR_BASE_GRID << 14), WR_BASE_EXPLODE = (WR_BASE_GRID << 15), WR_BASE_LAST = (WR_BASE_EXPLODE), WR_BASE_MASK = datatools::bit_mask::nbits16 }
	Wires rendering optional flags. More...

enum	sampling_level_type { SL_NONE = 0, SL_LOW = 1, SL_NORMAL = 2, SL_HIGH = 3, SL_VERY_HIGH = 4, SL_HUGE = 5 }
	Sampling levels. More...

Public Member Functions
virtual bool	has_number_of_sides () const
	Check if the 2D shape knows its number of associated sides. More...

virtual unsigned int	get_number_of_sides () const
	Return the number of associated sides. More...

virtual bool	has_perimeter (uint32_t flags_=ALL_PIECES) const
	Check if the 2D shape known its perimeter. More...

virtual double	get_perimeter (uint32_t flags_=ALL_PIECES) const
	Return the perimeter. More...

virtual bool	has_surface (uint32_t flags_=ALL_PIECES) const
	Check if the 2D shape surface is defined. More...

virtual double	get_surface (uint32_t flags_=ALL_PIECES) const
	Return the surface. More...

int	get_dimensional () const
	Return the dimension of the object. More...

	i_shape_2d ()
	Default constructor. More...

	i_shape_2d (double tolerance_)
	Constructor. More...

	i_shape_2d (double tolerance_, double angular_tolerance_)
	Constructor. More...

virtual	~i_shape_2d ()
	Destructor. More...

virtual bool	is_on_surface (const vector_3d &position_, double skin_=GEOMTOOLS_PROPER_TOLERANCE) const =0

virtual vector_3d	get_normal_on_surface (const vector_3d &position_, bool check_=false, double skin_=GEOMTOOLS_PROPER_TOLERANCE) const =0

Public Member Functions inherited from geomtools::i_object_3d
virtual std::string	get_shape_name () const =0
	Return the name of the shape. More...

virtual bool	is_valid () const =0
	Check the validity of the object. More...

datatools::logger::priority	get_logging_priority () const
	Return the logging priority threshold. More...

void	set_logging_priority (datatools::logger::priority)
	Set the logging priority threshold. More...

bool	has_wires_drawer () const
	Check is a wires drawer is available. More...

void	set_wires_drawer (i_wires_3d_rendering &wires_drawer_)
	Set a wires drawer. More...

void	reset_wires_drawer ()
	Reset the wires drawer. More...

i_wires_3d_rendering &	grab_wires_drawer ()
	Return a wires drawer. More...

const i_wires_3d_rendering &	get_wires_drawer () const
	Return a wires drawer. More...

double	compute_tolerance (double tolerance_) const
	Return the distance tolerance. More...

double	compute_angular_tolerance (double angular_tolerance_) const
	Return the angular tolerance. More...

double	get_tolerance () const
	Return the distance tolerance. More...

void	set_tolerance (double tolerance_)
	Set the distance tolerance. More...

double	get_angular_tolerance () const
	Return the angular tolerance. More...

void	set_angular_tolerance (double tolerance_)
	Set the angular tolerance. More...

virtual bool	is_composite () const
	Check if the object is composite. More...

	i_object_3d ()
	Default constructor. More...

	i_object_3d (double tolerance_)
	Constructor on length tolerance. More...

	i_object_3d (double tolerance_, double angular_tolerance_)
	Constructor on length tolerance. More...

	i_object_3d (const i_object_3d &)
	Copy constructor. More...

i_object_3d &	operator= (const i_object_3d &)
	Assignment operator. More...

virtual	~i_object_3d ()
	Destructor. More...

void	initialize_simple ()
	Initialize the 3D object. More...

virtual void	initialize (const datatools::properties &, const handle_dict_type *=0)
	Initialize from properties and a dictionary of 3D-objects. More...

virtual 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_serializable
	i_serializable ()
	Default constructor. More...

virtual	~i_serializable ()
	Destructor. More...

virtual const std::string &	get_serial_tag () const =0
	Return the serialization string identifier of the class. 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

Public Member Functions inherited from geomtools::i_find_intercept
	i_find_intercept ()
	Default constructor. More...

virtual	~i_find_intercept ()
	Destructor. More...

virtual bool	find_intercept (const vector_3d &a_from, const vector_3d &a_direction, face_intercept_info &a_intercept, double a_skin=GEOMTOOLS_PROPER_TOLERANCE) const =0

bool	find_intercept_self (const vector_3d &a_from, const vector_3d &a_direction, face_intercept_info &a_intercept, double a_skin=GEOMTOOLS_PROPER_TOLERANCE) const

bool	find_intercept (const vector_3d &a_from, const vector_3d &a_direction, const placement &a_placement, face_intercept_info &a_intercept, double a_skin=GEOMTOOLS_PROPER_TOLERANCE) const

Public Member Functions inherited from geomtools::i_wires_3d_rendering
virtual	~i_wires_3d_rendering ()
	Destructor. More...

void	generate_wires (wires_type &wires_, const placement &positioning_, uint32_t options_=0) const

void	generate_wires (wires_type &wires_, const geomtools::vector_3d &position_, const geomtools::rotation_3d &rotation_, uint32_t options_=0) const

virtual void	generate_wires_self (wires_type &wires_, uint32_t options_=0) const =0

Static Public Member Functions
static void	init_ocd (datatools::object_configuration_description &ocd_)

Static Public Member Functions inherited from geomtools::i_object_3d
static void	init_ocd (datatools::object_configuration_description &)
	OCD support. 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_)

Static Public Member Functions inherited from geomtools::i_wires_3d_rendering
static uint32_t	linear_sampling (sampling_level_type)
	Return linear sampling from sampling level. More...

static uint32_t	linear_sampling_from_options (uint32_t)
	Return linear sampling from rendering options. More...

static uint32_t	angular_sampling (sampling_level_type)
	Return angular sampling from sampling level. More...

static uint32_t	angular_sampling_from_options (uint32_t)
	Return angular sampling from rendering options. More...

static void	boost_linear_sampling (uint32_t &)
	Boost the linear sampling. More...

Static Public Attributes
static const uint32_t	ALL_PIECES = 0xFFFFFFFF
	Special flag representing all pieces composing a 2D shape. More...

Additional Inherited Members
Protected Member Functions inherited from geomtools::i_object_3d
void	_set_defaults ()
	Set default values for attributes. More...

void	_initialize (const datatools::properties &, const handle_dict_type *=0)
	Initialize from properties. More...

void	_reset ()
	Reset. More...

Detailed Description

The abstract base class for all 2D shapes/surfaces.

Member Enumeration Documentation

◆ faces_mask_type

enum geomtools::i_shape_2d::faces_mask_type

The up/down identifier of the face.

Enumerator
FACE_NONE	Invalid face.
FACE_UNIQUE	Up face.
FACE_UP	Unique face.
FACE_DOWN	Down face.
FACE_ALL

Constructor & Destructor Documentation

◆ i_shape_2d() [1/3]

geomtools::i_shape_2d::i_shape_2d ( )

Default constructor.

◆ i_shape_2d() [2/3]

geomtools::i_shape_2d::i_shape_2d ( double tolerance_ )

Constructor.

◆ i_shape_2d() [3/3]

geomtools::i_shape_2d::i_shape_2d	(	double	tolerance_,
		double	angular_tolerance_
	)

Constructor.

◆ ~i_shape_2d()

virtual geomtools::i_shape_2d::~i_shape_2d ( )

virtual

Destructor.

Member Function Documentation

◆ get_dimensional()

int geomtools::i_shape_2d::get_dimensional ( ) const

virtual

Return the dimension of the object.

Implements geomtools::i_object_3d.

◆ get_normal_on_surface()

virtual vector_3d geomtools::i_shape_2d::get_normal_on_surface	(	const vector_3d &	position_,
		bool	check_ = `false`,
		double	skin_ = `GEOMTOOLS_PROPER_TOLERANCE`
	)		const

pure virtual

Return the normal direction at some position on the 2D shape's path

position_ The position to be checked
Returns
the normal 3D vector at the checked position that is assumes belonging to the surface

Implemented in geomtools::disk, geomtools::regular_polygon, geomtools::simple_polygon, geomtools::ellipsoid_sector, geomtools::elliptical_sector, geomtools::spherical_sector, geomtools::elliptical_cylinder_sector, geomtools::quadrangle, geomtools::right_circular_conical_nappe, geomtools::quadric, geomtools::cylindrical_sector, geomtools::triangle, geomtools::toroid_nappe, geomtools::plane, geomtools::composite_surface, and geomtools::rectangle.

◆ get_number_of_sides()

virtual unsigned int geomtools::i_shape_2d::get_number_of_sides ( ) const

virtual

Return the number of associated sides.

◆ get_perimeter()

virtual double geomtools::i_shape_2d::get_perimeter ( uint32_t flags_ = ALL_PIECES ) const

virtual

Return the perimeter.

Reimplemented in geomtools::disk, geomtools::simple_polygon, geomtools::elliptical_sector, geomtools::regular_polygon, geomtools::composite_surface, geomtools::rectangle, geomtools::quadrangle, and geomtools::triangle.

◆ get_surface()

virtual double geomtools::i_shape_2d::get_surface ( uint32_t flags_ = ALL_PIECES ) const

virtual

Return the surface.

Reimplemented in geomtools::ellipsoid_sector, geomtools::elliptical_cylinder_sector, geomtools::regular_polygon, geomtools::cylindrical_sector, geomtools::disk, geomtools::spherical_sector, geomtools::right_circular_conical_nappe, geomtools::simple_polygon, geomtools::elliptical_sector, geomtools::composite_surface, geomtools::toroid_nappe, geomtools::rectangle, geomtools::quadrangle, and geomtools::triangle.

◆ has_number_of_sides()

virtual bool geomtools::i_shape_2d::has_number_of_sides ( ) const

virtual

Check if the 2D shape knows its number of associated sides.

◆ has_perimeter()

virtual bool geomtools::i_shape_2d::has_perimeter ( uint32_t flags_ = ALL_PIECES ) const

virtual

Check if the 2D shape known its perimeter.

◆ has_surface()

virtual bool geomtools::i_shape_2d::has_surface ( uint32_t flags_ = ALL_PIECES ) const

virtual

Check if the 2D shape surface is defined.

◆ init_ocd()

static void geomtools::i_shape_2d::init_ocd ( datatools::object_configuration_description & ocd_ )

static

Document the base object configuration description (OCD) associated to a 2D shape.

ocd_ The object configuration description to be documented

◆ is_on_surface()

virtual bool geomtools::i_shape_2d::is_on_surface	(	const vector_3d &	position_,
		double	skin_ = `GEOMTOOLS_PROPER_TOLERANCE`
	)		const

pure virtual

Check is a given point belongs to the surface of the 2D shape

position_ The position to be checked
skin_ The tolerance (effective thickness of the surface)
Returns
true if the checked position belongs to the surface

Implemented in geomtools::disk, geomtools::regular_polygon, geomtools::simple_polygon, geomtools::ellipsoid_sector, geomtools::elliptical_sector, geomtools::spherical_sector, geomtools::elliptical_cylinder_sector, geomtools::quadrangle, geomtools::right_circular_conical_nappe, geomtools::quadric, geomtools::cylindrical_sector, geomtools::triangle, geomtools::toroid_nappe, geomtools::plane, geomtools::composite_surface, and geomtools::rectangle.

Member Data Documentation

◆ ALL_PIECES

const uint32_t geomtools::i_shape_2d::ALL_PIECES = 0xFFFFFFFF

static

Special flag representing all pieces composing a 2D shape.

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

bayeux/geomtools/i_shape_2d.h

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ faces_mask_type

Constructor & Destructor Documentation

◆ i_shape_2d() [1/3]

◆ i_shape_2d() [2/3]

◆ i_shape_2d() [3/3]

◆ ~i_shape_2d()

Member Function Documentation

◆ get_dimensional()

◆ get_normal_on_surface()

◆ get_number_of_sides()

◆ get_perimeter()

◆ get_surface()

◆ has_number_of_sides()

◆ has_perimeter()

◆ has_surface()

◆ init_ocd()

◆ is_on_surface()

Member Data Documentation

◆ ALL_PIECES