Interface PartInstanceConverterInterface

The PartInstanceConverterInterface interface is used to get, from a list of part instance ids, the corresponding geometric instance ids.

Contrary to the GeometricInstanceConverterInterface, this operation is not dependant on a filtering context.

This conversion may be useful to change the display on some part instances, from a search query for example , since the InfiniteEngineInterface works on geometric instance ids.

The PartInstanceConverterInterface interfaces are created through the createPartInstanceConverter method.

The list of signals the PartInstanceConverterInterface may trigger is available in the PartInstanceConverterInterfaceSignal enumeration.

The conversion mechanism is triggered through the convert method. The result is not available right away, but the event PartInstanceConverterReady is triggered when the result of the PartInstanceConverterInterfaceSignal is available. The result is available through the getGeometricInstanceIds function.

Warning : there may be cases when the getGeometricInstanceIds is not available such as when the PartInstanceConverterInterface is fetching data, i.e. when isRunning returns true, or when the PartInstanceConverterInterface has been cancelled, i.e. when isCancelled returns true.

A PartInstanceConverterInterface may be interrupted (cancelled) when the PartInstanceConverterInterface is fetching data and cancel is called. In such cases, the PartInstanceConverterCancelled signal is fired, and shortly after, PartInstanceConverterReady signal is fired, but getGeometricInstanceIds will return undefined. Just call convert with another (or the same) part instance ids to trigger a new retrieval.

If you call multiple times convert before receiving the PartInstanceConverterReady, only one PartInstanceConverterReady will be sent with the content of the last call to convert.

This interface performs the opposite operation of the GeometricInstanceConverterInterface interface.

/** 
 * Sample to explain how to convert part instance ids to geometric instance ids using a PartInstanceConverterInterface.
 */
import {
    PartInstanceConverterInterface, PartInstanceConverterInterfaceSignal,
    InfiniteEngineInterface, VisualStates, DataSessionInterface,
} from 'generated/documentation/appinfiniteapi';

// the DataSessionInterface has been created previously and is connected
let lDataSession : DataSessionInterface;
// lInfiniteEngine has been created previously
let lInfiniteEngine : InfiniteEngineInterface;
// the `part instance id` to get information from
let lPartInstanceId : number;
// what to do when the conversion from picking is ready
let onGeometricInstanceReady : (pEvent, _pCallbackData) => void;

// the `part instance ids` to convert
const lPartInstanceIds: Uint32Array = new Uint32Array(1);
lPartInstanceIds[0] = lPartInstanceId;

// create a partInstanceConverter to convert `part instances` to `geometric instance ids`
const lPartInstanceConverter : PartInstanceConverterInterface = lDataSession.createPartInstanceConverter();
// connect the PartInstanceConverterReady signal to the set ghost procedure
lPartInstanceConverter.addEventListener(PartInstanceConverterInterfaceSignal.PartInstanceConverterReady, onGeometricInstanceReady);

onGeometricInstanceReady = (_pEvent, _pCallbackData) : void =>
{
    // triggered when we have all the `geometric instances` of the given `part instance`
    const lGeometricInstanceIds : Uint32Array| undefined = lPartInstanceConverter.getGeometricInstanceIds();
    if (lGeometricInstanceIds && (lGeometricInstanceIds.length > 0))
    {
        // display the given `geometric instances` ghosted
        lInfiniteEngine.updateGeometricState(lGeometricInstanceIds, VisualStates.S_Ghost, VisualStates.S_Ghost);
    }
}

// trigger the conversion
lPartInstanceConverter.convert(lPartInstanceIds);

/** 
 * Sample to explain how to asynchronously convert part instance ids to geometric instance ids using a PartInstanceConverterInterface.
 */
import {
    PartInstanceConverterInterface, DataSessionInterface,
    InfiniteEngineInterface, VisualStates, AsyncUInt32ArrayResult, AsyncResultReason
} from 'generated/documentation/appinfiniteapi';

// the DataSessionInterface has been created previously and is connected
let lDataSession : DataSessionInterface;
// lInfiniteEngine has been created previously
let lInfiniteEngine : InfiniteEngineInterface;
// the `part instance id` to get information from
let lPartInstanceId : number;

// the `part instance ids` to convert
const lPartInstanceIds: Uint32Array = new Uint32Array(1);
lPartInstanceIds[0] = lPartInstanceId;

// create a partInstanceConverter to convert `part instances` to `geometric instance ids`
const lPartInstanceConverter : PartInstanceConverterInterface = lDataSession.createPartInstanceConverter();

const convertPartInstances = async () : Promise<any> =>
{
    // trigger the conversion
    const lResult : AsyncUInt32ArrayResult = await lPartInstanceConverter.asyncConvert(lPartInstanceIds);
    if (lResult.reason !== AsyncResultReason.ARR_Success || lResult.value === undefined || lResult.value.length <= 0)
    {
        // perhaps some fancy GUI message ?
        console.log('Error while converting part instances')
        return;
    }
    // display the given `geometric instances` ghosted
    lInfiniteEngine.updateGeometricState(lResult.value, VisualStates.S_Ghost, VisualStates.S_Ghost);
}

convertPartInstances();

See

PartInstanceConverterInterfaceSignal