The 3D shape model for a tube. More...

#include <bayeux/geomtools/tube.h>

Inheritance diagram for geomtools::tube:

Public Types
enum	faces_mask_type { FACE_NONE = face_identifier::FACE_BITS_NONE, FACE_OUTER_SIDE = datatools::bit_mask::bit00, FACE_BOTTOM = datatools::bit_mask::bit01, FACE_TOP = datatools::bit_mask::bit02, FACE_INNER_SIDE = datatools::bit_mask::bit03, FACE_START_ANGLE = datatools::bit_mask::bit04, FACE_STOP_ANGLE = datatools::bit_mask::bit05, FACE_ALL }
	Face flags. More...

enum	volumes_mask_type { VOLUME_NONE = 0, VOLUME_BULK = datatools::bit_mask::bit00, VOLUME_CAVITY = datatools::bit_mask::bit01 }
	Volume flags. More...

enum	tube_wires_rendering_option_type { WR_TUBE_NO_BOTTOM_FACE = (WR_BASE_LAST << 1), WR_TUBE_NO_TOP_FACE = (WR_BASE_LAST << 2), WR_TUBE_NO_INNER_FACE = (WR_BASE_LAST << 3), WR_TUBE_NO_OUTER_FACE = (WR_BASE_LAST << 4), WR_TUBE_NO_START_ANGLE_FACE = (WR_BASE_LAST << 5), WR_TUBE_NO_STOP_ANGLE_FACE = (WR_BASE_LAST << 6), WR_TUBE_LAST = (WR_TUBE_NO_STOP_ANGLE_FACE), WR_TUBE_MASK }
	3D rendering options 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
void	compute_top_bottom_face (faces_mask_type face_id_, disk &face_, placement &face_placement_) const
	Compute the top or bottom face and placement. More...

void	compute_side_face (faces_mask_type face_id_, cylindrical_sector &face_, placement &face_placement_) const
	Compute the side bottom face and placement. More...

void	compute_start_stop_angle_face (faces_mask_type face_id_, rectangle &face_, placement &face_placement_) const
	Compute the top or bottom face and placement. More...

bool	has_inner_face () const
	Check for an inner face. More...

virtual unsigned int	compute_faces (face_info_collection_type &faces_) const
	Return a collection of face info objects. More...

double	get_xmin () const
	Return the minimum X. More...

double	get_xmax () const
	Return the maximum X. More...

double	get_ymin () const
	Return the minimum Y. More...

double	get_ymax () const
	Return the maximum Y. More...

double	get_zmin () const
	Return the minimum Z. More...

double	get_zmax () const
	Return the maximum Z. More...

double	get_z () const
	Return the Z dimension. More...

void	set_z (double)
	Set the Z dimension. More...

double	get_half_z () const
	Return half the Z dimension. More...

void	set_half_z (double)
	Set half the Z dimension. More...

bool	has_inner_r () const
	Check the inner radius. More...

double	get_inner_r () const
	Return the inner radius. More...

void	set_inner_r (double)
	Set the inner radius. More...

void	set_radii (double inner_r_, double outer_r_)
	Set the inner and outer radii. More...

double	get_outer_r () const
	Return the outer radius. More...

void	set_outer_r (double)
	Set the inner radius. More...

void	set (double outer_r_, double z_)
	Set the dimensions. More...

void	set (double inner_r_, double outer_r_, double z_)
	Set the dimensions. More...

void	set_half (double inner_r_, double outer_r_, double half_z_)
	Set the dimensions by halves. More...

void	set (double inner_r_, double outer_r_, double z_, double start_phi_, double delta_phi_)
	Set the dimensions and angular limits. More...

const angular_range &	get_phi_domain () const
	Return the phi domain. More...

bool	has_partial_phi () const
	Check for the partial arc. More...

bool	has_start_phi () const
	Check the start phi. More...

void	set_start_phi (double)
	Set the start phi. More...

double	get_start_phi () const
	Return the start phi. More...

bool	has_delta_phi () const
	Check the dedislta phi. More...

void	set_delta_phi (double)
	Set the delta phi. More...

double	get_delta_phi () const
	Return the delta phi. More...

void	set_phi (double start_phi_, double delta_phi_)

void	compute_inner_cylinder (cylinder &ic_)
	Compute the inner nappe. More...

