Drake
SurfaceFace Class Reference

Detailed Description

SurfaceFace represents a triangular face in a SurfaceMesh.

#include <drake/geometry/proximity/surface_mesh.h>

Public Member Functions

 SurfaceFace (SurfaceVertexIndex v0, SurfaceVertexIndex v1, SurfaceVertexIndex v2)
 Constructs SurfaceFace. More...
 
 SurfaceFace (const int v[3])
 Constructs SurfaceFace. More...
 
SurfaceVertexIndex vertex (int i) const
 Returns the vertex index in SurfaceMesh of the i-th vertex of this face. More...
 
void ReverseWinding ()
 Reverses the order of the vertex indices – this essentially flips the face normal based on the right-handed normal rule. More...
 
Implements CopyConstructible, CopyAssignable, MoveConstructible, MoveAssignable
 SurfaceFace (const SurfaceFace &)=default
 
SurfaceFaceoperator= (const SurfaceFace &)=default
 
 SurfaceFace (SurfaceFace &&)=default
 
SurfaceFaceoperator= (SurfaceFace &&)=default
 

Constructor & Destructor Documentation

◆ SurfaceFace() [1/4]

SurfaceFace ( const SurfaceFace )
default

◆ SurfaceFace() [2/4]

SurfaceFace ( SurfaceFace &&  )
default

◆ SurfaceFace() [3/4]

Constructs SurfaceFace.

Parameters
v0Index of the first vertex in SurfaceMesh.
v1Index of the second vertex in SurfaceMesh.
v2Index of the last vertex in SurfaceMesh.

◆ SurfaceFace() [4/4]

SurfaceFace ( const int  v[3])
explicit

Constructs SurfaceFace.

Parameters
varray of three integer indices of the vertices of the face in SurfaceMesh.

Member Function Documentation

◆ operator=() [1/2]

SurfaceFace& operator= ( const SurfaceFace )
default

◆ operator=() [2/2]

SurfaceFace& operator= ( SurfaceFace &&  )
default

◆ ReverseWinding()

void ReverseWinding ( )

Reverses the order of the vertex indices – this essentially flips the face normal based on the right-handed normal rule.

◆ vertex()

SurfaceVertexIndex vertex ( int  i) const

Returns the vertex index in SurfaceMesh of the i-th vertex of this face.

Parameters
iThe local index of the vertex in this face.
Precondition
0 <= i < 3

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