pw:: Solver

The solver mode type

Derives From

pw::Object pw::Mode

Summary
The solver mode type
This action runs the solver.
This action resumes running the solver.
This action returns the number of steps completed by the last call to run or resume.
This action returns the list of entities completed by the last call to run or resume.
This action returns the list of entities failed by the last call to run or resume.

Instance Actions

run

$solver run ?-entities ents? ?< method | steps >?

This action runs the solver.

Parameters

-entities entsThis optional parameter is a subset of the entities in the solver mode to run the solver on.  If this parameter is not given the solver will be run on all the entities of the solver mode.
methodThis optional parameter is the method to run: Initialize | Refine | Decimate | Release | Smooth | Restart.  Not all methods may be valid for the current mode.
stepsThis optional parameter is the integer number of steps to run; the default is 1, and 0 is a special value that means the solver should run until stopped by the user or some other stop condition.

Returns

This action returns nothing.

Information

This command supports progress updates.  Unlike most commands that support progress updates, if the user aborts this command, instead of reverting to the previous state the entities being solved will be left as is.

resume

$solver resume

This action resumes running the solver.  It does nothing if the solver has not been run yet, or if the previous run has completed.

Parameters

This action has no parameters.

Returns

This action returns nothing.

Information

This command supports progress updates.  Unlike most commands that support progress updates, if the user aborts this command, instead of reverting to the previous state the entities being solved will be left as is.

getCompletedSteps

$solver getCompletedSteps

This action returns the number of steps completed by the last call to run or resume.

Parameters

This action has no parameters.

Returns

This action returns the integer number of steps completed.

Information

The number of completed steps will only be valid when the previous solver run used the steps parameter.

getCompletedEntities

$solver getCompletedEntities

This action returns the list of entities completed by the last call to run or resume.

Parameters

This action has no parameters.

Returns

This action returns a list of pw::Entity objects that have been completed.

Information

The list of completed entities will only be populated if the previous solver run used the method parameter.

getFailedEntities

$solver getFailedEntities

This action returns the list of entities failed by the last call to run or resume.

Parameters

This action has no parameters.

Returns

This action returns a list of pw::Entity objects that failed.

Information

The list of failed entities will only be populated if the previous solver run used the method parameter.

$solver run ?-entities ents? ?< method | steps >?
This action runs the solver.
$solver resume
This action resumes running the solver.
$solver getCompletedSteps
This action returns the number of steps completed by the last call to run or resume.
$solver getCompletedEntities
This action returns the list of entities completed by the last call to run or resume.
$solver getFailedEntities
This action returns the list of entities failed by the last call to run or resume.
Base type for all glyph types
The mode base type
An integer is a whole number.
Entity type