void	compute_outer_cylinder (cylinder &oc_)
	Compute the outer nappe. More...

	tube ()
	Default constructor. More...

	tube (double outer_radius_, double z_)
	Constructor. More...

	tube (double inner_radius_, double outer_radius_, double z_)
	Constructor. More...

	tube (double inner_radius_, double outer_radius_, double z_, double start_phi_, double delta_phi_)
	Constructor. More...

virtual	~tube ()
	Destructor. More...

virtual std::string	get_shape_name () const
	Return the identifier/name of the shape. More...

virtual double	get_parameter (const std::string &) const
	Return a parameter given its name. More...

bool	is_extruded () const
	Check if the tube is extruded. More...

bool	is_valid () const
	Check if the tube is valid. More...

virtual void	initialize (const datatools::properties &, const handle_dict_type *=0)
	Initialize the tube from properties. More...

virtual void	reset ()
	Reset the tube. More...

virtual double	get_surface (uint32_t mask_=FACE_ALL) const
	Compute the surface. More...

virtual double	get_volume (uint32_t flags_=VOLUME_BULK) const
	Compute the volume. More...

virtual bool	is_inside (const vector_3d &, double skin_=GEOMTOOLS_PROPER_TOLERANCE) const
	Check if a point is inside the tube. More...

virtual bool	is_outside (const vector_3d &, double skin_=GEOMTOOLS_PROPER_TOLERANCE) const
	Check if a point is outside the tube. More...

virtual face_identifier	on_surface (const vector_3d &, const face_identifier &a_surface_mask=face_identifier::face_bits_any(), double a_skin=GEOMTOOLS_PROPER_TOLERANCE) const
	Return the surface bit a point belongs to. More...

virtual vector_3d	get_normal_on_surface (const vector_3d &a_position, const face_identifier &a_surface_bit) const
	Return the vector normal to the surface at some position. More...

virtual bool	find_intercept (const vector_3d &from_, const vector_3d &direction_, face_intercept_info &intercept_, double skin_=GEOMTOOLS_PROPER_TOLERANCE) const
	Find the intercept point with a face of the tube. 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...

virtual void	generate_wires_self (wires_type &wires_, uint32_t options_=0) const
	Generate a sequence of polylines for wires 3D rendering. More...

Public Member Functions inherited from geomtools::i_shape_3d
bool	is_native_stackable () const

const stackable_data &	get_stackable_data () const
	Return the enforced stackable data associated to the shape. More...

bool	has_stackable_data () const
	Check if some enforced stackable data are available. More...

bool	owns_stackable_data () const
	Check if some enforced stackable data are available and owned by the shape itself. More...

void	set_stackable_data (const stackable_data &a_stackable_data)
	Set external enforced stackable data. More...

void	set_stackable_data (const stackable_data *a_stackable_data)
	Set internal enforced stackable data. More...

void	reset_stackable_data ()
	Reset enforced stackable data. More...

int	get_dimensional () const
	Return the dimension (3) More...

double	get_skin (double a_skin) const
	Return the effective skin tolerance associated to the 3D shape. More...

double	get_skin () const
	Return the intrinsic skin tolerance. More...

void	set_skin (double a_skin)
	Set the intrinsic skin tolerance. More...

	i_shape_3d ()
	Constructor. More...

	i_shape_3d (double a_skin)
	Constructor with skin tolerance. More...

	i_shape_3d (double a_skin_, double angular_tolerance_)
	Constructor. More...

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

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

virtual	~i_shape_3d ()
	Destructor. More...

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

virtual bool	using_face_id_bits () const
	Check if the face identification scheme is based on face bits. More...

virtual bool	using_face_id_index () const
	Check if the face identification scheme is based on face index. More...

virtual bool	using_face_id_part_index () const
	Check if the face identification scheme uses part index. More...

virtual void	make_any_face (face_identifier &) const
	Build a face identifier any mask. More...

virtual bool	has_number_of_faces () const
	Check if the number of faces is known. More...

virtual unsigned int	get_number_of_faces () const
	Return the number of faces. More...

virtual bool	volume_can_be_forced () const
	Check if a forced volume can be set. More...

virtual bool	has_forced_volume () const
	Check is a forced volume is set. More...

void	set_forced_volume (double volume_)
	Force the volume. More...

double	get_forced_volume () const
	Return the forced volume. More...

virtual bool	has_volume (uint32_t flags_=0) const
	Check is the volume is known. More...

