Enumeration GeometricInstanceConverterInterfaceSignal

The GeometricInstanceConverterInterfaceSignal lists all the signals that may be sent by the GeometricInstanceConverterInterface.

These signals are emitted by the GeometricInstanceConverterInterface when some data is available.

• GeometricInstanceConverterReady : the GeometricInstanceConverterInterface is ready, i.e. when it has finished getting the part instance ids that are expressed by the given geometric instance ids, getPartInstanceIds can be called.
• GeometricInstanceConverterCancelled : the retrieving of the content by the GeometricInstanceConverterInterface has been cancelled.

/** 
 * Sample to illustrate the use of a GeometricInstanceConverterInterface from a `geometric instance id`.
 */
import {
    VisibilityContextInterface, GeometricInstanceConverterInterface, GeometricInstanceConverterInterfaceSignal,
    DataSessionInterface,
} from 'generated/documentation/appinfiniteapi';

// the `geometric instances` are retrieved by a picking for example

// the DataSessionInterface has been created previously and is connected
let lDataSession : DataSessionInterface;
// the `geometric instance id` to get information from
let lGeometricInstanceId : number;
// create a `geometric instance id` converter
const lGeometricConverter : GeometricInstanceConverterInterface = lDataSession.createGeometricInstanceConverter();
// the current filtering context has been created previously
let lVisibilityContext : VisibilityContextInterface;

// the `geometric instance` to get
const lGeometricInstanceIds: Uint32Array = new Uint32Array(1);
lGeometricInstanceIds[0] = lGeometricInstanceId;

const onPartInstanceReady = (_pEvent, _pCallbackData) : void =>
{
    // triggered when we have all the `part instances` of the given geometry
    const lPartInstanceIds : Uint32Array| undefined = lGeometricConverter.getPartInstanceIds();
    if (lPartInstanceIds && (lPartInstanceIds.length > 0))
    {
        // only work if result is valid
        console.log('result found');
        console.log(lPartInstanceIds.join(','));
    }
}

// connect the GeometricInstanceConverterReady signal to the id card retrieval
lGeometricConverter.addEventListener(GeometricInstanceConverterInterfaceSignal.GeometricInstanceConverterReady, onPartInstanceReady);

// trigger the conversion
lGeometricConverter.convert(lGeometricInstanceIds, lVisibilityContext);

Or with an idcard request :

/** 
 * Sample to illustrate the use of an IdCardGetterInterface from a `geometric instance id`.
 */
import {
    VisibilityContextInterface, IdCardGetterInterface, GeometricInstanceConverterInterface,
    IdCardGetterInterfaceSignal, GeometricInstanceConverterInterfaceSignal, DataSessionInterface,
} from 'generated/documentation/appinfiniteapi';
// the `part instances` are retrieved by a picking for example

// the DataSessionInterface has been created previously and is connected
let lDataSession : DataSessionInterface;
// the `geometric instance id` to get information from
let lGeometricInstanceId : number;
// create a `geometric instance id` converter
const lGeometricConverter : GeometricInstanceConverterInterface = lDataSession.createGeometricInstanceConverter();
// the current filtering context has been created previously
let lVisibilityContext : VisibilityContextInterface;
// what to do when the conversion from picking is ready
let onPartInstanceReady : (pEvent, _pCallbackData) => void;
// what to do when the id card retrieval is over
let onIdCardReady : (pEvent, _pCallbackData) => void;

// id card getter interface creation
const lIdCardGetterInterface : IdCardGetterInterface = lDataSession.createIdCardGetter();
// connect the IDCardReady signal to the handling of the metadata of the `part instance` and its genealogy 
lIdCardGetterInterface.addEventListener(IdCardGetterInterfaceSignal.IdCardReady, onIdCardReady);

// the `geometric instance` to get
const lGeometricInstanceIds: Uint32Array = new Uint32Array(1);
lGeometricInstanceIds[0] = lGeometricInstanceId;
// connect the GeometricInstanceConverterReady signal to the id card retrieval
lGeometricConverter.addEventListener(GeometricInstanceConverterInterfaceSignal.GeometricInstanceConverterReady, onPartInstanceReady);

onPartInstanceReady = (_pEvent, _pCallbackData) : void =>
{
    // triggered when we have all the `part instances` of the given geometry
    const lPartInstanceIds : Uint32Array| undefined = lGeometricConverter.getPartInstanceIds();
    if (lPartInstanceIds && (lPartInstanceIds.length > 0))
    {
        // only get the idcard of the first `part instance` (we may do other things if multiple idcards to retrieve)
        // onIdCardReady will be called shortly after
        lIdCardGetterInterface.retrieveIdCard(lPartInstanceIds[0], lVisibilityContext);
    }
}

// trigger the conversion
lGeometricConverter.convert(lGeometricInstanceIds, lVisibilityContext);

Please refer to [IdCardGetterInterface](../interfaces/IdCardGetterInterface.html) for more information about idcard requests.

See

GeometricInstanceConverterInterface