SurfacePolygon Class Reference

Detailed Description

Representation of a polygonal face in a SurfacePolygon.

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

Public Member Functions
int	num_vertices () const
	Returns the number of vertices in this face.
int	vertex (int i) const
	Returns the vertex index in PolygonSurfaceMesh of the i-th vertex of this face.
std::unique_ptr< SurfacePolygon >	copy_to_unique () const
	(Internal use only) Returns a copy of this, wrapped in a unique_ptr.
Does not allow copy, move, or assignment
	SurfacePolygon (const SurfacePolygon &)=delete
SurfacePolygon &	operator= (const SurfacePolygon &)=delete
	SurfacePolygon (SurfacePolygon &&)=delete
SurfacePolygon &	operator= (SurfacePolygon &&)=delete

Friends
template<typename>
class	PolygonSurfaceMesh

Constructor & Destructor Documentation

SurfacePolygon() [1/2]

SurfacePolygon ( const SurfacePolygon & )

delete

SurfacePolygon() [2/2]

SurfacePolygon ( SurfacePolygon && )

delete

Member Function Documentation

copy_to_unique()

std::unique_ptr< SurfacePolygon > copy_to_unique

(

)

const

(Internal use only) Returns a copy of this, wrapped in a unique_ptr.

This function is only intended for use by Drake's Python bindings.

num_vertices()

int num_vertices

(

)

const

Returns the number of vertices in this face.

operator=() [1/2]

SurfacePolygon & operator= ( const SurfacePolygon & )

delete

operator=() [2/2]

SurfacePolygon & operator= ( SurfacePolygon && )

delete

vertex()

int vertex

(

int

i

)

const

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

Parameters

i	The local index of the vertex in this face.

Precondition

0 <= i < num_vertices()

Friends And Related Symbol Documentation

PolygonSurfaceMesh

template<typename>

friend class PolygonSurfaceMesh

friend

---

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

• drake/geometry/proximity/polygon_surface_mesh.h