double	get_effective_volume () const
	Return the total effective volume. More...

virtual bool	has_surface (uint32_t flags_=face_identifier::FACE_BITS_ANY) const
	Check is the surface is known. More...

bool	check_inside (const vector_3d &position_, double a_skin=GEOMTOOLS_PROPER_TOLERANCE) const
	Check if a point is inside the solid. More...

bool	check_outside (const vector_3d &position_, double a_skin=GEOMTOOLS_PROPER_TOLERANCE) const
	Check if a point is outside the solid. More...

face_identifier	check_surface (const vector_3d &position_, const face_identifier &a_surface_mask=face_identifier::FACE_BITS_ANY, double a_skin=GEOMTOOLS_PROPER_TOLERANCE) const
	Check is a point is located on a given surface. More...

bool	check_surface (const vector_3d &position_, double a_skin=GEOMTOOLS_PROPER_TOLERANCE) const
	Check if a point is on the surface of the solid. More...

bool	is_on_surface (const vector_3d &position_, const face_identifier &a_surface_mask=face_identifier::FACE_BITS_ANY, double a_skin=GEOMTOOLS_PROPER_TOLERANCE) const
	Check is a point is on a surface of the solid. More...

virtual shape_domain_flags_type	where_is (const vector_3d &position_, double a_skin) const
	Localize a point with respect to the solid. More...

bool	has_computed_faces () const
	Check if the embedded collection of faces has been computed. More...

const face_info_collection_type &	get_computed_faces () const
	Return the collection of faces. More...

void	reset_computed_faces ()
	Reset the computed faces. More...

bool	has_bounding_data () const
	Check the bounding data. More...

const bounding_data &	get_bounding_data () const
	Return the bounding data. More...

void	reset_bounding_data ()
	Reset the bounding data. More...

void	set_bounding_data (const bounding_data &)
	Set the bounding data. More...

void	build_default_bounding_data ()
	Build default bounding data. More...

bool	is_locked () const
	Check the lock flag. More...

void	lock ()
	Lock the shape, performing some internal calculations. More...

void	unlock ()
	Unlock the shape. More...

Public Member Functions inherited from geomtools::i_object_3d
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...

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

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

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

virtual	~i_find_intercept ()
	Destructor. More...

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_stackable
	i_stackable ()

virtual	~i_stackable ()

bool	has_xmin () const

bool	has_xmax () const

bool	has_ymin () const

bool	has_ymax () const

bool	has_zmin () const

bool	has_zmax () const

Static Public Member Functions
static const std::string &	tube_label ()
	Return the identifier label for the class. More...

static void	init_ocd (datatools::object_configuration_description &)
	OCD support. More...

Static Public Member Functions inherited from geomtools::i_shape_3d
static double	get_default_skin ()
	Return the default skin value. More...

static double	get_zero_skin ()
	Return the zero skin value (0 == no thickness) More...

static double	get_proper_skin ()
	Return the special skin value that tells to use the intrinsic skin of the shape itself (< 0) More...

static const std::string &	volume_key ()

static const std::string &	surface_key ()

static bool	pickup_stackable (const i_shape_3d &, stackable_data &)
	Initialize a 'stackable_data' instance from stackable data attached to the 3D-shape. More...

static bool	check_stackability (const i_shape_3d &, const stackable::stackability_mode)
	Check the stackability of the shape (from native or enforced stackable infos) More...

static void	init_ocd (datatools::object_configuration_description &)
	OCD support. More...

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

Protected Member Functions
void	_set_defaults ()
	Set default attributes. More...

virtual void	_build_bounding_data ()
	Build bounding data. More...

Protected Member Functions inherited from geomtools::i_shape_3d
void	_set_defaults ()
	Set default values for attributes. More...

virtual void	_at_lock ()
	Executed at lock stage. More...

virtual void	_at_unlock ()
	Executed at unlock stage. More...

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

void	_reset ()
	Reset. More...

void	_initialize_bounding_data (const datatools::properties &config_)
	Parse bounding data from a properties container. More...

void	_initialize_stackable_data (const datatools::properties &config_)
	Parse stackable data from a properties container. More...

void	_reset_bounding_data ()
	Reset the bounding data. More...

bounding_data &	_grab_bounding_data ()
	Return the bounding data. More...

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

