A sequence of connected linear segments (3D) More...

#include <bayeux/geomtools/polyline_3d.h>

Inheritance diagram for geomtools::polyline_3d:

Public Types
typedef polyline_type	point_col
	A sequence of vertexes. 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 std::string	get_shape_name () const
	Return the name of the shape. More...

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

bool	is_closed () const
	Check if the polyline is closed. More...

void	set_closed (bool)
	Set the 'closed' flag. More...

bool	is_empty () const
	Check if the polyline has no points. More...

	polyline_3d ()
	Default constructor. More...

	polyline_3d (bool closed_)
	Constructor. More...

virtual	~polyline_3d ()
	Destructor. More...

void	clear ()
	Remove all points. More...

void	add (const vector_3d &)
	Add a point at the end of the sequence. More...

int	get_number_of_points () const
	Return the number of points in the sequence. More...

const vector_3d &	get_point (int i_) const
	Return the point at given index. More...

int	get_number_of_vertex () const

int	get_number_of_vertexes () const
	Return the number of vertexes in the sequence. More...

const vector_3d &	get_vertex (int i_) const
	Return the vertex at given index. More...

virtual double	get_length (uint32_t flags_=PATH_ALL_BITS) const
	Return the length of the linear segment. More...

void	make_vertex_collection (basic_polyline_3d &) const

polyline_type	make_vertex_collection () const

virtual bool	is_on_curve (const vector_3d &position_, double tolerance_=GEOMTOOLS_PROPER_TOLERANCE) const
	Check if a point belongs to the polyline. More...

virtual vector_3d	get_direction_on_curve (const vector_3d &position_) const
	Return the direction at some position along the polyline. More...

const polyline_type &	get_points () const
	Return a non mutable reference to the collection of points. More...

polyline_type &	grab_points ()
	Return a mutable reference to the collection of points. 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_1d
int	get_dimensional () const
	Return the dimension of the object. More...

virtual bool	has_number_of_paths () const
	Check if the 1D shape knows its number of associated paths. More...

virtual unsigned int	get_number_of_paths () const
	Return the number of paths. More...

virtual bool	has_length (uint32_t flags_=PATH_ALL_BITS) const
	Check if the 1D shape known its length. More...

	i_shape_1d ()
	Default constructor. More...

	i_shape_1d (double tolerance_)
	Constructor. More...

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

virtual	~i_shape_1d ()
	Destructor. 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...

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

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

Static Public Member Functions
static const std::string &	polyline_3d_label ()
	Return the identifier of the polyline 3D-object. More...

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

Static Public Attributes
static const bool	CLOSED = true

static const bool	closed = CLOSED

static const bool	OPEN = false

static const bool	open = OPEN

static const bool	DEFAULT_CLOSED = OPEN

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

A sequence of connected linear segments (3D)

Member Typedef Documentation

◆ point_col

typedef polyline_type geomtools::polyline_3d::point_col

A sequence of vertexes.

Constructor & Destructor Documentation

◆ polyline_3d() [1/2]

geomtools::polyline_3d::polyline_3d ( )

Default constructor.

◆ polyline_3d() [2/2]

geomtools::polyline_3d::polyline_3d ( bool closed_ )

Constructor.

◆ ~polyline_3d()

virtual geomtools::polyline_3d::~polyline_3d ( )

virtual

Destructor.

Member Function Documentation

◆ add()

void geomtools::polyline_3d::add ( const vector_3d & )

Add a point at the end of the sequence.

◆ clear()

void geomtools::polyline_3d::clear ( )

Remove all points.

◆ generate_wires_self()

virtual void geomtools::polyline_3d::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_direction_on_curve()

virtual vector_3d geomtools::polyline_3d::get_direction_on_curve ( const vector_3d & position_ ) const

virtual

Return the direction at some position along the polyline.

Implements geomtools::i_shape_1d.

◆ get_length()

virtual double geomtools::polyline_3d::get_length ( uint32_t flags_ = PATH_ALL_BITS ) const

