@itwin/core-common 4.8.0-dev.3 → 4.8.0-dev.31

package/lib/esm/IModel.js.map

@@ -1 +1 @@
-{"version":3,"file":"IModel.js","sourceRoot":"","sources":["../../src/IModel.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,gBAAgB,EAAc,IAAI,EAAc,YAAY,EAAW,QAAQ,EAAE,MAAM,qBAAqB,CAAC;AACvI,OAAO,EACE,SAAS,EAAE,SAAS,EAAE,QAAQ,EAAE,QAAQ,EAAE,QAAQ,EAAE,OAAO,EAAE,OAAO,EAAgB,SAAS,EAAkB,QAAQ,EAC9H,kBAAkB,GACnB,MAAM,sBAAsB,CAAC;AAE9B,OAAO,EAAE,YAAY,EAAqB,MAAM,yBAAyB,CAAC;AAC1E,OAAO,EAAE,aAAa,EAAsB,MAAM,sCAAsC,CAAC;AAEzF,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAqN5C;;;;GAIG;AACH,MAAM,OAAO,YAAY;IAcvB,uFAAuF;IAChF,YAAY,KAAgB,OAAO,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC;IAE5D,2FAA2F;IAC3F,YAAY,KAAwB;QAPpC,mFAAmF;QAClE,eAAU,GAAc,SAAS,CAAC,cAAc,EAAE,CAAC;QAOlE,IAAI,CAAC,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,MAAM,EAAE,CAAC;QACtD,IAAI,CAAC,WAAW,GAAG,kBAAkB,CAAC,QAAQ,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC,MAAM,EAAE,CAAC;QAC3E,IAAI,KAAK,CAAC,kBAAkB;YAC1B,IAAI,CAAC,kBAAkB,GAAG,YAAY,CAAC,WAAW,CAAC,EAAE,SAAS,EAAE,KAAK,CAAC,kBAAkB,CAAC,SAAS,EAAE,QAAQ,EAAE,KAAK,CAAC,kBAAkB,CAAC,QAAQ,EAAE,MAAM,EAAE,KAAK,CAAC,kBAAkB,CAAC,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC;QACvM,IAAI,KAAK,CAAC,OAAO,IAAI,KAAK,CAAC,OAAO,EAAE,CAAC;YACnC,IAAI,CAAC,OAAO,GAAG,QAAQ,CAAC,QAAQ,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,CAAC;YACzD,IAAI,CAAC,OAAO,GAAG,QAAQ,CAAC,QAAQ,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,CAAC;QAC3D,CAAC;QACD,IAAI,KAAK,CAAC,SAAS,EAAE,CAAC;YACpB,IAAI,CAAC,UAAU,CAAC,WAAW,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;YAC7C,IAAI,CAAC,UAAU,CAAC,MAAM,EAAE,CAAC;QAC3B,CAAC;aAAM,CAAC;YACN,IAAI,MAAM,CAAC;YACX,IAAI,IAAI,CAAC,OAAO,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;gBACjC,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;gBACxD,IAAI,OAAO,CAAC,gBAAgB,EAAE;oBAC5B,MAAM,GAAG,QAAQ,CAAC,aAAa,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;YACzE,CAAC;YACD,IAAI,CAAC,MAAM;gBACT,MAAM,GAAG,IAAI,CAAC,WAAW,CAAC,UAAU,EAAE,CAAC;YAEzC,IAAI,CAAC,UAAU,GAAG,SAAS,CAAC,qBAAqB,CAAC,IAAI,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;YACvE,IAAI,CAAC,UAAU,CAAC,MAAM,EAAE,CAAC;QAC3B,CAAC;IACH,CAAC;IAED;;OAEG;IACH,IAAW,OAAO;QAChB,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC;IAC7B,CAAC;IAED,8FAA8F;IACvF,MAAM,CAAC,4BAA4B,CAAC,MAAoB,EAAE,KAAe,EAAE,KAAa;QAC7F,MAAM,UAAU,GAAG,MAAM,CAAC,MAAM,EAAE,CAAC;QACnC,MAAM,YAAY,GAAG,EAAE,GAAG,QAAQ,CAAC,gBAAgB,CAAC,KAAK,CAAC;QAC1D,MAAM,UAAU,GAAG,YAAY,CAAC,WAAW,CAAC,EAAE,SAAS,EAAE,MAAM,CAAC,SAAS,EAAE,QAAQ,EAAE,MAAM,CAAC,QAAQ,GAAG,YAAY,EAAE,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC;QAC9I,MAAM,SAAS,GAAG,YAAY,CAAC,WAAW,CAAC,EAAE,SAAS,EAAE,MAAM,CAAC,SAAS,GAAG,YAAY,EAAE,QAAQ,EAAE,MAAM,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC;QAC7I,MAAM,SAAS,GAAG,UAAU,CAAC,MAAM,EAAE,CAAC;QACtC,MAAM,QAAQ,GAAG,SAAS,CAAC,MAAM,EAAE,CAAC;QACpC,MAAM,OAAO,GAAG,QAAQ,CAAC,cAAc,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC,SAAS,EAAE,CAAC;QAC1E,MAAM,OAAO,GAAG,QAAQ,CAAC,cAAc,CAAC,UAAU,EAAE,SAAS,CAAC,CAAC,SAAS,EAAE,CAAC;QAC3E,MAAM,MAAM,GAAG,QAAQ,CAAC,sBAAsB,CAAC,OAAQ,EAAE,OAAQ,EAAE,SAAS,CAAC,GAAG,CAAE,CAAC;QACnF,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;YACxB,MAAM,KAAK,GAAG,QAAQ,CAAC,6BAA6B,CAAC,SAAS,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;YACzE,MAAM,CAAC,oBAAoB,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;QAC7C,CAAC;QACD,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;YACxB,MAAM,KAAK,GAAG,MAAM,CAAC,cAAc,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;YACnF,UAAU,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;QAC/B,CAAC;QAED,OAAO,IAAI,YAAY,CAAC,EAAE,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,kBAAkB,CAAC,kBAAkB,CAAC,MAAM,CAAE,EAAE,kBAAkB,EAAE,MAAM,EAAE,CAAC,CAAC;IAC3I,CAAC;IAED,oIAAoI;IAC7H,MAAM,CAAC,mBAAmB,CAAC,SAAoB;QACpD,MAAM,UAAU,GAAG,SAAS,CAAC,SAAS,EAAE,CAAC;QACzC,MAAM,cAAc,GAAG,kBAAkB,CAAC,aAAa,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;QACjE,MAAM,6BAA6B,GAAG,kBAAkB,CAAC,kBAAkB,CAAC,SAAS,CAAC,SAAS,EAAE,EAAE,cAAc,CAAC,CAAC;QACnH,MAAM,cAAc,GAAG,SAAS,CAAC,MAAM,EAAE,CAAC;QAE1C,OAAO,IAAI,YAAY,CAAC,EAAE,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,6BAA6B,IAAI,cAAc,EAAE,SAAS,EAAE,cAAc,EAAE,CAAC,CAAC;IAC3I,CAAC;IAED,4EAA4E;IAC5E,IAAW,WAAW;QACpB,MAAM,MAAM,GAAG,IAAI,CAAC,WAAW,CAAC,UAAU,EAAE,CAAC;QAC7C,OAAO,OAAO,CAAC,UAAU,CAAC,MAAM,CAAC,oBAAoB,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;IACzG,CAAC;IAED,+FAA+F;IACxF,aAAa,CAAC,KAAmB;QACtC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,aAAa,CAAC,KAAK,CAAC,WAAW,CAAC;YAChG,OAAO,KAAK,CAAC;QAEf,IAAI,CAAC,IAAI,CAAC,OAAO,KAAK,SAAS,CAAC,KAAK,CAAC,KAAK,CAAC,OAAO,KAAK,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,KAAK,SAAS,CAAC,KAAK,CAAC,KAAK,CAAC,OAAO,KAAK,SAAS,CAAC;YAClI,OAAO,KAAK,CAAC;QAEf,IAAI,IAAI,CAAC,OAAO,KAAK,SAAS,IAAI,KAAK,CAAC,OAAO,KAAK,SAAS,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,KAAK,CAAC,OAAO,CAAC;YACzG,OAAO,KAAK,CAAC;QAEf,IAAI,IAAI,CAAC,OAAO,KAAK,SAAS,IAAI,KAAK,CAAC,OAAO,KAAK,SAAS,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,KAAK,CAAC,OAAO,CAAC;YACzG,OAAO,KAAK,CAAC;QAEf,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,CAAC,aAAa,CAAC,KAAK,CAAC,YAAY,EAAE,CAAC;YAC1D,OAAO,KAAK,CAAC;QAEf,MAAM,SAAS,GAAG,IAAI,CAAC,kBAAkB,CAAC;QAC1C,MAAM,UAAU,GAAG,KAAK,CAAC,kBAAkB,CAAC;QAC5C,IAAI,SAAS,KAAK,SAAS,IAAI,SAAS,KAAK,UAAU;YACrD,OAAO,SAAS,KAAK,SAAS,IAAI,SAAS,KAAK,UAAU,CAAC;QAE7D,OAAO,SAAS,CAAC,aAAa,CAAC,UAAU,EAAE,QAAQ,CAAC,mBAAmB,CAAC,CAAC;IAC3E,CAAC;IAEM,MAAM;QACX,MAAM,KAAK,GAA+B;YACxC,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE;YAC5B,WAAW,EAAE,IAAI,CAAC,WAAW,CAAC,MAAM,EAAE;YACtC,SAAS,EAAE,IAAI,CAAC,YAAY,EAAE,CAAC,MAAM,EAAE;SACxC,CAAC;QAEF,IAAI,IAAI,CAAC,kBAAkB;YACzB,KAAK,CAAC,kBAAkB,GAAG,IAAI,CAAC,kBAAkB,CAAC,MAAM,EAAE,CAAC;QAE9D,IAAI,IAAI,CAAC,OAAO;YACd,KAAK,CAAC,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC;QAExC,IAAI,IAAI,CAAC,OAAO;YACd,KAAK,CAAC,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC;QAExC,OAAO,KAAK,CAAC;IACf,CAAC;CACF;AAED;;;GAGG;AACH,MAAM,OAAgB,MAAM;IA6B1B,yBAAyB;IACzB,IAAW,IAAI;QACb,MAAM,CAAC,IAAI,CAAC,KAAK,KAAK,SAAS,CAAC,CAAC;QACjC,OAAO,IAAI,CAAC,KAAK,CAAC;IACpB,CAAC;IACD,IAAW,IAAI,CAAC,IAAY;QAC1B,IAAI,IAAI,KAAK,IAAI,CAAC,KAAK,EAAE,CAAC;YACxB,MAAM,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC;YACvB,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;YAClB,IAAI,SAAS,KAAK,GAAG;gBACnB,IAAI,CAAC,aAAa,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;QACvC,CAAC;IACH,CAAC;IAED,kEAAkE;IAClE,IAAW,WAAW;QACpB,MAAM,CAAC,IAAI,CAAC,YAAY,KAAK,SAAS,CAAC,CAAC;QACxC,OAAO,IAAI,CAAC,YAAY,CAAC;IAC3B,CAAC;IACD,IAAW,WAAW,CAAC,OAAyB;QAC9C,IAAI,SAAS,KAAK,IAAI,CAAC,YAAY,IAAI,IAAI,CAAC,YAAY,CAAC,IAAI,KAAK,OAAO,CAAC,IAAI,IAAI,IAAI,CAAC,YAAY,CAAC,WAAW,KAAK,OAAO,CAAC,WAAW,EAAE,CAAC;YACxI,MAAM,GAAG,GAAG,IAAI,CAAC,YAAY,CAAC;YAC9B,IAAI,CAAC,YAAY,GAAG,OAAO,CAAC;YAC5B,IAAI,GAAG;gBACL,IAAI,CAAC,oBAAoB,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;QAC9C,CAAC;IACH,CAAC;IASD;;;OAGG;IACH,IAAW,cAAc;QACvB,MAAM,CAAC,SAAS,KAAK,IAAI,CAAC,eAAe,CAAC,CAAC;QAC3C,OAAO,IAAI,CAAC,eAAe,CAAC;IAC9B,CAAC;IACD,IAAW,cAAc,CAAC,OAAyB;QACjD,uEAAuE;QACvE,MAAM,cAAc,GAAG,OAAO,CAAC,KAAK,EAAE,CAAC;QACvC,cAAc,CAAC,gBAAgB,CAAC,GAAG,CAAC,CAAC;QACrC,IAAI,CAAC,IAAI,CAAC,eAAe,IAAI,CAAC,IAAI,CAAC,eAAe,CAAC,aAAa,CAAC,cAAc,CAAC,EAAE,CAAC;YACjF,MAAM,GAAG,GAAG,IAAI,CAAC,eAAe,CAAC;YACjC,cAAc,CAAC,MAAM,EAAE,CAAC;YACxB,IAAI,CAAC,eAAe,GAAG,cAAc,CAAC;YACtC,IAAI,GAAG;gBACL,IAAI,CAAC,uBAAuB,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;QACjD,CAAC;IACH,CAAC;IAED,0DAA0D;IAC1D,IAAW,YAAY;QACrB,MAAM,CAAC,IAAI,CAAC,aAAa,KAAK,SAAS,CAAC,CAAC;QACzC,OAAO,IAAI,CAAC,aAAa,CAAC;IAC5B,CAAC;IACD,IAAW,YAAY,CAAC,GAAY;QAClC,IAAI,CAAC,IAAI,CAAC,aAAa,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,aAAa,CAAC,GAAG,CAAC,EAAE,CAAC;YAClE,MAAM,GAAG,GAAG,IAAI,CAAC,aAAa,CAAC;YAC/B,GAAG,CAAC,MAAM,EAAE,CAAC;YACb,IAAI,CAAC,aAAa,GAAG,GAAG,CAAC;YACzB,IAAI,GAAG;gBACL,IAAI,CAAC,qBAAqB,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;QAC/C,CAAC;IACH,CAAC;IAED;;;;;;;;;;MAUE;IACF,IAAW,YAAY;QACrB,OAAO,IAAI,CAAC,aAAa,CAAC;IAC5B,CAAC;IACD,IAAW,YAAY,CAAC,YAAsC;QAC5D,MAAM,GAAG,GAAG,IAAI,CAAC,aAAa,CAAC;QAC/B,IAAI,CAAC,GAAG,IAAI,CAAC,YAAY;YACvB,OAAO;aACJ,IAAI,GAAG,IAAI,YAAY,IAAI,GAAG,CAAC,aAAa,CAAC,YAAY,CAAC;YAC7D,OAAO;QAET,IAAI,CAAC,aAAa,GAAG,YAAY,CAAC;QAClC,IAAI,CAAC,qBAAqB,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;IAC7C,CAAC;IAED,oFAAoF;IAC7E,eAAe,CAAC,IAAuB;QAC5C,IAAI,CAAC,YAAY,GAAG,IAAI,YAAY,CAAC,IAAI,CAAC,CAAC;IAC7C,CAAC;IAED,gEAAgE;IAChE,IAAW,0BAA0B;QACnC,OAAO,IAAI,CAAC,2BAA2B,CAAC;IAC1C,CAAC;IACD,IAAW,0BAA0B,CAAC,MAAiC;QACrE,MAAM,GAAG,GAAG,IAAI,CAAC,2BAA2B,CAAC;QAC7C,IAAI,CAAC,GAAG,IAAI,CAAC,MAAM;YACjB,OAAO;aACJ,IAAI,GAAG,IAAI,MAAM,IAAI,GAAG,CAAC,MAAM,CAAC,MAAM,CAAC;YAC1C,OAAO;QAET,IAAI,CAAC,2BAA2B,GAAG,MAAM,CAAC;QAC1C,IAAI,CAAC,mCAAmC,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;IAC3D,CAAC;IAED,+EAA+E;IACxE,6BAA6B,CAAC,MAA0B;QAC7D,IAAI,CAAC,0BAA0B,GAAG,IAAI,aAAa,CAAC,MAAM,CAAC,CAAC;IAC9D,CAAC;IAED,gBAAgB;IACT,kBAAkB;QACvB,OAAO;YACL,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,WAAW,EAAE,IAAI,CAAC,WAAW;YAC7B,cAAc,EAAE,IAAI,CAAC,cAAc,CAAC,MAAM,EAAE;YAC5C,YAAY,EAAE,IAAI,CAAC,YAAY,CAAC,MAAM,EAAE;YACxC,YAAY,EAAE,IAAI,CAAC,YAAY;YAC/B,0BAA0B,EAAE,IAAI,CAAC,0BAA0B;YAC3D,GAAI,IAAI,CAAC,YAAY,EAAE;SACxB,CAAC;IACJ,CAAC;IAED,oDAAoD;IAC7C,MAAM;QACX,OAAO,IAAI,CAAC,kBAAkB,EAAE,CAAC;IACnC,CAAC;IAMD,4GAA4G;IAC5G,IAAW,GAAG,KAAa,OAAO,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC;IAIlD,gEAAgE;IAChE,IAAW,OAAO,KAA6B,OAAO,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC;IAEtE,4CAA4C;IAC5C,IAAW,QAAQ,KAA6B,OAAO,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC;IAMxE,6CAA6C;IAC7C,IAAW,QAAQ,KAAe,OAAO,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC;IAE1D;;OAEG;IACI,WAAW;QAChB,IAAI,CAAC,IAAI,CAAC,MAAM;YACd,MAAM,IAAI,WAAW,CAAC,YAAY,CAAC,UAAU,EAAE,4BAA4B,CAAC,CAAC;QAE/E,OAAO,IAAI,CAAC,YAAY,EAAE,CAAC;IAC7B,CAAC;IAED;;;OAGG;IACO,YAAY;QACpB,OAAO;YACL,GAAG,EAAE,IAAI,CAAC,QAAQ;YAClB,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,QAAQ,EAAE,IAAI,CAAC,QAAQ;YACvB,SAAS,EAAE,IAAI,CAAC,SAAS;SAC1B,CAAC;IACJ,CAAC;IAED,gBAAgB;IAChB,YAAsB,UAA2B;QAtMjD,2CAA2C;QAC3B,kBAAa,GAAG,IAAI,OAAO,EAAkC,CAAC;QAC9E,kDAAkD;QAClC,yBAAoB,GAAG,IAAI,OAAO,EAA+C,CAAC;QAClG,qDAAqD;QACrC,4BAAuB,GAAG,IAAI,OAAO,EAA+C,CAAC;QACrG,mDAAmD;QACnC,0BAAqB,GAAG,IAAI,OAAO,EAAqC,CAAC;QACzF,mDAAmD;QACnC,0BAAqB,GAAG,IAAI,OAAO,EAAwD,CAAC;QAC5G,iEAAiE;QACjD,wCAAmC,GAAG,IAAI,OAAO,EAAoD,CAAC;QA+J5G,cAAS,GAAG,QAAQ,CAAC,QAAQ,CAAC;QA6BtC,IAAI,CAAC,SAAS,GAAG,EAAE,EAAE,EAAE,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE,CAAC;QACtC,IAAI,CAAC,QAAQ,GAAG,EAAE,CAAC;QACnB,IAAI,UAAU,EAAE,CAAC;YACf,IAAI,CAAC,QAAQ,GAAG,UAAU,CAAC,GAAG,CAAC;YAC/B,IAAI,CAAC,QAAQ,GAAG,UAAU,CAAC,OAAO,CAAC;YACnC,IAAI,CAAC,SAAS,GAAG,UAAU,CAAC,QAAQ,CAAC;YACrC,IAAI,UAAU,CAAC,SAAS;gBACtB,IAAI,CAAC,SAAS,GAAG,UAAU,CAAC,SAAS,CAAC;QAC1C,CAAC;IACH,CAAC;IAED,gBAAgB;IACN,UAAU,CAAC,IAAY,EAAE,KAAkB;QACnD,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,WAAW,GAAG,KAAK,CAAC,WAAW,CAAC;QACrC,IAAI,CAAC,cAAc,GAAG,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,cAAc,CAAC,CAAC;QAC7D,IAAI,CAAC,YAAY,GAAG,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC;QAEzD,MAAM,YAAY,GAAG,KAAK,CAAC,YAAY,CAAC,CAAC,CAAC,IAAI,YAAY,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QAC3F,IAAI,CAAC,YAAY,GAAG,YAAY,EAAE,OAAO,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,SAAS,CAAC;QAErE,IAAI,CAAC,0BAA0B,GAAG,KAAK,CAAC,0BAA0B,CAAC,CAAC,CAAC,IAAI,aAAa,CAAC,KAAK,CAAC,0BAA0B,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IACvI,CAAC;IAED,gEAAgE;IACzD,MAAM,CAAC,uBAAuB,CAAC,UAAsB;QAC1D,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,wBAAwB,CAAC,IAAI,CAAC,UAAU,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,IAAI,CAAC,cAAc,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC;IACnJ,CAAC;IAED,uFAAuF;IACvF,IAAW,YAAY,KAAK,OAAO,SAAS,KAAK,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC;IAEtE;;OAEG;IACI,gBAAgB;QACrB,IAAI,SAAS,KAAK,IAAI,CAAC,aAAa;YAClC,MAAM,IAAI,WAAW,CAAC,gBAAgB,CAAC,aAAa,EAAE,0BAA0B,CAAC,CAAC;QACpF,OAAO,IAAI,CAAC,aAAa,CAAC,YAAY,EAAE,CAAC;IAC3C,CAAC;IAED;;;;;OAKG;IACI,aAAa,CAAC,OAAe,EAAE,MAAgB,IAAa,OAAO,IAAI,CAAC,gBAAgB,EAAE,CAAC,eAAe,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC;IAErI;;;;;;OAMG;IACI,aAAa,CAAC,IAAY,EAAE,MAAgB,IAAa,OAAO,IAAI,CAAC,gBAAgB,EAAE,CAAC,sBAAsB,CAAC,IAAI,EAAE,MAAM,CAAE,CAAC,CAAC,CAAC;IAEvI;;;;;OAKG;IACI,6BAA6B,CAAC,OAAe,EAAE,MAAqB,IAAkB,OAAO,YAAY,CAAC,QAAQ,CAAC,IAAI,CAAC,aAAa,CAAC,OAAO,CAAC,EAAE,MAAM,CAAE,CAAC,CAAC,CAAC;IAElK;;;;;;OAMG;IACI,6BAA6B,CAAC,YAA0B,EAAE,MAAgB,IAAI,OAAO,IAAI,CAAC,aAAa,CAAC,YAAY,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC;;AAvRtJ,sCAAsC;AACf,wBAAiB,GAAe,KAAK,AAApB,CAAqB;AAC7D,0CAA0C;AACnB,oBAAa,GAAe,KAAK,AAApB,CAAqB;AACzD,sCAAsC;AACf,mBAAY,GAAe,MAAM,AAArB,CAAsB","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module iModels\n */\n\nimport { assert, BeEvent, GeoServiceStatus, GuidString, Id64, Id64String, IModelStatus, Mutable, OpenMode } from \"@itwin/core-bentley\";\nimport {\n  Angle, AxisIndex, AxisOrder, Constant, Geometry, Matrix3d, Point3d, Range3d, Range3dProps, Transform, TransformProps, Vector3d, XYAndZ, XYZProps,\n  YawPitchRollAngles, YawPitchRollProps,\n} from \"@itwin/core-geometry\";\nimport { ChangesetIdWithIndex } from \"./ChangesetProps\";\nimport { Cartographic, CartographicProps } from \"./geometry/Cartographic\";\nimport { GeographicCRS, GeographicCRSProps } from \"./geometry/CoordinateReferenceSystem\";\nimport { AxisAlignedBox3d } from \"./geometry/Placement\";\nimport { IModelError } from \"./IModelError\";\nimport { ThumbnailProps } from \"./Thumbnail\";\n\n/** The properties to open a connection to an iModel for RPC operations.\n * @public\n */\nexport interface IModelRpcOpenProps {\n  /** The iTwin in which the iModel exists - must be defined for briefcases that are synchronized with iModelHub. */\n  readonly iTwinId?: GuidString;\n  /** Guid of the iModel. */\n  readonly iModelId?: GuidString;\n\n  /** Id of the last Changeset that was applied to the iModel - must be defined for briefcases that are synchronized with iModelHub.\n   * @note Changeset Ids are string hash values based on the content and parent.\n   */\n  readonly changeset?: ChangesetIdWithIndex;\n}\n\n/** The properties that identify an opened iModel for RPC operations.\n * @public\n */\nexport interface IModelRpcProps extends IModelRpcOpenProps {\n  /** Unique key used for identifying the iModel between the frontend and the backend */\n  readonly key: string;\n}\n\n/** Properties that position an iModel on the earth via [ECEF](https://en.wikipedia.org/wiki/ECEF) (Earth Centered Earth Fixed) coordinates\n * The origin is specified as an ECEF coordinate. The cartographicOrigin property contains the latitude, longitude and elevation above the WGS84 ellipsoid\n * of the origin property. This cartographicOrigin is offered as a convenient pre-calculated value representing the location of the ECEF origin.\n * The 3D coordinate system this class represents is positioned at specified origin and the axis positioned according to\n * the other properties.\n * If transform property is defined then it will not be computed from other properties.\n * If the xVector and yVector properties are defined (and transform is not defined) then they take precedence over the YawPitchRoll orientation property. The xVector and yVector\n * represent the direction and scale of the X and Y axes. The Z axis is always perpendicular (according to the right hand rule) to these X-Y axes.\n * The scaling in the Z direction is always unity. The scale of the X and Y axes is represented by the size of the vector length.\n * If the xVector and yVector are not present then the YawPitchRoll properties indicates the angles for all tree axes. Scaling in that case\n * is unity in all three directions.\n * Note that the present class is intended to represent geolocated 3D coordinate systems that are normally tangent to the WGS84 ellipsoid\n * possibly offset in altitude by the terrain elevation above the ellipsoid but other general 3D coordinate systems\n * can be defined.\n * @public\n * @extensions\n */\nexport interface EcefLocationProps {\n  /** The Origin of an iModel on the earth in ECEF coordinates */\n  readonly origin: XYZProps;\n  /** The [orientation](https://en.wikipedia.org/wiki/Geographic_coordinate_conversion) of an iModel on the earth. */\n  readonly orientation: YawPitchRollProps;\n  /** Optional position on the earth used to establish the ECEF coordinates. */\n  readonly cartographicOrigin?: CartographicProps;\n  /** Optional X column vector used with [[yVector]] to calculate potentially non-rigid transform if a projection is present. */\n  readonly xVector?: XYZProps;\n  /** Optional Y column vector used with [[xVector]] to calculate potentially non-rigid transform if a projection is present. */\n  readonly yVector?: XYZProps;\n  /** Optional potentially non-rigid transform defining the ECEF location.\n   * @note If this property is supplied, the other properties are ignored.\n   */\n  readonly transform?: TransformProps;\n}\n\n/** Properties of the [Root Subject]($docs/bis/guide/references/glossary#subject-root).\n * @public\n * @extensions\n */\nexport interface RootSubjectProps {\n  /** The name of the root subject. */\n  readonly name: string;\n  /** Description of the root subject (optional). */\n  readonly description?: string;\n}\n\n/** Properties of an iModel that are always held in memory whenever one is opened, both on the frontend and on the backend .\n * @public\n */\nexport interface IModelProps {\n  /** The name and description of the root subject of this iModel */\n  readonly rootSubject: RootSubjectProps;\n  /** The volume of the entire project, in spatial coordinates */\n  readonly projectExtents?: Range3dProps;\n  /** An offset to be applied to all spatial coordinates. This is normally used to transform spatial coordinates into the Cartesian coordinate system of a Geographic Coordinate System. */\n  readonly globalOrigin?: XYZProps;\n  /** The location of the iModel in Earth Centered Earth Fixed coordinates. iModel units are always meters */\n  readonly ecefLocation?: EcefLocationProps;\n  /** The Geographic Coordinate Reference System indicating the projection and datum used. */\n  readonly geographicCoordinateSystem?: GeographicCRSProps;\n  /** The name of the iModel. */\n  readonly name?: string;\n}\n\n/** The properties returned by the backend when creating a new [[IModelConnection]] from the frontend, either with Rpc or with Ipc.\n * These properties describe the iModel held on the backend for thew newly formed connection and are used to construct a new\n * [[IModelConnection]] instance on the frontend to access it.\n * @public\n */\nexport type IModelConnectionProps = IModelProps & IModelRpcProps;\n\n/** The properties that can be supplied when creating a *new* iModel.\n * @public\n */\nexport interface CreateIModelProps extends IModelProps {\n  /** The GUID of new iModel. If not present, a GUID will be generated. */\n  readonly guid?: GuidString;\n  /** Client name for new iModel */\n  readonly client?: string;\n  /** Thumbnail for new iModel\n   * @alpha\n   */\n  readonly thumbnail?: ThumbnailProps;\n}\n\n/**\n * Encryption-related properties that can be supplied when creating or opening snapshot iModels.\n * @public\n * @deprecated in 3.x. **NOTE**, encrypted iModels are no longer supported since they require licensed code.\n */\nexport interface IModelEncryptionProps {\n  /** The password used to encrypt/decrypt the snapshot iModel. */\n  readonly password?: string;\n}\n\n/**\n * Sqlite options.\n * @public\n */\nexport interface OpenSqliteArgs {\n  /**\n   * Specify timeout after which SQLite stop retrying to acquire lock to database file and throw SQLITE_BUSY error.\n   * Timeout is specified in milliseconds.\n   * For more information https://www.sqlite.org/c3ref/busy_timeout.html.\n   * */\n  readonly busyTimeout?: number;\n}\n\n/**\n * A key used to identify an opened [IModelDb]($backend) between the frontend and backend for Rpc and Ipc communications.\n * Keys must be unique - that is there can never be two IModelDbs opened with the same key at any given time.\n * If no key is supplied in a call to open an IModelDb, one is generated and returned.\n * It is only necessary to supply a key if you have some reason to assign a specific value to identify an IModelDb.\n * If you don't supply the key, you must use the returned value for Rpc and Ipc communications.\n * @public\n */\nexport interface OpenDbKey {\n  readonly key?: string;\n}\n\n/** @beta TODO documentation */\nexport interface CloudContainerUri {\n  readonly uriParams: string;\n}\n\n/** Options to open a [SnapshotDb]($backend).\n * @public\n */\nexport interface SnapshotOpenOptions extends IModelEncryptionProps, OpenDbKey { // eslint-disable-line deprecation/deprecation\n  /**\n   * The \"base\" name that can be used for creating temporary files related to this Db.\n   * The string should be a name related to the current Db filename using some known pattern so that all files named \"baseName*\" can be deleted externally during cleanup.\n   * It must be the name of a file (that may or may not exist) in a writable directory.\n   * If not present, the baseName will default to the database's file name (including the path).\n   * @internal\n   */\n  readonly tempFileBase?: string;\n}\n\n/** Options to open a [StandaloneDb]($backend) via [StandaloneDb.openFile]($backend) from the backend,\n * or [BriefcaseConnection.openStandalone]($frontend) from the frontend.\n * @public\n */\nexport type StandaloneOpenOptions = OpenDbKey;\n\n/** Options that can be supplied when creating snapshot iModels.\n * @public\n */\n// eslint-disable-next-line deprecation/deprecation\nexport interface CreateSnapshotIModelProps extends IModelEncryptionProps {\n  /** If true, then create SQLite views for Model, Element, ElementAspect, and Relationship classes.\n   * These database views can often be useful for interoperability workflows.\n   */\n  readonly createClassViews?: boolean;\n}\n\n/** The options that can be specified when creating an *empty* snapshot iModel.\n * @see [SnapshotDb.createEmpty]($backend)\n * @public\n */\nexport type CreateEmptySnapshotIModelProps = CreateIModelProps & CreateSnapshotIModelProps;\n\n/** Options that can be supplied when creating standalone iModels.\n * @internal\n */\n// eslint-disable-next-line deprecation/deprecation\nexport interface CreateStandaloneIModelProps extends IModelEncryptionProps {\n  /** If present, file will allow local editing, but cannot be used to create changesets */\n  readonly allowEdit?: string;\n}\n\n/** The options that can be specified when creating an *empty* standalone iModel.\n * @see [standalone.createEmpty]($backend)\n * @internal\n */\nexport type CreateEmptyStandaloneIModelProps = CreateIModelProps & CreateStandaloneIModelProps;\n\n/**\n * @public\n * @extensions\n */\nexport interface FilePropertyProps {\n  readonly namespace: string;\n  readonly name: string;\n  id?: number | string;\n  subId?: number | string;\n}\n\n/** The position and orientation of an iModel on the earth in [ECEF](https://en.wikipedia.org/wiki/ECEF) (Earth Centered Earth Fixed) coordinates\n * @note This is an immutable type - all of its properties are frozen.\n * @see [GeoLocation of iModels]($docs/learning/GeoLocation.md)\n * @public\n */\nexport class EcefLocation implements EcefLocationProps {\n  /** The origin of the ECEF transform. */\n  public readonly origin: Point3d;\n  /** The orientation of the ECEF transform */\n  public readonly orientation: YawPitchRollAngles;\n  /** Optional position on the earth used to establish the ECEF origin and orientation. */\n  public readonly cartographicOrigin?: Cartographic;\n  /** Optional X column vector used with [[yVector]] to calculate potentially non-rigid transform if a projection is present. */\n  public readonly xVector?: Vector3d;\n  /** Optional Y column vector used with [[xVector]] to calculate potentially non-rigid transform if a projection is present. */\n  public readonly yVector?: Vector3d;\n  /** The transform from iModel Spatial coordinates to ECEF from this EcefLocation */\n  private readonly _transform: Transform = Transform.createIdentity();\n\n  /** Get the transform from iModel Spatial coordinates to ECEF from this EcefLocation */\n  public getTransform(): Transform { return this._transform; }\n\n  /** Construct a new EcefLocation. Once constructed, it is frozen and cannot be modified. */\n  constructor(props: EcefLocationProps) {\n    this.origin = Point3d.fromJSON(props.origin).freeze();\n    this.orientation = YawPitchRollAngles.fromJSON(props.orientation).freeze();\n    if (props.cartographicOrigin)\n      this.cartographicOrigin = Cartographic.fromRadians({ longitude: props.cartographicOrigin.longitude, latitude: props.cartographicOrigin.latitude, height: props.cartographicOrigin.height }).freeze();\n    if (props.xVector && props.yVector) {\n      this.xVector = Vector3d.fromJSON(props.xVector).freeze();\n      this.yVector = Vector3d.fromJSON(props.yVector).freeze();\n    }\n    if (props.transform) {\n      this._transform.setFromJSON(props.transform);\n      this._transform.freeze();\n    } else {\n      let matrix;\n      if (this.xVector && this.yVector) {\n        const zVector = this.xVector.crossProduct(this.yVector);\n        if (zVector.normalizeInPlace())\n          matrix = Matrix3d.createColumns(this.xVector, this.yVector, zVector);\n      }\n      if (!matrix)\n        matrix = this.orientation.toMatrix3d();\n\n      this._transform = Transform.createOriginAndMatrix(this.origin, matrix);\n      this._transform.freeze();\n    }\n  }\n\n  /** Returns true if this EcefLocation is not located at the center of the Earth.\n   * @alpha are locations very close to the center considered valid? What are the specific criteria?\n   */\n  public get isValid(): boolean {\n    return !this.origin.isZero;\n  }\n\n  /** Construct ECEF Location from cartographic origin with optional known point and angle.   */\n  public static createFromCartographicOrigin(origin: Cartographic, point?: Point3d, angle?: Angle) {\n    const ecefOrigin = origin.toEcef();\n    const deltaRadians = 10 / Constant.earthRadiusWGS84.polar;\n    const northCarto = Cartographic.fromRadians({ longitude: origin.longitude, latitude: origin.latitude + deltaRadians, height: origin.height });\n    const eastCarto = Cartographic.fromRadians({ longitude: origin.longitude + deltaRadians, latitude: origin.latitude, height: origin.height });\n    const ecefNorth = northCarto.toEcef();\n    const ecefEast = eastCarto.toEcef();\n    const xVector = Vector3d.createStartEnd(ecefOrigin, ecefEast).normalize();\n    const yVector = Vector3d.createStartEnd(ecefOrigin, ecefNorth).normalize();\n    const matrix = Matrix3d.createRigidFromColumns(xVector!, yVector!, AxisOrder.XYZ)!;\n    if (angle !== undefined) {\n      const north = Matrix3d.createRotationAroundAxisIndex(AxisIndex.Z, angle);\n      matrix.multiplyMatrixMatrix(north, matrix);\n    }\n    if (point !== undefined) {\n      const delta = matrix.multiplyVector(Vector3d.create(-point.x, -point.y, -point.z));\n      ecefOrigin.addInPlace(delta);\n    }\n\n    return new EcefLocation({ origin: ecefOrigin, orientation: YawPitchRollAngles.createFromMatrix3d(matrix)!, cartographicOrigin: origin });\n  }\n\n  /** Construct ECEF Location from transform with optional position on the earth used to establish the ECEF origin and orientation. */\n  public static createFromTransform(transform: Transform): EcefLocation {\n    const ecefOrigin = transform.getOrigin();\n    const angleFromInput = YawPitchRollAngles.createDegrees(0, 0, 0);\n    const locationOrientationFromInputT = YawPitchRollAngles.createFromMatrix3d(transform.getMatrix(), angleFromInput);\n    const transformProps = transform.toJSON();\n\n    return new EcefLocation({ origin: ecefOrigin, orientation: locationOrientationFromInputT ?? angleFromInput, transform: transformProps });\n  }\n\n  /** Get the location center of the earth in the iModel coordinate system. */\n  public get earthCenter(): Point3d {\n    const matrix = this.orientation.toMatrix3d();\n    return Point3d.createFrom(matrix.multiplyTransposeXYZ(-this.origin.x, -this.origin.y, -this.origin.z));\n  }\n\n  /** Return true if this location is equivalent to another location within a small tolerance. */\n  public isAlmostEqual(other: EcefLocation): boolean {\n    if (!this.origin.isAlmostEqual(other.origin) || !this.orientation.isAlmostEqual(other.orientation))\n      return false;\n\n    if ((this.xVector === undefined) !== (other.xVector === undefined) || (this.yVector === undefined) !== (other.yVector === undefined))\n      return false;\n\n    if (this.xVector !== undefined && other.xVector !== undefined && !this.xVector.isAlmostEqual(other.xVector))\n      return false;\n\n    if (this.yVector !== undefined && other.yVector !== undefined && !this.yVector.isAlmostEqual(other.yVector))\n      return false;\n\n    if (!this.getTransform().isAlmostEqual(other.getTransform()))\n      return false;\n\n    const thisCarto = this.cartographicOrigin;\n    const otherCarto = other.cartographicOrigin;\n    if (undefined === thisCarto || undefined === otherCarto)\n      return undefined === thisCarto && undefined === otherCarto;\n\n    return thisCarto.equalsEpsilon(otherCarto, Geometry.smallMetricDistance);\n  }\n\n  public toJSON(): EcefLocationProps {\n    const props: Mutable<EcefLocationProps> = {\n      origin: this.origin.toJSON(),\n      orientation: this.orientation.toJSON(),\n      transform: this.getTransform().toJSON(),\n    };\n\n    if (this.cartographicOrigin)\n      props.cartographicOrigin = this.cartographicOrigin.toJSON();\n\n    if (this.xVector)\n      props.xVector = this.xVector.toJSON();\n\n    if (this.yVector)\n      props.yVector = this.yVector.toJSON();\n\n    return props;\n  }\n}\n\n/** Represents an iModel in JavaScript.\n * @see [GeoLocation of iModels]($docs/learning/GeoLocation.md)\n * @public\n */\nexport abstract class IModel implements IModelProps {\n  private _projectExtents?: AxisAlignedBox3d;\n  private _name?: string;\n  private _rootSubject?: RootSubjectProps;\n  private _globalOrigin?: Point3d;\n  private _ecefLocation?: EcefLocation;\n  private _geographicCoordinateSystem?: GeographicCRS;\n  private _iModelId?: GuidString;\n\n  /** The Id of the repository model. */\n  public static readonly repositoryModelId: Id64String = \"0x1\";\n  /** The Id of the root subject element. */\n  public static readonly rootSubjectId: Id64String = \"0x1\";\n  /** The Id of the dictionary model. */\n  public static readonly dictionaryId: Id64String = \"0x10\";\n\n  /** Event raised after [[name]] changes. */\n  public readonly onNameChanged = new BeEvent<(previousName: string) => void>();\n  /** Event raised after [[rootSubject]] changes. */\n  public readonly onRootSubjectChanged = new BeEvent<(previousSubject: RootSubjectProps) => void>();\n  /** Event raised after [[projectExtents]] changes. */\n  public readonly onProjectExtentsChanged = new BeEvent<(previousExtents: AxisAlignedBox3d) => void>();\n  /** Event raised after [[globalOrigin]] changes. */\n  public readonly onGlobalOriginChanged = new BeEvent<(previousOrigin: Point3d) => void>();\n  /** Event raised after [[ecefLocation]] changes. */\n  public readonly onEcefLocationChanged = new BeEvent<(previousLocation: EcefLocation | undefined) => void>();\n  /** Event raised after [[geographicCoordinateSystem]] changes. */\n  public readonly onGeographicCoordinateSystemChanged = new BeEvent<(previousGCS: GeographicCRS | undefined) => void>();\n\n  /** Name of the iModel */\n  public get name(): string {\n    assert(this._name !== undefined);\n    return this._name;\n  }\n  public set name(name: string) {\n    if (name !== this._name) {\n      const old = this._name;\n      this._name = name;\n      if (undefined !== old)\n        this.onNameChanged.raiseEvent(old);\n    }\n  }\n\n  /** The name and description of the root subject of this iModel */\n  public get rootSubject(): RootSubjectProps {\n    assert(this._rootSubject !== undefined);\n    return this._rootSubject;\n  }\n  public set rootSubject(subject: RootSubjectProps) {\n    if (undefined === this._rootSubject || this._rootSubject.name !== subject.name || this._rootSubject.description !== subject.description) {\n      const old = this._rootSubject;\n      this._rootSubject = subject;\n      if (old)\n        this.onRootSubjectChanged.raiseEvent(old);\n    }\n  }\n\n  /** Returns `true` if this is a snapshot iModel. */\n  public abstract get isSnapshot(): boolean;\n  /** Returns `true` if this is a briefcase copy of an iModel that is synchronized with iModelHub. */\n  public abstract get isBriefcase(): boolean;\n\n  public abstract get isOpen(): boolean;\n\n  /**\n   * The volume, in spatial coordinates, inside which the entire project is contained.\n   * @note The object returned from this method is frozen. You *must* make a copy before you do anything that might attempt to modify it.\n   */\n  public get projectExtents() {\n    assert(undefined !== this._projectExtents);\n    return this._projectExtents;\n  }\n  public set projectExtents(extents: AxisAlignedBox3d) {\n    // Don't allow any axis of the project extents to be less than 1 meter.\n    const projectExtents = extents.clone();\n    projectExtents.ensureMinLengths(1.0);\n    if (!this._projectExtents || !this._projectExtents.isAlmostEqual(projectExtents)) {\n      const old = this._projectExtents;\n      projectExtents.freeze();\n      this._projectExtents = projectExtents;\n      if (old)\n        this.onProjectExtentsChanged.raiseEvent(old);\n    }\n  }\n\n  /** An offset to be applied to all spatial coordinates. */\n  public get globalOrigin(): Point3d {\n    assert(this._globalOrigin !== undefined);\n    return this._globalOrigin;\n  }\n  public set globalOrigin(org: Point3d) {\n    if (!this._globalOrigin || !this._globalOrigin.isAlmostEqual(org)) {\n      const old = this._globalOrigin;\n      org.freeze();\n      this._globalOrigin = org;\n      if (old)\n        this.onGlobalOriginChanged.raiseEvent(old);\n    }\n  }\n\n  /** The [EcefLocation]($docs/learning/glossary#ecefLocation) of the iModel in Earth Centered Earth Fixed coordinates.\n   * If the iModel property geographicCoordinateSystem is not defined then the ecefLocation provides a geolocation by defining a\n   * 3D coordinate system relative to the Earth model WGS84. Refer to additional documentation for details. If the geographicCoordinateSystem\n   * property is defined then the ecefLocation must be used with care. When the geographicCoordinateSystem is defined it indicates the\n   * iModel cartesian space is the result of a cartographic projection. This implies a flattening of the Earth surface process that\n   * results in scale, angular or area distortion. The ecefLocation is then an approximation calculated at the center of the project extent.\n   * If the project is more than 2 kilometer in size, the ecefLocation may represent a poor approximation of the effective\n   * cartographic projection used and a linear transformation should then be calculated at the exact origin of the data\n   * it must position.\n   * @see [GeoLocation of iModels]($docs/learning/GeoLocation.md)\n  */\n  public get ecefLocation(): EcefLocation | undefined {\n    return this._ecefLocation;\n  }\n  public set ecefLocation(ecefLocation: EcefLocation | undefined) {\n    const old = this._ecefLocation;\n    if (!old && !ecefLocation)\n      return;\n    else if (old && ecefLocation && old.isAlmostEqual(ecefLocation))\n      return;\n\n    this._ecefLocation = ecefLocation;\n    this.onEcefLocationChanged.raiseEvent(old);\n  }\n\n  /** Set the [EcefLocation]($docs/learning/glossary#ecefLocation) for this iModel. */\n  public setEcefLocation(ecef: EcefLocationProps): void {\n    this.ecefLocation = new EcefLocation(ecef);\n  }\n\n  /** The geographic coordinate reference system of the iModel. */\n  public get geographicCoordinateSystem(): GeographicCRS | undefined {\n    return this._geographicCoordinateSystem;\n  }\n  public set geographicCoordinateSystem(geoCRS: GeographicCRS | undefined) {\n    const old = this._geographicCoordinateSystem;\n    if (!old && !geoCRS)\n      return;\n    else if (old && geoCRS && old.equals(geoCRS))\n      return;\n\n    this._geographicCoordinateSystem = geoCRS;\n    this.onGeographicCoordinateSystemChanged.raiseEvent(old);\n  }\n\n  /** Sets the geographic coordinate reference system from GeographicCRSProps. */\n  public setGeographicCoordinateSystem(geoCRS: GeographicCRSProps) {\n    this.geographicCoordinateSystem = new GeographicCRS(geoCRS);\n  }\n\n  /** @internal */\n  public getConnectionProps(): IModelConnectionProps {\n    return {\n      name: this.name,\n      rootSubject: this.rootSubject,\n      projectExtents: this.projectExtents.toJSON(),\n      globalOrigin: this.globalOrigin.toJSON(),\n      ecefLocation: this.ecefLocation,\n      geographicCoordinateSystem: this.geographicCoordinateSystem,\n      ... this._getRpcProps(),\n    };\n  }\n\n  /** Convert this iModel to a JSON representation. */\n  public toJSON(): IModelConnectionProps {\n    return this.getConnectionProps();\n  }\n\n  /** A key used to identify this iModel in RPC calls from frontend to backend.\n   * @internal\n   */\n  protected _fileKey: string;\n  /** Get the key that was used to open this iModel. This is the value used for Rpc and Ipc communications. */\n  public get key(): string { return this._fileKey; }\n\n  /** @internal */\n  protected _iTwinId?: GuidString;\n  /** The Guid that identifies the iTwin that owns this iModel. */\n  public get iTwinId(): GuidString | undefined { return this._iTwinId; }\n\n  /** The Guid that identifies this iModel. */\n  public get iModelId(): GuidString | undefined { return this._iModelId; }\n\n  /** @public */\n  public changeset: ChangesetIdWithIndex;\n\n  protected _openMode = OpenMode.Readonly;\n  /** The [[OpenMode]] used for this IModel. */\n  public get openMode(): OpenMode { return this._openMode; }\n\n  /** Return a token for RPC operations.\n   * @throws IModelError if the iModel is not open.\n   */\n  public getRpcProps(): IModelRpcProps {\n    if (!this.isOpen)\n      throw new IModelError(IModelStatus.BadRequest, \"IModel is not open for rpc\");\n\n    return this._getRpcProps();\n  }\n\n  /** Returns the iModel's RPC properties.\n   * @note It is an error to attempt to use these properties as a token for RPC operations if the iModel is not open.\n   * @internal\n   */\n  protected _getRpcProps(): IModelRpcProps {\n    return {\n      key: this._fileKey,\n      iTwinId: this.iTwinId,\n      iModelId: this.iModelId,\n      changeset: this.changeset,\n    };\n  }\n\n  /** @internal */\n  protected constructor(tokenProps?: IModelRpcProps) {\n    this.changeset = { id: \"\", index: 0 };\n    this._fileKey = \"\";\n    if (tokenProps) {\n      this._fileKey = tokenProps.key;\n      this._iTwinId = tokenProps.iTwinId;\n      this._iModelId = tokenProps.iModelId;\n      if (tokenProps.changeset)\n        this.changeset = tokenProps.changeset;\n    }\n  }\n\n  /** @internal */\n  protected initialize(name: string, props: IModelProps) {\n    this.name = name;\n    this.rootSubject = props.rootSubject;\n    this.projectExtents = Range3d.fromJSON(props.projectExtents);\n    this.globalOrigin = Point3d.fromJSON(props.globalOrigin);\n\n    const ecefLocation = props.ecefLocation ? new EcefLocation(props.ecefLocation) : undefined;\n    this.ecefLocation = ecefLocation?.isValid ? ecefLocation : undefined;\n\n    this.geographicCoordinateSystem = props.geographicCoordinateSystem ? new GeographicCRS(props.geographicCoordinateSystem) : undefined;\n  }\n\n  /** Get the default subCategoryId for the supplied categoryId */\n  public static getDefaultSubCategoryId(categoryId: Id64String): Id64String {\n    return Id64.isValid(categoryId) ? Id64.fromLocalAndBriefcaseIds(Id64.getLocalId(categoryId) + 1, Id64.getBriefcaseId(categoryId)) : Id64.invalid;\n  }\n\n  /** True if this iModel has an [EcefLocation]($docs/learning/glossary#ecefLocation). */\n  public get isGeoLocated() { return undefined !== this._ecefLocation; }\n\n  /** Get the Transform from this iModel's Spatial coordinates to ECEF coordinates using its [[IModel.ecefLocation]].\n   * @throws IModelError if [[isGeoLocated]] is false.\n   */\n  public getEcefTransform(): Transform {\n    if (undefined === this._ecefLocation)\n      throw new IModelError(GeoServiceStatus.NoGeoLocation, \"iModel is not GeoLocated\");\n    return this._ecefLocation.getTransform();\n  }\n\n  /** Convert a point in this iModel's Spatial coordinates to an ECEF point using its [[IModel.ecefLocation]].\n   * @param spatial A point in the iModel's spatial coordinates\n   * @param result If defined, use this for output\n   * @returns A Point3d in ECEF coordinates\n   * @throws IModelError if [[isGeoLocated]] is false.\n   */\n  public spatialToEcef(spatial: XYAndZ, result?: Point3d): Point3d { return this.getEcefTransform().multiplyPoint3d(spatial, result); }\n\n  /** Convert a point in ECEF coordinates to a point in this iModel's Spatial coordinates using its [[ecefLocation]].\n   * @param ecef A point in ECEF coordinates\n   * @param result If defined, use this for output\n   * @returns A Point3d in this iModel's spatial coordinates\n   * @throws IModelError if [[isGeoLocated]] is false.\n   * @note The resultant point will only be meaningful if the ECEF coordinate is close on the earth to the iModel.\n   */\n  public ecefToSpatial(ecef: XYAndZ, result?: Point3d): Point3d { return this.getEcefTransform().multiplyInversePoint3d(ecef, result)!; }\n\n  /** Convert a point in this iModel's Spatial coordinates to a [[Cartographic]] using its [[IModel.ecefLocation]].\n   * @param spatial A point in the iModel's spatial coordinates\n   * @param result If defined, use this for output\n   * @returns A Cartographic location\n   * @throws IModelError if [[isGeoLocated]] is false.\n   */\n  public spatialToCartographicFromEcef(spatial: XYAndZ, result?: Cartographic): Cartographic { return Cartographic.fromEcef(this.spatialToEcef(spatial), result)!; }\n\n  /** Convert a [[Cartographic]] to a point in this iModel's Spatial coordinates using its [[IModel.ecefLocation]].\n   * @param cartographic A cartographic location\n   * @param result If defined, use this for output\n   * @returns A point in this iModel's spatial coordinates\n   * @throws IModelError if [[isGeoLocated]] is false.\n   * @note The resultant point will only be meaningful if the ECEF coordinate is close on the earth to the iModel.\n   */\n  public cartographicToSpatialFromEcef(cartographic: Cartographic, result?: Point3d) { return this.ecefToSpatial(cartographic.toEcef(result), result); }\n}\n"]}
+{"version":3,"file":"IModel.js","sourceRoot":"","sources":["../../src/IModel.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,gBAAgB,EAAc,IAAI,EAAc,YAAY,EAAW,QAAQ,EAAE,MAAM,qBAAqB,CAAC;AACvI,OAAO,EACE,SAAS,EAAE,SAAS,EAAE,QAAQ,EAAE,QAAQ,EAAE,QAAQ,EAAE,OAAO,EAAE,OAAO,EAAgB,SAAS,EAAkB,QAAQ,EAC9H,kBAAkB,GACnB,MAAM,sBAAsB,CAAC;AAE9B,OAAO,EAAE,YAAY,EAAqB,MAAM,yBAAyB,CAAC;AAC1E,OAAO,EAAE,aAAa,EAAsB,MAAM,sCAAsC,CAAC;AAEzF,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAqN5C;;;;GAIG;AACH,MAAM,OAAO,YAAY;IAcvB,uFAAuF;IAChF,YAAY,KAAgB,OAAO,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC;IAE5D,2FAA2F;IAC3F,YAAY,KAAwB;QAPpC,mFAAmF;QAClE,eAAU,GAAc,SAAS,CAAC,cAAc,EAAE,CAAC;QAOlE,IAAI,CAAC,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,MAAM,EAAE,CAAC;QACtD,IAAI,CAAC,WAAW,GAAG,kBAAkB,CAAC,QAAQ,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC,MAAM,EAAE,CAAC;QAC3E,IAAI,KAAK,CAAC,kBAAkB;YAC1B,IAAI,CAAC,kBAAkB,GAAG,YAAY,CAAC,WAAW,CAAC,EAAE,SAAS,EAAE,KAAK,CAAC,kBAAkB,CAAC,SAAS,EAAE,QAAQ,EAAE,KAAK,CAAC,kBAAkB,CAAC,QAAQ,EAAE,MAAM,EAAE,KAAK,CAAC,kBAAkB,CAAC,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC;QACvM,IAAI,KAAK,CAAC,OAAO,IAAI,KAAK,CAAC,OAAO,EAAE,CAAC;YACnC,IAAI,CAAC,OAAO,GAAG,QAAQ,CAAC,QAAQ,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,CAAC;YACzD,IAAI,CAAC,OAAO,GAAG,QAAQ,CAAC,QAAQ,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,CAAC;QAC3D,CAAC;QACD,IAAI,KAAK,CAAC,SAAS,EAAE,CAAC;YACpB,IAAI,CAAC,UAAU,CAAC,WAAW,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;YAC7C,IAAI,CAAC,UAAU,CAAC,MAAM,EAAE,CAAC;QAC3B,CAAC;aAAM,CAAC;YACN,IAAI,MAAM,CAAC;YACX,IAAI,IAAI,CAAC,OAAO,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;gBACjC,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;gBACxD,IAAI,OAAO,CAAC,gBAAgB,EAAE;oBAC5B,MAAM,GAAG,QAAQ,CAAC,aAAa,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;YACzE,CAAC;YACD,IAAI,CAAC,MAAM;gBACT,MAAM,GAAG,IAAI,CAAC,WAAW,CAAC,UAAU,EAAE,CAAC;YAEzC,IAAI,CAAC,UAAU,GAAG,SAAS,CAAC,qBAAqB,CAAC,IAAI,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;YACvE,IAAI,CAAC,UAAU,CAAC,MAAM,EAAE,CAAC;QAC3B,CAAC;IACH,CAAC;IAED;;OAEG;IACH,IAAW,OAAO;QAChB,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC;IAC7B,CAAC;IAED,8FAA8F;IACvF,MAAM,CAAC,4BAA4B,CAAC,MAAoB,EAAE,KAAe,EAAE,KAAa;QAC7F,MAAM,UAAU,GAAG,MAAM,CAAC,MAAM,EAAE,CAAC;QACnC,MAAM,YAAY,GAAG,EAAE,GAAG,QAAQ,CAAC,gBAAgB,CAAC,KAAK,CAAC;QAC1D,MAAM,UAAU,GAAG,YAAY,CAAC,WAAW,CAAC,EAAE,SAAS,EAAE,MAAM,CAAC,SAAS,EAAE,QAAQ,EAAE,MAAM,CAAC,QAAQ,GAAG,YAAY,EAAE,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC;QAC9I,MAAM,SAAS,GAAG,YAAY,CAAC,WAAW,CAAC,EAAE,SAAS,EAAE,MAAM,CAAC,SAAS,GAAG,YAAY,EAAE,QAAQ,EAAE,MAAM,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC;QAC7I,MAAM,SAAS,GAAG,UAAU,CAAC,MAAM,EAAE,CAAC;QACtC,MAAM,QAAQ,GAAG,SAAS,CAAC,MAAM,EAAE,CAAC;QACpC,MAAM,OAAO,GAAG,QAAQ,CAAC,cAAc,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC,SAAS,EAAE,CAAC;QAC1E,MAAM,OAAO,GAAG,QAAQ,CAAC,cAAc,CAAC,UAAU,EAAE,SAAS,CAAC,CAAC,SAAS,EAAE,CAAC;QAC3E,MAAM,MAAM,GAAG,QAAQ,CAAC,sBAAsB,CAAC,OAAQ,EAAE,OAAQ,EAAE,SAAS,CAAC,GAAG,CAAE,CAAC;QACnF,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;YACxB,MAAM,KAAK,GAAG,QAAQ,CAAC,6BAA6B,CAAC,SAAS,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;YACzE,MAAM,CAAC,oBAAoB,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;QAC7C,CAAC;QACD,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;YACxB,MAAM,KAAK,GAAG,MAAM,CAAC,cAAc,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;YACnF,UAAU,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;QAC/B,CAAC;QAED,OAAO,IAAI,YAAY,CAAC,EAAE,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,kBAAkB,CAAC,kBAAkB,CAAC,MAAM,CAAE,EAAE,kBAAkB,EAAE,MAAM,EAAE,CAAC,CAAC;IAC3I,CAAC;IAED,oIAAoI;IAC7H,MAAM,CAAC,mBAAmB,CAAC,SAAoB;QACpD,MAAM,UAAU,GAAG,SAAS,CAAC,SAAS,EAAE,CAAC;QACzC,MAAM,cAAc,GAAG,kBAAkB,CAAC,aAAa,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;QACjE,MAAM,6BAA6B,GAAG,kBAAkB,CAAC,kBAAkB,CAAC,SAAS,CAAC,SAAS,EAAE,EAAE,cAAc,CAAC,CAAC;QACnH,MAAM,cAAc,GAAG,SAAS,CAAC,MAAM,EAAE,CAAC;QAE1C,OAAO,IAAI,YAAY,CAAC,EAAE,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,6BAA6B,IAAI,cAAc,EAAE,SAAS,EAAE,cAAc,EAAE,CAAC,CAAC;IAC3I,CAAC;IAED,4EAA4E;IAC5E,IAAW,WAAW;QACpB,MAAM,MAAM,GAAG,IAAI,CAAC,WAAW,CAAC,UAAU,EAAE,CAAC;QAC7C,OAAO,OAAO,CAAC,UAAU,CAAC,MAAM,CAAC,oBAAoB,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;IACzG,CAAC;IAED,+FAA+F;IACxF,aAAa,CAAC,KAAmB;QACtC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,aAAa,CAAC,KAAK,CAAC,WAAW,CAAC;YAChG,OAAO,KAAK,CAAC;QAEf,IAAI,CAAC,IAAI,CAAC,OAAO,KAAK,SAAS,CAAC,KAAK,CAAC,KAAK,CAAC,OAAO,KAAK,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,KAAK,SAAS,CAAC,KAAK,CAAC,KAAK,CAAC,OAAO,KAAK,SAAS,CAAC;YAClI,OAAO,KAAK,CAAC;QAEf,IAAI,IAAI,CAAC,OAAO,KAAK,SAAS,IAAI,KAAK,CAAC,OAAO,KAAK,SAAS,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,KAAK,CAAC,OAAO,CAAC;YACzG,OAAO,KAAK,CAAC;QAEf,IAAI,IAAI,CAAC,OAAO,KAAK,SAAS,IAAI,KAAK,CAAC,OAAO,KAAK,SAAS,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,KAAK,CAAC,OAAO,CAAC;YACzG,OAAO,KAAK,CAAC;QAEf,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,CAAC,aAAa,CAAC,KAAK,CAAC,YAAY,EAAE,CAAC;YAC1D,OAAO,KAAK,CAAC;QAEf,MAAM,SAAS,GAAG,IAAI,CAAC,kBAAkB,CAAC;QAC1C,MAAM,UAAU,GAAG,KAAK,CAAC,kBAAkB,CAAC;QAC5C,IAAI,SAAS,KAAK,SAAS,IAAI,SAAS,KAAK,UAAU;YACrD,OAAO,SAAS,KAAK,SAAS,IAAI,SAAS,KAAK,UAAU,CAAC;QAE7D,OAAO,SAAS,CAAC,aAAa,CAAC,UAAU,EAAE,QAAQ,CAAC,mBAAmB,CAAC,CAAC;IAC3E,CAAC;IAEM,MAAM;QACX,MAAM,KAAK,GAA+B;YACxC,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE;YAC5B,WAAW,EAAE,IAAI,CAAC,WAAW,CAAC,MAAM,EAAE;YACtC,SAAS,EAAE,IAAI,CAAC,YAAY,EAAE,CAAC,MAAM,EAAE;SACxC,CAAC;QAEF,IAAI,IAAI,CAAC,kBAAkB;YACzB,KAAK,CAAC,kBAAkB,GAAG,IAAI,CAAC,kBAAkB,CAAC,MAAM,EAAE,CAAC;QAE9D,IAAI,IAAI,CAAC,OAAO;YACd,KAAK,CAAC,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC;QAExC,IAAI,IAAI,CAAC,OAAO;YACd,KAAK,CAAC,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC;QAExC,OAAO,KAAK,CAAC;IACf,CAAC;CACF;AAED;;;GAGG;AACH,MAAM,OAAgB,MAAM;IAgC1B,yBAAyB;IACzB,IAAW,IAAI;QACb,MAAM,CAAC,IAAI,CAAC,KAAK,KAAK,SAAS,CAAC,CAAC;QACjC,OAAO,IAAI,CAAC,KAAK,CAAC;IACpB,CAAC;IACD,IAAW,IAAI,CAAC,IAAY;QAC1B,IAAI,IAAI,KAAK,IAAI,CAAC,KAAK,EAAE,CAAC;YACxB,MAAM,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC;YACvB,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;YAClB,IAAI,SAAS,KAAK,GAAG;gBACnB,IAAI,CAAC,aAAa,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;QACvC,CAAC;IACH,CAAC;IAED,kEAAkE;IAClE,IAAW,WAAW;QACpB,MAAM,CAAC,IAAI,CAAC,YAAY,KAAK,SAAS,CAAC,CAAC;QACxC,OAAO,IAAI,CAAC,YAAY,CAAC;IAC3B,CAAC;IACD,IAAW,WAAW,CAAC,OAAyB;QAC9C,IAAI,SAAS,KAAK,IAAI,CAAC,YAAY,IAAI,IAAI,CAAC,YAAY,CAAC,IAAI,KAAK,OAAO,CAAC,IAAI,IAAI,IAAI,CAAC,YAAY,CAAC,WAAW,KAAK,OAAO,CAAC,WAAW,EAAE,CAAC;YACxI,MAAM,GAAG,GAAG,IAAI,CAAC,YAAY,CAAC;YAC9B,IAAI,CAAC,YAAY,GAAG,OAAO,CAAC;YAC5B,IAAI,GAAG;gBACL,IAAI,CAAC,oBAAoB,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;QAC9C,CAAC;IACH,CAAC;IASD;;;OAGG;IACH,IAAW,cAAc;QACvB,MAAM,CAAC,SAAS,KAAK,IAAI,CAAC,eAAe,CAAC,CAAC;QAC3C,OAAO,IAAI,CAAC,eAAe,CAAC;IAC9B,CAAC;IACD,IAAW,cAAc,CAAC,OAAyB;QACjD,uEAAuE;QACvE,MAAM,cAAc,GAAG,OAAO,CAAC,KAAK,EAAE,CAAC;QACvC,cAAc,CAAC,gBAAgB,CAAC,GAAG,CAAC,CAAC;QACrC,IAAI,CAAC,IAAI,CAAC,eAAe,IAAI,CAAC,IAAI,CAAC,eAAe,CAAC,aAAa,CAAC,cAAc,CAAC,EAAE,CAAC;YACjF,MAAM,GAAG,GAAG,IAAI,CAAC,eAAe,CAAC;YACjC,cAAc,CAAC,MAAM,EAAE,CAAC;YACxB,IAAI,CAAC,eAAe,GAAG,cAAc,CAAC;YACtC,IAAI,GAAG;gBACL,IAAI,CAAC,uBAAuB,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;QACjD,CAAC;IACH,CAAC;IAED,0DAA0D;IAC1D,IAAW,YAAY;QACrB,MAAM,CAAC,IAAI,CAAC,aAAa,KAAK,SAAS,CAAC,CAAC;QACzC,OAAO,IAAI,CAAC,aAAa,CAAC;IAC5B,CAAC;IACD,IAAW,YAAY,CAAC,GAAY;QAClC,IAAI,CAAC,IAAI,CAAC,aAAa,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,aAAa,CAAC,GAAG,CAAC,EAAE,CAAC;YAClE,MAAM,GAAG,GAAG,IAAI,CAAC,aAAa,CAAC;YAC/B,GAAG,CAAC,MAAM,EAAE,CAAC;YACb,IAAI,CAAC,aAAa,GAAG,GAAG,CAAC;YACzB,IAAI,GAAG;gBACL,IAAI,CAAC,qBAAqB,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;QAC/C,CAAC;IACH,CAAC;IAED;;;;;;;;;;MAUE;IACF,IAAW,YAAY;QACrB,OAAO,IAAI,CAAC,aAAa,CAAC;IAC5B,CAAC;IACD,IAAW,YAAY,CAAC,YAAsC;QAC5D,MAAM,GAAG,GAAG,IAAI,CAAC,aAAa,CAAC;QAC/B,IAAI,CAAC,GAAG,IAAI,CAAC,YAAY;YACvB,OAAO;aACJ,IAAI,GAAG,IAAI,YAAY,IAAI,GAAG,CAAC,aAAa,CAAC,YAAY,CAAC;YAC7D,OAAO;QAET,IAAI,CAAC,aAAa,GAAG,YAAY,CAAC;QAClC,IAAI,CAAC,qBAAqB,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;IAC7C,CAAC;IAED,oFAAoF;IAC7E,eAAe,CAAC,IAAuB;QAC5C,IAAI,CAAC,YAAY,GAAG,IAAI,YAAY,CAAC,IAAI,CAAC,CAAC;IAC7C,CAAC;IAED,gEAAgE;IAChE,IAAW,0BAA0B;QACnC,OAAO,IAAI,CAAC,2BAA2B,CAAC;IAC1C,CAAC;IACD,IAAW,0BAA0B,CAAC,MAAiC;QACrE,MAAM,GAAG,GAAG,IAAI,CAAC,2BAA2B,CAAC;QAC7C,IAAI,CAAC,GAAG,IAAI,CAAC,MAAM;YACjB,OAAO;aACJ,IAAI,GAAG,IAAI,MAAM,IAAI,GAAG,CAAC,MAAM,CAAC,MAAM,CAAC;YAC1C,OAAO;QAET,IAAI,CAAC,2BAA2B,GAAG,MAAM,CAAC;QAC1C,IAAI,CAAC,mCAAmC,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;IAC3D,CAAC;IAED,+EAA+E;IACxE,6BAA6B,CAAC,MAA0B;QAC7D,IAAI,CAAC,0BAA0B,GAAG,IAAI,aAAa,CAAC,MAAM,CAAC,CAAC;IAC9D,CAAC;IAED,gBAAgB;IACT,kBAAkB;QACvB,OAAO;YACL,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,WAAW,EAAE,IAAI,CAAC,WAAW;YAC7B,cAAc,EAAE,IAAI,CAAC,cAAc,CAAC,MAAM,EAAE;YAC5C,YAAY,EAAE,IAAI,CAAC,YAAY,CAAC,MAAM,EAAE;YACxC,YAAY,EAAE,IAAI,CAAC,YAAY;YAC/B,0BAA0B,EAAE,IAAI,CAAC,0BAA0B;YAC3D,GAAI,IAAI,CAAC,YAAY,EAAE;SACxB,CAAC;IACJ,CAAC;IAED,oDAAoD;IAC7C,MAAM;QACX,OAAO,IAAI,CAAC,kBAAkB,EAAE,CAAC;IACnC,CAAC;IAMD,4GAA4G;IAC5G,IAAW,GAAG,KAAa,OAAO,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC;IAIlD,gEAAgE;IAChE,IAAW,OAAO,KAA6B,OAAO,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC;IAEtE,4CAA4C;IAC5C,IAAW,QAAQ,KAA6B,OAAO,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC;IAExE,cAAc;IACd,IAAW,SAAS;QAClB,OAAO,EAAE,GAAG,IAAI,CAAC,UAAU,EAAE,CAAC;IAChC,CAAC;IACD,IAAW,SAAS,CAAC,SAA+B;QAClD,MAAM,IAAI,GAAG,IAAI,CAAC,UAAU,CAAC;QAC7B,IAAI,IAAI,CAAC,EAAE,KAAK,SAAS,CAAC,EAAE,IAAI,IAAI,CAAC,KAAK,KAAK,SAAS,CAAC,KAAK,EAAE,CAAC;YAC/D,IAAI,CAAC,UAAU,GAAG,EAAE,EAAE,EAAE,SAAS,CAAC,EAAE,EAAE,KAAK,EAAE,SAAS,CAAC,KAAK,EAAE,CAAC;YAC/D,IAAI,CAAC,kBAAkB,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;QAC3C,CAAC;IACH,CAAC;IAGD,6CAA6C;IAC7C,IAAW,QAAQ,KAAe,OAAO,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC;IAE1D;;OAEG;IACI,WAAW;QAChB,IAAI,CAAC,IAAI,CAAC,MAAM;YACd,MAAM,IAAI,WAAW,CAAC,YAAY,CAAC,UAAU,EAAE,4BAA4B,CAAC,CAAC;QAE/E,OAAO,IAAI,CAAC,YAAY,EAAE,CAAC;IAC7B,CAAC;IAED;;;OAGG;IACO,YAAY;QACpB,OAAO;YACL,GAAG,EAAE,IAAI,CAAC,QAAQ;YAClB,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,QAAQ,EAAE,IAAI,CAAC,QAAQ;YACvB,SAAS,EAAE,IAAI,CAAC,SAAS;SAC1B,CAAC;IACJ,CAAC;IAED,gBAAgB;IAChB,YAAsB,UAA2B;QAjNjD,2CAA2C;QAC3B,kBAAa,GAAG,IAAI,OAAO,EAAkC,CAAC;QAC9E,kDAAkD;QAClC,yBAAoB,GAAG,IAAI,OAAO,EAA+C,CAAC;QAClG,qDAAqD;QACrC,4BAAuB,GAAG,IAAI,OAAO,EAA+C,CAAC;QACrG,mDAAmD;QACnC,0BAAqB,GAAG,IAAI,OAAO,EAAqC,CAAC;QACzF,mDAAmD;QACnC,0BAAqB,GAAG,IAAI,OAAO,EAAwD,CAAC;QAC5G,iEAAiE;QACjD,wCAAmC,GAAG,IAAI,OAAO,EAAoD,CAAC;QACtH,gDAAgD;QAChC,uBAAkB,GAAG,IAAI,OAAO,EAAqD,CAAC;QAwK5F,cAAS,GAAG,QAAQ,CAAC,QAAQ,CAAC;QA6BtC,IAAI,CAAC,UAAU,GAAG,UAAU,EAAE,SAAS,IAAI,EAAE,EAAE,EAAE,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE,CAAC;QAChE,IAAI,CAAC,QAAQ,GAAG,EAAE,CAAC;QACnB,IAAI,UAAU,EAAE,CAAC;YACf,IAAI,CAAC,QAAQ,GAAG,UAAU,CAAC,GAAG,CAAC;YAC/B,IAAI,CAAC,QAAQ,GAAG,UAAU,CAAC,OAAO,CAAC;YACnC,IAAI,CAAC,SAAS,GAAG,UAAU,CAAC,QAAQ,CAAC;QACvC,CAAC;IACH,CAAC;IAED,gBAAgB;IACN,UAAU,CAAC,IAAY,EAAE,KAAkB;QACnD,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,WAAW,GAAG,KAAK,CAAC,WAAW,CAAC;QACrC,IAAI,CAAC,cAAc,GAAG,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,cAAc,CAAC,CAAC;QAC7D,IAAI,CAAC,YAAY,GAAG,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC;QAEzD,MAAM,YAAY,GAAG,KAAK,CAAC,YAAY,CAAC,CAAC,CAAC,IAAI,YAAY,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QAC3F,IAAI,CAAC,YAAY,GAAG,YAAY,EAAE,OAAO,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,SAAS,CAAC;QAErE,IAAI,CAAC,0BAA0B,GAAG,KAAK,CAAC,0BAA0B,CAAC,CAAC,CAAC,IAAI,aAAa,CAAC,KAAK,CAAC,0BAA0B,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IACvI,CAAC;IAED,gEAAgE;IACzD,MAAM,CAAC,uBAAuB,CAAC,UAAsB;QAC1D,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,wBAAwB,CAAC,IAAI,CAAC,UAAU,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,IAAI,CAAC,cAAc,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC;IACnJ,CAAC;IAED,uFAAuF;IACvF,IAAW,YAAY,KAAK,OAAO,SAAS,KAAK,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC;IAEtE;;OAEG;IACI,gBAAgB;QACrB,IAAI,SAAS,KAAK,IAAI,CAAC,aAAa;YAClC,MAAM,IAAI,WAAW,CAAC,gBAAgB,CAAC,aAAa,EAAE,0BAA0B,CAAC,CAAC;QACpF,OAAO,IAAI,CAAC,aAAa,CAAC,YAAY,EAAE,CAAC;IAC3C,CAAC;IAED;;;;;OAKG;IACI,aAAa,CAAC,OAAe,EAAE,MAAgB,IAAa,OAAO,IAAI,CAAC,gBAAgB,EAAE,CAAC,eAAe,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC;IAErI;;;;;;OAMG;IACI,aAAa,CAAC,IAAY,EAAE,MAAgB,IAAa,OAAO,IAAI,CAAC,gBAAgB,EAAE,CAAC,sBAAsB,CAAC,IAAI,EAAE,MAAM,CAAE,CAAC,CAAC,CAAC;IAEvI;;;;;OAKG;IACI,6BAA6B,CAAC,OAAe,EAAE,MAAqB,IAAkB,OAAO,YAAY,CAAC,QAAQ,CAAC,IAAI,CAAC,aAAa,CAAC,OAAO,CAAC,EAAE,MAAM,CAAE,CAAC,CAAC,CAAC;IAElK;;;;;;OAMG;IACI,6BAA6B,CAAC,YAA0B,EAAE,MAAgB,IAAI,OAAO,IAAI,CAAC,aAAa,CAAC,YAAY,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC;;AAhStJ,sCAAsC;AACf,wBAAiB,GAAe,KAAK,AAApB,CAAqB;AAC7D,0CAA0C;AACnB,oBAAa,GAAe,KAAK,AAApB,CAAqB;AACzD,sCAAsC;AACf,mBAAY,GAAe,MAAM,AAArB,CAAsB","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module iModels\n */\n\nimport { assert, BeEvent, GeoServiceStatus, GuidString, Id64, Id64String, IModelStatus, Mutable, OpenMode } from \"@itwin/core-bentley\";\nimport {\n  Angle, AxisIndex, AxisOrder, Constant, Geometry, Matrix3d, Point3d, Range3d, Range3dProps, Transform, TransformProps, Vector3d, XYAndZ, XYZProps,\n  YawPitchRollAngles, YawPitchRollProps,\n} from \"@itwin/core-geometry\";\nimport { ChangesetIdWithIndex } from \"./ChangesetProps\";\nimport { Cartographic, CartographicProps } from \"./geometry/Cartographic\";\nimport { GeographicCRS, GeographicCRSProps } from \"./geometry/CoordinateReferenceSystem\";\nimport { AxisAlignedBox3d } from \"./geometry/Placement\";\nimport { IModelError } from \"./IModelError\";\nimport { ThumbnailProps } from \"./Thumbnail\";\n\n/** The properties to open a connection to an iModel for RPC operations.\n * @public\n */\nexport interface IModelRpcOpenProps {\n  /** The iTwin in which the iModel exists - must be defined for briefcases that are synchronized with iModelHub. */\n  readonly iTwinId?: GuidString;\n  /** Guid of the iModel. */\n  readonly iModelId?: GuidString;\n\n  /** Id of the last Changeset that was applied to the iModel - must be defined for briefcases that are synchronized with iModelHub.\n   * @note Changeset Ids are string hash values based on the content and parent.\n   */\n  readonly changeset?: ChangesetIdWithIndex;\n}\n\n/** The properties that identify an opened iModel for RPC operations.\n * @public\n */\nexport interface IModelRpcProps extends IModelRpcOpenProps {\n  /** Unique key used for identifying the iModel between the frontend and the backend */\n  readonly key: string;\n}\n\n/** Properties that position an iModel on the earth via [ECEF](https://en.wikipedia.org/wiki/ECEF) (Earth Centered Earth Fixed) coordinates\n * The origin is specified as an ECEF coordinate. The cartographicOrigin property contains the latitude, longitude and elevation above the WGS84 ellipsoid\n * of the origin property. This cartographicOrigin is offered as a convenient pre-calculated value representing the location of the ECEF origin.\n * The 3D coordinate system this class represents is positioned at specified origin and the axis positioned according to\n * the other properties.\n * If transform property is defined then it will not be computed from other properties.\n * If the xVector and yVector properties are defined (and transform is not defined) then they take precedence over the YawPitchRoll orientation property. The xVector and yVector\n * represent the direction and scale of the X and Y axes. The Z axis is always perpendicular (according to the right hand rule) to these X-Y axes.\n * The scaling in the Z direction is always unity. The scale of the X and Y axes is represented by the size of the vector length.\n * If the xVector and yVector are not present then the YawPitchRoll properties indicates the angles for all tree axes. Scaling in that case\n * is unity in all three directions.\n * Note that the present class is intended to represent geolocated 3D coordinate systems that are normally tangent to the WGS84 ellipsoid\n * possibly offset in altitude by the terrain elevation above the ellipsoid but other general 3D coordinate systems\n * can be defined.\n * @public\n * @extensions\n */\nexport interface EcefLocationProps {\n  /** The Origin of an iModel on the earth in ECEF coordinates */\n  readonly origin: XYZProps;\n  /** The [orientation](https://en.wikipedia.org/wiki/Geographic_coordinate_conversion) of an iModel on the earth. */\n  readonly orientation: YawPitchRollProps;\n  /** Optional position on the earth used to establish the ECEF coordinates. */\n  readonly cartographicOrigin?: CartographicProps;\n  /** Optional X column vector used with [[yVector]] to calculate potentially non-rigid transform if a projection is present. */\n  readonly xVector?: XYZProps;\n  /** Optional Y column vector used with [[xVector]] to calculate potentially non-rigid transform if a projection is present. */\n  readonly yVector?: XYZProps;\n  /** Optional potentially non-rigid transform defining the ECEF location.\n   * @note If this property is supplied, the other properties are ignored.\n   */\n  readonly transform?: TransformProps;\n}\n\n/** Properties of the [Root Subject]($docs/bis/guide/references/glossary#subject-root).\n * @public\n * @extensions\n */\nexport interface RootSubjectProps {\n  /** The name of the root subject. */\n  readonly name: string;\n  /** Description of the root subject (optional). */\n  readonly description?: string;\n}\n\n/** Properties of an iModel that are always held in memory whenever one is opened, both on the frontend and on the backend .\n * @public\n */\nexport interface IModelProps {\n  /** The name and description of the root subject of this iModel */\n  readonly rootSubject: RootSubjectProps;\n  /** The volume of the entire project, in spatial coordinates */\n  readonly projectExtents?: Range3dProps;\n  /** An offset to be applied to all spatial coordinates. This is normally used to transform spatial coordinates into the Cartesian coordinate system of a Geographic Coordinate System. */\n  readonly globalOrigin?: XYZProps;\n  /** The location of the iModel in Earth Centered Earth Fixed coordinates. iModel units are always meters */\n  readonly ecefLocation?: EcefLocationProps;\n  /** The Geographic Coordinate Reference System indicating the projection and datum used. */\n  readonly geographicCoordinateSystem?: GeographicCRSProps;\n  /** The name of the iModel. */\n  readonly name?: string;\n}\n\n/** The properties returned by the backend when creating a new [[IModelConnection]] from the frontend, either with Rpc or with Ipc.\n * These properties describe the iModel held on the backend for thew newly formed connection and are used to construct a new\n * [[IModelConnection]] instance on the frontend to access it.\n * @public\n */\nexport type IModelConnectionProps = IModelProps & IModelRpcProps;\n\n/** The properties that can be supplied when creating a *new* iModel.\n * @public\n */\nexport interface CreateIModelProps extends IModelProps {\n  /** The GUID of new iModel. If not present, a GUID will be generated. */\n  readonly guid?: GuidString;\n  /** Client name for new iModel */\n  readonly client?: string;\n  /** Thumbnail for new iModel\n   * @alpha\n   */\n  readonly thumbnail?: ThumbnailProps;\n}\n\n/**\n * Encryption-related properties that can be supplied when creating or opening snapshot iModels.\n * @public\n * @deprecated in 3.x. **NOTE**, encrypted iModels are no longer supported since they require licensed code.\n */\nexport interface IModelEncryptionProps {\n  /** The password used to encrypt/decrypt the snapshot iModel. */\n  readonly password?: string;\n}\n\n/**\n * Sqlite options.\n * @public\n */\nexport interface OpenSqliteArgs {\n  /**\n   * Specify timeout after which SQLite stop retrying to acquire lock to database file and throw SQLITE_BUSY error.\n   * Timeout is specified in milliseconds.\n   * For more information https://www.sqlite.org/c3ref/busy_timeout.html.\n   * */\n  readonly busyTimeout?: number;\n}\n\n/**\n * A key used to identify an opened [IModelDb]($backend) between the frontend and backend for Rpc and Ipc communications.\n * Keys must be unique - that is there can never be two IModelDbs opened with the same key at any given time.\n * If no key is supplied in a call to open an IModelDb, one is generated and returned.\n * It is only necessary to supply a key if you have some reason to assign a specific value to identify an IModelDb.\n * If you don't supply the key, you must use the returned value for Rpc and Ipc communications.\n * @public\n */\nexport interface OpenDbKey {\n  readonly key?: string;\n}\n\n/** @beta TODO documentation */\nexport interface CloudContainerUri {\n  readonly uriParams: string;\n}\n\n/** Options to open a [SnapshotDb]($backend).\n * @public\n */\nexport interface SnapshotOpenOptions extends IModelEncryptionProps, OpenDbKey { // eslint-disable-line deprecation/deprecation\n  /**\n   * The \"base\" name that can be used for creating temporary files related to this Db.\n   * The string should be a name related to the current Db filename using some known pattern so that all files named \"baseName*\" can be deleted externally during cleanup.\n   * It must be the name of a file (that may or may not exist) in a writable directory.\n   * If not present, the baseName will default to the database's file name (including the path).\n   * @internal\n   */\n  readonly tempFileBase?: string;\n}\n\n/** Options to open a [StandaloneDb]($backend) via [StandaloneDb.openFile]($backend) from the backend,\n * or [BriefcaseConnection.openStandalone]($frontend) from the frontend.\n * @public\n */\nexport type StandaloneOpenOptions = OpenDbKey;\n\n/** Options that can be supplied when creating snapshot iModels.\n * @public\n */\n// eslint-disable-next-line deprecation/deprecation\nexport interface CreateSnapshotIModelProps extends IModelEncryptionProps {\n  /** If true, then create SQLite views for Model, Element, ElementAspect, and Relationship classes.\n   * These database views can often be useful for interoperability workflows.\n   */\n  readonly createClassViews?: boolean;\n}\n\n/** The options that can be specified when creating an *empty* snapshot iModel.\n * @see [SnapshotDb.createEmpty]($backend)\n * @public\n */\nexport type CreateEmptySnapshotIModelProps = CreateIModelProps & CreateSnapshotIModelProps;\n\n/** Options that can be supplied when creating standalone iModels.\n * @internal\n */\n// eslint-disable-next-line deprecation/deprecation\nexport interface CreateStandaloneIModelProps extends IModelEncryptionProps {\n  /** If present, file will allow local editing, but cannot be used to create changesets */\n  readonly allowEdit?: string;\n}\n\n/** The options that can be specified when creating an *empty* standalone iModel.\n * @see [standalone.createEmpty]($backend)\n * @internal\n */\nexport type CreateEmptyStandaloneIModelProps = CreateIModelProps & CreateStandaloneIModelProps;\n\n/**\n * @public\n * @extensions\n */\nexport interface FilePropertyProps {\n  readonly namespace: string;\n  readonly name: string;\n  id?: number | string;\n  subId?: number | string;\n}\n\n/** The position and orientation of an iModel on the earth in [ECEF](https://en.wikipedia.org/wiki/ECEF) (Earth Centered Earth Fixed) coordinates\n * @note This is an immutable type - all of its properties are frozen.\n * @see [GeoLocation of iModels]($docs/learning/GeoLocation.md)\n * @public\n */\nexport class EcefLocation implements EcefLocationProps {\n  /** The origin of the ECEF transform. */\n  public readonly origin: Point3d;\n  /** The orientation of the ECEF transform */\n  public readonly orientation: YawPitchRollAngles;\n  /** Optional position on the earth used to establish the ECEF origin and orientation. */\n  public readonly cartographicOrigin?: Cartographic;\n  /** Optional X column vector used with [[yVector]] to calculate potentially non-rigid transform if a projection is present. */\n  public readonly xVector?: Vector3d;\n  /** Optional Y column vector used with [[xVector]] to calculate potentially non-rigid transform if a projection is present. */\n  public readonly yVector?: Vector3d;\n  /** The transform from iModel Spatial coordinates to ECEF from this EcefLocation */\n  private readonly _transform: Transform = Transform.createIdentity();\n\n  /** Get the transform from iModel Spatial coordinates to ECEF from this EcefLocation */\n  public getTransform(): Transform { return this._transform; }\n\n  /** Construct a new EcefLocation. Once constructed, it is frozen and cannot be modified. */\n  constructor(props: EcefLocationProps) {\n    this.origin = Point3d.fromJSON(props.origin).freeze();\n    this.orientation = YawPitchRollAngles.fromJSON(props.orientation).freeze();\n    if (props.cartographicOrigin)\n      this.cartographicOrigin = Cartographic.fromRadians({ longitude: props.cartographicOrigin.longitude, latitude: props.cartographicOrigin.latitude, height: props.cartographicOrigin.height }).freeze();\n    if (props.xVector && props.yVector) {\n      this.xVector = Vector3d.fromJSON(props.xVector).freeze();\n      this.yVector = Vector3d.fromJSON(props.yVector).freeze();\n    }\n    if (props.transform) {\n      this._transform.setFromJSON(props.transform);\n      this._transform.freeze();\n    } else {\n      let matrix;\n      if (this.xVector && this.yVector) {\n        const zVector = this.xVector.crossProduct(this.yVector);\n        if (zVector.normalizeInPlace())\n          matrix = Matrix3d.createColumns(this.xVector, this.yVector, zVector);\n      }\n      if (!matrix)\n        matrix = this.orientation.toMatrix3d();\n\n      this._transform = Transform.createOriginAndMatrix(this.origin, matrix);\n      this._transform.freeze();\n    }\n  }\n\n  /** Returns true if this EcefLocation is not located at the center of the Earth.\n   * @alpha are locations very close to the center considered valid? What are the specific criteria?\n   */\n  public get isValid(): boolean {\n    return !this.origin.isZero;\n  }\n\n  /** Construct ECEF Location from cartographic origin with optional known point and angle.   */\n  public static createFromCartographicOrigin(origin: Cartographic, point?: Point3d, angle?: Angle) {\n    const ecefOrigin = origin.toEcef();\n    const deltaRadians = 10 / Constant.earthRadiusWGS84.polar;\n    const northCarto = Cartographic.fromRadians({ longitude: origin.longitude, latitude: origin.latitude + deltaRadians, height: origin.height });\n    const eastCarto = Cartographic.fromRadians({ longitude: origin.longitude + deltaRadians, latitude: origin.latitude, height: origin.height });\n    const ecefNorth = northCarto.toEcef();\n    const ecefEast = eastCarto.toEcef();\n    const xVector = Vector3d.createStartEnd(ecefOrigin, ecefEast).normalize();\n    const yVector = Vector3d.createStartEnd(ecefOrigin, ecefNorth).normalize();\n    const matrix = Matrix3d.createRigidFromColumns(xVector!, yVector!, AxisOrder.XYZ)!;\n    if (angle !== undefined) {\n      const north = Matrix3d.createRotationAroundAxisIndex(AxisIndex.Z, angle);\n      matrix.multiplyMatrixMatrix(north, matrix);\n    }\n    if (point !== undefined) {\n      const delta = matrix.multiplyVector(Vector3d.create(-point.x, -point.y, -point.z));\n      ecefOrigin.addInPlace(delta);\n    }\n\n    return new EcefLocation({ origin: ecefOrigin, orientation: YawPitchRollAngles.createFromMatrix3d(matrix)!, cartographicOrigin: origin });\n  }\n\n  /** Construct ECEF Location from transform with optional position on the earth used to establish the ECEF origin and orientation. */\n  public static createFromTransform(transform: Transform): EcefLocation {\n    const ecefOrigin = transform.getOrigin();\n    const angleFromInput = YawPitchRollAngles.createDegrees(0, 0, 0);\n    const locationOrientationFromInputT = YawPitchRollAngles.createFromMatrix3d(transform.getMatrix(), angleFromInput);\n    const transformProps = transform.toJSON();\n\n    return new EcefLocation({ origin: ecefOrigin, orientation: locationOrientationFromInputT ?? angleFromInput, transform: transformProps });\n  }\n\n  /** Get the location center of the earth in the iModel coordinate system. */\n  public get earthCenter(): Point3d {\n    const matrix = this.orientation.toMatrix3d();\n    return Point3d.createFrom(matrix.multiplyTransposeXYZ(-this.origin.x, -this.origin.y, -this.origin.z));\n  }\n\n  /** Return true if this location is equivalent to another location within a small tolerance. */\n  public isAlmostEqual(other: EcefLocation): boolean {\n    if (!this.origin.isAlmostEqual(other.origin) || !this.orientation.isAlmostEqual(other.orientation))\n      return false;\n\n    if ((this.xVector === undefined) !== (other.xVector === undefined) || (this.yVector === undefined) !== (other.yVector === undefined))\n      return false;\n\n    if (this.xVector !== undefined && other.xVector !== undefined && !this.xVector.isAlmostEqual(other.xVector))\n      return false;\n\n    if (this.yVector !== undefined && other.yVector !== undefined && !this.yVector.isAlmostEqual(other.yVector))\n      return false;\n\n    if (!this.getTransform().isAlmostEqual(other.getTransform()))\n      return false;\n\n    const thisCarto = this.cartographicOrigin;\n    const otherCarto = other.cartographicOrigin;\n    if (undefined === thisCarto || undefined === otherCarto)\n      return undefined === thisCarto && undefined === otherCarto;\n\n    return thisCarto.equalsEpsilon(otherCarto, Geometry.smallMetricDistance);\n  }\n\n  public toJSON(): EcefLocationProps {\n    const props: Mutable<EcefLocationProps> = {\n      origin: this.origin.toJSON(),\n      orientation: this.orientation.toJSON(),\n      transform: this.getTransform().toJSON(),\n    };\n\n    if (this.cartographicOrigin)\n      props.cartographicOrigin = this.cartographicOrigin.toJSON();\n\n    if (this.xVector)\n      props.xVector = this.xVector.toJSON();\n\n    if (this.yVector)\n      props.yVector = this.yVector.toJSON();\n\n    return props;\n  }\n}\n\n/** Represents an iModel in JavaScript.\n * @see [GeoLocation of iModels]($docs/learning/GeoLocation.md)\n * @public\n */\nexport abstract class IModel implements IModelProps {\n  private _projectExtents?: AxisAlignedBox3d;\n  private _name?: string;\n  private _rootSubject?: RootSubjectProps;\n  private _globalOrigin?: Point3d;\n  private _ecefLocation?: EcefLocation;\n  private _geographicCoordinateSystem?: GeographicCRS;\n  private _iModelId?: GuidString;\n  private _changeset: ChangesetIdWithIndex;\n\n  /** The Id of the repository model. */\n  public static readonly repositoryModelId: Id64String = \"0x1\";\n  /** The Id of the root subject element. */\n  public static readonly rootSubjectId: Id64String = \"0x1\";\n  /** The Id of the dictionary model. */\n  public static readonly dictionaryId: Id64String = \"0x10\";\n\n  /** Event raised after [[name]] changes. */\n  public readonly onNameChanged = new BeEvent<(previousName: string) => void>();\n  /** Event raised after [[rootSubject]] changes. */\n  public readonly onRootSubjectChanged = new BeEvent<(previousSubject: RootSubjectProps) => void>();\n  /** Event raised after [[projectExtents]] changes. */\n  public readonly onProjectExtentsChanged = new BeEvent<(previousExtents: AxisAlignedBox3d) => void>();\n  /** Event raised after [[globalOrigin]] changes. */\n  public readonly onGlobalOriginChanged = new BeEvent<(previousOrigin: Point3d) => void>();\n  /** Event raised after [[ecefLocation]] changes. */\n  public readonly onEcefLocationChanged = new BeEvent<(previousLocation: EcefLocation | undefined) => void>();\n  /** Event raised after [[geographicCoordinateSystem]] changes. */\n  public readonly onGeographicCoordinateSystemChanged = new BeEvent<(previousGCS: GeographicCRS | undefined) => void>();\n  /** Event raised after [[changeset]] changes. */\n  public readonly onChangesetChanged = new BeEvent<(previousChangeset: ChangesetIdWithIndex) => void>();\n\n  /** Name of the iModel */\n  public get name(): string {\n    assert(this._name !== undefined);\n    return this._name;\n  }\n  public set name(name: string) {\n    if (name !== this._name) {\n      const old = this._name;\n      this._name = name;\n      if (undefined !== old)\n        this.onNameChanged.raiseEvent(old);\n    }\n  }\n\n  /** The name and description of the root subject of this iModel */\n  public get rootSubject(): RootSubjectProps {\n    assert(this._rootSubject !== undefined);\n    return this._rootSubject;\n  }\n  public set rootSubject(subject: RootSubjectProps) {\n    if (undefined === this._rootSubject || this._rootSubject.name !== subject.name || this._rootSubject.description !== subject.description) {\n      const old = this._rootSubject;\n      this._rootSubject = subject;\n      if (old)\n        this.onRootSubjectChanged.raiseEvent(old);\n    }\n  }\n\n  /** Returns `true` if this is a snapshot iModel. */\n  public abstract get isSnapshot(): boolean;\n  /** Returns `true` if this is a briefcase copy of an iModel that is synchronized with iModelHub. */\n  public abstract get isBriefcase(): boolean;\n\n  public abstract get isOpen(): boolean;\n\n  /**\n   * The volume, in spatial coordinates, inside which the entire project is contained.\n   * @note The object returned from this method is frozen. You *must* make a copy before you do anything that might attempt to modify it.\n   */\n  public get projectExtents() {\n    assert(undefined !== this._projectExtents);\n    return this._projectExtents;\n  }\n  public set projectExtents(extents: AxisAlignedBox3d) {\n    // Don't allow any axis of the project extents to be less than 1 meter.\n    const projectExtents = extents.clone();\n    projectExtents.ensureMinLengths(1.0);\n    if (!this._projectExtents || !this._projectExtents.isAlmostEqual(projectExtents)) {\n      const old = this._projectExtents;\n      projectExtents.freeze();\n      this._projectExtents = projectExtents;\n      if (old)\n        this.onProjectExtentsChanged.raiseEvent(old);\n    }\n  }\n\n  /** An offset to be applied to all spatial coordinates. */\n  public get globalOrigin(): Point3d {\n    assert(this._globalOrigin !== undefined);\n    return this._globalOrigin;\n  }\n  public set globalOrigin(org: Point3d) {\n    if (!this._globalOrigin || !this._globalOrigin.isAlmostEqual(org)) {\n      const old = this._globalOrigin;\n      org.freeze();\n      this._globalOrigin = org;\n      if (old)\n        this.onGlobalOriginChanged.raiseEvent(old);\n    }\n  }\n\n  /** The [EcefLocation]($docs/learning/glossary#ecefLocation) of the iModel in Earth Centered Earth Fixed coordinates.\n   * If the iModel property geographicCoordinateSystem is not defined then the ecefLocation provides a geolocation by defining a\n   * 3D coordinate system relative to the Earth model WGS84. Refer to additional documentation for details. If the geographicCoordinateSystem\n   * property is defined then the ecefLocation must be used with care. When the geographicCoordinateSystem is defined it indicates the\n   * iModel cartesian space is the result of a cartographic projection. This implies a flattening of the Earth surface process that\n   * results in scale, angular or area distortion. The ecefLocation is then an approximation calculated at the center of the project extent.\n   * If the project is more than 2 kilometer in size, the ecefLocation may represent a poor approximation of the effective\n   * cartographic projection used and a linear transformation should then be calculated at the exact origin of the data\n   * it must position.\n   * @see [GeoLocation of iModels]($docs/learning/GeoLocation.md)\n  */\n  public get ecefLocation(): EcefLocation | undefined {\n    return this._ecefLocation;\n  }\n  public set ecefLocation(ecefLocation: EcefLocation | undefined) {\n    const old = this._ecefLocation;\n    if (!old && !ecefLocation)\n      return;\n    else if (old && ecefLocation && old.isAlmostEqual(ecefLocation))\n      return;\n\n    this._ecefLocation = ecefLocation;\n    this.onEcefLocationChanged.raiseEvent(old);\n  }\n\n  /** Set the [EcefLocation]($docs/learning/glossary#ecefLocation) for this iModel. */\n  public setEcefLocation(ecef: EcefLocationProps): void {\n    this.ecefLocation = new EcefLocation(ecef);\n  }\n\n  /** The geographic coordinate reference system of the iModel. */\n  public get geographicCoordinateSystem(): GeographicCRS | undefined {\n    return this._geographicCoordinateSystem;\n  }\n  public set geographicCoordinateSystem(geoCRS: GeographicCRS | undefined) {\n    const old = this._geographicCoordinateSystem;\n    if (!old && !geoCRS)\n      return;\n    else if (old && geoCRS && old.equals(geoCRS))\n      return;\n\n    this._geographicCoordinateSystem = geoCRS;\n    this.onGeographicCoordinateSystemChanged.raiseEvent(old);\n  }\n\n  /** Sets the geographic coordinate reference system from GeographicCRSProps. */\n  public setGeographicCoordinateSystem(geoCRS: GeographicCRSProps) {\n    this.geographicCoordinateSystem = new GeographicCRS(geoCRS);\n  }\n\n  /** @internal */\n  public getConnectionProps(): IModelConnectionProps {\n    return {\n      name: this.name,\n      rootSubject: this.rootSubject,\n      projectExtents: this.projectExtents.toJSON(),\n      globalOrigin: this.globalOrigin.toJSON(),\n      ecefLocation: this.ecefLocation,\n      geographicCoordinateSystem: this.geographicCoordinateSystem,\n      ... this._getRpcProps(),\n    };\n  }\n\n  /** Convert this iModel to a JSON representation. */\n  public toJSON(): IModelConnectionProps {\n    return this.getConnectionProps();\n  }\n\n  /** A key used to identify this iModel in RPC calls from frontend to backend.\n   * @internal\n   */\n  protected _fileKey: string;\n  /** Get the key that was used to open this iModel. This is the value used for Rpc and Ipc communications. */\n  public get key(): string { return this._fileKey; }\n\n  /** @internal */\n  protected _iTwinId?: GuidString;\n  /** The Guid that identifies the iTwin that owns this iModel. */\n  public get iTwinId(): GuidString | undefined { return this._iTwinId; }\n\n  /** The Guid that identifies this iModel. */\n  public get iModelId(): GuidString | undefined { return this._iModelId; }\n\n  /** @public */\n  public get changeset(): ChangesetIdWithIndex {\n    return { ...this._changeset };\n  }\n  public set changeset(changeset: ChangesetIdWithIndex) {\n    const prev = this._changeset;\n    if (prev.id !== changeset.id || prev.index !== changeset.index) {\n      this._changeset = { id: changeset.id, index: changeset.index };\n      this.onChangesetChanged.raiseEvent(prev);\n    }\n  }\n\n  protected _openMode = OpenMode.Readonly;\n  /** The [[OpenMode]] used for this IModel. */\n  public get openMode(): OpenMode { return this._openMode; }\n\n  /** Return a token for RPC operations.\n   * @throws IModelError if the iModel is not open.\n   */\n  public getRpcProps(): IModelRpcProps {\n    if (!this.isOpen)\n      throw new IModelError(IModelStatus.BadRequest, \"IModel is not open for rpc\");\n\n    return this._getRpcProps();\n  }\n\n  /** Returns the iModel's RPC properties.\n   * @note It is an error to attempt to use these properties as a token for RPC operations if the iModel is not open.\n   * @internal\n   */\n  protected _getRpcProps(): IModelRpcProps {\n    return {\n      key: this._fileKey,\n      iTwinId: this.iTwinId,\n      iModelId: this.iModelId,\n      changeset: this.changeset,\n    };\n  }\n\n  /** @internal */\n  protected constructor(tokenProps?: IModelRpcProps) {\n    this._changeset = tokenProps?.changeset ?? { id: \"\", index: 0 };\n    this._fileKey = \"\";\n    if (tokenProps) {\n      this._fileKey = tokenProps.key;\n      this._iTwinId = tokenProps.iTwinId;\n      this._iModelId = tokenProps.iModelId;\n    }\n  }\n\n  /** @internal */\n  protected initialize(name: string, props: IModelProps) {\n    this.name = name;\n    this.rootSubject = props.rootSubject;\n    this.projectExtents = Range3d.fromJSON(props.projectExtents);\n    this.globalOrigin = Point3d.fromJSON(props.globalOrigin);\n\n    const ecefLocation = props.ecefLocation ? new EcefLocation(props.ecefLocation) : undefined;\n    this.ecefLocation = ecefLocation?.isValid ? ecefLocation : undefined;\n\n    this.geographicCoordinateSystem = props.geographicCoordinateSystem ? new GeographicCRS(props.geographicCoordinateSystem) : undefined;\n  }\n\n  /** Get the default subCategoryId for the supplied categoryId */\n  public static getDefaultSubCategoryId(categoryId: Id64String): Id64String {\n    return Id64.isValid(categoryId) ? Id64.fromLocalAndBriefcaseIds(Id64.getLocalId(categoryId) + 1, Id64.getBriefcaseId(categoryId)) : Id64.invalid;\n  }\n\n  /** True if this iModel has an [EcefLocation]($docs/learning/glossary#ecefLocation). */\n  public get isGeoLocated() { return undefined !== this._ecefLocation; }\n\n  /** Get the Transform from this iModel's Spatial coordinates to ECEF coordinates using its [[IModel.ecefLocation]].\n   * @throws IModelError if [[isGeoLocated]] is false.\n   */\n  public getEcefTransform(): Transform {\n    if (undefined === this._ecefLocation)\n      throw new IModelError(GeoServiceStatus.NoGeoLocation, \"iModel is not GeoLocated\");\n    return this._ecefLocation.getTransform();\n  }\n\n  /** Convert a point in this iModel's Spatial coordinates to an ECEF point using its [[IModel.ecefLocation]].\n   * @param spatial A point in the iModel's spatial coordinates\n   * @param result If defined, use this for output\n   * @returns A Point3d in ECEF coordinates\n   * @throws IModelError if [[isGeoLocated]] is false.\n   */\n  public spatialToEcef(spatial: XYAndZ, result?: Point3d): Point3d { return this.getEcefTransform().multiplyPoint3d(spatial, result); }\n\n  /** Convert a point in ECEF coordinates to a point in this iModel's Spatial coordinates using its [[ecefLocation]].\n   * @param ecef A point in ECEF coordinates\n   * @param result If defined, use this for output\n   * @returns A Point3d in this iModel's spatial coordinates\n   * @throws IModelError if [[isGeoLocated]] is false.\n   * @note The resultant point will only be meaningful if the ECEF coordinate is close on the earth to the iModel.\n   */\n  public ecefToSpatial(ecef: XYAndZ, result?: Point3d): Point3d { return this.getEcefTransform().multiplyInversePoint3d(ecef, result)!; }\n\n  /** Convert a point in this iModel's Spatial coordinates to a [[Cartographic]] using its [[IModel.ecefLocation]].\n   * @param spatial A point in the iModel's spatial coordinates\n   * @param result If defined, use this for output\n   * @returns A Cartographic location\n   * @throws IModelError if [[isGeoLocated]] is false.\n   */\n  public spatialToCartographicFromEcef(spatial: XYAndZ, result?: Cartographic): Cartographic { return Cartographic.fromEcef(this.spatialToEcef(spatial), result)!; }\n\n  /** Convert a [[Cartographic]] to a point in this iModel's Spatial coordinates using its [[IModel.ecefLocation]].\n   * @param cartographic A cartographic location\n   * @param result If defined, use this for output\n   * @returns A point in this iModel's spatial coordinates\n   * @throws IModelError if [[isGeoLocated]] is false.\n   * @note The resultant point will only be meaningful if the ECEF coordinate is close on the earth to the iModel.\n   */\n  public cartographicToSpatialFromEcef(cartographic: Cartographic, result?: Point3d) { return this.ecefToSpatial(cartographic.toEcef(result), result); }\n}\n"]}