Friends
std::ostream &	operator<< (std::ostream &, const tube &)
	Output operator. More...

std::istream &	operator>> (std::istream &, tube &)
	Input operator. More...

Additional Inherited Members
Static Public Attributes inherited from geomtools::i_shape_3d
static const double	DEFAULT_SKIN

static const double	ZERO_SKIN

static const double	USING_PROPER_SKIN

Detailed Description

The 3D shape model for a tube.

Member Enumeration Documentation

◆ faces_mask_type

enum geomtools::tube::faces_mask_type

Face flags.

Enumerator
FACE_NONE
FACE_OUTER_SIDE
FACE_BOTTOM
FACE_TOP
FACE_INNER_SIDE
FACE_START_ANGLE
FACE_STOP_ANGLE
FACE_ALL

◆ tube_wires_rendering_option_type

enum geomtools::tube::tube_wires_rendering_option_type

3D rendering options

Enumerator
WR_TUBE_NO_BOTTOM_FACE	Do not render the bottom face.
WR_TUBE_NO_TOP_FACE	Do not render the top face.
WR_TUBE_NO_INNER_FACE	Do not render the inner face.
WR_TUBE_NO_OUTER_FACE	Do not render the outer face.
WR_TUBE_NO_START_ANGLE_FACE	Do not render the start angle face.
WR_TUBE_NO_STOP_ANGLE_FACE	Do not render the stop angle face.
WR_TUBE_LAST	Last defined bit.
WR_TUBE_MASK	Rendering options bit mask.

◆ volumes_mask_type

enum geomtools::tube::volumes_mask_type

Volume flags.

Enumerator
VOLUME_NONE
VOLUME_BULK
VOLUME_CAVITY

Constructor & Destructor Documentation

◆ tube() [1/4]

geomtools::tube::tube ( )

Default constructor.

◆ tube() [2/4]

geomtools::tube::tube	(	double	outer_radius_,
		double	z_
	)

Constructor.

◆ tube() [3/4]

geomtools::tube::tube	(	double	inner_radius_,
		double	outer_radius_,
		double	z_
	)

Constructor.

◆ tube() [4/4]

geomtools::tube::tube	(	double	inner_radius_,
		double	outer_radius_,
		double	z_,
		double	start_phi_,
		double	delta_phi_
	)

Constructor.

◆ ~tube()

virtual geomtools::tube::~tube ( )

virtual

Destructor.

Member Function Documentation

◆ _build_bounding_data()

virtual void geomtools::tube::_build_bounding_data ( )

protectedvirtual

Build bounding data.

Reimplemented from geomtools::i_shape_3d.

◆ _set_defaults()

void geomtools::tube::_set_defaults ( )

protected

Set default attributes.

◆ compute_faces()

virtual unsigned int geomtools::tube::compute_faces ( face_info_collection_type & faces_ ) const

virtual

Return a collection of face info objects.

Reimplemented from geomtools::i_shape_3d.

◆ compute_inner_cylinder()

void geomtools::tube::compute_inner_cylinder ( cylinder & ic_ )

Compute the inner nappe.

◆ compute_outer_cylinder()

void geomtools::tube::compute_outer_cylinder ( cylinder & oc_ )

Compute the outer nappe.

◆ compute_side_face()

void geomtools::tube::compute_side_face	(	faces_mask_type	face_id_,
		cylindrical_sector &	face_,
		placement &	face_placement_
	)		const

Compute the side bottom face and placement.

◆ compute_start_stop_angle_face()

void geomtools::tube::compute_start_stop_angle_face	(	faces_mask_type	face_id_,
		rectangle &	face_,
		placement &	face_placement_
	)		const

Compute the top or bottom face and placement.

◆ compute_top_bottom_face()

void geomtools::tube::compute_top_bottom_face	(	faces_mask_type	face_id_,
		disk &	face_,
		placement &	face_placement_
	)		const

Compute the top or bottom face and placement.

◆ find_intercept()

virtual bool geomtools::tube::find_intercept	(	const vector_3d &	from_,
		const vector_3d &	direction_,
		face_intercept_info &	intercept_,
		double	skin_ = `GEOMTOOLS_PROPER_TOLERANCE`
	)		const

virtual

Find the intercept point with a face of the tube.

Implements geomtools::i_find_intercept.

◆ generate_wires_self()

virtual void geomtools::tube::generate_wires_self	(	wires_type &	wires_,
		uint32_t	options_ = `0`
	)		const

