Bayeux  3.4.1
Core Foundation library for SuperNEMO
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | List of all members
geomtools::regular_polygon Class Reference

A regular polygon. More...

#include <bayeux/geomtools/regular_polygon.h>

Inheritance diagram for geomtools::regular_polygon:
geomtools::i_shape_2d geomtools::i_polygon geomtools::i_object_3d geomtools::i_find_intercept geomtools::i_wires_3d_rendering datatools::i_serializable datatools::i_tree_dumpable

Public Types

enum  mode_type { BUILD_BY_RADIUS = 1, BUILD_BY_APOTHEM = 2 }
 Construction mode. More...
 
enum  rp_wires_rendering_option_type { WR_RP_NO_EXTERNAL_EDGES = (WR_BASE_LAST << 1), WR_RP_LAST = (WR_RP_NO_EXTERNAL_EDGES), WR_RP_MASK = (WR_RP_NO_EXTERNAL_EDGES) }
 3D rendering options More...
 
- 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_3dhandle_type
 A handle to a 3D object. More...
 
typedef std::map< std::string, object_entryhandle_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

bool is_valid () const
 Check the validity of the polygon. More...
 
uint32_t get_n_sides () const
 Return the number of sides. More...
 
void set_n_sides (uint32_t)
 Set the number of sides. More...
 
double get_apothem () const
 Return the apothem. More...
 
virtual double get_perimeter (uint32_t flags_=ALL_PIECES) const
 Return the perimeter. More...
 
double get_side_length () const
 Return the length of a side. More...
 
double get_reference_angle () const
 Return the reference angle. More...
 
double get_r () const
 Return the radius. More...
 
double get_radius () const
 Return the radius. More...
 
void set_r (double)
 Set the radius. More...
 
void set_diameter (double)
 Set the diameter. More...
 
virtual double get_diameter () const
 Return the diameter. More...
 
virtual double get_surface (uint32_t flags_=ALL_PIECES) const
 Return the surface. More...
 
void get_vertex (int n_, double &x_, double &y_) const
 Compute the coordinates of a vertex given its index. More...
 
void get_vertex (int n_, vector_3d &vertex_) const
 Compute the vertex given its index. More...
 
 regular_polygon ()
 Default constructor. More...
 
 regular_polygon (uint32_t n_sides_, double r_, int mode_=BUILD_BY_RADIUS)
 Constructor. More...
 
virtual ~regular_polygon ()
 Destructor. More...
 
void initialize (const datatools::properties &, const handle_dict_type *=0)
 Initialize from properties and a dictionary of 3D-objects. More...
 
void reset ()
 Reset. More...
 
virtual std::string get_shape_name () const
 Return the identifier/name of the shape. More...
 
virtual bool is_on_surface (const vector_3d &, double tolerance_=GEOMTOOLS_PROPER_TOLERANCE) const
 Check is a given point belongs to the surface of the 2D shape. More...
 
virtual vector_3d get_normal_on_surface (const vector_3d &position_, bool check_=true, double skin_=GEOMTOOLS_PROPER_TOLERANCE) const
 Return the normal direction at some position on the 2D shape's path. More...
 
virtual bool find_intercept (const vector_3d &from_, const vector_3d &direction_, face_intercept_info &intercept_, double tolerance_=GEOMTOOLS_PROPER_TOLERANCE) const
 Find the intercept of a ray with the 2D shape's surfaces. 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...
 
virtual unsigned int compute_vertexes (vertex_col_type &vertexes_) const
 Build an ordered collection of vertexes. 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 bool has_surface (uint32_t flags_=ALL_PIECES) const
 Check if the 2D shape surface is defined. 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_renderinggrab_wires_drawer ()
 Return a wires drawer. More...
 
