PPL API Reference
Overview Core Algorithm Abstractions Utilities Parallel Methods
Modules Class Hierarchy Classes Functions
Todo List Bug List Dead Code
List of all members | Static Public Attributes
MeanCurvatureSkeleton3D Class Reference

3D Mean Curvature Skeleton implementation from CGAL More...

Public Member Functions

IO functions
void Write (string _filename)
 
void Read (string _filename)
 
Modifiers
template<typename PolyhedronType >
void AddPolyhedron (PolyhedronType &_poly, double _refine=1.32)
 Add an input polyhedron in the input mesh.
 
void BuildSkeleton (bool _curve=true)
 Construct the mean curvature skeleton.
 
void BuildSkeleton (const WorkspaceDecomposition *_decomposition, bool _curve=true)
 Construct the mean curvature skeleton from a decomposition.
 
Accessors
pair< WorkspaceSkeleton, AnnotationTypeGetSkeleton ()
 
pair< WorkspaceSkeleton, AnnotationTypeGetMesoSkeleton ()
 
void SetParameters (Parameters &_p)
 

Public Types

Local types

{ Note: Please do not change the kernel to exact computation that will hamper the computation of mean curvature skeleton internal functions

typedef CGAL::Simple_cartesian< double > CGALKernel
 
typedef CGALKernel::Point_3 Point3
 
typedef CGAL::Surface_mesh< Point3 > SurfaceMesh
 
typedef CGAL::Polyhedron_3< CGALKernel, CGAL::Polyhedron_items_with_id_3 > Polyhedron
 
typedef CGAL::Mean_curvature_flow_skeletonization< SurfaceMesh > Skeletonization
 
typedef Skeletonization::Skeleton MCSkeleton
 
typedef MCSkeleton::vertex_descriptor MCVD
 
typedef MCSkeleton::edge_descriptor MCED
 
typedef Skeletonization::Meso_skeleton MESO
 
typedef vector< Point3d > WitnessType
 
typedef PropertyMap< vector< WitnessType >, WitnessType > AnnotationType
 

Static Public Attributes

static Parameters m_defaultParams
 Parameters.
 

Construction

 MeanCurvatureSkeleton3D ()
 
void SetEnvironment (const Environment *_env)
 
template<typename PolyhedronType >
 MeanCurvatureSkeleton3D (PolyhedronType &_poly, bool _d=false)
 
 ~MeanCurvatureSkeleton3D ()
 
static void SetDefaultParameters (XMLNode &_node)
 

Detailed Description

3D Mean Curvature Skeleton implementation from CGAL

Constructor & Destructor Documentation

◆ MeanCurvatureSkeleton3D()

template<typename PolyhedronType >
MeanCurvatureSkeleton3D::MeanCurvatureSkeleton3D ( PolyhedronType &  _poly,
bool  _d = false 
)

Initialize the input mesh from the input exact polyhedron

Parameters
_polyThe polyhedron to use.
_dSet to debug mode or not.

Member Function Documentation

◆ SetDefaultParameters()

void MeanCurvatureSkeleton3D::SetDefaultParameters ( XMLNode _node)
static

Construct a Mean Curvature Skeleton from an XML node.

Parameters
_nodeThe XML node to parse.

◆ SetEnvironment()

void MeanCurvatureSkeleton3D::SetEnvironment ( const Environment _env)

Initializes the input mesh as the obstacle space of a given environment

Parameters
_envThe environment to use.

◆ Write()

void MeanCurvatureSkeleton3D::Write ( string  _filename)

Write MeanCurvatureSkeleton3D to a file

Parameters
_filenameThe filename to write to.

◆ Read()

void MeanCurvatureSkeleton3D::Read ( string  _filename)

Read MeanCurvatureSkeleton3D from a file

Parameters
_filenameThe filename to read from.

◆ GetSkeleton()

pair< WorkspaceSkeleton, MeanCurvatureSkeleton3D::AnnotationType > MeanCurvatureSkeleton3D::GetSkeleton ( )

Get the workspace skeleton from the curved skeleton with surface mesh points as annotations of the skeleton

◆ GetMesoSkeleton()

pair< WorkspaceSkeleton, MeanCurvatureSkeleton3D::AnnotationType > MeanCurvatureSkeleton3D::GetMesoSkeleton ( )

Get the workspace skeleton from the meso skeleton with surface mesh points as annotations of the skeleton

◆ SetParameters()

void MeanCurvatureSkeleton3D::SetParameters ( Parameters &  _p)

Set the parameters to use to build and access the skeleton

Parameters
_pThe parameters to use.

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