Mother abstract class for all 3D object classes. More...

#include <bayeux/geomtools/i_object_3d.h>

Inheritance diagram for geomtools::i_object_3d:

Classes
class	i_getter
	Object 3D abstract getter class. More...

class	object_entry
	An entry that stores a 3D object. More...

Public Types
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 Member Functions
virtual int	get_dimensional () const =0
	Return the dimension of the object. More...

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

Static Public Member Functions
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_)

Protected Member Functions
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

Mother abstract class for all 3D object classes.

Member Typedef Documentation

◆ handle_dict_type

typedef std::map<std::string, object_entry> geomtools::i_object_3d::handle_dict_type

Dictionary of handle of 3D object entries.

◆ handle_type

typedef datatools::handle<i_object_3d> geomtools::i_object_3d::handle_type

A handle to a 3D object.

Member Enumeration Documentation

◆ dimensional_type

enum geomtools::i_object_3d::dimensional_type

Known dimensions.

Enumerator
DIMENSIONAL_0	No dimension object (example: a vertex)
DIMENSIONAL_1	One dimension object (example: a segment)
DIMENSIONAL_2	Two dimension object (example: a rectangle)
DIMENSIONAL_3	Three dimension object (example: a box)

Constructor & Destructor Documentation

◆ i_object_3d() [1/4]

geomtools::i_object_3d::i_object_3d ( )

Default constructor.

◆ i_object_3d() [2/4]

geomtools::i_object_3d::i_object_3d ( double tolerance_ )

Constructor on length tolerance.

◆ i_object_3d() [3/4]

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

Constructor on length tolerance.

◆ i_object_3d() [4/4]

geomtools::i_object_3d::i_object_3d ( const i_object_3d & )

Copy constructor.

◆ ~i_object_3d()

virtual geomtools::i_object_3d::~i_object_3d ( )

virtual

Destructor.

Member Function Documentation

◆ _initialize()

void geomtools::i_object_3d::_initialize	(	const datatools::properties &	,
		const handle_dict_type *	= `0`
	)

protected

Initialize from properties.

◆ _reset()

void geomtools::i_object_3d::_reset ( )

protected

Reset.

◆ _set_defaults()

void geomtools::i_object_3d::_set_defaults ( )

protected

Set default values for attributes.

◆ compute_angular_tolerance()

double geomtools::i_object_3d::compute_angular_tolerance ( double angular_tolerance_ ) const

Return the angular tolerance.

◆ compute_tolerance()

double geomtools::i_object_3d::compute_tolerance ( double tolerance_ ) const

Return the distance tolerance.

◆ get_angular_tolerance()

double geomtools::i_object_3d::get_angular_tolerance ( ) const

Return the angular tolerance.

◆ get_dimensional()

virtual int geomtools::i_object_3d::get_dimensional ( ) const

pure virtual

Return the dimension of the object.

Implemented in geomtools::i_shape_3d, geomtools::i_shape_2d, and geomtools::i_shape_1d.

◆ get_logging_priority()

datatools::logger::priority geomtools::i_object_3d::get_logging_priority ( ) const

Return the logging priority threshold.

◆ get_shape_name()

virtual std::string geomtools::i_object_3d::get_shape_name ( ) const

pure virtual

Return the name of the shape.

Implemented in geomtools::tessellated_solid, geomtools::tube, geomtools::extruded_box, geomtools::sphere, geomtools::torus, geomtools::polyhedra, geomtools::ellipse, geomtools::polycone, geomtools::box, geomtools::cylinder, geomtools::elliptical_cylinder, geomtools::disk, geomtools::regular_polygon, geomtools::ellipsoid, geomtools::elliptical_sector, geomtools::circle, geomtools::quadrangle, geomtools::plane, geomtools::triangle, geomtools::wall_solid, geomtools::rectangle, geomtools::right_circular_conical_frustrum, geomtools::simple_polygon, geomtools::right_polygonal_frustrum, geomtools::helix_3d, geomtools::line_3d, geomtools::elliptical_cylinder_sector, geomtools::ellipsoid_sector, geomtools::polyline_3d, geomtools::quadric, geomtools::right_circular_conical_nappe, geomtools::composite_surface, geomtools::intersection_3d, geomtools::union_3d, geomtools::cylindrical_sector, geomtools::spherical_sector, geomtools::subtraction_3d, and geomtools::toroid_nappe.

