OpenMEEG
Loading...
Searching...
No Matches
Public Types | Public Member Functions | List of all members
OpenMEEG::Interface Class Reference

Interface class An interface is a closed-shape composed of oriented meshes (vector of oriented meshes). More...

#include <interface.h>

Public Types

typedef std::vector< OrientedMeshOrientedMeshes
 

Public Member Functions

 Interface ()
 Default Constructor.
 
 Interface (const std::string &interfname)
 Constructor from a name.
 
const std::string & name () const
 
OrientedMeshesoriented_meshes ()
 
const OrientedMeshesoriented_meshes () const
 
bool outermost () const
 
void set_to_outermost ()
 set all interface meshes to outermost state.
 
bool contains (const Vect3 &p) const
 
bool is_mesh_orientations_coherent (const bool doublechecked=false)
 Check the global orientation.
 
size_t nb_vertices () const
 
size_t nb_triangles () const
 
TrianglesRefs adjacent_triangles (const Triangle &t) const
 

Detailed Description

Interface class An interface is a closed-shape composed of oriented meshes (vector of oriented meshes).

Definition at line 49 of file interface.h.

Member Typedef Documentation

◆ OrientedMeshes

Definition at line 54 of file interface.h.

Constructor & Destructor Documentation

◆ Interface() [1/2]

OpenMEEG::Interface::Interface ( )
inline

Default Constructor.

Definition at line 58 of file interface.h.

◆ Interface() [2/2]

OpenMEEG::Interface::Interface ( const std::string &  interfname)
inline

Constructor from a name.

Definition at line 62 of file interface.h.

Member Function Documentation

◆ name()

const std::string & OpenMEEG::Interface::name ( ) const
inline
Returns
Interface name

Definition at line 64 of file interface.h.

◆ oriented_meshes() [1/2]

OrientedMeshes & OpenMEEG::Interface::oriented_meshes ( )
inline

Definition at line 66 of file interface.h.

◆ oriented_meshes() [2/2]

const OrientedMeshes & OpenMEEG::Interface::oriented_meshes ( ) const
inline

Definition at line 67 of file interface.h.

◆ outermost()

bool OpenMEEG::Interface::outermost ( ) const
inline
Returns
true if it is the outermost interface.

Definition at line 69 of file interface.h.

◆ set_to_outermost()

void OpenMEEG::Interface::set_to_outermost ( )

set all interface meshes to outermost state.

◆ contains()

bool OpenMEEG::Interface::contains ( const Vect3 p) const
Parameters
pa point
Returns
true if point is inside interface

◆ is_mesh_orientations_coherent()

bool OpenMEEG::Interface::is_mesh_orientations_coherent ( const bool  doublechecked = false)

Check the global orientation.

◆ nb_vertices()

size_t OpenMEEG::Interface::nb_vertices ( ) const
inline
Returns
the total number of the interface vertices

Definition at line 78 of file interface.h.

◆ nb_triangles()

size_t OpenMEEG::Interface::nb_triangles ( ) const
inline
Returns
the total number of the interface triangles

Definition at line 87 of file interface.h.

◆ adjacent_triangles()

TrianglesRefs OpenMEEG::Interface::adjacent_triangles ( const Triangle t) const
inline
Returns
the adjacent triangles

Definition at line 96 of file interface.h.


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