virtual

Return the length of the linear segment.

Reimplemented from geomtools::i_shape_1d.

◆ get_number_of_points()

int geomtools::polyline_3d::get_number_of_points ( ) const

Return the number of points in the sequence.

◆ get_number_of_vertex()

int geomtools::polyline_3d::get_number_of_vertex ( ) const

Deprecated:: Return the number of points in the sequence

◆ get_number_of_vertexes()

int geomtools::polyline_3d::get_number_of_vertexes ( ) const

Return the number of vertexes in the sequence.

◆ get_point()

const vector_3d& geomtools::polyline_3d::get_point ( int i_ ) const

Return the point at given index.

◆ get_points()

const polyline_type& geomtools::polyline_3d::get_points ( ) const

Return a non mutable reference to the collection of points.

◆ get_shape_name()

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

virtual

Return the name of the shape.

Implements geomtools::i_object_3d.

◆ get_vertex()

const vector_3d& geomtools::polyline_3d::get_vertex ( int i_ ) const

Return the vertex at given index.

◆ grab_points()

polyline_type& geomtools::polyline_3d::grab_points ( )

Return a mutable reference to the collection of points.

◆ is_closed()

bool geomtools::polyline_3d::is_closed ( ) const

Check if the polyline is closed.

◆ is_empty()

bool geomtools::polyline_3d::is_empty ( ) const

Check if the polyline has no points.

◆ is_on_curve()

virtual bool geomtools::polyline_3d::is_on_curve	(	const vector_3d &	position_,
		double	tolerance_ = `GEOMTOOLS_PROPER_TOLERANCE`
	)		const

virtual

Check if a point belongs to the polyline.

Implements geomtools::i_shape_1d.

◆ is_valid()

bool geomtools::polyline_3d::is_valid ( ) const

virtual

Check if the polyline is valid.

Implements geomtools::i_object_3d.

◆ make_vertex_collection() [1/2]

void geomtools::polyline_3d::make_vertex_collection ( basic_polyline_3d & ) const

◆ make_vertex_collection() [2/2]

polyline_type geomtools::polyline_3d::make_vertex_collection ( ) const

◆ polyline_3d_label()

static const std::string& geomtools::polyline_3d::polyline_3d_label ( )

static

Return the identifier of the polyline 3D-object.

◆ set_closed()

void geomtools::polyline_3d::set_closed ( bool )

Set the 'closed' flag.

◆ tree_dump()

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

Member Data Documentation

◆ CLOSED

const bool geomtools::polyline_3d::CLOSED = true

static

◆ closed

const bool geomtools::polyline_3d::closed = CLOSED

static

◆ DEFAULT_CLOSED

const bool geomtools::polyline_3d::DEFAULT_CLOSED = OPEN

static

◆ OPEN

const bool geomtools::polyline_3d::OPEN = false

static

◆ open

const bool geomtools::polyline_3d::open = OPEN

static

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

bayeux/geomtools/polyline_3d.h

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ point_col

Constructor & Destructor Documentation

◆ polyline_3d() [1/2]

◆ polyline_3d() [2/2]

◆ ~polyline_3d()

Member Function Documentation

◆ add()

◆ clear()

◆ generate_wires_self()

◆ get_direction_on_curve()

◆ get_length()

◆ get_number_of_points()

◆ get_number_of_vertex()

◆ get_number_of_vertexes()

◆ get_point()

◆ get_points()

◆ get_shape_name()

◆ get_vertex()

◆ grab_points()

◆ is_closed()

◆ is_empty()

◆ is_on_curve()

◆ is_valid()

◆ make_vertex_collection() [1/2]

◆ make_vertex_collection() [2/2]

◆ polyline_3d_label()

◆ set_closed()

◆ tree_dump()

Member Data Documentation

◆ CLOSED

◆ closed

◆ DEFAULT_CLOSED

◆ OPEN

◆ open