Interface PartInstanceMatrixGetterInterface

The PartInstanceMatrixGetterInterface interface is used to fetch matrices of part instances.

The PartInstanceMatrixGetterInterface interfaces are created through the DataSessionInterface.createPartInstanceMatrixGetter method.

The list of signals the PartInstanceMatrixGetterInterface may trigger is available in the PartInstanceMatrixGetterInterfaceSignal enumeration.

The matrix retrieval request is triggered through the fetchMatrices method. The result is not available right away, but the event PartInstanceMatrixGetterInterfaceSignal.MatrixFetchReady is triggered when the result of the PartInstanceMatrixGetterInterface is available. The result is available through the getMatricesResult function.

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

An PartInstanceMatrixGetterInterface may be interrupted (cancelled) when the PartInstanceMatrixGetterInterface is running and cancelFetch is called. In such cases, the PartInstanceMatrixGetterInterfaceSignal.MatrixFetchCancelled signal is fired, and shortly after, PartInstanceMatrixGetterInterfaceSignal.MatrixFetchReady signal is fired, but getMatricesResult will return undefined. Just call fetchMatrices with another (or the same) array of part instances to trigger a new fetch request.

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

/** 
 * Sample to illustrate the use of an PartInstanceMatrixGetterInterface to retrieve multiple matrices.
 */
import {
    DataSessionInterface, PartInstanceMatrixGetterInterfaceSignal,
    InfiniteEvent, PartInstanceMatrixResultInterface, PartInstanceMatrixGetterInterface
} from 'generated_files/documentation/appinfiniteapi';

// the DataSessionInterface has been created previously and is connected
let lDataSession : DataSessionInterface;
// the part instance ids to fetch
let lPartInstanceIds: Array<number>;

// to retrieve the matrices
const lPartInstanceMatrixGetter : PartInstanceMatrixGetterInterface = lDataSession.createPartInstanceMatrixGetter();

// what to do when matrix data has been downloaded ?
let onMatricesReady : (_pEvent: InfiniteEvent, _pCallbackData: Object | undefined) => void;

// what to do when the download of the matrices is ready ?
lPartInstanceMatrixGetter.addEventListener(PartInstanceMatrixGetterInterfaceSignal.MatrixFetchReady, onMatricesReady);

// what to do when matrix data has been downloaded ?
onMatricesReady = (_pEvent: InfiniteEvent, _pCallbackData: Object | undefined) : void =>
{
    // matrices are ready
    const lMatricesContent : Array<PartInstanceMatrixResultInterface> | undefined = lPartInstanceMatrixGetter.getMatricesResult();
    if ((!lMatricesContent) || (lMatricesContent.length === 0))
    {
        console.log('error while fetching matrices content');
        return;
    }
    // now matrix content is there, just need to display them
    // use only the first part instance
    const lCurMatrixResult : PartInstanceMatrixResultInterface = lMatricesContent[0];
    console.log('Matrices info : instance:', lCurMatrixResult.getInstanceId(), 'local matrix:', lCurMatrixResult.getLocalMatrix(), 'world matrix:', lCurMatrixResult.getWorldMatrix(), ')');
};

lPartInstanceMatrixGetter.fetchMatrices(lPartInstanceIds);

Copy

Or with async calls :

/** 
 * Sample to illustrate the asynchronous use of an PartInstanceMatrixGetterInterface to retrieve multiple matrices.
 */
import {
    DataSessionInterface, PartInstanceMatrixGetterInterface, AsyncResultReason, AsyncPartInstanceMatrixResult,
    PartInstanceMatrixResultInterface
} from 'generated_files/documentation/appinfiniteapi';
// the DataSessionInterface has been created previously and is connected
let lDataSession : DataSessionInterface;
// the part instance ids to fetch
let lPartInstanceIds: Array<number>;

// to retrieve the matrices
const lPartInstanceMatrixGetter : PartInstanceMatrixGetterInterface = lDataSession.createPartInstanceMatrixGetter();

const fetchMatrices = async () : Promise<void> =>
{
    const lMatrixRes : AsyncPartInstanceMatrixResult = await lPartInstanceMatrixGetter.asyncFetchMatrices(lPartInstanceIds);
    if (!lMatrixRes.value || !lMatrixRes.value.length)
    {
        // display some fancy error message
        return;
    }
    console.assert(lMatrixRes.reason === AsyncResultReason.ARR_Success);
    // now matrix content is there, just need to display them
    // use only the first view
    const lCurMatrixResult : PartInstanceMatrixResultInterface = lMatrixRes.value[0];
    console.log('Matrices info : instance:', lCurMatrixResult.getInstanceId(), 'local matrix:', lCurMatrixResult.getLocalMatrix(), 'world matrix:', lCurMatrixResult.getWorldMatrix(), ')');
};

fetchMatrices();

Copy

Please make sure the destination browser supports promises before using async calls.

See

• PartInstanceMatrixGetterInterfaceSignal
• PartInstanceMatrixResultInterface