A plane (2D shape) in a 3D space. More...

#include <bayeux/geomtools/plane.h>

Inheritance diagram for geomtools::plane:

Public Member Functions
bool	is_valid () const
	Check if the plane is valid. More...

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

void	reset ()
	Reset the shape. More...

double	a () const
	Return the first parameter. More...

double	b () const
	Return the second parameter. More...

double	c () const
	Return the third parameter. More...

double	d () const
	Return the fourth parameter. More...

geomtools::vector_3d	normal () const
	Return the normal to the plane. More...

void	set (double a_, double b_, double c_, double d_)
	Set the parameters. More...

void	set (const geomtools::vector_3d &point_, const geomtools::vector_3d &normal_)
	Set the parameters from a point and the normal. More...

void	set (const geomtools::vector_3d &point_, const geomtools::vector_3d &u1_, const geomtools::vector_3d &u2_)
	Set the parameters from a point and two vectors. More...

	plane ()
	Default constructor. More...

	plane (double a_, double b_, double c_, double d_)
	Constructor. More...

	plane (const geomtools::vector_3d &point_, const geomtools::vector_3d &normal_)
	Constructor from a point and the normal. More...

	plane (const geomtools::vector_3d &point_, const geomtools::vector_3d &u1_, const geomtools::vector_3d &u2_)
	Constructor from a point and two vectors. More...

double	distance (const geomtools::vector_3d &position_) const
	Compute the distance from a position to the plane. More...

geomtools::vector_3d	orthogonal_projection (const geomtools::vector_3d &position_) const
	Compute the orthogonal projection from a position. More...

geomtools::vector_3d	projection (const geomtools::vector_3d &position_, const geomtools::vector_3d &direction_) const

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

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

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

void	print_grid (std::ostream &out_, double padding_=1.0, int n1_=3, int n2_=3) const

virtual std::string	get_shape_name () const
	Return the name of the shape. 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_2d
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...

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

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

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

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

Protected Member Functions
void	_set_defaults ()
	Set default attributes values. 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...

Additional Inherited Members
Public Types inherited from geomtools::i_shape_2d
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...

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

Detailed Description

A plane (2D shape) in a 3D space.

Constructor & Destructor Documentation

◆ plane() [1/4]

geomtools::plane::plane ( )

Default constructor.

◆ plane() [2/4]

geomtools::plane::plane	(	double	a_,
		double	b_,
		double	c_,
		double	d_
	)

Constructor.

◆ plane() [3/4]

geomtools::plane::plane	(	const geomtools::vector_3d &	point_,
		const geomtools::vector_3d &	normal_
	)

Constructor from a point and the normal.

◆ plane() [4/4]

geomtools::plane::plane	(	const geomtools::vector_3d &	point_,
		const geomtools::vector_3d &	u1_,
		const geomtools::vector_3d &	u2_
	)

Constructor from a point and two vectors.

Member Function Documentation

◆ _set_defaults()

void geomtools::plane::_set_defaults ( )

protected

Set default attributes values.

◆ a()

double geomtools::plane::a ( ) const

Return the first parameter.

◆ b()

double geomtools::plane::b ( ) const

Return the second parameter.

◆ c()

double geomtools::plane::c ( ) const

Return the third parameter.

◆ d()

double geomtools::plane::d ( ) const

Return the fourth parameter.

◆ distance()

double geomtools::plane::distance ( const geomtools::vector_3d & position_ ) const

Compute the distance from a position to the plane.

◆ find_intercept()

virtual bool geomtools::plane::find_intercept	(	const geomtools::vector_3d &	a_from,
		const geomtools::vector_3d &	a_direction,
		face_intercept_info &	a_intercept,
		double	a_skin = `GEOMTOOLS_PROPER_TOLERANCE`
	)		const

virtual

Find intercept on some surface from a segment/ray emitted from a point

This method implies we work in the local coordinate system of the target object

a_from the position from which the ray is emitted
a_direction the direction of the emitted ray
a_intercept the data structure that contains the result of the intercept algorithm (impact point)
Returns
true if a valid intercept/impact has been found

Implements geomtools::i_find_intercept.

◆ generate_wires_self()

virtual void geomtools::plane::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_normal_on_surface()

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

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

Implements geomtools::i_shape_2d.

◆ get_shape_name()

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

virtual

Return the name of the shape.

Implements geomtools::i_object_3d.

◆ initialize()

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

virtual

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

Reimplemented from geomtools::i_object_3d.

◆ is_on_surface()

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

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

Implements geomtools::i_shape_2d.

◆ is_valid()

bool geomtools::plane::is_valid ( ) const

virtual

Check if the plane is valid.

Implements geomtools::i_object_3d.

◆ normal()

geomtools::vector_3d geomtools::plane::normal ( ) const

Return the normal to the plane.

◆ orthogonal_projection()

geomtools::vector_3d geomtools::plane::orthogonal_projection ( const geomtools::vector_3d & position_ ) const

Compute the orthogonal projection from a position.

◆ plane_label()

static const std::string& geomtools::plane::plane_label ( )

static

Return the identifier label for the class.

◆ print_grid()

void geomtools::plane::print_grid	(	std::ostream &	out_,
		double	padding_ = `1.0`,
		int	n1_ = `3`,
		int	n2_ = `3`
	)		const

◆ projection()

geomtools::vector_3d geomtools::plane::projection	(	const geomtools::vector_3d &	position_,
		const geomtools::vector_3d &	direction_
	)		const

◆ reset()

void geomtools::plane::reset ( )

virtual

Reset the shape.

Reimplemented from geomtools::i_object_3d.

◆ set() [1/3]

void geomtools::plane::set	(	double	a_,
		double	b_,
		double	c_,
		double	d_
	)

Set the parameters.

◆ set() [2/3]

void geomtools::plane::set	(	const geomtools::vector_3d &	point_,
		const geomtools::vector_3d &	normal_
	)

Set the parameters from a point and the normal.

◆ set() [3/3]

void geomtools::plane::set	(	const geomtools::vector_3d &	point_,
		const geomtools::vector_3d &	u1_,
		const geomtools::vector_3d &	u2_
	)

Set the parameters from a point and two vectors.

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

bayeux/geomtools/plane.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ plane() [1/4]

◆ plane() [2/4]

◆ plane() [3/4]

◆ plane() [4/4]

Member Function Documentation

◆ _set_defaults()

◆ a()

◆ b()

◆ c()

◆ d()

◆ distance()

◆ find_intercept()

◆ generate_wires_self()

◆ get_normal_on_surface()

◆ get_shape_name()

◆ initialize()

◆ is_on_surface()

◆ is_valid()

◆ normal()

◆ orthogonal_projection()

◆ plane_label()

◆ print_grid()

◆ projection()

◆ reset()

◆ set() [1/3]

◆ set() [2/3]

◆ set() [3/3]