const i_wires_3d_renderingget_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_3doperator= (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_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 & regular_polygon_label ()
 
- 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...
 

Static Public Attributes

static const unsigned int MIN_NUMBER_OF_SIDES = 3
 The minimum number of sides. 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...
 

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

 C         B
  *-------*
 /       / \
/       /  .* M

/ O /. \ D * * <-r-> ----------------—> y \ : / A \ : / \ : / *----— E | F | V x

A, B... F : vertices OA = OB : radius (or circumradius) OM : apothem (http://en.wikipedia.org/wiki/Apothem) AB : side's length (A0B) : reference angle

Member Enumeration Documentation

◆ mode_type

Construction mode.

Enumerator
BUILD_BY_RADIUS 
BUILD_BY_APOTHEM 

◆ rp_wires_rendering_option_type

3D rendering options

Enumerator
WR_RP_NO_EXTERNAL_EDGES 

Do not render the external edges.

WR_RP_LAST 

Last defined bit.

WR_RP_MASK 

Rendering options bit mask.

Constructor & Destructor Documentation

◆ regular_polygon() [1/2]

geomtools::regular_polygon::regular_polygon ( )

Default constructor.

◆ regular_polygon() [2/2]

geomtools::regular_polygon::regular_polygon ( uint32_t  n_sides_,
double  r_,
int  mode_ = BUILD_BY_RADIUS 
)

Constructor.

◆ ~regular_polygon()

virtual geomtools::regular_polygon::~regular_polygon ( )
virtual

Destructor.

Member Function Documentation

◆ compute_vertexes()

virtual unsigned int geomtools::regular_polygon::compute_vertexes ( vertex_col_type vertexes_) const
virtual

Build an ordered collection of vertexes.

Implements geomtools::i_polygon.

◆ find_intercept()

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

Find the intercept of a ray with the 2D shape's surfaces.

Implements geomtools::i_find_intercept.

◆ generate_wires_self()

virtual void geomtools::regular_polygon::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_apothem()

double geomtools::regular_polygon::get_apothem ( ) const

Return the apothem.

◆ get_diameter()

virtual double geomtools::regular_polygon::get_diameter ( ) const
virtual

Return the diameter.

◆ get_n_sides()

uint32_t geomtools::regular_polygon::get_n_sides ( ) const

Return the number of sides.

◆ get_normal_on_surface()

virtual vector_3d geomtools::regular_polygon::get_normal_on_surface ( const 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.

Implements geomtools::i_shape_2d.

◆ get_perimeter()

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

Return the perimeter.

Reimplemented from geomtools::i_shape_2d.

◆ get_r()

double geomtools::regular_polygon::get_r ( ) const

Return the radius.

◆ get_radius()

double geomtools::regular_polygon::get_radius ( ) const

Return the radius.

◆ get_reference_angle()

double geomtools::regular_polygon::get_reference_angle ( ) const

Return the reference angle.

◆ get_shape_name()

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

Return the identifier/name of the shape.

Implements geomtools::i_object_3d.

◆ get_side_length()

double geomtools::regular_polygon::get_side_length ( ) const

Return the length of a side.

◆ get_surface()

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

Return the surface.

Reimplemented from geomtools::i_shape_2d.

◆ get_vertex() [1/2]

void geomtools::regular_polygon::get_vertex ( int  n_,
double &  x_,
double &  y_ 
) const

Compute the coordinates of a vertex given its index.

◆ get_vertex() [2/2]

void geomtools::regular_polygon::get_vertex ( int  n_,
vector_3d vertex_ 
) const

Compute the vertex given its index.

◆ initialize()

void geomtools::regular_polygon::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::regular_polygon::is_on_surface ( const vector_3d ,
double  tolerance_ = GEOMTOOLS_PROPER_TOLERANCE 
) const
virtual

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

Implements geomtools::i_shape_2d.

◆ is_valid()

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

Check the validity of the polygon.

Implements geomtools::i_object_3d.

◆ regular_polygon_label()

static const std::string& geomtools::regular_polygon::regular_polygon_label ( )
static

◆ reset()

void geomtools::regular_polygon::reset ( )
virtual

Reset.

Reimplemented from geomtools::i_object_3d.

◆ set_diameter()

void geomtools::regular_polygon::set_diameter ( double  )

Set the diameter.

◆ set_n_sides()

void geomtools::regular_polygon::set_n_sides ( uint32_t  )

Set the number of sides.

◆ set_r()

void geomtools::regular_polygon::set_r ( double  )

Set the radius.

◆ tree_dump()

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

◆ MIN_NUMBER_OF_SIDES

const unsigned int geomtools::regular_polygon::MIN_NUMBER_OF_SIDES = 3
static

The minimum number of sides.


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