package/lib/esm/IModelError.d.ts

@@ -16,6 +16,43 @@ export type IModelErrorNumber = IModelStatus | DbResult | BentleyStatus | Briefc
 export declare class IModelError extends BentleyError {
     constructor(errorNumber: IModelErrorNumber | number, message: string, getMetaData?: LoggingMetaData);
 }
+/** The state of a lock. See [Acquiring locks on elements.]($docs/learning/backend/ConcurrencyControl.md#acquiring-locks-on-elements).
+ * @public
+ */
+export declare enum LockState {
+    /** The element is not locked */
+    None = 0,
+    /** Holding a shared lock on an element blocks other users from acquiring the Exclusive lock it. More than one user may acquire the shared lock. */
+    Shared = 1,
+    /** A Lock that permits modifications to an element and blocks other users from making modifications to it.
+     * Holding an exclusive lock on an "owner" (a model or a parent element), implicitly exclusively locks all its members.
+     */
+    Exclusive = 2
+}
+/** Detailed information about a particular object Lock that is causing the Lock update conflict.
+ * An example of a lock update conflict would be attempting to use [LockControl.acquireLocks]($backend) on an object that is already locked by another Briefcase.
+ * @public
+*/
+export interface ConflictingLock {
+    /** Id of the object that is causing conflict. */
+    objectId: string;
+    /**
+       * The level of conflicting lock. Possible values are {@link LockState.Shared}, {@link LockState.Exclusive}.
+       * See {@link LockState}.
+       */
+    state: LockState;
+    /** An array of Briefcase ids that hold this lock. */
+    briefcaseIds: number[];
+}
+/**
+ * An error raised when there is a lock conflict detected.
+ * Typically this error would be thrown by [LockControl.acquireLocks]($backend) when you are requesting a lock on an element that is already held by another briefcase.
+ * @public
+ */
+export declare class ConflictingLocksError extends IModelError {
+    conflictingLocks?: ConflictingLock[];
+    constructor(message: string, getMetaData?: LoggingMetaData, conflictingLocks?: ConflictingLock[]);
+}
 /** @public */
 export declare class ServerError extends IModelError {
     constructor(errorNumber: number, message: string);
@@ -28,13 +65,6 @@ export declare class ServerTimeoutError extends ServerError {
 export declare class BackendError extends IModelError {
     constructor(errorNumber: number, name: string, message: string, getMetaData?: LoggingMetaData);
 }
-/**
- * Channel constraint error
- * @alpha
- */
-export declare class ChannelConstraintError extends IModelError {
-    constructor(message: string, getMetaData?: LoggingMetaData);
-}
 /** Intended for API "no content" semantics where the error case should not trigger application failure monitoring systems.
  * @public
  */

package/lib/esm/IModelError.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"IModelError.d.ts","sourceRoot":"","sources":["../../src/IModelError.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EACL,YAAY,EAAE,aAAa,EAAE,eAAe,EAAE,eAAe,EAAE,QAAQ,EAAE,YAAY,EAAE,eAAe,EACvG,MAAM,qBAAqB,CAAC;AAE7B,OAAO,EACL,aAAa,EAAE,YAAY,EAAE,YAAY,EAAE,eAAe,EAAE,QAAQ,EAAE,eAAe,GACtF,MAAM,qBAAqB,CAAC;AAE7B,YAAY,EAAC,mBAAmB,EAAE,WAAW,EAAE,eAAe,EAAC,MAAM,qBAAqB,CAAC;AAE3F;;;GAGG;AACH,MAAM,MAAM,iBAAiB,GAAG,YAAY,GAAG,QAAQ,GAAG,aAAa,GAAG,eAAe,GAAG,eAAe,CAAC;AAE5G;;;GAGG;AACH,qBAAa,WAAY,SAAQ,YAAY;gBACxB,WAAW,EAAE,iBAAiB,GAAG,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,WAAW,CAAC,EAAE,eAAe;CAG3G;AAED,cAAc;AACd,qBAAa,WAAY,SAAQ,WAAW;gBACvB,WAAW,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM;CAIxD;AAED,cAAc;AACd,qBAAa,kBAAmB,SAAQ,WAAW;gBAC9B,OAAO,EAAE,MAAM;CAInC;AAED,cAAc;AACd,qBAAa,YAAa,SAAQ,WAAW;gBACxB,WAAW,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,WAAW,CAAC,EAAE,eAAe;CAIrG;AAED;;;GAGG;AACH,qBAAa,sBAAuB,SAAQ,WAAW;gBAClC,OAAO,EAAE,MAAM,EAAE,WAAW,CAAC,EAAE,eAAe;CAGlE;AAED;;GAEG;AACH,qBAAa,cAAe,SAAQ,WAAW;;CAI9C"}
+{"version":3,"file":"IModelError.d.ts","sourceRoot":"","sources":["../../src/IModelError.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EACL,YAAY,EAAE,aAAa,EAAE,eAAe,EAAE,eAAe,EAAE,QAAQ,EAAmB,YAAY,EAAE,eAAe,EACxH,MAAM,qBAAqB,CAAC;AAE7B,OAAO,EACL,aAAa,EAAE,YAAY,EAAE,YAAY,EAAE,eAAe,EAAE,QAAQ,EAAE,eAAe,GACtF,MAAM,qBAAqB,CAAC;AAE7B,YAAY,EAAC,mBAAmB,EAAE,WAAW,EAAE,eAAe,EAAC,MAAM,qBAAqB,CAAC;AAE3F;;;GAGG;AACH,MAAM,MAAM,iBAAiB,GAAG,YAAY,GAAG,QAAQ,GAAG,aAAa,GAAG,eAAe,GAAG,eAAe,CAAC;AAE5G;;;GAGG;AACH,qBAAa,WAAY,SAAQ,YAAY;gBACxB,WAAW,EAAE,iBAAiB,GAAG,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,WAAW,CAAC,EAAE,eAAe;CAG3G;AAED;;GAEG;AACH,oBAAY,SAAS;IACnB,gCAAgC;IAChC,IAAI,IAAI;IACR,mJAAmJ;IACnJ,MAAM,IAAI;IACV;;OAEG;IACH,SAAS,IAAI;CACd;AAED;;;EAGE;AACF,MAAM,WAAW,eAAe;IAC9B,iDAAiD;IACjD,QAAQ,EAAE,MAAM,CAAC;IACjB;;;SAGK;IACL,KAAK,EAAE,SAAS,CAAC;IACjB,qDAAqD;IACrD,YAAY,EAAE,MAAM,EAAE,CAAC;CACxB;AAED;;;;GAIG;AACH,qBAAa,qBAAsB,SAAQ,WAAW;IAC7C,gBAAgB,CAAC,EAAE,eAAe,EAAE,CAAC;gBAChC,OAAO,EAAE,MAAM,EAAE,WAAW,CAAC,EAAE,eAAe,EAAE,gBAAgB,CAAC,EAAE,eAAe,EAAE;CAKjG;AAED,cAAc;AACd,qBAAa,WAAY,SAAQ,WAAW;gBACvB,WAAW,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM;CAIxD;AAED,cAAc;AACd,qBAAa,kBAAmB,SAAQ,WAAW;gBAC9B,OAAO,EAAE,MAAM;CAInC;AAED,cAAc;AACd,qBAAa,YAAa,SAAQ,WAAW;gBACxB,WAAW,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,WAAW,CAAC,EAAE,eAAe;CAIrG;AAED;;GAEG;AACH,qBAAa,cAAe,SAAQ,WAAW;;CAI9C"}

package/lib/esm/IModelError.js

@@ -5,7 +5,7 @@
 /** @packageDocumentation
  * @module iModels
  */
-import { BentleyError, IModelStatus, RepositoryStatus, } from "@itwin/core-bentley";
+import { BentleyError, IModelHubStatus, IModelStatus, } from "@itwin/core-bentley";
 export { BentleyStatus, BentleyError, IModelStatus, BriefcaseStatus, DbResult, ChangeSetStatus, } from "@itwin/core-bentley";
 /** The error type thrown by this module.
  * @see [[IModelErrorNumber]] for commonly-used error codes.
@@ -16,6 +16,31 @@ export class IModelError extends BentleyError {
         super(errorNumber, message, getMetaData);
     }
 }
+/** The state of a lock. See [Acquiring locks on elements.]($docs/learning/backend/ConcurrencyControl.md#acquiring-locks-on-elements).
+ * @public
+ */
+export var LockState;
+(function (LockState) {
+    /** The element is not locked */
+    LockState[LockState["None"] = 0] = "None";
+    /** Holding a shared lock on an element blocks other users from acquiring the Exclusive lock it. More than one user may acquire the shared lock. */
+    LockState[LockState["Shared"] = 1] = "Shared";
+    /** A Lock that permits modifications to an element and blocks other users from making modifications to it.
+     * Holding an exclusive lock on an "owner" (a model or a parent element), implicitly exclusively locks all its members.
+     */
+    LockState[LockState["Exclusive"] = 2] = "Exclusive";
+})(LockState || (LockState = {}));
+/**
+ * An error raised when there is a lock conflict detected.
+ * Typically this error would be thrown by [LockControl.acquireLocks]($backend) when you are requesting a lock on an element that is already held by another briefcase.
+ * @public
+ */
+export class ConflictingLocksError extends IModelError {
+    constructor(message, getMetaData, conflictingLocks) {
+        super(IModelHubStatus.LockOwnedByAnotherBriefcase, message, getMetaData);
+        this.conflictingLocks = conflictingLocks;
+    }
+}
 /** @public */
 export class ServerError extends IModelError {
     constructor(errorNumber, message) {
@@ -37,15 +62,6 @@ export class BackendError extends IModelError {
         this.name = name;
     }
 }
-/**
- * Channel constraint error
- * @alpha
- */
-export class ChannelConstraintError extends IModelError {
-    constructor(message, getMetaData) {
-        super(RepositoryStatus.ChannelConstraintViolation, message, getMetaData);
-    }
-}
 /** Intended for API "no content" semantics where the error case should not trigger application failure monitoring systems.
  * @public
  */

package/lib/esm/IModelError.js.map

@@ -1 +1 @@
-{"version":3,"file":"IModelError.js","sourceRoot":"","sources":["../../src/IModelError.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EACL,YAAY,EAA6D,YAAY,EAAmB,gBAAgB,GACzH,MAAM,qBAAqB,CAAC;AAE7B,OAAO,EACL,aAAa,EAAE,YAAY,EAAE,YAAY,EAAE,eAAe,EAAE,QAAQ,EAAE,eAAe,GACtF,MAAM,qBAAqB,CAAC;AAU7B;;;GAGG;AACH,MAAM,OAAO,WAAY,SAAQ,YAAY;IAC3C,YAAmB,WAAuC,EAAE,OAAe,EAAE,WAA6B;QACxG,KAAK,CAAC,WAAW,EAAE,OAAO,EAAE,WAAW,CAAC,CAAC;IAC3C,CAAC;CACF;AAED,cAAc;AACd,MAAM,OAAO,WAAY,SAAQ,WAAW;IAC1C,YAAmB,WAAmB,EAAE,OAAe;QACrD,KAAK,CAAC,WAAW,EAAE,OAAO,CAAC,CAAC;QAC5B,IAAI,CAAC,IAAI,GAAG,iBAAiB,WAAW,GAAG,CAAC;IAC9C,CAAC;CACF;AAED,cAAc;AACd,MAAM,OAAO,kBAAmB,SAAQ,WAAW;IACjD,YAAmB,OAAe;QAChC,KAAK,CAAC,YAAY,CAAC,aAAa,EAAE,OAAO,CAAC,CAAC;QAC3C,IAAI,CAAC,IAAI,GAAG,sBAAsB,CAAC;IACrC,CAAC;CACF;AAED,cAAc;AACd,MAAM,OAAO,YAAa,SAAQ,WAAW;IAC3C,YAAmB,WAAmB,EAAE,IAAY,EAAE,OAAe,EAAE,WAA6B;QAClG,KAAK,CAAC,WAAW,EAAE,OAAO,EAAE,WAAW,CAAC,CAAC;QACzC,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;IACnB,CAAC;CACF;AAED;;;GAGG;AACH,MAAM,OAAO,sBAAuB,SAAQ,WAAW;IACrD,YAAmB,OAAe,EAAE,WAA6B;QAC/D,KAAK,CAAC,gBAAgB,CAAC,0BAA0B,EAAE,OAAO,EAAE,WAAW,CAAC,CAAC;IAC3E,CAAC;CACF;AAED;;GAEG;AACH,MAAM,OAAO,cAAe,SAAQ,WAAW;IAC7C;QACE,KAAK,CAAC,YAAY,CAAC,SAAS,EAAE,YAAY,CAAC,CAAC;IAC9C,CAAC;CACF","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module iModels\n */\n\nimport {\n  BentleyError, BentleyStatus, BriefcaseStatus, ChangeSetStatus, DbResult, IModelStatus, LoggingMetaData, RepositoryStatus,\n} from \"@itwin/core-bentley\";\n\nexport {\n  BentleyStatus, BentleyError, IModelStatus, BriefcaseStatus, DbResult, ChangeSetStatus,\n} from \"@itwin/core-bentley\";\n\nexport type {GetMetaDataFunction, LogFunction, LoggingMetaData} from \"@itwin/core-bentley\";\n\n/** Numeric values for common errors produced by iTwin.js APIs, typically provided by [[IModelError]].\n * The values within each of these `enum`s are guaranteed not to conflict with one another.\n * @public\n */\nexport type IModelErrorNumber = IModelStatus | DbResult | BentleyStatus | BriefcaseStatus | ChangeSetStatus;\n\n/** The error type thrown by this module.\n * @see [[IModelErrorNumber]] for commonly-used error codes.\n * @public\n */\nexport class IModelError extends BentleyError {\n  public constructor(errorNumber: IModelErrorNumber | number, message: string, getMetaData?: LoggingMetaData) {\n    super(errorNumber, message, getMetaData);\n  }\n}\n\n/** @public */\nexport class ServerError extends IModelError {\n  public constructor(errorNumber: number, message: string) {\n    super(errorNumber, message);\n    this.name = `Server error (${errorNumber})`;\n  }\n}\n\n/** @public */\nexport class ServerTimeoutError extends ServerError {\n  public constructor(message: string) {\n    super(IModelStatus.ServerTimeout, message);\n    this.name = \"Server timeout error\";\n  }\n}\n\n/** @public */\nexport class BackendError extends IModelError {\n  public constructor(errorNumber: number, name: string, message: string, getMetaData?: LoggingMetaData) {\n    super(errorNumber, message, getMetaData);\n    this.name = name;\n  }\n}\n\n/**\n * Channel constraint error\n * @alpha\n */\nexport class ChannelConstraintError extends IModelError {\n  public constructor(message: string, getMetaData?: LoggingMetaData) {\n    super(RepositoryStatus.ChannelConstraintViolation, message, getMetaData);\n  }\n}\n\n/** Intended for API \"no content\" semantics where the error case should not trigger application failure monitoring systems.\n * @public\n */\nexport class NoContentError extends IModelError {\n  public constructor() {\n    super(IModelStatus.NoContent, \"No Content\");\n  }\n}\n"]}
+{"version":3,"file":"IModelError.js","sourceRoot":"","sources":["../../src/IModelError.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EACL,YAAY,EAA6D,eAAe,EAAE,YAAY,GACvG,MAAM,qBAAqB,CAAC;AAE7B,OAAO,EACL,aAAa,EAAE,YAAY,EAAE,YAAY,EAAE,eAAe,EAAE,QAAQ,EAAE,eAAe,GACtF,MAAM,qBAAqB,CAAC;AAU7B;;;GAGG;AACH,MAAM,OAAO,WAAY,SAAQ,YAAY;IAC3C,YAAmB,WAAuC,EAAE,OAAe,EAAE,WAA6B;QACxG,KAAK,CAAC,WAAW,EAAE,OAAO,EAAE,WAAW,CAAC,CAAC;IAC3C,CAAC;CACF;AAED;;GAEG;AACH,MAAM,CAAN,IAAY,SASX;AATD,WAAY,SAAS;IACnB,gCAAgC;IAChC,yCAAQ,CAAA;IACR,mJAAmJ;IACnJ,6CAAU,CAAA;IACV;;OAEG;IACH,mDAAa,CAAA;AACf,CAAC,EATW,SAAS,KAAT,SAAS,QASpB;AAkBD;;;;GAIG;AACH,MAAM,OAAO,qBAAsB,SAAQ,WAAW;IAEpD,YAAY,OAAe,EAAE,WAA6B,EAAE,gBAAoC;QAC9F,KAAK,CAAC,eAAe,CAAC,2BAA2B,EAAE,OAAO,EAAE,WAAW,CAAC,CAAC;QACzE,IAAI,CAAC,gBAAgB,GAAG,gBAAgB,CAAC;IAC3C,CAAC;CAEF;AAED,cAAc;AACd,MAAM,OAAO,WAAY,SAAQ,WAAW;IAC1C,YAAmB,WAAmB,EAAE,OAAe;QACrD,KAAK,CAAC,WAAW,EAAE,OAAO,CAAC,CAAC;QAC5B,IAAI,CAAC,IAAI,GAAG,iBAAiB,WAAW,GAAG,CAAC;IAC9C,CAAC;CACF;AAED,cAAc;AACd,MAAM,OAAO,kBAAmB,SAAQ,WAAW;IACjD,YAAmB,OAAe;QAChC,KAAK,CAAC,YAAY,CAAC,aAAa,EAAE,OAAO,CAAC,CAAC;QAC3C,IAAI,CAAC,IAAI,GAAG,sBAAsB,CAAC;IACrC,CAAC;CACF;AAED,cAAc;AACd,MAAM,OAAO,YAAa,SAAQ,WAAW;IAC3C,YAAmB,WAAmB,EAAE,IAAY,EAAE,OAAe,EAAE,WAA6B;QAClG,KAAK,CAAC,WAAW,EAAE,OAAO,EAAE,WAAW,CAAC,CAAC;QACzC,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;IACnB,CAAC;CACF;AAED;;GAEG;AACH,MAAM,OAAO,cAAe,SAAQ,WAAW;IAC7C;QACE,KAAK,CAAC,YAAY,CAAC,SAAS,EAAE,YAAY,CAAC,CAAC;IAC9C,CAAC;CACF","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module iModels\n */\n\nimport {\n  BentleyError, BentleyStatus, BriefcaseStatus, ChangeSetStatus, DbResult, IModelHubStatus, IModelStatus, LoggingMetaData,\n} from \"@itwin/core-bentley\";\n\nexport {\n  BentleyStatus, BentleyError, IModelStatus, BriefcaseStatus, DbResult, ChangeSetStatus,\n} from \"@itwin/core-bentley\";\n\nexport type {GetMetaDataFunction, LogFunction, LoggingMetaData} from \"@itwin/core-bentley\";\n\n/** Numeric values for common errors produced by iTwin.js APIs, typically provided by [[IModelError]].\n * The values within each of these `enum`s are guaranteed not to conflict with one another.\n * @public\n */\nexport type IModelErrorNumber = IModelStatus | DbResult | BentleyStatus | BriefcaseStatus | ChangeSetStatus;\n\n/** The error type thrown by this module.\n * @see [[IModelErrorNumber]] for commonly-used error codes.\n * @public\n */\nexport class IModelError extends BentleyError {\n  public constructor(errorNumber: IModelErrorNumber | number, message: string, getMetaData?: LoggingMetaData) {\n    super(errorNumber, message, getMetaData);\n  }\n}\n\n/** The state of a lock. See [Acquiring locks on elements.]($docs/learning/backend/ConcurrencyControl.md#acquiring-locks-on-elements).\n * @public\n */\nexport enum LockState {\n  /** The element is not locked */\n  None = 0,\n  /** Holding a shared lock on an element blocks other users from acquiring the Exclusive lock it. More than one user may acquire the shared lock. */\n  Shared = 1,\n  /** A Lock that permits modifications to an element and blocks other users from making modifications to it.\n   * Holding an exclusive lock on an \"owner\" (a model or a parent element), implicitly exclusively locks all its members.\n   */\n  Exclusive = 2,\n}\n\n/** Detailed information about a particular object Lock that is causing the Lock update conflict.\n * An example of a lock update conflict would be attempting to use [LockControl.acquireLocks]($backend) on an object that is already locked by another Briefcase.\n * @public\n*/\nexport interface ConflictingLock {\n  /** Id of the object that is causing conflict. */\n  objectId: string;\n  /**\n     * The level of conflicting lock. Possible values are {@link LockState.Shared}, {@link LockState.Exclusive}.\n     * See {@link LockState}.\n     */\n  state: LockState;\n  /** An array of Briefcase ids that hold this lock. */\n  briefcaseIds: number[];\n}\n\n/**\n * An error raised when there is a lock conflict detected.\n * Typically this error would be thrown by [LockControl.acquireLocks]($backend) when you are requesting a lock on an element that is already held by another briefcase.\n * @public\n */\nexport class ConflictingLocksError extends IModelError {\n  public conflictingLocks?: ConflictingLock[];\n  constructor(message: string, getMetaData?: LoggingMetaData, conflictingLocks?: ConflictingLock[]) {\n    super(IModelHubStatus.LockOwnedByAnotherBriefcase, message, getMetaData);\n    this.conflictingLocks = conflictingLocks;\n  }\n\n}\n\n/** @public */\nexport class ServerError extends IModelError {\n  public constructor(errorNumber: number, message: string) {\n    super(errorNumber, message);\n    this.name = `Server error (${errorNumber})`;\n  }\n}\n\n/** @public */\nexport class ServerTimeoutError extends ServerError {\n  public constructor(message: string) {\n    super(IModelStatus.ServerTimeout, message);\n    this.name = \"Server timeout error\";\n  }\n}\n\n/** @public */\nexport class BackendError extends IModelError {\n  public constructor(errorNumber: number, name: string, message: string, getMetaData?: LoggingMetaData) {\n    super(errorNumber, message, getMetaData);\n    this.name = name;\n  }\n}\n\n/** Intended for API \"no content\" semantics where the error case should not trigger application failure monitoring systems.\n * @public\n */\nexport class NoContentError extends IModelError {\n  public constructor() {\n    super(IModelStatus.NoContent, \"No Content\");\n  }\n}\n"]}

package/lib/esm/PlanarClipMask.d.ts

@@ -12,15 +12,24 @@ export declare enum PlanarClipMaskMode {
     /** Mask based on priority. Different types of models have different default priorities as enumerated by [[PlanarClipMaskPriority]].
      * For example, background maps have the lowest priority, so they are masked by all other types, while design models have the highest priority and are therefore never masked.
      * The priority of a reality model can be overridden by [[PlanarClipMaskSettings.priority]]. This is useful to allow one reality model to mask another overlapping one.
+     * Everything visible in the view creates the mask, so turning off models, categories, or elements (via fully transparent overrides) will make things not be in the mask.
      */
     Priority = 1,
-    /** Indicates that masks should be produced from the geometry in a set of [GeometricModel]($backend)s. */
+    /** Indicates that masks should be produced from the geometry in a set of [GeometricModel]($backend)s, regardless of what model is on or off in the view.
+     * However, things that are off from category settings or element feature overrides in the view will not be in the mask for these models.
+     */
     Models = 2,
-    /** Indicates that masks should be produced from geometry belonging to a set of subcategories. */
+    /** Indicates that masks should be produced from geometry belonging to a set of subcategories.
+     * View settings do not affect what is in the mask, unless [[PlanarClipMaskSettings.subCategoryOrElementIds]] is undefined, in which case it behaves like Models mode.
+     */
     IncludeSubCategories = 3,
-    /** Indicates that masks should be produced from the geometry of a set of [GeometricElement]($backend)s. */
+    /** Indicates that masks should be produced from the geometry of a set of [GeometricElement]($backend)s.
+     * View settings do not affect what is in the mask, unless [[PlanarClipMaskSettings.subCategoryOrElementIds]] is undefined, in which case it behaves like Models mode.
+     */
     IncludeElements = 4,
-    /** Indicates that masks should be produced from the geometry of all [GeometricElement]($backend)s in a view, **except** for a specified set of excluded elements. */
+    /** Indicates that masks should be produced from the geometry of all [GeometricElement]($backend)s in a view, **except** for a specified set of excluded elements.
+     * View settings do not affect what is in the mask, unless [[PlanarClipMaskSettings.subCategoryOrElementIds]] is undefined, in which case it behaves like Models mode.
+     */
     ExcludeElements = 5
 }
 /** The default priority values for a [[PlanarClipMaskSettings]], based on model type. Models with a lower priority are masked by models with a higher priority.
@@ -136,13 +145,14 @@ export interface PriorityPlanarClipMaskArgs extends BasicPlanarClipMaskArgs {
 export declare class PlanarClipMaskSettings {
     /** Specifies how the mask geometry is produced. */
     readonly mode: PlanarClipMaskMode;
-    /** For any mode other than [[PlanarClipMaskMode.Priority]], the Ids of the [GeometricModel]($backend)s containing the geometry used to produce the mask.
-     * If `undefined`, the set of all models in the view's [ModelSelector]($backend) is used.
+    /** For any mode other than [[PlanarClipMaskMode.Priority]], the Ids of the [GeometricModel]($backend)s containing the geometry used to produce the mask,
+     * and if `undefined`, no mask geometry will be created.
      * The mask geometry can be filtered by [[subCategoryOrElementIds]].
      */
     readonly modelIds?: OrderedId64Iterable;
     /** For [[PlanarClipMaskMode.IncludeElements]] or [[PlanarClipMaskMode.ExcludedElements]], the Ids of the [GeometricElement]($backend)s to include or exclude from masking;
      * for [[PlanarClipMaskMode.IncludeSubCategories]], the Ids of the subcategories whose geometry contributes to the mask.
+     * If undefined, Modes IncludeSubCategories, IncludeElements, and ExcludeElements behave like Models mode.
      */
     readonly subCategoryOrElementIds?: OrderedId64Iterable;
     /** For [[PlanarClipMaskMode.Priority]], the priority value. */

package/lib/esm/PlanarClipMask.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"PlanarClipMask.d.ts","sourceRoot":"","sources":["../../src/PlanarClipMask.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,iBAAiB,EAAE,UAAU,EAAE,mBAAmB,EAAE,MAAM,qBAAqB,CAAC;AAEzF;;;GAGG;AACH,oBAAY,kBAAkB;IAC5B,kBAAkB;IAClB,IAAI,IAAI;IACR;;;OAGG;IACH,QAAQ,IAAI;IACZ,yGAAyG;IACzG,MAAM,IAAI;IACV,iGAAiG;IACjG,oBAAoB,IAAI;IACxB,2GAA2G;IAC3G,eAAe,IAAI;IACnB,qKAAqK;IACrK,eAAe,IAAI;CACpB;AAED;;;;GAIG;AACH,oBAAY,sBAAsB;IAChC,sBAAsB;IACtB,aAAa,QAAQ;IACrB,6EAA6E;IAC7E,kBAAkB,QAAQ;IAC1B,4CAA4C;IAC5C,YAAY,IAAI;IAChB,yDAAyD;IACzD,WAAW,OAAO;CACnB;AAED;;;;GAIG;AACH,MAAM,WAAW,mBAAmB;IAClC,kDAAkD;IAClD,IAAI,EAAE,kBAAkB,CAAC;IACzB,+CAA+C;IAC/C,QAAQ,CAAC,EAAE,iBAAiB,CAAC;IAC7B,8DAA8D;IAC9D,uBAAuB,CAAC,EAAE,iBAAiB,CAAC;IAC5C,+CAA+C;IAC/C,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,mDAAmD;IACnD,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,wCAAwC;IACxC,MAAM,CAAC,EAAE,OAAO,CAAC;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC,mDAAmD;IACnD,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,6CAA6C;IAC7C,MAAM,CAAC,EAAE,OAAO,CAAC;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,uBAAwB,SAAQ,uBAAuB;IACtE,+CAA+C;IAC/C,QAAQ,CAAC,EAAE,QAAQ,CAAC,UAAU,CAAC,CAAC;IAChC,gBAAgB;IAChB,OAAO,CAAC,EAAE,KAAK,CAAC;IAChB,gBAAgB;IAChB,UAAU,CAAC,EAAE,KAAK,CAAC;IACnB,gBAAgB;IAChB,cAAc,CAAC,EAAE,KAAK,CAAC;IACvB,gBAAgB;IAChB,QAAQ,CAAC,EAAE,KAAK,CAAC;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,yBAA0B,SAAQ,uBAAuB;IACxE,+CAA+C;IAC/C,QAAQ,CAAC,EAAE,QAAQ,CAAC,UAAU,CAAC,CAAC;IAChC,8FAA8F;IAC9F,UAAU,EAAE,QAAQ,CAAC,UAAU,CAAC,CAAC;IACjC,4HAA4H;IAC5H,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,gBAAgB;IAChB,cAAc,CAAC,EAAE,KAAK,CAAC;IACvB,gBAAgB;IAChB,QAAQ,CAAC,EAAE,KAAK,CAAC;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,6BAA8B,SAAQ,uBAAuB;IAC5E,+CAA+C;IAC/C,QAAQ,CAAC,EAAE,QAAQ,CAAC,UAAU,CAAC,CAAC;IAChC,mGAAmG;IACnG,cAAc,EAAE,QAAQ,CAAC,UAAU,CAAC,CAAC;IACrC,gBAAgB;IAChB,OAAO,CAAC,EAAE,KAAK,CAAC;IAChB,gBAAgB;IAChB,UAAU,CAAC,EAAE,KAAK,CAAC;IACnB,gBAAgB;IAChB,QAAQ,CAAC,EAAE,KAAK,CAAC;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,0BAA2B,SAAQ,uBAAuB;IACzE,+CAA+C;IAC/C,QAAQ,EAAE,MAAM,CAAC;IACjB,gBAAgB;IAChB,OAAO,CAAC,EAAE,KAAK,CAAC;IAChB,gBAAgB;IAChB,UAAU,CAAC,EAAE,KAAK,CAAC;IACnB,gBAAgB;IAChB,QAAQ,CAAC,EAAE,KAAK,CAAC;CAClB;AAED;;;;;;;;GAQG;AACH,qBAAa,sBAAsB;IACjC,mDAAmD;IACnD,SAAgB,IAAI,EAAE,kBAAkB,CAAC;IACzC;;;OAGG;IACH,SAAgB,QAAQ,CAAC,EAAE,mBAAmB,CAAC;IAC/C;;OAEG;IACH,SAAgB,uBAAuB,CAAC,EAAE,mBAAmB,CAAC;IAC9D,+DAA+D;IAC/D,SAAgB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClC;;OAEG;IACH,SAAgB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtC,iMAAiM;IACjM,SAAgB,MAAM,EAAE,OAAO,CAAC;IAChC,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAoB;IAC/C,OAAO,CAAC,QAAQ,CAAC,wBAAwB,CAAC,CAAoB;IAE9D,qDAAqD;IACrD,IAAW,kBAAkB,IAAI,iBAAiB,GAAG,SAAS,CAE7D;IAED,mFAAmF;WACrE,QAAQ,CAAC,IAAI,CAAC,EAAE,mBAAmB,GAAG,sBAAsB;IAO1E,2CAA2C;WAC7B,MAAM,CAAC,IAAI,EAAE,uBAAuB,GAAG,yBAAyB,GAAG,6BAA6B,GAAG,0BAA0B,GAAG,sBAAsB;IAYpK,sEAAsE;IAC/D,MAAM,IAAI,mBAAmB;IAoBpC,0CAA0C;IAC1C,IAAW,OAAO,IAAI,OAAO,CAE5B;IAEM,MAAM,CAAC,KAAK,EAAE,sBAAsB,GAAG,OAAO;IASrD;;;OAGG;IACI,KAAK,CAAC,YAAY,CAAC,EAAE,mBAAmB,GAAG,sBAAsB;IAUxE,OAAO;IAeP,oDAAoD;IACpD,OAAc,QAAQ,yBAAuD;CAC9E"}
+{"version":3,"file":"PlanarClipMask.d.ts","sourceRoot":"","sources":["../../src/PlanarClipMask.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,iBAAiB,EAAE,UAAU,EAAE,mBAAmB,EAAE,MAAM,qBAAqB,CAAC;AAEzF;;;GAGG;AACH,oBAAY,kBAAkB;IAC5B,kBAAkB;IAClB,IAAI,IAAI;IACR;;;;OAIG;IACH,QAAQ,IAAI;IACZ;;OAEG;IACH,MAAM,IAAI;IACV;;OAEG;IACH,oBAAoB,IAAI;IACxB;;OAEG;IACH,eAAe,IAAI;IACnB;;OAEG;IACH,eAAe,IAAI;CACpB;AAED;;;;GAIG;AACH,oBAAY,sBAAsB;IAChC,sBAAsB;IACtB,aAAa,QAAQ;IACrB,6EAA6E;IAC7E,kBAAkB,QAAQ;IAC1B,4CAA4C;IAC5C,YAAY,IAAI;IAChB,yDAAyD;IACzD,WAAW,OAAO;CACnB;AAED;;;;GAIG;AACH,MAAM,WAAW,mBAAmB;IAClC,kDAAkD;IAClD,IAAI,EAAE,kBAAkB,CAAC;IACzB,+CAA+C;IAC/C,QAAQ,CAAC,EAAE,iBAAiB,CAAC;IAC7B,8DAA8D;IAC9D,uBAAuB,CAAC,EAAE,iBAAiB,CAAC;IAC5C,+CAA+C;IAC/C,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,mDAAmD;IACnD,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,wCAAwC;IACxC,MAAM,CAAC,EAAE,OAAO,CAAC;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC,mDAAmD;IACnD,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,6CAA6C;IAC7C,MAAM,CAAC,EAAE,OAAO,CAAC;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,uBAAwB,SAAQ,uBAAuB;IACtE,+CAA+C;IAC/C,QAAQ,CAAC,EAAE,QAAQ,CAAC,UAAU,CAAC,CAAC;IAChC,gBAAgB;IAChB,OAAO,CAAC,EAAE,KAAK,CAAC;IAChB,gBAAgB;IAChB,UAAU,CAAC,EAAE,KAAK,CAAC;IACnB,gBAAgB;IAChB,cAAc,CAAC,EAAE,KAAK,CAAC;IACvB,gBAAgB;IAChB,QAAQ,CAAC,EAAE,KAAK,CAAC;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,yBAA0B,SAAQ,uBAAuB;IACxE,+CAA+C;IAC/C,QAAQ,CAAC,EAAE,QAAQ,CAAC,UAAU,CAAC,CAAC;IAChC,8FAA8F;IAC9F,UAAU,EAAE,QAAQ,CAAC,UAAU,CAAC,CAAC;IACjC,4HAA4H;IAC5H,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,gBAAgB;IAChB,cAAc,CAAC,EAAE,KAAK,CAAC;IACvB,gBAAgB;IAChB,QAAQ,CAAC,EAAE,KAAK,CAAC;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,6BAA8B,SAAQ,uBAAuB;IAC5E,+CAA+C;IAC/C,QAAQ,CAAC,EAAE,QAAQ,CAAC,UAAU,CAAC,CAAC;IAChC,mGAAmG;IACnG,cAAc,EAAE,QAAQ,CAAC,UAAU,CAAC,CAAC;IACrC,gBAAgB;IAChB,OAAO,CAAC,EAAE,KAAK,CAAC;IAChB,gBAAgB;IAChB,UAAU,CAAC,EAAE,KAAK,CAAC;IACnB,gBAAgB;IAChB,QAAQ,CAAC,EAAE,KAAK,CAAC;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,0BAA2B,SAAQ,uBAAuB;IACzE,+CAA+C;IAC/C,QAAQ,EAAE,MAAM,CAAC;IACjB,gBAAgB;IAChB,OAAO,CAAC,EAAE,KAAK,CAAC;IAChB,gBAAgB;IAChB,UAAU,CAAC,EAAE,KAAK,CAAC;IACnB,gBAAgB;IAChB,QAAQ,CAAC,EAAE,KAAK,CAAC;CAClB;AAED;;;;;;;;GAQG;AACH,qBAAa,sBAAsB;IACjC,mDAAmD;IACnD,SAAgB,IAAI,EAAE,kBAAkB,CAAC;IACzC;;;OAGG;IACH,SAAgB,QAAQ,CAAC,EAAE,mBAAmB,CAAC;IAC/C;;;OAGG;IACH,SAAgB,uBAAuB,CAAC,EAAE,mBAAmB,CAAC;IAC9D,+DAA+D;IAC/D,SAAgB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClC;;OAEG;IACH,SAAgB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtC,iMAAiM;IACjM,SAAgB,MAAM,EAAE,OAAO,CAAC;IAChC,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAoB;IAC/C,OAAO,CAAC,QAAQ,CAAC,wBAAwB,CAAC,CAAoB;IAE9D,qDAAqD;IACrD,IAAW,kBAAkB,IAAI,iBAAiB,GAAG,SAAS,CAE7D;IAED,mFAAmF;WACrE,QAAQ,CAAC,IAAI,CAAC,EAAE,mBAAmB,GAAG,sBAAsB;IAO1E,2CAA2C;WAC7B,MAAM,CAAC,IAAI,EAAE,uBAAuB,GAAG,yBAAyB,GAAG,6BAA6B,GAAG,0BAA0B,GAAG,sBAAsB;IAYpK,sEAAsE;IAC/D,MAAM,IAAI,mBAAmB;IAoBpC,0CAA0C;IAC1C,IAAW,OAAO,IAAI,OAAO,CAE5B;IAEM,MAAM,CAAC,KAAK,EAAE,sBAAsB,GAAG,OAAO;IASrD;;;OAGG;IACI,KAAK,CAAC,YAAY,CAAC,EAAE,mBAAmB,GAAG,sBAAsB;IAUxE,OAAO;IAeP,oDAAoD;IACpD,OAAc,QAAQ,yBAAuD;CAC9E"}

package/lib/esm/PlanarClipMask.js

@@ -17,15 +17,24 @@ export var PlanarClipMaskMode;
     /** Mask based on priority. Different types of models have different default priorities as enumerated by [[PlanarClipMaskPriority]].
      * For example, background maps have the lowest priority, so they are masked by all other types, while design models have the highest priority and are therefore never masked.
      * The priority of a reality model can be overridden by [[PlanarClipMaskSettings.priority]]. This is useful to allow one reality model to mask another overlapping one.
+     * Everything visible in the view creates the mask, so turning off models, categories, or elements (via fully transparent overrides) will make things not be in the mask.
      */
     PlanarClipMaskMode[PlanarClipMaskMode["Priority"] = 1] = "Priority";
-    /** Indicates that masks should be produced from the geometry in a set of [GeometricModel]($backend)s. */
+    /** Indicates that masks should be produced from the geometry in a set of [GeometricModel]($backend)s, regardless of what model is on or off in the view.
+     * However, things that are off from category settings or element feature overrides in the view will not be in the mask for these models.
+     */
     PlanarClipMaskMode[PlanarClipMaskMode["Models"] = 2] = "Models";
-    /** Indicates that masks should be produced from geometry belonging to a set of subcategories. */
+    /** Indicates that masks should be produced from geometry belonging to a set of subcategories.
+     * View settings do not affect what is in the mask, unless [[PlanarClipMaskSettings.subCategoryOrElementIds]] is undefined, in which case it behaves like Models mode.
+     */
     PlanarClipMaskMode[PlanarClipMaskMode["IncludeSubCategories"] = 3] = "IncludeSubCategories";
-    /** Indicates that masks should be produced from the geometry of a set of [GeometricElement]($backend)s. */
+    /** Indicates that masks should be produced from the geometry of a set of [GeometricElement]($backend)s.
+     * View settings do not affect what is in the mask, unless [[PlanarClipMaskSettings.subCategoryOrElementIds]] is undefined, in which case it behaves like Models mode.
+     */
     PlanarClipMaskMode[PlanarClipMaskMode["IncludeElements"] = 4] = "IncludeElements";
-    /** Indicates that masks should be produced from the geometry of all [GeometricElement]($backend)s in a view, **except** for a specified set of excluded elements. */
+    /** Indicates that masks should be produced from the geometry of all [GeometricElement]($backend)s in a view, **except** for a specified set of excluded elements.
+     * View settings do not affect what is in the mask, unless [[PlanarClipMaskSettings.subCategoryOrElementIds]] is undefined, in which case it behaves like Models mode.
+     */
     PlanarClipMaskMode[PlanarClipMaskMode["ExcludeElements"] = 5] = "ExcludeElements";
 })(PlanarClipMaskMode || (PlanarClipMaskMode = {}));
 /** The default priority values for a [[PlanarClipMaskSettings]], based on model type. Models with a lower priority are masked by models with a higher priority.

package/lib/esm/PlanarClipMask.js.map

@@ -1 +1 @@
-{"version":3,"file":"PlanarClipMask.js","sourceRoot":"","sources":["../../src/PlanarClipMask.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAE,iBAAiB,EAAmC,MAAM,qBAAqB,CAAC;AAEzF;;;GAGG;AACH,MAAM,CAAN,IAAY,kBAgBX;AAhBD,WAAY,kBAAkB;IAC5B,kBAAkB;IAClB,2DAAQ,CAAA;IACR;;;OAGG;IACH,mEAAY,CAAA;IACZ,yGAAyG;IACzG,+DAAU,CAAA;IACV,iGAAiG;IACjG,2FAAwB,CAAA;IACxB,2GAA2G;IAC3G,iFAAmB,CAAA;IACnB,qKAAqK;IACrK,iFAAmB,CAAA;AACrB,CAAC,EAhBW,kBAAkB,KAAlB,kBAAkB,QAgB7B;AAED;;;;GAIG;AACH,MAAM,CAAN,IAAY,sBASX;AATD,WAAY,sBAAsB;IAChC,sBAAsB;IACtB,yFAAqB,CAAA;IACrB,6EAA6E;IAC7E,mGAA0B,CAAA;IAC1B,4CAA4C;IAC5C,mFAAgB,CAAA;IAChB,yDAAyD;IACzD,oFAAkB,CAAA;AACpB,CAAC,EATW,sBAAsB,KAAtB,sBAAsB,QASjC;AA8FD;;;;;;;;GAQG;AACH,MAAM,OAAO,sBAAsB;IAuBjC,qDAAqD;IACrD,IAAW,kBAAkB;QAC3B,OAAO,IAAI,CAAC,SAAS,CAAC;IACxB,CAAC;IAED,mFAAmF;IAC5E,MAAM,CAAC,QAAQ,CAAC,IAA0B;QAC/C,IAAI,CAAC,IAAI,IAAI,SAAS,KAAK,IAAI,CAAC,IAAI;YAClC,OAAO,IAAI,CAAC,QAAQ,CAAC;QAEvB,OAAO,IAAI,sBAAsB,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,YAAY,EAAE,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,uBAAuB,EAAE,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;IAC3I,CAAC;IAED,2CAA2C;IACpC,MAAM,CAAC,MAAM,CAAC,IAAsH;QACzI,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,iBAAiB,CAAC,eAAe,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QAC9F,IAAI,SAAS,KAAK,IAAI,CAAC,QAAQ;YAC7B,OAAO,IAAI,sBAAsB,CAAC,kBAAkB,CAAC,QAAQ,EAAE,IAAI,CAAC,YAAY,EAAE,SAAS,EAAE,SAAS,EAAE,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;aACjI,IAAI,SAAS,KAAK,IAAI,CAAC,cAAc;YACxC,OAAO,IAAI,sBAAsB,CAAC,kBAAkB,CAAC,oBAAoB,EAAE,IAAI,CAAC,YAAY,EAAE,QAAQ,EAAE,iBAAiB,CAAC,eAAe,CAAC,IAAI,CAAC,cAAc,CAAC,EAAE,SAAS,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;aACrL,IAAI,SAAS,KAAK,IAAI,CAAC,UAAU;YACpC,OAAO,IAAI,sBAAsB,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,kBAAkB,CAAC,eAAe,CAAC,CAAC,CAAC,kBAAkB,CAAC,eAAe,EAAE,IAAI,CAAC,YAAY,EAAE,QAAQ,EAAE,iBAAiB,CAAC,eAAe,CAAC,IAAI,CAAC,UAAU,CAAC,EAAE,SAAS,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;;YAEnO,OAAO,IAAI,sBAAsB,CAAC,kBAAkB,CAAC,MAAM,EAAE,IAAI,CAAC,YAAY,EAAE,QAAQ,EAAE,SAAS,EAAE,SAAS,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;IACjI,CAAC;IAED,sEAAsE;IAC/D,MAAM;QACX,MAAM,KAAK,GAAwB,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,CAAC;QACvD,IAAI,SAAS,KAAK,IAAI,CAAC,SAAS;YAC9B,KAAK,CAAC,QAAQ,GAAG,IAAI,CAAC,SAAS,CAAC;QAElC,IAAI,SAAS,KAAK,IAAI,CAAC,wBAAwB;YAC7C,KAAK,CAAC,uBAAuB,GAAG,IAAI,CAAC,wBAAwB,CAAC;QAEhE,IAAI,SAAS,KAAK,IAAI,CAAC,QAAQ;YAC7B,KAAK,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC;QAEjC,IAAI,SAAS,KAAK,IAAI,CAAC,YAAY;YACjC,KAAK,CAAC,YAAY,GAAG,IAAI,CAAC,YAAY,CAAC;QAEzC,IAAI,IAAI,CAAC,MAAM;YACb,KAAK,CAAC,MAAM,GAAG,IAAI,CAAC;QAEtB,OAAO,KAAK,CAAC;IACf,CAAC;IAED,0CAA0C;IAC1C,IAAW,OAAO;QAChB,OAAO,IAAI,CAAC,IAAI,KAAK,kBAAkB,CAAC,IAAI,CAAC;IAC/C,CAAC;IAEM,MAAM,CAAC,KAA6B;QACzC,OAAO,IAAI,CAAC,IAAI,KAAK,KAAK,CAAC,IAAI;YAC7B,IAAI,CAAC,QAAQ,KAAK,KAAK,CAAC,QAAQ;YAChC,IAAI,CAAC,YAAY,KAAK,KAAK,CAAC,YAAY;YACxC,IAAI,CAAC,MAAM,KAAK,KAAK,CAAC,MAAM;YAC5B,IAAI,CAAC,SAAS,KAAK,KAAK,CAAC,SAAS;YAClC,IAAI,CAAC,wBAAwB,KAAK,KAAK,CAAC,wBAAwB,CAAC;IACrE,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,YAAkC;QAC7C,IAAI,SAAS,KAAK,YAAY;YAC5B,OAAO,IAAI,CAAC;QAEd,OAAO,sBAAsB,CAAC,QAAQ,CAAC;YACrC,GAAG,IAAI,CAAC,MAAM,EAAE;YAChB,GAAG,YAAY;SAChB,CAAC,CAAC;IACL,CAAC;IAED,YAAoB,IAAwB,EAAE,YAAqB,EAAE,QAA4B,EAAE,uBAA2C,EAAE,QAAiB,EAAE,MAAgB;QACjL,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,SAAS,GAAG,QAAQ,CAAC;QAC1B,IAAI,CAAC,wBAAwB,GAAG,uBAAuB,CAAC;QACxD,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QACzB,IAAI,CAAC,MAAM,GAAG,IAAI,KAAK,MAAM,CAAC;QAC9B,IAAI,CAAC,YAAY,GAAG,SAAS,KAAK,YAAY,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QAEpG,IAAI,QAAQ;YACV,IAAI,CAAC,QAAQ,GAAG,iBAAiB,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;QAEvD,IAAI,uBAAuB;YACzB,IAAI,CAAC,uBAAuB,GAAG,iBAAiB,CAAC,QAAQ,CAAC,uBAAuB,CAAC,CAAC;IACvF,CAAC;;AAED,oDAAoD;AACtC,+BAAQ,GAAG,IAAI,sBAAsB,CAAC,kBAAkB,CAAC,IAAI,CAAC,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module DisplayStyles\n */\n\nimport { CompressedId64Set, Id64String, OrderedId64Iterable } from \"@itwin/core-bentley\";\n\n/** The different modes by which a [[PlanarClipMaskSettings]] collects the geometry used to mask a model.\n * @public\n * @extensions\n */\nexport enum PlanarClipMaskMode {\n  /** No masking. */\n  None = 0,\n  /** Mask based on priority. Different types of models have different default priorities as enumerated by [[PlanarClipMaskPriority]].\n   * For example, background maps have the lowest priority, so they are masked by all other types, while design models have the highest priority and are therefore never masked.\n   * The priority of a reality model can be overridden by [[PlanarClipMaskSettings.priority]]. This is useful to allow one reality model to mask another overlapping one.\n   */\n  Priority = 1,\n  /** Indicates that masks should be produced from the geometry in a set of [GeometricModel]($backend)s. */\n  Models = 2,\n  /** Indicates that masks should be produced from geometry belonging to a set of subcategories. */\n  IncludeSubCategories = 3,\n  /** Indicates that masks should be produced from the geometry of a set of [GeometricElement]($backend)s. */\n  IncludeElements = 4,\n  /** Indicates that masks should be produced from the geometry of all [GeometricElement]($backend)s in a view, **except** for a specified set of excluded elements. */\n  ExcludeElements = 5,\n}\n\n/** The default priority values for a [[PlanarClipMaskSettings]], based on model type. Models with a lower priority are masked by models with a higher priority.\n * The default can be overridden by [[PlanarClipMaskSettings.priority]].\n *  @public\n * @extensions\n */\nexport enum PlanarClipMaskPriority {\n  /** Background map. */\n  BackgroundMap = -2048,\n  /** A reality model that spans the globe - e.g., OpenStreetMaps Buildings. */\n  GlobalRealityModel = -1024,\n  /** A reality model with a bounded range. */\n  RealityModel = 0,\n  /** A design model stored in the [IModelDb]($backend). */\n  DesignModel = 2048,\n}\n\n/** JSON representation of a [[PlanarClipMaskSettings]].\n * @see [[DisplayStyleSettingsProps.planarClipOvr]] and [[ContextRealityModelProps.planarClipMask]].\n * @public\n * @extensions\n */\nexport interface PlanarClipMaskProps {\n  /** Controls how the mask geometry is collected */\n  mode: PlanarClipMaskMode;\n  /** See [[PlanarClipMaskSettings.modelIds]]. */\n  modelIds?: CompressedId64Set;\n  /** See [[PlanarClipMaskSettings.subCategoryOrElementIds]]. */\n  subCategoryOrElementIds?: CompressedId64Set;\n  /** See [[PlanarClipMaskSettings.priority]]. */\n  priority?: number;\n  /** See [[PlanarClipMaskSettings.transparency]]. */\n  transparency?: number;\n  /** See PlanarClipMaskSettings.invert */\n  invert?: boolean;\n}\n\n/** Basic arguments supplied to [[PlanarClipMaskSettings.create]].\n * @public\n */\nexport interface BasicPlanarClipMaskArgs {\n  /** See [[PlanarClipMaskSettings.transparency]]. */\n  transparency?: number;\n  /** See [[PlanarClipMaskSettings.invert]]. */\n  invert?: boolean;\n}\n\n/** Arguments supplied to [[PlanarClipMaskSettings.create]] to create a mask of [[PlanarClipMaskMode.Models]].\n * @public\n */\nexport interface ModelPlanarClipMaskArgs extends BasicPlanarClipMaskArgs {\n  /** See [[PlanarClipMaskSettings.modelIds]]. */\n  modelIds?: Iterable<Id64String>;\n  /** @internal */\n  exclude?: never;\n  /** @internal */\n  elementIds?: never;\n  /** @internal */\n  subCategoryIds?: never;\n  /** @internal */\n  priority?: never;\n}\n\n/** Arguments supplied to [[PlanarClipMaskSettings.create]] to create a mask of [[PlanarClipMaskMode.IncludeElements]] or [[PlanarClipMaskMode.ExcludeElements]].\n * @public\n */\nexport interface ElementPlanarClipMaskArgs extends BasicPlanarClipMaskArgs {\n  /** See [[PlanarClipMaskSettings.modelIds]]. */\n  modelIds?: Iterable<Id64String>;\n  /** The elements used by the mask. @see [[PlanarClipMaskSettings.subCategoryOrElementIds]]. */\n  elementIds: Iterable<Id64String>;\n  /** If true, creates a mask of [[PlanarClipMaskMode.ExcludeElements]]; otherwise, [[PlanarClipMaskMode.IncludeElements]]. */\n  exclude?: boolean;\n  /** @internal */\n  subCategoryIds?: never;\n  /** @internal */\n  priority?: never;\n}\n\n/** Arguments supplied to [[PlanarClipMaskSettings.create]] to create a mask of [[PlanarClipMaskMode.IncludeSubCategories]].\n * @public\n */\nexport interface SubCategoryPlanarClipMaskArgs extends BasicPlanarClipMaskArgs {\n  /** See [[PlanarClipMaskSettings.modelIds]]. */\n  modelIds?: Iterable<Id64String>;\n  /** The subcategories used by the mask. @see [[PlanarClipMaskSettings.subCategoryOrElementIds]]. */\n  subCategoryIds: Iterable<Id64String>;\n  /** @internal */\n  exclude?: never;\n  /** @internal */\n  elementIds?: never;\n  /** @internal */\n  priority?: never;\n}\n\n/** Arguments supplied to [[PlanarClipMaskSettings.create]] to create a mask of [[PlanarClipMaskMode.Priority]].\n * @public\n */\nexport interface PriorityPlanarClipMaskArgs extends BasicPlanarClipMaskArgs {\n  /** See [[PlanarClipMaskSettings.priority]]. */\n  priority: number;\n  /** @internal */\n  exclude?: never;\n  /** @internal */\n  elementIds?: never;\n  /** @internal */\n  modelIds?: never;\n}\n\n/** Describes how to mask the geometry of one [GeometricModel]($backend) for display. The mask is produced by projecting geometry from any number of other models -\n * optionally filtered by [SubCategory]($backend) or by a set of specific [GeometricElement]($backend)s - onto a plane. Regions of the masked model that intersect the\n * mask are rendered partially or completely transparent. This is useful for, e.g., making subsurface geometry visible below the background map, or clipping out portions\n * of a reality model that intersect a design model.\n * @note Currently reality models (including background maps and terrain) can be masked, but design models can only produce masks.\n * @see [[DisplayStyleSettings.planarClipMasks]] to define clip masks for a [DisplayStyle]($backend).\n * @see [[ContextRealityModel.planarClipMaskSettings]] to apply a clip mask to a context reality model.\n * @public\n */\nexport class PlanarClipMaskSettings {\n  /** Specifies how the mask geometry is produced. */\n  public readonly mode: PlanarClipMaskMode;\n  /** For any mode other than [[PlanarClipMaskMode.Priority]], the Ids of the [GeometricModel]($backend)s containing the geometry used to produce the mask.\n   * If `undefined`, the set of all models in the view's [ModelSelector]($backend) is used.\n   * The mask geometry can be filtered by [[subCategoryOrElementIds]].\n   */\n  public readonly modelIds?: OrderedId64Iterable;\n  /** For [[PlanarClipMaskMode.IncludeElements]] or [[PlanarClipMaskMode.ExcludedElements]], the Ids of the [GeometricElement]($backend)s to include or exclude from masking;\n   * for [[PlanarClipMaskMode.IncludeSubCategories]], the Ids of the subcategories whose geometry contributes to the mask.\n   */\n  public readonly subCategoryOrElementIds?: OrderedId64Iterable;\n  /** For [[PlanarClipMaskMode.Priority]], the priority value. */\n  public readonly priority?: number;\n  /** A value between 0 and 1 indicating an override for mask transparency. A transparency of 0 indicates complete masking. 1 is completely transparent (no masking).\n   If no transparency is defined then the transparencies of the mask elements are used.\n   */\n  public readonly transparency?: number;\n  /** A value of true indicates that the mask should be inverted and only content within the mask should be displayed, in other words the area inside the mask is displayed rather than outside. */\n  public readonly invert: boolean;\n  private readonly _modelIds?: CompressedId64Set;\n  private readonly _subCategoryOrElementIds?: CompressedId64Set;\n\n  /** The compressed representation of [[modelIds]]. */\n  public get compressedModelIds(): CompressedId64Set | undefined {\n    return this._modelIds;\n  }\n\n  /** Create a new [[PlanarClipMaskSettings]] object from its JSON representation. */\n  public static fromJSON(json?: PlanarClipMaskProps): PlanarClipMaskSettings {\n    if (!json || undefined === json.mode)\n      return this.defaults;\n\n    return new PlanarClipMaskSettings(json.mode, json.transparency, json.modelIds, json.subCategoryOrElementIds, json.priority, json.invert);\n  }\n\n  /** Create a new PlanarClipMaskSettings. */\n  public static create(args: ModelPlanarClipMaskArgs | ElementPlanarClipMaskArgs | SubCategoryPlanarClipMaskArgs | PriorityPlanarClipMaskArgs): PlanarClipMaskSettings {\n    const modelIds = args.modelIds ? CompressedId64Set.sortAndCompress(args.modelIds) : undefined;\n    if (undefined !== args.priority)\n      return new PlanarClipMaskSettings(PlanarClipMaskMode.Priority, args.transparency, undefined, undefined, args.priority, args.invert);\n    else if (undefined !== args.subCategoryIds)\n      return new PlanarClipMaskSettings(PlanarClipMaskMode.IncludeSubCategories, args.transparency, modelIds, CompressedId64Set.sortAndCompress(args.subCategoryIds), undefined, args.invert);\n    else if (undefined !== args.elementIds)\n      return new PlanarClipMaskSettings(args.exclude ? PlanarClipMaskMode.ExcludeElements : PlanarClipMaskMode.IncludeElements, args.transparency, modelIds, CompressedId64Set.sortAndCompress(args.elementIds), undefined, args.invert);\n    else\n      return new PlanarClipMaskSettings(PlanarClipMaskMode.Models, args.transparency, modelIds, undefined, undefined, args.invert);\n  }\n\n  /** Create JSON object representing this [[PlanarClipMaskSettings]] */\n  public toJSON(): PlanarClipMaskProps {\n    const props: PlanarClipMaskProps = { mode: this.mode };\n    if (undefined !== this._modelIds)\n      props.modelIds = this._modelIds;\n\n    if (undefined !== this._subCategoryOrElementIds)\n      props.subCategoryOrElementIds = this._subCategoryOrElementIds;\n\n    if (undefined !== this.priority)\n      props.priority = this.priority;\n\n    if (undefined !== this.transparency)\n      props.transparency = this.transparency;\n\n    if (this.invert)\n      props.invert = true;\n\n    return props;\n  }\n\n  /** Returns true if masking is enabled. */\n  public get isValid(): boolean {\n    return this.mode !== PlanarClipMaskMode.None;\n  }\n\n  public equals(other: PlanarClipMaskSettings): boolean {\n    return this.mode === other.mode &&\n      this.priority === other.priority &&\n      this.transparency === other.transparency &&\n      this.invert === other.invert &&\n      this._modelIds === other._modelIds &&\n      this._subCategoryOrElementIds === other._subCategoryOrElementIds;\n  }\n\n  /** Create a copy of this TerrainSettings, optionally modifying some of its properties.\n   * @param changedProps JSON representation of the properties to change.\n   * @returns A PlanarClipMaskSettings with all of its properties set to match those of`this`, except those explicitly defined in `changedProps`.\n   */\n  public clone(changedProps?: PlanarClipMaskProps): PlanarClipMaskSettings {\n    if (undefined === changedProps)\n      return this;\n\n    return PlanarClipMaskSettings.fromJSON({\n      ...this.toJSON(),\n      ...changedProps,\n    });\n  }\n\n  private constructor(mode: PlanarClipMaskMode, transparency?: number, modelIds?: CompressedId64Set, subCategoryOrElementIds?: CompressedId64Set, priority?: number, invert?: boolean) {\n    this.mode = mode;\n    this._modelIds = modelIds;\n    this._subCategoryOrElementIds = subCategoryOrElementIds;\n    this.priority = priority;\n    this.invert = true === invert;\n    this.transparency = undefined !== transparency ? Math.max(0, Math.min(1, transparency)) : undefined;\n\n    if (modelIds)\n      this.modelIds = CompressedId64Set.iterable(modelIds);\n\n    if (subCategoryOrElementIds)\n      this.subCategoryOrElementIds = CompressedId64Set.iterable(subCategoryOrElementIds);\n  }\n\n  /** A default PlanarClipMask which masks nothing. */\n  public static defaults = new PlanarClipMaskSettings(PlanarClipMaskMode.None);\n}\n"]}
+{"version":3,"file":"PlanarClipMask.js","sourceRoot":"","sources":["../../src/PlanarClipMask.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAE,iBAAiB,EAAmC,MAAM,qBAAqB,CAAC;AAEzF;;;GAGG;AACH,MAAM,CAAN,IAAY,kBAyBX;AAzBD,WAAY,kBAAkB;IAC5B,kBAAkB;IAClB,2DAAQ,CAAA;IACR;;;;OAIG;IACH,mEAAY,CAAA;IACZ;;OAEG;IACH,+DAAU,CAAA;IACV;;OAEG;IACH,2FAAwB,CAAA;IACxB;;OAEG;IACH,iFAAmB,CAAA;IACnB;;OAEG;IACH,iFAAmB,CAAA;AACrB,CAAC,EAzBW,kBAAkB,KAAlB,kBAAkB,QAyB7B;AAED;;;;GAIG;AACH,MAAM,CAAN,IAAY,sBASX;AATD,WAAY,sBAAsB;IAChC,sBAAsB;IACtB,yFAAqB,CAAA;IACrB,6EAA6E;IAC7E,mGAA0B,CAAA;IAC1B,4CAA4C;IAC5C,mFAAgB,CAAA;IAChB,yDAAyD;IACzD,oFAAkB,CAAA;AACpB,CAAC,EATW,sBAAsB,KAAtB,sBAAsB,QASjC;AA8FD;;;;;;;;GAQG;AACH,MAAM,OAAO,sBAAsB;IAwBjC,qDAAqD;IACrD,IAAW,kBAAkB;QAC3B,OAAO,IAAI,CAAC,SAAS,CAAC;IACxB,CAAC;IAED,mFAAmF;IAC5E,MAAM,CAAC,QAAQ,CAAC,IAA0B;QAC/C,IAAI,CAAC,IAAI,IAAI,SAAS,KAAK,IAAI,CAAC,IAAI;YAClC,OAAO,IAAI,CAAC,QAAQ,CAAC;QAEvB,OAAO,IAAI,sBAAsB,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,YAAY,EAAE,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,uBAAuB,EAAE,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;IAC3I,CAAC;IAED,2CAA2C;IACpC,MAAM,CAAC,MAAM,CAAC,IAAsH;QACzI,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,iBAAiB,CAAC,eAAe,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QAC9F,IAAI,SAAS,KAAK,IAAI,CAAC,QAAQ;YAC7B,OAAO,IAAI,sBAAsB,CAAC,kBAAkB,CAAC,QAAQ,EAAE,IAAI,CAAC,YAAY,EAAE,SAAS,EAAE,SAAS,EAAE,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;aACjI,IAAI,SAAS,KAAK,IAAI,CAAC,cAAc;YACxC,OAAO,IAAI,sBAAsB,CAAC,kBAAkB,CAAC,oBAAoB,EAAE,IAAI,CAAC,YAAY,EAAE,QAAQ,EAAE,iBAAiB,CAAC,eAAe,CAAC,IAAI,CAAC,cAAc,CAAC,EAAE,SAAS,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;aACrL,IAAI,SAAS,KAAK,IAAI,CAAC,UAAU;YACpC,OAAO,IAAI,sBAAsB,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,kBAAkB,CAAC,eAAe,CAAC,CAAC,CAAC,kBAAkB,CAAC,eAAe,EAAE,IAAI,CAAC,YAAY,EAAE,QAAQ,EAAE,iBAAiB,CAAC,eAAe,CAAC,IAAI,CAAC,UAAU,CAAC,EAAE,SAAS,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;;YAEnO,OAAO,IAAI,sBAAsB,CAAC,kBAAkB,CAAC,MAAM,EAAE,IAAI,CAAC,YAAY,EAAE,QAAQ,EAAE,SAAS,EAAE,SAAS,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;IACjI,CAAC;IAED,sEAAsE;IAC/D,MAAM;QACX,MAAM,KAAK,GAAwB,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,CAAC;QACvD,IAAI,SAAS,KAAK,IAAI,CAAC,SAAS;YAC9B,KAAK,CAAC,QAAQ,GAAG,IAAI,CAAC,SAAS,CAAC;QAElC,IAAI,SAAS,KAAK,IAAI,CAAC,wBAAwB;YAC7C,KAAK,CAAC,uBAAuB,GAAG,IAAI,CAAC,wBAAwB,CAAC;QAEhE,IAAI,SAAS,KAAK,IAAI,CAAC,QAAQ;YAC7B,KAAK,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC;QAEjC,IAAI,SAAS,KAAK,IAAI,CAAC,YAAY;YACjC,KAAK,CAAC,YAAY,GAAG,IAAI,CAAC,YAAY,CAAC;QAEzC,IAAI,IAAI,CAAC,MAAM;YACb,KAAK,CAAC,MAAM,GAAG,IAAI,CAAC;QAEtB,OAAO,KAAK,CAAC;IACf,CAAC;IAED,0CAA0C;IAC1C,IAAW,OAAO;QAChB,OAAO,IAAI,CAAC,IAAI,KAAK,kBAAkB,CAAC,IAAI,CAAC;IAC/C,CAAC;IAEM,MAAM,CAAC,KAA6B;QACzC,OAAO,IAAI,CAAC,IAAI,KAAK,KAAK,CAAC,IAAI;YAC7B,IAAI,CAAC,QAAQ,KAAK,KAAK,CAAC,QAAQ;YAChC,IAAI,CAAC,YAAY,KAAK,KAAK,CAAC,YAAY;YACxC,IAAI,CAAC,MAAM,KAAK,KAAK,CAAC,MAAM;YAC5B,IAAI,CAAC,SAAS,KAAK,KAAK,CAAC,SAAS;YAClC,IAAI,CAAC,wBAAwB,KAAK,KAAK,CAAC,wBAAwB,CAAC;IACrE,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,YAAkC;QAC7C,IAAI,SAAS,KAAK,YAAY;YAC5B,OAAO,IAAI,CAAC;QAEd,OAAO,sBAAsB,CAAC,QAAQ,CAAC;YACrC,GAAG,IAAI,CAAC,MAAM,EAAE;YAChB,GAAG,YAAY;SAChB,CAAC,CAAC;IACL,CAAC;IAED,YAAoB,IAAwB,EAAE,YAAqB,EAAE,QAA4B,EAAE,uBAA2C,EAAE,QAAiB,EAAE,MAAgB;QACjL,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,SAAS,GAAG,QAAQ,CAAC;QAC1B,IAAI,CAAC,wBAAwB,GAAG,uBAAuB,CAAC;QACxD,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QACzB,IAAI,CAAC,MAAM,GAAG,IAAI,KAAK,MAAM,CAAC;QAC9B,IAAI,CAAC,YAAY,GAAG,SAAS,KAAK,YAAY,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QAEpG,IAAI,QAAQ;YACV,IAAI,CAAC,QAAQ,GAAG,iBAAiB,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;QAEvD,IAAI,uBAAuB;YACzB,IAAI,CAAC,uBAAuB,GAAG,iBAAiB,CAAC,QAAQ,CAAC,uBAAuB,CAAC,CAAC;IACvF,CAAC;;AAED,oDAAoD;AACtC,+BAAQ,GAAG,IAAI,sBAAsB,CAAC,kBAAkB,CAAC,IAAI,CAAC,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module DisplayStyles\n */\n\nimport { CompressedId64Set, Id64String, OrderedId64Iterable } from \"@itwin/core-bentley\";\n\n/** The different modes by which a [[PlanarClipMaskSettings]] collects the geometry used to mask a model.\n * @public\n * @extensions\n */\nexport enum PlanarClipMaskMode {\n  /** No masking. */\n  None = 0,\n  /** Mask based on priority. Different types of models have different default priorities as enumerated by [[PlanarClipMaskPriority]].\n   * For example, background maps have the lowest priority, so they are masked by all other types, while design models have the highest priority and are therefore never masked.\n   * The priority of a reality model can be overridden by [[PlanarClipMaskSettings.priority]]. This is useful to allow one reality model to mask another overlapping one.\n   * Everything visible in the view creates the mask, so turning off models, categories, or elements (via fully transparent overrides) will make things not be in the mask.\n   */\n  Priority = 1,\n  /** Indicates that masks should be produced from the geometry in a set of [GeometricModel]($backend)s, regardless of what model is on or off in the view.\n   * However, things that are off from category settings or element feature overrides in the view will not be in the mask for these models.\n   */\n  Models = 2,\n  /** Indicates that masks should be produced from geometry belonging to a set of subcategories.\n   * View settings do not affect what is in the mask, unless [[PlanarClipMaskSettings.subCategoryOrElementIds]] is undefined, in which case it behaves like Models mode.\n   */\n  IncludeSubCategories = 3,\n  /** Indicates that masks should be produced from the geometry of a set of [GeometricElement]($backend)s.\n   * View settings do not affect what is in the mask, unless [[PlanarClipMaskSettings.subCategoryOrElementIds]] is undefined, in which case it behaves like Models mode.\n   */\n  IncludeElements = 4,\n  /** Indicates that masks should be produced from the geometry of all [GeometricElement]($backend)s in a view, **except** for a specified set of excluded elements.\n   * View settings do not affect what is in the mask, unless [[PlanarClipMaskSettings.subCategoryOrElementIds]] is undefined, in which case it behaves like Models mode.\n   */\n  ExcludeElements = 5,\n}\n\n/** The default priority values for a [[PlanarClipMaskSettings]], based on model type. Models with a lower priority are masked by models with a higher priority.\n * The default can be overridden by [[PlanarClipMaskSettings.priority]].\n *  @public\n * @extensions\n */\nexport enum PlanarClipMaskPriority {\n  /** Background map. */\n  BackgroundMap = -2048,\n  /** A reality model that spans the globe - e.g., OpenStreetMaps Buildings. */\n  GlobalRealityModel = -1024,\n  /** A reality model with a bounded range. */\n  RealityModel = 0,\n  /** A design model stored in the [IModelDb]($backend). */\n  DesignModel = 2048,\n}\n\n/** JSON representation of a [[PlanarClipMaskSettings]].\n * @see [[DisplayStyleSettingsProps.planarClipOvr]] and [[ContextRealityModelProps.planarClipMask]].\n * @public\n * @extensions\n */\nexport interface PlanarClipMaskProps {\n  /** Controls how the mask geometry is collected */\n  mode: PlanarClipMaskMode;\n  /** See [[PlanarClipMaskSettings.modelIds]]. */\n  modelIds?: CompressedId64Set;\n  /** See [[PlanarClipMaskSettings.subCategoryOrElementIds]]. */\n  subCategoryOrElementIds?: CompressedId64Set;\n  /** See [[PlanarClipMaskSettings.priority]]. */\n  priority?: number;\n  /** See [[PlanarClipMaskSettings.transparency]]. */\n  transparency?: number;\n  /** See PlanarClipMaskSettings.invert */\n  invert?: boolean;\n}\n\n/** Basic arguments supplied to [[PlanarClipMaskSettings.create]].\n * @public\n */\nexport interface BasicPlanarClipMaskArgs {\n  /** See [[PlanarClipMaskSettings.transparency]]. */\n  transparency?: number;\n  /** See [[PlanarClipMaskSettings.invert]]. */\n  invert?: boolean;\n}\n\n/** Arguments supplied to [[PlanarClipMaskSettings.create]] to create a mask of [[PlanarClipMaskMode.Models]].\n * @public\n */\nexport interface ModelPlanarClipMaskArgs extends BasicPlanarClipMaskArgs {\n  /** See [[PlanarClipMaskSettings.modelIds]]. */\n  modelIds?: Iterable<Id64String>;\n  /** @internal */\n  exclude?: never;\n  /** @internal */\n  elementIds?: never;\n  /** @internal */\n  subCategoryIds?: never;\n  /** @internal */\n  priority?: never;\n}\n\n/** Arguments supplied to [[PlanarClipMaskSettings.create]] to create a mask of [[PlanarClipMaskMode.IncludeElements]] or [[PlanarClipMaskMode.ExcludeElements]].\n * @public\n */\nexport interface ElementPlanarClipMaskArgs extends BasicPlanarClipMaskArgs {\n  /** See [[PlanarClipMaskSettings.modelIds]]. */\n  modelIds?: Iterable<Id64String>;\n  /** The elements used by the mask. @see [[PlanarClipMaskSettings.subCategoryOrElementIds]]. */\n  elementIds: Iterable<Id64String>;\n  /** If true, creates a mask of [[PlanarClipMaskMode.ExcludeElements]]; otherwise, [[PlanarClipMaskMode.IncludeElements]]. */\n  exclude?: boolean;\n  /** @internal */\n  subCategoryIds?: never;\n  /** @internal */\n  priority?: never;\n}\n\n/** Arguments supplied to [[PlanarClipMaskSettings.create]] to create a mask of [[PlanarClipMaskMode.IncludeSubCategories]].\n * @public\n */\nexport interface SubCategoryPlanarClipMaskArgs extends BasicPlanarClipMaskArgs {\n  /** See [[PlanarClipMaskSettings.modelIds]]. */\n  modelIds?: Iterable<Id64String>;\n  /** The subcategories used by the mask. @see [[PlanarClipMaskSettings.subCategoryOrElementIds]]. */\n  subCategoryIds: Iterable<Id64String>;\n  /** @internal */\n  exclude?: never;\n  /** @internal */\n  elementIds?: never;\n  /** @internal */\n  priority?: never;\n}\n\n/** Arguments supplied to [[PlanarClipMaskSettings.create]] to create a mask of [[PlanarClipMaskMode.Priority]].\n * @public\n */\nexport interface PriorityPlanarClipMaskArgs extends BasicPlanarClipMaskArgs {\n  /** See [[PlanarClipMaskSettings.priority]]. */\n  priority: number;\n  /** @internal */\n  exclude?: never;\n  /** @internal */\n  elementIds?: never;\n  /** @internal */\n  modelIds?: never;\n}\n\n/** Describes how to mask the geometry of one [GeometricModel]($backend) for display. The mask is produced by projecting geometry from any number of other models -\n * optionally filtered by [SubCategory]($backend) or by a set of specific [GeometricElement]($backend)s - onto a plane. Regions of the masked model that intersect the\n * mask are rendered partially or completely transparent. This is useful for, e.g., making subsurface geometry visible below the background map, or clipping out portions\n * of a reality model that intersect a design model.\n * @note Currently reality models (including background maps and terrain) can be masked, but design models can only produce masks.\n * @see [[DisplayStyleSettings.planarClipMasks]] to define clip masks for a [DisplayStyle]($backend).\n * @see [[ContextRealityModel.planarClipMaskSettings]] to apply a clip mask to a context reality model.\n * @public\n */\nexport class PlanarClipMaskSettings {\n  /** Specifies how the mask geometry is produced. */\n  public readonly mode: PlanarClipMaskMode;\n  /** For any mode other than [[PlanarClipMaskMode.Priority]], the Ids of the [GeometricModel]($backend)s containing the geometry used to produce the mask,\n   * and if `undefined`, no mask geometry will be created.\n   * The mask geometry can be filtered by [[subCategoryOrElementIds]].\n   */\n  public readonly modelIds?: OrderedId64Iterable;\n  /** For [[PlanarClipMaskMode.IncludeElements]] or [[PlanarClipMaskMode.ExcludedElements]], the Ids of the [GeometricElement]($backend)s to include or exclude from masking;\n   * for [[PlanarClipMaskMode.IncludeSubCategories]], the Ids of the subcategories whose geometry contributes to the mask.\n   * If undefined, Modes IncludeSubCategories, IncludeElements, and ExcludeElements behave like Models mode.\n   */\n  public readonly subCategoryOrElementIds?: OrderedId64Iterable;\n  /** For [[PlanarClipMaskMode.Priority]], the priority value. */\n  public readonly priority?: number;\n  /** A value between 0 and 1 indicating an override for mask transparency. A transparency of 0 indicates complete masking. 1 is completely transparent (no masking).\n   If no transparency is defined then the transparencies of the mask elements are used.\n   */\n  public readonly transparency?: number;\n  /** A value of true indicates that the mask should be inverted and only content within the mask should be displayed, in other words the area inside the mask is displayed rather than outside. */\n  public readonly invert: boolean;\n  private readonly _modelIds?: CompressedId64Set;\n  private readonly _subCategoryOrElementIds?: CompressedId64Set;\n\n  /** The compressed representation of [[modelIds]]. */\n  public get compressedModelIds(): CompressedId64Set | undefined {\n    return this._modelIds;\n  }\n\n  /** Create a new [[PlanarClipMaskSettings]] object from its JSON representation. */\n  public static fromJSON(json?: PlanarClipMaskProps): PlanarClipMaskSettings {\n    if (!json || undefined === json.mode)\n      return this.defaults;\n\n    return new PlanarClipMaskSettings(json.mode, json.transparency, json.modelIds, json.subCategoryOrElementIds, json.priority, json.invert);\n  }\n\n  /** Create a new PlanarClipMaskSettings. */\n  public static create(args: ModelPlanarClipMaskArgs | ElementPlanarClipMaskArgs | SubCategoryPlanarClipMaskArgs | PriorityPlanarClipMaskArgs): PlanarClipMaskSettings {\n    const modelIds = args.modelIds ? CompressedId64Set.sortAndCompress(args.modelIds) : undefined;\n    if (undefined !== args.priority)\n      return new PlanarClipMaskSettings(PlanarClipMaskMode.Priority, args.transparency, undefined, undefined, args.priority, args.invert);\n    else if (undefined !== args.subCategoryIds)\n      return new PlanarClipMaskSettings(PlanarClipMaskMode.IncludeSubCategories, args.transparency, modelIds, CompressedId64Set.sortAndCompress(args.subCategoryIds), undefined, args.invert);\n    else if (undefined !== args.elementIds)\n      return new PlanarClipMaskSettings(args.exclude ? PlanarClipMaskMode.ExcludeElements : PlanarClipMaskMode.IncludeElements, args.transparency, modelIds, CompressedId64Set.sortAndCompress(args.elementIds), undefined, args.invert);\n    else\n      return new PlanarClipMaskSettings(PlanarClipMaskMode.Models, args.transparency, modelIds, undefined, undefined, args.invert);\n  }\n\n  /** Create JSON object representing this [[PlanarClipMaskSettings]] */\n  public toJSON(): PlanarClipMaskProps {\n    const props: PlanarClipMaskProps = { mode: this.mode };\n    if (undefined !== this._modelIds)\n      props.modelIds = this._modelIds;\n\n    if (undefined !== this._subCategoryOrElementIds)\n      props.subCategoryOrElementIds = this._subCategoryOrElementIds;\n\n    if (undefined !== this.priority)\n      props.priority = this.priority;\n\n    if (undefined !== this.transparency)\n      props.transparency = this.transparency;\n\n    if (this.invert)\n      props.invert = true;\n\n    return props;\n  }\n\n  /** Returns true if masking is enabled. */\n  public get isValid(): boolean {\n    return this.mode !== PlanarClipMaskMode.None;\n  }\n\n  public equals(other: PlanarClipMaskSettings): boolean {\n    return this.mode === other.mode &&\n      this.priority === other.priority &&\n      this.transparency === other.transparency &&\n      this.invert === other.invert &&\n      this._modelIds === other._modelIds &&\n      this._subCategoryOrElementIds === other._subCategoryOrElementIds;\n  }\n\n  /** Create a copy of this TerrainSettings, optionally modifying some of its properties.\n   * @param changedProps JSON representation of the properties to change.\n   * @returns A PlanarClipMaskSettings with all of its properties set to match those of`this`, except those explicitly defined in `changedProps`.\n   */\n  public clone(changedProps?: PlanarClipMaskProps): PlanarClipMaskSettings {\n    if (undefined === changedProps)\n      return this;\n\n    return PlanarClipMaskSettings.fromJSON({\n      ...this.toJSON(),\n      ...changedProps,\n    });\n  }\n\n  private constructor(mode: PlanarClipMaskMode, transparency?: number, modelIds?: CompressedId64Set, subCategoryOrElementIds?: CompressedId64Set, priority?: number, invert?: boolean) {\n    this.mode = mode;\n    this._modelIds = modelIds;\n    this._subCategoryOrElementIds = subCategoryOrElementIds;\n    this.priority = priority;\n    this.invert = true === invert;\n    this.transparency = undefined !== transparency ? Math.max(0, Math.min(1, transparency)) : undefined;\n\n    if (modelIds)\n      this.modelIds = CompressedId64Set.iterable(modelIds);\n\n    if (subCategoryOrElementIds)\n      this.subCategoryOrElementIds = CompressedId64Set.iterable(subCategoryOrElementIds);\n  }\n\n  /** A default PlanarClipMask which masks nothing. */\n  public static defaults = new PlanarClipMaskSettings(PlanarClipMaskMode.None);\n}\n"]}

package/lib/esm/Render.d.ts

@@ -3,11 +3,16 @@
  */
 import { OctEncodedNormalPair } from "./OctEncodedNormal";
 /** Describes the semantics of a [PolylineArgs]($frontend).
- * @alpha
+ * @public
  */
 export declare enum PolylineTypeFlags {
-    Normal = 0,// Just an ordinary polyline
-    Edge = 1,// A polyline used to define the edges of a planar region.
+    /** Just an ordinary polyline with no special semantics. */
+    Normal = 0,
+    /** A polyline used to define the edges of a planar region. */
+    Edge = 1,
+    /** Like [[Edge]], but the edges are only displayed in [[RenderMode.Wireframe]] when the surface's fill is not displayed.
+     * [[FillFlags]] controls whether the fill is displayed.
+     */
     Outline = 2
 }
 /** Flags describing a [PolylineArgs]($frontend).
@@ -20,9 +25,7 @@ export interface PolylineFlags {
     isPlanar?: boolean;
     /** If `true`, the polylines' positions all have the same z coordinate. */
     is2d?: boolean;
-    /** Default: Normal.
-     * @alpha
-     */
+    /** Default: Normal. */
     type?: PolylineTypeFlags;
 }
 /** Describes the vertex indices of a single line within a [PolylineArgs]($frontend).

package/lib/esm/Render.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Render.d.ts","sourceRoot":"","sources":["../../src/Render.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,oBAAoB,EAAE,MAAM,oBAAoB,CAAC;AAI1D;;GAEG;AACH,oBAAY,iBAAiB;IAC3B,MAAM,IAAI,CAAO,4BAA4B;IAC7C,IAAI,IAAS,CAAE,0DAA0D;IACzE,OAAO,IAAS;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B,8HAA8H;IAC9H,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,4DAA4D;IAC5D,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,0EAA0E;IAC1E,IAAI,CAAC,EAAE,OAAO,CAAC;IACf;;OAEG;IACH,IAAI,CAAC,EAAE,iBAAiB,CAAC;CAC1B;AAED;;;;GAIG;AACH,MAAM,MAAM,eAAe,GAAG,MAAM,EAAE,CAAC;AAEvC,gBAAgB;AAChB,qBAAa,YAAY;IACvB,SAAgB,OAAO,EAAE,eAAe,CAAC;gBAEtB,OAAO,GAAE,eAAoB;IAIzC,QAAQ,CAAC,KAAK,EAAE,MAAM;IAMtB,KAAK;CACb;AAED,gBAAgB;AAChB,qBAAa,gBAAiB,SAAQ,KAAK,CAAC,YAAY,CAAC;gBAC3C,GAAG,IAAI,EAAE,YAAY,EAAE;CAGpC;AAED,gBAAgB;AAChB,qBAAa,QAAQ;IACZ,OAAO,WAAU;gBAEL,MAAM,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM;IAY5C,SAAS,CAAC,KAAK,EAAE,QAAQ,GAAG,MAAM;CAO1C;AAED,gBAAgB;AAChB,qBAAa,SAAS;IACb,OAAO,EAAE,QAAQ,EAAE,CAAM;IACzB,UAAU,EAAE,QAAQ,EAAE,CAAM;IAC5B,SAAS,EAAE,gBAAgB,CAA0B;IACrD,iBAAiB,EAAE,oBAAoB,EAAE,CAAM;;CAEvD;AAED,gBAAgB;AAChB,qBAAa,QAAQ;IACZ,KAAK,CAAC,EAAE,QAAQ,EAAE,CAAC;IAEnB,IAAI,CAAC,SAAS,CAAC,EAAE,SAAS,GAAG,OAAO;IAQpC,KAAK,IAAI,IAAI;IACpB,IAAW,OAAO,IAAI,OAAO,CAA8B;IAC3D,IAAW,QAAQ,WAA+D;CACnF;AAED,gBAAgB;AAChB,qBAAa,kBAAmB,SAAQ,QAAQ;IACvC,OAAO,CAAC,EAAE,oBAAoB,EAAE,CAAC;IAExB,IAAI,CAAC,SAAS,CAAC,EAAE,SAAS;IAU1B,KAAK;CAItB;AAED,gBAAgB;AAChB,qBAAa,gBAAgB;IACpB,KAAK,CAAC,EAAE,eAAe,EAAE,CAAC;gBAEd,KAAK,CAAC,EAAE,eAAe,EAAE;IAErC,IAAI,CAAC,KAAK,CAAC,EAAE,eAAe,EAAE,GAAG,OAAO;IAK/C,IAAW,QAAQ,WAA+D;IAClF,IAAW,OAAO,YAAgC;IAC3C,KAAK;CACb"}
+{"version":3,"file":"Render.d.ts","sourceRoot":"","sources":["../../src/Render.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,oBAAoB,EAAE,MAAM,oBAAoB,CAAC;AAI1D;;GAEG;AACH,oBAAY,iBAAiB;IAC3B,2DAA2D;IAC3D,MAAM,IAAI;IACV,8DAA8D;IAC9D,IAAI,IAAS;IACb;;OAEG;IACH,OAAO,IAAS;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B,8HAA8H;IAC9H,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,4DAA4D;IAC5D,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,0EAA0E;IAC1E,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,uBAAuB;IACvB,IAAI,CAAC,EAAE,iBAAiB,CAAC;CAC1B;AAED;;;;GAIG;AACH,MAAM,MAAM,eAAe,GAAG,MAAM,EAAE,CAAC;AAEvC,gBAAgB;AAChB,qBAAa,YAAY;IACvB,SAAgB,OAAO,EAAE,eAAe,CAAC;gBAEtB,OAAO,GAAE,eAAoB;IAIzC,QAAQ,CAAC,KAAK,EAAE,MAAM;IAMtB,KAAK;CACb;AAED,gBAAgB;AAChB,qBAAa,gBAAiB,SAAQ,KAAK,CAAC,YAAY,CAAC;gBAC3C,GAAG,IAAI,EAAE,YAAY,EAAE;CAGpC;AAED,gBAAgB;AAChB,qBAAa,QAAQ;IACZ,OAAO,WAAU;gBAEL,MAAM,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM;IAY5C,SAAS,CAAC,KAAK,EAAE,QAAQ,GAAG,MAAM;CAO1C;AAED,gBAAgB;AAChB,qBAAa,SAAS;IACb,OAAO,EAAE,QAAQ,EAAE,CAAM;IACzB,UAAU,EAAE,QAAQ,EAAE,CAAM;IAC5B,SAAS,EAAE,gBAAgB,CAA0B;IACrD,iBAAiB,EAAE,oBAAoB,EAAE,CAAM;;CAEvD;AAED,gBAAgB;AAChB,qBAAa,QAAQ;IACZ,KAAK,CAAC,EAAE,QAAQ,EAAE,CAAC;IAEnB,IAAI,CAAC,SAAS,CAAC,EAAE,SAAS,GAAG,OAAO;IAQpC,KAAK,IAAI,IAAI;IACpB,IAAW,OAAO,IAAI,OAAO,CAA8B;IAC3D,IAAW,QAAQ,WAA+D;CACnF;AAED,gBAAgB;AAChB,qBAAa,kBAAmB,SAAQ,QAAQ;IACvC,OAAO,CAAC,EAAE,oBAAoB,EAAE,CAAC;IAExB,IAAI,CAAC,SAAS,CAAC,EAAE,SAAS;IAU1B,KAAK;CAItB;AAED,gBAAgB;AAChB,qBAAa,gBAAgB;IACpB,KAAK,CAAC,EAAE,eAAe,EAAE,CAAC;gBAEd,KAAK,CAAC,EAAE,eAAe,EAAE;IAErC,IAAI,CAAC,KAAK,CAAC,EAAE,eAAe,EAAE,GAAG,OAAO;IAK/C,IAAW,QAAQ,WAA+D;IAClF,IAAW,OAAO,YAAgC;IAC3C,KAAK;CACb"}

package/lib/esm/Render.js

@@ -7,12 +7,17 @@
  */
 // cSpell:ignore vals
 /** Describes the semantics of a [PolylineArgs]($frontend).
- * @alpha
+ * @public
  */
 export var PolylineTypeFlags;
 (function (PolylineTypeFlags) {
+    /** Just an ordinary polyline with no special semantics. */
     PolylineTypeFlags[PolylineTypeFlags["Normal"] = 0] = "Normal";
+    /** A polyline used to define the edges of a planar region. */
     PolylineTypeFlags[PolylineTypeFlags["Edge"] = 1] = "Edge";
+    /** Like [[Edge]], but the edges are only displayed in [[RenderMode.Wireframe]] when the surface's fill is not displayed.
+     * [[FillFlags]] controls whether the fill is displayed.
+     */
     PolylineTypeFlags[PolylineTypeFlags["Outline"] = 2] = "Outline";
 })(PolylineTypeFlags || (PolylineTypeFlags = {}));
 /** @internal */