Bayeux  3.4.1
Core Foundation library for SuperNEMO
Public Member Functions | Public Attributes | List of all members
geomtools::classified_segment Struct Reference

A classified segment consists in a 3D segment with a first and a last point in an arbitrary reference frame and which is assigned a property that details if the segment lies inside a volume, outside a volume or is contained on the surface of a volume. More...

#include <bayeux/geomtools/i_wires_3d_rendering.h>

Public Member Functions

 classified_segment ()
 Default constructor. More...
 
void reset ()
 Reset. More...
 
void to_line (segment_type &segment_) const
 Convert to a 3D segment object. More...
 
void to_wire (polyline_type &wire_) const
 Convert to a 3D polyline object. More...
 
bool is_inside () const
 Check if the segment is inside the volume. More...
 
bool is_outside () const
 Check if the segment is outside the volume. More...
 
bool is_on_surface () const
 Check if the segment is on the surface of the volume. More...
 

Public Attributes

vector_3d first
 First point of a segment. More...
 
vector_3d last
 Last point of a segment. More...
 
shape_domain_flags_type domain
 Domain flag of the segment. More...
 

Detailed Description

A classified segment consists in a 3D segment with a first and a last point in an arbitrary reference frame and which is assigned a property that details if the segment lies inside a volume, outside a volume or is contained on the surface of a volume.

Constructor & Destructor Documentation

◆ classified_segment()

geomtools::classified_segment::classified_segment ( )

Default constructor.

Member Function Documentation

◆ is_inside()

bool geomtools::classified_segment::is_inside ( ) const

Check if the segment is inside the volume.

◆ is_on_surface()

bool geomtools::classified_segment::is_on_surface ( ) const

Check if the segment is on the surface of the volume.

◆ is_outside()

bool geomtools::classified_segment::is_outside ( ) const

Check if the segment is outside the volume.

◆ reset()

void geomtools::classified_segment::reset ( )

Reset.

◆ to_line()

void geomtools::classified_segment::to_line ( segment_type segment_) const

Convert to a 3D segment object.

◆ to_wire()

void geomtools::classified_segment::to_wire ( polyline_type wire_) const

Convert to a 3D polyline object.

Member Data Documentation

◆ domain

shape_domain_flags_type geomtools::classified_segment::domain

Domain flag of the segment.

◆ first

vector_3d geomtools::classified_segment::first

First point of a segment.

◆ last

vector_3d geomtools::classified_segment::last

Last point of a segment.


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