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

A segment associated to a facet. More...

#include <bayeux/geomtools/tessellation.h>

Public Types

enum  vertex_id_type { VTX_ID_NONE = -1, VTX_ID_FIRST = 0, VTX_ID_SECOND = 1 }
 The Id of the vertex. More...
 

Public Member Functions

bool is_valid () const
 Check validity. More...
 
bool is_shown () const
 Check if the segment is shown. More...
 
void set_shown (bool)
 Set the shown flag. More...
 
 facet_segment ()
 Default constructor. More...
 
void set_vertex_keys (int, int)
 Set vertex keys. More...
 
void set_vertexes (const facet_vertex &vtx0_, const facet_vertex &vtx1_)
 Set vertexes (associated to vertex keys) More...
 
bool has_vertex (vertex_id_type) const
 Check if the vertex at given rank is defined. More...
 
const vector_3dget_vertex_position (vertex_id_type) const
 Return the vertex at given rank (first/second) More...
 
void set_facet_keys (int, int)
 Set facet keys. More...
 
void set (int, int, int, int)
 
void dump (std::ostream &out_) const
 Print. More...
 

Public Attributes

int vertex0_key
 Key of the first vertex. More...
 
int vertex1_key
 Key of the second vertex. More...
 
int facet0_key
 Key of the first facet. More...
 
int facet1_key
 Key of the second facet. More...
 

Friends

bool operator== (const facet_segment &fs1_, const facet_segment &fs2_)
 
bool operator< (const facet_segment &fs1_, const facet_segment &fs2_)
 

Detailed Description

A segment associated to a facet.

Member Enumeration Documentation

◆ vertex_id_type

The Id of the vertex.

Enumerator
VTX_ID_NONE 
VTX_ID_FIRST 
VTX_ID_SECOND 

Constructor & Destructor Documentation

◆ facet_segment()

geomtools::facet_segment::facet_segment ( )

Default constructor.

Member Function Documentation

◆ dump()

void geomtools::facet_segment::dump ( std::ostream &  out_) const

Print.

◆ get_vertex_position()

const vector_3d& geomtools::facet_segment::get_vertex_position ( vertex_id_type  ) const

Return the vertex at given rank (first/second)

◆ has_vertex()

bool geomtools::facet_segment::has_vertex ( vertex_id_type  ) const

Check if the vertex at given rank is defined.

◆ is_shown()

bool geomtools::facet_segment::is_shown ( ) const

Check if the segment is shown.

◆ is_valid()

bool geomtools::facet_segment::is_valid ( ) const

Check validity.

◆ set()

void geomtools::facet_segment::set ( int  ,
int  ,
int  ,
int   
)

◆ set_facet_keys()

void geomtools::facet_segment::set_facet_keys ( int  ,
int   
)

Set facet keys.

◆ set_shown()

void geomtools::facet_segment::set_shown ( bool  )

Set the shown flag.

◆ set_vertex_keys()

void geomtools::facet_segment::set_vertex_keys ( int  ,
int   
)

Set vertex keys.

◆ set_vertexes()

void geomtools::facet_segment::set_vertexes ( const facet_vertex vtx0_,
const facet_vertex vtx1_ 
)

Set vertexes (associated to vertex keys)

Friends And Related Function Documentation

◆ operator<

bool operator< ( const facet_segment fs1_,
const facet_segment fs2_ 
)
friend

◆ operator==

bool operator== ( const facet_segment fs1_,
const facet_segment fs2_ 
)
friend

Member Data Documentation

◆ facet0_key

int geomtools::facet_segment::facet0_key

Key of the first facet.

◆ facet1_key

int geomtools::facet_segment::facet1_key

Key of the second facet.

◆ vertex0_key

int geomtools::facet_segment::vertex0_key

Key of the first vertex.

◆ vertex1_key

int geomtools::facet_segment::vertex1_key

Key of the second vertex.


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