virtual

Generate a sequence of polylines for wires 3D rendering.

Implements geomtools::i_wires_3d_rendering.

◆ get_delta_phi()

double geomtools::tube::get_delta_phi ( ) const

Return the delta phi.

◆ get_half_z()

double geomtools::tube::get_half_z ( ) const

Return half the Z dimension.

◆ get_inner_r()

double geomtools::tube::get_inner_r ( ) const

Return the inner radius.

◆ get_normal_on_surface()

virtual vector_3d geomtools::tube::get_normal_on_surface	(	const vector_3d &	a_position,
		const face_identifier &	a_surface_bit
	)		const

virtual

Return the vector normal to the surface at some position.

Implements geomtools::i_shape_3d.

◆ get_outer_r()

double geomtools::tube::get_outer_r ( ) const

Return the outer radius.

◆ get_parameter()

virtual double geomtools::tube::get_parameter ( const std::string & ) const

virtual

Return a parameter given its name.

◆ get_phi_domain()

const angular_range& geomtools::tube::get_phi_domain ( ) const

Return the phi domain.

◆ get_shape_name()

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

virtual

Return the identifier/name of the shape.

Implements geomtools::i_object_3d.

◆ get_start_phi()

double geomtools::tube::get_start_phi ( ) const

Return the start phi.

◆ get_surface()

virtual double geomtools::tube::get_surface ( uint32_t mask_ = FACE_ALL ) const

virtual

Compute the surface.

Reimplemented from geomtools::i_shape_3d.

◆ get_volume()

virtual double geomtools::tube::get_volume ( uint32_t flags_ = VOLUME_BULK ) const

virtual

Compute the volume.

Reimplemented from geomtools::i_shape_3d.

◆ get_xmax()

double geomtools::tube::get_xmax ( ) const

virtual

Return the maximum X.

Implements geomtools::i_stackable.

◆ get_xmin()

double geomtools::tube::get_xmin ( ) const

virtual

Return the minimum X.

Implements geomtools::i_stackable.

◆ get_ymax()

double geomtools::tube::get_ymax ( ) const

virtual

Return the maximum Y.

Implements geomtools::i_stackable.

◆ get_ymin()

double geomtools::tube::get_ymin ( ) const

virtual

Return the minimum Y.

Implements geomtools::i_stackable.

◆ get_z()

double geomtools::tube::get_z ( ) const

Return the Z dimension.

◆ get_zmax()

double geomtools::tube::get_zmax ( ) const

virtual

Return the maximum Z.

Implements geomtools::i_stackable.

◆ get_zmin()

double geomtools::tube::get_zmin ( ) const

virtual

Return the minimum Z.

Implements geomtools::i_stackable.

◆ has_delta_phi()

bool geomtools::tube::has_delta_phi ( ) const

Check the dedislta phi.

◆ has_inner_face()

bool geomtools::tube::has_inner_face ( ) const

Check for an inner face.

◆ has_inner_r()

bool geomtools::tube::has_inner_r ( ) const

Check the inner radius.

◆ has_partial_phi()

bool geomtools::tube::has_partial_phi ( ) const

Check for the partial arc.

◆ has_start_phi()

bool geomtools::tube::has_start_phi ( ) const

Check the start phi.

◆ init_ocd()

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

static

OCD support.

◆ initialize()

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

virtual

Initialize the tube from properties.

Reimplemented from geomtools::i_object_3d.

◆ is_extruded()

bool geomtools::tube::is_extruded ( ) const

Check if the tube is extruded.

◆ is_inside()

virtual bool geomtools::tube::is_inside	(	const vector_3d &	,
		double	skin_ = `GEOMTOOLS_PROPER_TOLERANCE`
	)		const

virtual

Check if a point is inside the tube.

Implements geomtools::i_shape_3d.

◆ is_outside()

virtual bool geomtools::tube::is_outside	(	const vector_3d &	,
		double	skin_ = `GEOMTOOLS_PROPER_TOLERANCE`
	)		const

virtual

Check if a point is outside the tube.

Implements geomtools::i_shape_3d.

◆ is_valid()

bool geomtools::tube::is_valid ( ) const

virtual

Check if the tube is valid.

Implements geomtools::i_object_3d.

◆ on_surface()

