shapeworks::Groom

High level groom API. More...

#include <Groom.h>

Inherited by shapeworks::QGroom

Public Functions

	Name
	Groom(ProjectHandle project)
virtual bool	run() Run the grooming.
void	set_skip_grooming(bool skip) Set if grooming steps should be skipped.
void	abort() Set abort as soon as possible.
bool	get_aborted() Return if grooming was aborted.

Protected Functions

	Name
virtual void	update_progress() call to be overridden by subclasses

Protected Attributes

	Name
tbb::atomic< float >	progress_
tbb::atomic< int >	total_ops_
tbb::atomic< int >	progress_counter_

Detailed Description

class shapeworks::Groom;

High level groom API.

The Groom class operates on a Project. It is used by Studio and other tools to perform Grooming operations.

Public Functions Documentation

function Groom

Groom(
    ProjectHandle project
)

function run

virtual bool run()

Run the grooming.

function set_skip_grooming

void set_skip_grooming(
    bool skip
)

Set if grooming steps should be skipped.

function abort

void abort()

Set abort as soon as possible.

function get_aborted

bool get_aborted()

Return if grooming was aborted.

Protected Functions Documentation

function update_progress

inline virtual void update_progress()

call to be overridden by subclasses

Reimplemented by: shapeworks::QGroom::update_progress

Protected Attributes Documentation

variable progress_

tbb::atomic< float > progress_ = 0;

variable total_ops_

tbb::atomic< int > total_ops_ = 0;

variable progress_counter_

tbb::atomic< int > progress_counter_ = 0;

---

Updated on 2022-03-31 at 09:51:18 -0600