◆ get_tolerance()

double geomtools::i_object_3d::get_tolerance ( ) const

Return the distance tolerance.

◆ get_wires_drawer()

const i_wires_3d_rendering& geomtools::i_object_3d::get_wires_drawer ( ) const

Return a wires drawer.

◆ grab_wires_drawer()

i_wires_3d_rendering& geomtools::i_object_3d::grab_wires_drawer ( )

Return a wires drawer.

◆ has_wires_drawer()

bool geomtools::i_object_3d::has_wires_drawer ( ) const

Check is a wires drawer is available.

◆ init_ocd()

static void geomtools::i_object_3d::init_ocd ( datatools::object_configuration_description & )

static

OCD support.

◆ initialize()

virtual void geomtools::i_object_3d::initialize	(	const datatools::properties &	,
		const handle_dict_type *	= `0`
	)

virtual

Initialize from properties and a dictionary of 3D-objects.

Reimplemented in geomtools::tessellated_solid, geomtools::right_circular_conical_frustrum, geomtools::tube, geomtools::right_polygonal_frustrum, geomtools::polycone, geomtools::extruded_box, geomtools::i_composite_shape_3d, geomtools::simple_polygon, geomtools::sphere, geomtools::ellipse, geomtools::torus, geomtools::polyhedra, geomtools::right_circular_conical_nappe, geomtools::box, geomtools::cylinder, geomtools::elliptical_cylinder, geomtools::circle, geomtools::ellipsoid, geomtools::disk, geomtools::regular_polygon, geomtools::rectangle, geomtools::ellipsoid_sector, geomtools::elliptical_sector, geomtools::spherical_sector, geomtools::elliptical_cylinder_sector, geomtools::quadrangle, geomtools::wall_solid, geomtools::cylindrical_sector, geomtools::triangle, geomtools::toroid_nappe, geomtools::composite_surface, geomtools::quadric, and geomtools::plane.

◆ initialize_simple()

void geomtools::i_object_3d::initialize_simple ( )

Initialize the 3D object.

◆ is_composite()

virtual bool geomtools::i_object_3d::is_composite ( ) const

virtual

Check if the object is composite.

Reimplemented in geomtools::i_composite_shape_3d, and geomtools::i_shape_3d.

◆ is_valid()

virtual bool geomtools::i_object_3d::is_valid ( ) const

pure virtual

Check the validity of the object.

Implemented in geomtools::tessellated_solid, geomtools::tube, geomtools::extruded_box, geomtools::sphere, geomtools::torus, geomtools::polyhedra, geomtools::polycone, geomtools::box, geomtools::cylinder, geomtools::i_composite_shape_3d, geomtools::elliptical_cylinder, geomtools::ellipsoid, geomtools::ellipsoid_sector, geomtools::elliptical_cylinder_sector, geomtools::cylindrical_sector, geomtools::wall_solid, geomtools::regular_polygon, geomtools::right_circular_conical_frustrum, geomtools::right_polygonal_frustrum, geomtools::simple_polygon, geomtools::helix_3d, geomtools::line_3d, geomtools::polyline_3d, geomtools::quadrangle, geomtools::quadric, geomtools::circle, geomtools::ellipse, geomtools::rectangle, geomtools::right_circular_conical_nappe, geomtools::triangle, geomtools::elliptical_sector, geomtools::composite_surface, geomtools::disk, geomtools::spherical_sector, geomtools::toroid_nappe, and geomtools::plane.

◆ operator=()

i_object_3d& geomtools::i_object_3d::operator= ( const i_object_3d & )

Assignment operator.

◆ reset()

virtual void geomtools::i_object_3d::reset ( )

virtual

Reset.