virtual face_identifier geomtools::tube::on_surface	(	const vector_3d &	,
		const face_identifier &	a_surface_mask = `face_identifier::face_bits_any()`,
		double	a_skin = `GEOMTOOLS_PROPER_TOLERANCE`
	)		const

virtual

Return the surface bit a point belongs to.

Implements geomtools::i_shape_3d.

◆ reset()

virtual void geomtools::tube::reset ( )

virtual

Reset the tube.

Reimplemented from geomtools::i_object_3d.

◆ set() [1/3]

void geomtools::tube::set	(	double	outer_r_,
		double	z_
	)

Set the dimensions.

◆ set() [2/3]

void geomtools::tube::set	(	double	inner_r_,
		double	outer_r_,
		double	z_
	)

Set the dimensions.

◆ set() [3/3]

void geomtools::tube::set	(	double	inner_r_,
		double	outer_r_,
		double	z_,
		double	start_phi_,
		double	delta_phi_
	)

Set the dimensions and angular limits.

◆ set_delta_phi()

void geomtools::tube::set_delta_phi ( double )

Set the delta phi.

◆ set_half()

void geomtools::tube::set_half	(	double	inner_r_,
		double	outer_r_,
		double	half_z_
	)

Set the dimensions by halves.

◆ set_half_z()

void geomtools::tube::set_half_z ( double )

Set half the Z dimension.

◆ set_inner_r()

void geomtools::tube::set_inner_r ( double )

Set the inner radius.

◆ set_outer_r()

void geomtools::tube::set_outer_r ( double )

Set the inner radius.

◆ set_phi()

void geomtools::tube::set_phi	(	double	start_phi_,
		double	delta_phi_
	)

◆ set_radii()

void geomtools::tube::set_radii	(	double	inner_r_,
		double	outer_r_
	)

Set the inner and outer radii.

◆ set_start_phi()

void geomtools::tube::set_start_phi ( double )

Set the start phi.

◆ set_z()

void geomtools::tube::set_z ( double )

Set the Z dimension.

◆ tree_dump()

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

virtual

Smart print.

Reimplemented from geomtools::i_shape_3d.

◆ tube_label()

static const std::string& geomtools::tube::tube_label ( )

static

Return the identifier label for the class.

Friends And Related Function Documentation

◆ operator<<

std::ostream& operator<<	(	std::ostream &	,
		const tube &
	)

friend

Output operator.

◆ operator>>

std::istream& operator>>	(	std::istream &	,
		tube &
	)

friend

Input operator.

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

bayeux/geomtools/tube.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Friends

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ faces_mask_type

◆ tube_wires_rendering_option_type

◆ volumes_mask_type

Constructor & Destructor Documentation

◆ tube() [1/4]

◆ tube() [2/4]

◆ tube() [3/4]

◆ tube() [4/4]

◆ ~tube()

Member Function Documentation

◆ _build_bounding_data()

◆ _set_defaults()

◆ compute_faces()

◆ compute_inner_cylinder()

◆ compute_outer_cylinder()

◆ compute_side_face()

◆ compute_start_stop_angle_face()

◆ compute_top_bottom_face()

◆ find_intercept()

◆ generate_wires_self()

◆ get_delta_phi()

◆ get_half_z()

◆ get_inner_r()

◆ get_normal_on_surface()

◆ get_outer_r()

◆ get_parameter()

◆ get_phi_domain()

◆ get_shape_name()

◆ get_start_phi()

◆ get_surface()

◆ get_volume()

◆ get_xmax()

◆ get_xmin()

◆ get_ymax()

◆ get_ymin()

◆ get_z()

◆ get_zmax()

◆ get_zmin()

◆ has_delta_phi()

◆ has_inner_face()

◆ has_inner_r()

◆ has_partial_phi()

◆ has_start_phi()

◆ init_ocd()

◆ initialize()

◆ is_extruded()

◆ is_inside()

◆ is_outside()

◆ is_valid()

◆ on_surface()

◆ reset()

◆ set() [1/3]

◆ set() [2/3]

◆ set() [3/3]

◆ set_delta_phi()

◆ set_half()

◆ set_half_z()

◆ set_inner_r()

◆ set_outer_r()

◆ set_phi()

◆ set_radii()

◆ set_start_phi()

◆ set_z()

◆ tree_dump()

◆ tube_label()

Friends And Related Function Documentation

◆ operator<<

◆ operator>>