Enumeration FilterSolverInterfaceSignal

The FilterSolverInterfaceSignal lists all the signals that may be sent by the abstract FilterSolverInterface.

These signals are emitted by the FilterSolverInterface when it is modified and more importantly ready.

A FilterSolverInterface is ready when it has computed the result of its set of FilterItemInterfaces, such a result being a list of geometric instance ids and part instance ids.

The FilterSolverInterface may fire the following signals :

• SolverReady : the FilterSolverInterface result can be retrieved.
• SolverChanged : any FilterItemInterface inside the FilterSolverInterface has changed, a FilterItemInterface has been added or removed, or the VisibilityContextInterface inside the FilterSolverInterface has changed.
• SolverFilterAdded : a FilterItemInterface has been added in the FilterSolverInterface.
• SolverFilterRemoved : a FilterItemInterface has been removed from the FilterSolverInterface.
• SolverFilterMoved : a FilterItemInterface has been moved inside the FilterSolverInterface.
• SolverFilterBulkChanged : multiple changes have been done at once inside the FilterSolverInterface.
• SolverVisibilityContextChanged : the FilterSolverInterface has been set a new [VisibilityContextInterface]].

/** 
 * Sample to illustrate how to use a FilterDiagonalInterface and the unit conversion system.
 */
import {
    FilterSolverInterface,
    Unit, FilterRangeItemInterface,
    ConfContextInterface, VisibilityContextInterface, FilterSolverInterfaceSignal, tListenerCallback, FilterDiagonalInterface, DataSessionInterface,
} from 'generated/documentation/appinfiniteapi';

// the DataSessionInterface has been created previously and is connected
let lDataSession : DataSessionInterface;

// what to do when result has been computed ?
let onResultReady : tListenerCallback;

/* FILTERING CONTEXT / CONF CONTEXT */
// create the resolution chain : 
// create a filtering context "unconfigured"
// first create ConfContextInterface "unconfigured"
const lConfCtx : ConfContextInterface = lDataSession.createConfContext();
// and create the filtering context and bind it to the unconfigured ConfContextInterface
const lConfVisibilityCtx: VisibilityContextInterface = lDataSession.createVisibilityContext();
lConfVisibilityCtx.setConfContext(lConfCtx);

/* SOLVER */
// create the solver to retrieve the result
const lGlobalSolver : FilterSolverInterface = lDataSession.createFilterSolver();
lGlobalSolver.setVisibilityContext(lConfVisibilityCtx);
// we want to retrieve `geometric instance ids` and `part instance ids` on the solver
lGlobalSolver.setRetrievePartInstanceIds(true);
// bind the solver to custom implementation when the result is ready
lGlobalSolver.addEventListener(FilterSolverInterfaceSignal.SolverReady, onResultReady);

/* DIAGONAL FILTER */
// get the DMU build unit
const lDMUUnit : Unit = lDataSession.getDmuBuildUnit();
// we want to get values in DMU units
const lConvertFactor : number = lDataSession.convertUnitFactor(Unit.U_Millimeter, lDMUUnit);

// all leaves whose diagonal is contained within 2 and 3 millimeters
let lMinValue : number = 2 * lConvertFactor;
let lMaxValue : number = 3 * lConvertFactor;

// diagonal SQUARED
lMinValue *= lMinValue;
lMaxValue *= lMaxValue;

// create a diagonal filter
const lDiagonalFilter : FilterDiagonalInterface = lDataSession.createDiagonalFilter();
// useless, FilterOperator.FO_UNION is the default operator when creating a new filter
// lDiagonalFilter.setFilterOperator(FilterOperator.FO_UNION);

// and add a range to test ([2mm, 3mm] included)
const lDiagonalFilterContent : FilterRangeItemInterface = lDiagonalFilter.createFilterRangeItem();
// include lower bound
lDiagonalFilterContent.setIncludedLower(true);
// include upper bound
lDiagonalFilterContent.setIncludedUpper(true);
// set the lower bound as 2 mm in DMU units SQUARED
lDiagonalFilterContent.setLowerBound(lMinValue);
// set the upper bound as 3 mm in DMU units SQUARED
lDiagonalFilterContent.setUpperBound(lMaxValue);

// add the filter to the solver
lGlobalSolver.insertFilter(0, lDiagonalFilter);
// and go => make the DataSessionInterface compute the result
lDataSession.update();

Please refer to the [FilterSolverInterface](../interfaces/FilterSolverInterface.html) for more information.

See

• FilterSolverInterface
• FilterItemInterface