Reimplemented in geomtools::tessellated_solid, geomtools::right_circular_conical_frustrum, geomtools::tube, geomtools::right_polygonal_frustrum, geomtools::polycone, geomtools::extruded_box, geomtools::i_composite_shape_3d, geomtools::simple_polygon, geomtools::sphere, geomtools::ellipse, geomtools::torus, geomtools::polyhedra, geomtools::helix_3d, geomtools::right_circular_conical_nappe, geomtools::box, geomtools::cylinder, geomtools::elliptical_cylinder, geomtools::circle, geomtools::ellipsoid, geomtools::disk, geomtools::regular_polygon, geomtools::rectangle, geomtools::ellipsoid_sector, geomtools::elliptical_sector, geomtools::spherical_sector, geomtools::elliptical_cylinder_sector, geomtools::quadrangle, geomtools::wall_solid, geomtools::cylindrical_sector, geomtools::triangle, geomtools::toroid_nappe, geomtools::composite_surface, geomtools::quadric, and geomtools::plane.

◆ reset_wires_drawer()

void geomtools::i_object_3d::reset_wires_drawer ( )

Reset the wires drawer.

◆ set_angular_tolerance()

void geomtools::i_object_3d::set_angular_tolerance ( double tolerance_ )

Set the angular tolerance.

◆ set_logging_priority()

void geomtools::i_object_3d::set_logging_priority ( datatools::logger::priority )

Set the logging priority threshold.

◆ set_tolerance()

void geomtools::i_object_3d::set_tolerance ( double tolerance_ )

Set the distance tolerance.

◆ set_wires_drawer()

void geomtools::i_object_3d::set_wires_drawer ( i_wires_3d_rendering & wires_drawer_ )

Set a wires drawer.

◆ tree_dump()

virtual void geomtools::i_object_3d::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.

Reimplemented in geomtools::tessellated_solid, geomtools::polycone, geomtools::tube, geomtools::polyhedra, geomtools::i_shape_3d, geomtools::sphere, geomtools::extruded_box, geomtools::quadric, geomtools::torus, geomtools::box, geomtools::cylinder, geomtools::i_composite_shape_3d, geomtools::elliptical_cylinder, geomtools::right_circular_conical_frustrum, geomtools::ellipsoid, geomtools::right_polygonal_frustrum, geomtools::helix_3d, geomtools::ellipse, geomtools::simple_polygon, geomtools::wall_solid, geomtools::disk, geomtools::regular_polygon, geomtools::ellipsoid_sector, geomtools::elliptical_sector, geomtools::spherical_sector, geomtools::elliptical_cylinder_sector, geomtools::quadrangle, geomtools::right_circular_conical_nappe, geomtools::cylindrical_sector, geomtools::triangle, geomtools::circle, geomtools::polyline_3d, geomtools::toroid_nappe, geomtools::composite_surface, geomtools::line_3d, and geomtools::rectangle.

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

bayeux/geomtools/i_object_3d.h

Classes

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Detailed Description

Member Typedef Documentation

◆ handle_dict_type

◆ handle_type

Member Enumeration Documentation

◆ dimensional_type

Constructor & Destructor Documentation

◆ i_object_3d() [1/4]

◆ i_object_3d() [2/4]

◆ i_object_3d() [3/4]

◆ i_object_3d() [4/4]

◆ ~i_object_3d()

Member Function Documentation

◆ _initialize()

◆ _reset()

◆ _set_defaults()

◆ compute_angular_tolerance()

◆ compute_tolerance()

◆ get_angular_tolerance()

◆ get_dimensional()

◆ get_logging_priority()

◆ get_shape_name()

◆ get_tolerance()

◆ get_wires_drawer()

◆ grab_wires_drawer()

◆ has_wires_drawer()

◆ init_ocd()

◆ initialize()

◆ initialize_simple()

◆ is_composite()

◆ is_valid()

◆ operator=()

◆ reset()

◆ reset_wires_drawer()

◆ set_angular_tolerance()

◆ set_logging_priority()

◆ set_tolerance()

◆ set_wires_drawer()

◆ tree_dump()