12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384 |
- declare module "babylonjs-serializers/OBJ/objSerializer" {
- import { Mesh } from "babylonjs/Meshes/mesh";
- /**
- * Class for generating OBJ data from a Babylon scene.
- */
- export class OBJExport {
- /**
- * Exports the geometry of a Mesh array in .OBJ file format (text)
- * @param mesh defines the list of meshes to serialize
- * @param materials defines if materials should be exported
- * @param matlibname defines the name of the associated mtl file
- * @param globalposition defines if the exported positions are globals or local to the exported mesh
- * @returns the OBJ content
- */
- static OBJ(mesh: Mesh[], materials?: boolean, matlibname?: string, globalposition?: boolean): string;
- /**
- * Exports the material(s) of a mesh in .MTL file format (text)
- * @param mesh defines the mesh to extract the material from
- * @returns the mtl content
- */
- static MTL(mesh: Mesh): string;
- }
- }
- declare module "babylonjs-serializers/OBJ/index" {
- export * from "babylonjs-serializers/OBJ/objSerializer";
- }
- declare module "babylonjs-serializers/glTF/glTFFileExporter" {
- /** @hidden */
- export var __IGLTFExporterExtension: number;
- /**
- * Interface for extending the exporter
- * @hidden
- */
- export interface IGLTFExporterExtension {
- /**
- * The name of this extension
- */
- readonly name: string;
- /**
- * Defines whether this extension is enabled
- */
- enabled: boolean;
- /**
- * Defines whether this extension is required
- */
- required: boolean;
- }
- }
- declare module "babylonjs-serializers/glTF/2.0/glTFExporterExtension" {
- import { ImageMimeType, IMeshPrimitive, INode, IMaterial, ITextureInfo } from "babylonjs-gltf2interface";
- import { Node } from "babylonjs/node";
- import { Texture } from "babylonjs/Materials/Textures/texture";
- import { SubMesh } from "babylonjs/Meshes/subMesh";
- import { IDisposable } from "babylonjs/scene";
- import { _BinaryWriter } from "babylonjs-serializers/glTF/2.0/glTFExporter";
- import { IGLTFExporterExtension } from "babylonjs-serializers/glTF/glTFFileExporter";
- import { Material } from 'babylonjs/Materials/material';
- import { BaseTexture } from 'babylonjs/Materials/Textures/baseTexture';
- /** @hidden */
- export var __IGLTFExporterExtensionV2: number;
- /**
- * Interface for a glTF exporter extension
- * @hidden
- */
- export interface IGLTFExporterExtensionV2 extends IGLTFExporterExtension, IDisposable {
- /**
- * Define this method to modify the default behavior before exporting a texture
- * @param context The context when loading the asset
- * @param babylonTexture The Babylon.js texture
- * @param mimeType The mime-type of the generated image
- * @returns A promise that resolves with the exported texture
- */
- preExportTextureAsync?(context: string, babylonTexture: Texture, mimeType: ImageMimeType): Promise<Texture>;
- /**
- * Define this method to get notified when a texture info is created
- * @param context The context when loading the asset
- * @param textureInfo The glTF texture info
- * @param babylonTexture The Babylon.js texture
- */
- postExportTexture?(context: string, textureInfo: ITextureInfo, babylonTexture: BaseTexture): void;
- /**
- * Define this method to modify the default behavior when exporting texture info
- * @param context The context when loading the asset
- * @param meshPrimitive glTF mesh primitive
- * @param babylonSubMesh Babylon submesh
- * @param binaryWriter glTF serializer binary writer instance
- * @returns nullable IMeshPrimitive promise
- */
- postExportMeshPrimitiveAsync?(context: string, meshPrimitive: IMeshPrimitive, babylonSubMesh: SubMesh, binaryWriter: _BinaryWriter): Promise<IMeshPrimitive>;
- /**
- * Define this method to modify the default behavior when exporting a node
- * @param context The context when exporting the node
- * @param node glTF node
- * @param babylonNode BabylonJS node
- * @returns nullable INode promise
- */
- postExportNodeAsync?(context: string, node: INode, babylonNode: Node): Promise<INode>;
- /**
- * Define this method to modify the default behavior when exporting a material
- * @param material glTF material
- * @param babylonMaterial BabylonJS material
- * @returns nullable IMaterial promise
- */
- postExportMaterialAsync?(context: string, node: IMaterial, babylonMaterial: Material): Promise<IMaterial>;
- /**
- * Define this method to return additional textures to export from a material
- * @param material glTF material
- * @param babylonMaterial BabylonJS material
- * @returns List of textures
- */
- postExportMaterialAdditionalTextures?(context: string, node: IMaterial, babylonMaterial: Material): BaseTexture[];
- /** Gets a boolean indicating that this extension was used */
- wasUsed: boolean;
- /** Gets a boolean indicating that this extension is required for the file to work */
- required: boolean;
- /**
- * Called after the exporter state changes to EXPORTING
- */
- onExporting?(): void;
- }
- }
- declare module "babylonjs-serializers/glTF/2.0/glTFMaterialExporter" {
- import { ITextureInfo, ImageMimeType, IMaterial, IMaterialPbrMetallicRoughness } from "babylonjs-gltf2interface";
- import { Nullable } from "babylonjs/types";
- import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
- import { Material } from "babylonjs/Materials/material";
- import { StandardMaterial } from "babylonjs/Materials/standardMaterial";
- import { PBRMaterial } from "babylonjs/Materials/PBR/pbrMaterial";
- import { PBRMetallicRoughnessMaterial } from "babylonjs/Materials/PBR/pbrMetallicRoughnessMaterial";
- import { _Exporter } from "babylonjs-serializers/glTF/2.0/glTFExporter";
- /**
- * Utility methods for working with glTF material conversion properties. This class should only be used internally
- * @hidden
- */
- export class _GLTFMaterialExporter {
- /**
- * Represents the dielectric specular values for R, G and B
- */
- private static readonly _DielectricSpecular;
- /**
- * Allows the maximum specular power to be defined for material calculations
- */
- private static readonly _MaxSpecularPower;
- /**
- * Mapping to store textures
- */
- private _textureMap;
- /**
- * Numeric tolerance value
- */
- private static readonly _Epsilon;
- /**
- * Reference to the glTF Exporter
- */
- private _exporter;
- constructor(exporter: _Exporter);
- /**
- * Specifies if two colors are approximately equal in value
- * @param color1 first color to compare to
- * @param color2 second color to compare to
- * @param epsilon threshold value
- */
- private static FuzzyEquals;
- /**
- * Gets the materials from a Babylon scene and converts them to glTF materials
- * @param scene babylonjs scene
- * @param mimeType texture mime type
- * @param images array of images
- * @param textures array of textures
- * @param materials array of materials
- * @param imageData mapping of texture names to base64 textures
- * @param hasTextureCoords specifies if texture coordinates are present on the material
- */
- _convertMaterialsToGLTFAsync(babylonMaterials: Material[], mimeType: ImageMimeType, hasTextureCoords: boolean): Promise<void>;
- /**
- * Makes a copy of the glTF material without the texture parameters
- * @param originalMaterial original glTF material
- * @returns glTF material without texture parameters
- */
- _stripTexturesFromMaterial(originalMaterial: IMaterial): IMaterial;
- /**
- * Specifies if the material has any texture parameters present
- * @param material glTF Material
- * @returns boolean specifying if texture parameters are present
- */
- _hasTexturesPresent(material: IMaterial): boolean;
- /**
- * Converts a Babylon StandardMaterial to a glTF Metallic Roughness Material
- * @param babylonStandardMaterial
- * @returns glTF Metallic Roughness Material representation
- */
- _convertToGLTFPBRMetallicRoughness(babylonStandardMaterial: StandardMaterial): IMaterialPbrMetallicRoughness;
- /**
- * Computes the metallic factor
- * @param diffuse diffused value
- * @param specular specular value
- * @param oneMinusSpecularStrength one minus the specular strength
- * @returns metallic value
- */
- static _SolveMetallic(diffuse: number, specular: number, oneMinusSpecularStrength: number): number;
- /**
- * Sets the glTF alpha mode to a glTF material from the Babylon Material
- * @param glTFMaterial glTF material
- * @param babylonMaterial Babylon material
- */
- private static _SetAlphaMode;
- /**
- * Converts a Babylon Standard Material to a glTF Material
- * @param babylonStandardMaterial BJS Standard Material
- * @param mimeType mime type to use for the textures
- * @param images array of glTF image interfaces
- * @param textures array of glTF texture interfaces
- * @param materials array of glTF material interfaces
- * @param imageData map of image file name to data
- * @param hasTextureCoords specifies if texture coordinates are present on the submesh to determine if textures should be applied
- */
- _convertStandardMaterialAsync(babylonStandardMaterial: StandardMaterial, mimeType: ImageMimeType, hasTextureCoords: boolean): Promise<IMaterial>;
- private _finishMaterial;
- /**
- * Converts a Babylon PBR Metallic Roughness Material to a glTF Material
- * @param babylonPBRMetalRoughMaterial BJS PBR Metallic Roughness Material
- * @param mimeType mime type to use for the textures
- * @param images array of glTF image interfaces
- * @param textures array of glTF texture interfaces
- * @param materials array of glTF material interfaces
- * @param imageData map of image file name to data
- * @param hasTextureCoords specifies if texture coordinates are present on the submesh to determine if textures should be applied
- */
- _convertPBRMetallicRoughnessMaterialAsync(babylonPBRMetalRoughMaterial: PBRMetallicRoughnessMaterial, mimeType: ImageMimeType, hasTextureCoords: boolean): Promise<IMaterial>;
- /**
- * Converts an image typed array buffer to a base64 image
- * @param buffer typed array buffer
- * @param width width of the image
- * @param height height of the image
- * @param mimeType mimetype of the image
- * @returns base64 image string
- */
- private _createBase64FromCanvasAsync;
- /**
- * Generates a white texture based on the specified width and height
- * @param width width of the texture in pixels
- * @param height height of the texture in pixels
- * @param scene babylonjs scene
- * @returns white texture
- */
- private _createWhiteTexture;
- /**
- * Resizes the two source textures to the same dimensions. If a texture is null, a default white texture is generated. If both textures are null, returns null
- * @param texture1 first texture to resize
- * @param texture2 second texture to resize
- * @param scene babylonjs scene
- * @returns resized textures or null
- */
- private _resizeTexturesToSameDimensions;
- /**
- * Converts an array of pixels to a Float32Array
- * Throws an error if the pixel format is not supported
- * @param pixels - array buffer containing pixel values
- * @returns Float32 of pixels
- */
- private _convertPixelArrayToFloat32;
- /**
- * Convert Specular Glossiness Textures to Metallic Roughness
- * See link below for info on the material conversions from PBR Metallic/Roughness and Specular/Glossiness
- * @link https://github.com/KhronosGroup/glTF/blob/master/extensions/2.0/Khronos/KHR_materials_pbrSpecularGlossiness/examples/convert-between-workflows-bjs/js/babylon.pbrUtilities.js
- * @param diffuseTexture texture used to store diffuse information
- * @param specularGlossinessTexture texture used to store specular and glossiness information
- * @param factors specular glossiness material factors
- * @param mimeType the mime type to use for the texture
- * @returns pbr metallic roughness interface or null
- */
- private _convertSpecularGlossinessTexturesToMetallicRoughnessAsync;
- /**
- * Converts specular glossiness material properties to metallic roughness
- * @param specularGlossiness interface with specular glossiness material properties
- * @returns interface with metallic roughness material properties
- */
- private _convertSpecularGlossinessToMetallicRoughness;
- /**
- * Calculates the surface reflectance, independent of lighting conditions
- * @param color Color source to calculate brightness from
- * @returns number representing the perceived brightness, or zero if color is undefined
- */
- private _getPerceivedBrightness;
- /**
- * Returns the maximum color component value
- * @param color
- * @returns maximum color component value, or zero if color is null or undefined
- */
- private _getMaxComponent;
- /**
- * Convert a PBRMaterial (Metallic/Roughness) to Metallic Roughness factors
- * @param babylonPBRMaterial BJS PBR Metallic Roughness Material
- * @param mimeType mime type to use for the textures
- * @param images array of glTF image interfaces
- * @param textures array of glTF texture interfaces
- * @param glTFPbrMetallicRoughness glTF PBR Metallic Roughness interface
- * @param imageData map of image file name to data
- * @param hasTextureCoords specifies if texture coordinates are present on the submesh to determine if textures should be applied
- * @returns glTF PBR Metallic Roughness factors
- */
- private _convertMetalRoughFactorsToMetallicRoughnessAsync;
- private _getGLTFTextureSampler;
- private _getGLTFTextureWrapMode;
- private _getGLTFTextureWrapModesSampler;
- /**
- * Convert a PBRMaterial (Specular/Glossiness) to Metallic Roughness factors
- * @param babylonPBRMaterial BJS PBR Metallic Roughness Material
- * @param mimeType mime type to use for the textures
- * @param images array of glTF image interfaces
- * @param textures array of glTF texture interfaces
- * @param glTFPbrMetallicRoughness glTF PBR Metallic Roughness interface
- * @param imageData map of image file name to data
- * @param hasTextureCoords specifies if texture coordinates are present on the submesh to determine if textures should be applied
- * @returns glTF PBR Metallic Roughness factors
- */
- private _convertSpecGlossFactorsToMetallicRoughnessAsync;
- /**
- * Converts a Babylon PBR Metallic Roughness Material to a glTF Material
- * @param babylonPBRMaterial BJS PBR Metallic Roughness Material
- * @param mimeType mime type to use for the textures
- * @param images array of glTF image interfaces
- * @param textures array of glTF texture interfaces
- * @param materials array of glTF material interfaces
- * @param imageData map of image file name to data
- * @param hasTextureCoords specifies if texture coordinates are present on the submesh to determine if textures should be applied
- */
- _convertPBRMaterialAsync(babylonPBRMaterial: PBRMaterial, mimeType: ImageMimeType, hasTextureCoords: boolean): Promise<IMaterial>;
- private setMetallicRoughnessPbrMaterial;
- private getPixelsFromTexture;
- /**
- * Extracts a texture from a Babylon texture into file data and glTF data
- * @param babylonTexture Babylon texture to extract
- * @param mimeType Mime Type of the babylonTexture
- * @return glTF texture info, or null if the texture format is not supported
- */
- _exportTextureAsync(babylonTexture: BaseTexture, mimeType: ImageMimeType): Promise<Nullable<ITextureInfo>>;
- _exportTextureInfoAsync(babylonTexture: BaseTexture, mimeType: ImageMimeType): Promise<Nullable<ITextureInfo>>;
- /**
- * Builds a texture from base64 string
- * @param base64Texture base64 texture string
- * @param baseTextureName Name to use for the texture
- * @param mimeType image mime type for the texture
- * @param images array of images
- * @param textures array of textures
- * @param imageData map of image data
- * @returns glTF texture info, or null if the texture format is not supported
- */
- private _getTextureInfoFromBase64;
- }
- }
- declare module "babylonjs-serializers/glTF/2.0/glTFData" {
- /**
- * Class for holding and downloading glTF file data
- */
- export class GLTFData {
- /**
- * Object which contains the file name as the key and its data as the value
- */
- glTFFiles: {
- [fileName: string]: string | Blob;
- };
- /**
- * Initializes the glTF file object
- */
- constructor();
- /**
- * Downloads the glTF data as files based on their names and data
- */
- downloadFiles(): void;
- }
- }
- declare module "babylonjs-serializers/glTF/2.0/glTFSerializer" {
- import { Node } from "babylonjs/node";
- import { Scene } from "babylonjs/scene";
- import { GLTFData } from "babylonjs-serializers/glTF/2.0/glTFData";
- /**
- * Holds a collection of exporter options and parameters
- */
- export interface IExportOptions {
- /**
- * Function which indicates whether a babylon node should be exported or not
- * @param node source Babylon node. It is used to check whether it should be exported to glTF or not
- * @returns boolean, which indicates whether the node should be exported (true) or not (false)
- */
- shouldExportNode?(node: Node): boolean;
- /**
- * Function used to extract the part of node's metadata that will be exported into glTF node extras
- * @param metadata source metadata to read from
- * @returns the data to store to glTF node extras
- */
- metadataSelector?(metadata: any): any;
- /**
- * The sample rate to bake animation curves
- */
- animationSampleRate?: number;
- /**
- * Begin serialization without waiting for the scene to be ready
- */
- exportWithoutWaitingForScene?: boolean;
- }
- /**
- * Class for generating glTF data from a Babylon scene.
- */
- export class GLTF2Export {
- /**
- * Exports the geometry of the scene to .gltf file format asynchronously
- * @param scene Babylon scene with scene hierarchy information
- * @param filePrefix File prefix to use when generating the glTF file
- * @param options Exporter options
- * @returns Returns an object with a .gltf file and associates texture names
- * as keys and their data and paths as values
- */
- static GLTFAsync(scene: Scene, filePrefix: string, options?: IExportOptions): Promise<GLTFData>;
- private static _PreExportAsync;
- private static _PostExportAsync;
- /**
- * Exports the geometry of the scene to .glb file format asychronously
- * @param scene Babylon scene with scene hierarchy information
- * @param filePrefix File prefix to use when generating glb file
- * @param options Exporter options
- * @returns Returns an object with a .glb filename as key and data as value
- */
- static GLBAsync(scene: Scene, filePrefix: string, options?: IExportOptions): Promise<GLTFData>;
- }
- }
- declare module "babylonjs-serializers/glTF/2.0/glTFUtilities" {
- import { IBufferView, AccessorType, AccessorComponentType, IAccessor } from "babylonjs-gltf2interface";
- import { FloatArray, Nullable } from "babylonjs/types";
- import { Vector3, Vector4, Quaternion } from "babylonjs/Maths/math";
- /**
- * @hidden
- */
- export class _GLTFUtilities {
- /**
- * Creates a buffer view based on the supplied arguments
- * @param bufferIndex index value of the specified buffer
- * @param byteOffset byte offset value
- * @param byteLength byte length of the bufferView
- * @param byteStride byte distance between conequential elements
- * @param name name of the buffer view
- * @returns bufferView for glTF
- */
- static _CreateBufferView(bufferIndex: number, byteOffset: number, byteLength: number, byteStride?: number, name?: string): IBufferView;
- /**
- * Creates an accessor based on the supplied arguments
- * @param bufferviewIndex The index of the bufferview referenced by this accessor
- * @param name The name of the accessor
- * @param type The type of the accessor
- * @param componentType The datatype of components in the attribute
- * @param count The number of attributes referenced by this accessor
- * @param byteOffset The offset relative to the start of the bufferView in bytes
- * @param min Minimum value of each component in this attribute
- * @param max Maximum value of each component in this attribute
- * @returns accessor for glTF
- */
- static _CreateAccessor(bufferviewIndex: number, name: string, type: AccessorType, componentType: AccessorComponentType, count: number, byteOffset: Nullable<number>, min: Nullable<number[]>, max: Nullable<number[]>): IAccessor;
- /**
- * Calculates the minimum and maximum values of an array of position floats
- * @param positions Positions array of a mesh
- * @param vertexStart Starting vertex offset to calculate min and max values
- * @param vertexCount Number of vertices to check for min and max values
- * @returns min number array and max number array
- */
- static _CalculateMinMaxPositions(positions: FloatArray, vertexStart: number, vertexCount: number, convertToRightHandedSystem: boolean): {
- min: number[];
- max: number[];
- };
- /**
- * Converts a new right-handed Vector3
- * @param vector vector3 array
- * @returns right-handed Vector3
- */
- static _GetRightHandedPositionVector3(vector: Vector3): Vector3;
- /**
- * Converts a Vector3 to right-handed
- * @param vector Vector3 to convert to right-handed
- */
- static _GetRightHandedPositionVector3FromRef(vector: Vector3): void;
- /**
- * Converts a three element number array to right-handed
- * @param vector number array to convert to right-handed
- */
- static _GetRightHandedPositionArray3FromRef(vector: number[]): void;
- /**
- * Converts a new right-handed Vector3
- * @param vector vector3 array
- * @returns right-handed Vector3
- */
- static _GetRightHandedNormalVector3(vector: Vector3): Vector3;
- /**
- * Converts a Vector3 to right-handed
- * @param vector Vector3 to convert to right-handed
- */
- static _GetRightHandedNormalVector3FromRef(vector: Vector3): void;
- /**
- * Converts a three element number array to right-handed
- * @param vector number array to convert to right-handed
- */
- static _GetRightHandedNormalArray3FromRef(vector: number[]): void;
- /**
- * Converts a Vector4 to right-handed
- * @param vector Vector4 to convert to right-handed
- */
- static _GetRightHandedVector4FromRef(vector: Vector4): void;
- /**
- * Converts a Vector4 to right-handed
- * @param vector Vector4 to convert to right-handed
- */
- static _GetRightHandedArray4FromRef(vector: number[]): void;
- /**
- * Converts a Quaternion to right-handed
- * @param quaternion Source quaternion to convert to right-handed
- */
- static _GetRightHandedQuaternionFromRef(quaternion: Quaternion): void;
- /**
- * Converts a Quaternion to right-handed
- * @param quaternion Source quaternion to convert to right-handed
- */
- static _GetRightHandedQuaternionArrayFromRef(quaternion: number[]): void;
- static _NormalizeTangentFromRef(tangent: Vector4): void;
- }
- }
- declare module "babylonjs-serializers/glTF/2.0/glTFExporter" {
- import { IBufferView, IAccessor, INode, IMaterial, ITexture, IImage, ISampler, ImageMimeType, IMeshPrimitive, IGLTF, ITextureInfo } from "babylonjs-gltf2interface";
- import { FloatArray, Nullable } from "babylonjs/types";
- import { Vector3, Vector4 } from "babylonjs/Maths/math";
- import { Node } from "babylonjs/node";
- import { SubMesh } from "babylonjs/Meshes/subMesh";
- import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
- import { Texture } from "babylonjs/Materials/Textures/texture";
- import { Material } from "babylonjs/Materials/material";
- import { Engine } from "babylonjs/Engines/engine";
- import { Scene } from "babylonjs/scene";
- import { IGLTFExporterExtensionV2 } from "babylonjs-serializers/glTF/2.0/glTFExporterExtension";
- import { _GLTFMaterialExporter } from "babylonjs-serializers/glTF/2.0/glTFMaterialExporter";
- import { IExportOptions } from "babylonjs-serializers/glTF/2.0/glTFSerializer";
- import { GLTFData } from "babylonjs-serializers/glTF/2.0/glTFData";
- /**
- * Converts Babylon Scene into glTF 2.0.
- * @hidden
- */
- export class _Exporter {
- /**
- * Stores the glTF to export
- */
- _glTF: IGLTF;
- /**
- * Stores all generated buffer views, which represents views into the main glTF buffer data
- */
- _bufferViews: IBufferView[];
- /**
- * Stores all the generated accessors, which is used for accessing the data within the buffer views in glTF
- */
- _accessors: IAccessor[];
- /**
- * Stores all the generated nodes, which contains transform and/or mesh information per node
- */
- private _nodes;
- /**
- * Stores all the generated glTF scenes, which stores multiple node hierarchies
- */
- private _scenes;
- /**
- * Stores all the generated mesh information, each containing a set of primitives to render in glTF
- */
- private _meshes;
- /**
- * Stores all the generated material information, which represents the appearance of each primitive
- */
- _materials: IMaterial[];
- _materialMap: {
- [materialID: number]: number;
- };
- /**
- * Stores all the generated texture information, which is referenced by glTF materials
- */
- _textures: ITexture[];
- /**
- * Stores all the generated image information, which is referenced by glTF textures
- */
- _images: IImage[];
- /**
- * Stores all the texture samplers
- */
- _samplers: ISampler[];
- /**
- * Stores all the generated animation samplers, which is referenced by glTF animations
- */
- /**
- * Stores the animations for glTF models
- */
- private _animations;
- /**
- * Stores the total amount of bytes stored in the glTF buffer
- */
- private _totalByteLength;
- /**
- * Stores a reference to the Babylon scene containing the source geometry and material information
- */
- _babylonScene: Scene;
- /**
- * Stores a map of the image data, where the key is the file name and the value
- * is the image data
- */
- _imageData: {
- [fileName: string]: {
- data: Uint8Array;
- mimeType: ImageMimeType;
- };
- };
- /**
- * Stores a map of the unique id of a node to its index in the node array
- */
- private _nodeMap;
- /**
- * Specifies if the Babylon scene should be converted to right-handed on export
- */
- _convertToRightHandedSystem: boolean;
- /**
- * Baked animation sample rate
- */
- private _animationSampleRate;
- private _options;
- private _localEngine;
- _glTFMaterialExporter: _GLTFMaterialExporter;
- private _extensions;
- private static _ExtensionNames;
- private static _ExtensionFactories;
- private _applyExtension;
- private _applyExtensions;
- _extensionsPreExportTextureAsync(context: string, babylonTexture: Texture, mimeType: ImageMimeType): Promise<Nullable<BaseTexture>>;
- _extensionsPostExportMeshPrimitiveAsync(context: string, meshPrimitive: IMeshPrimitive, babylonSubMesh: SubMesh, binaryWriter: _BinaryWriter): Promise<Nullable<IMeshPrimitive>>;
- _extensionsPostExportNodeAsync(context: string, node: INode, babylonNode: Node): Promise<Nullable<INode>>;
- _extensionsPostExportMaterialAsync(context: string, material: IMaterial, babylonMaterial: Material): Promise<Nullable<IMaterial>>;
- _extensionsPostExportMaterialAdditionalTextures(context: string, material: IMaterial, babylonMaterial: Material): BaseTexture[];
- _extensionsPostExportTextures(context: string, textureInfo: ITextureInfo, babylonTexture: BaseTexture): void;
- private _forEachExtensions;
- private _extensionsOnExporting;
- /**
- * Load glTF serializer extensions
- */
- private _loadExtensions;
- /**
- * Creates a glTF Exporter instance, which can accept optional exporter options
- * @param babylonScene Babylon scene object
- * @param options Options to modify the behavior of the exporter
- */
- constructor(babylonScene: Scene, options?: IExportOptions);
- dispose(): void;
- /**
- * Registers a glTF exporter extension
- * @param name Name of the extension to export
- * @param factory The factory function that creates the exporter extension
- */
- static RegisterExtension(name: string, factory: (exporter: _Exporter) => IGLTFExporterExtensionV2): void;
- /**
- * Un-registers an exporter extension
- * @param name The name fo the exporter extension
- * @returns A boolean indicating whether the extension has been un-registered
- */
- static UnregisterExtension(name: string): boolean;
- /**
- * Lazy load a local engine with premultiplied alpha set to false
- */
- _getLocalEngine(): Engine;
- private reorderIndicesBasedOnPrimitiveMode;
- /**
- * Reorders the vertex attribute data based on the primitive mode. This is necessary when indices are not available and the winding order is
- * clock-wise during export to glTF
- * @param submesh BabylonJS submesh
- * @param primitiveMode Primitive mode of the mesh
- * @param sideOrientation the winding order of the submesh
- * @param vertexBufferKind The type of vertex attribute
- * @param meshAttributeArray The vertex attribute data
- * @param byteOffset The offset to the binary data
- * @param binaryWriter The binary data for the glTF file
- */
- private reorderVertexAttributeDataBasedOnPrimitiveMode;
- /**
- * Reorders the vertex attributes in the correct triangle mode order . This is necessary when indices are not available and the winding order is
- * clock-wise during export to glTF
- * @param submesh BabylonJS submesh
- * @param primitiveMode Primitive mode of the mesh
- * @param sideOrientation the winding order of the submesh
- * @param vertexBufferKind The type of vertex attribute
- * @param meshAttributeArray The vertex attribute data
- * @param byteOffset The offset to the binary data
- * @param binaryWriter The binary data for the glTF file
- */
- private reorderTriangleFillMode;
- /**
- * Reorders the vertex attributes in the correct triangle strip order. This is necessary when indices are not available and the winding order is
- * clock-wise during export to glTF
- * @param submesh BabylonJS submesh
- * @param primitiveMode Primitive mode of the mesh
- * @param sideOrientation the winding order of the submesh
- * @param vertexBufferKind The type of vertex attribute
- * @param meshAttributeArray The vertex attribute data
- * @param byteOffset The offset to the binary data
- * @param binaryWriter The binary data for the glTF file
- */
- private reorderTriangleStripDrawMode;
- /**
- * Reorders the vertex attributes in the correct triangle fan order. This is necessary when indices are not available and the winding order is
- * clock-wise during export to glTF
- * @param submesh BabylonJS submesh
- * @param primitiveMode Primitive mode of the mesh
- * @param sideOrientation the winding order of the submesh
- * @param vertexBufferKind The type of vertex attribute
- * @param meshAttributeArray The vertex attribute data
- * @param byteOffset The offset to the binary data
- * @param binaryWriter The binary data for the glTF file
- */
- private reorderTriangleFanMode;
- /**
- * Writes the vertex attribute data to binary
- * @param vertices The vertices to write to the binary writer
- * @param byteOffset The offset into the binary writer to overwrite binary data
- * @param vertexAttributeKind The vertex attribute type
- * @param meshAttributeArray The vertex attribute data
- * @param binaryWriter The writer containing the binary data
- */
- private writeVertexAttributeData;
- /**
- * Writes mesh attribute data to a data buffer
- * Returns the bytelength of the data
- * @param vertexBufferKind Indicates what kind of vertex data is being passed in
- * @param meshAttributeArray Array containing the attribute data
- * @param binaryWriter The buffer to write the binary data to
- * @param indices Used to specify the order of the vertex data
- */
- writeAttributeData(vertexBufferKind: string, meshAttributeArray: FloatArray, byteStride: number, binaryWriter: _BinaryWriter): void;
- /**
- * Generates glTF json data
- * @param shouldUseGlb Indicates whether the json should be written for a glb file
- * @param glTFPrefix Text to use when prefixing a glTF file
- * @param prettyPrint Indicates whether the json file should be pretty printed (true) or not (false)
- * @returns json data as string
- */
- private generateJSON;
- /**
- * Generates data for .gltf and .bin files based on the glTF prefix string
- * @param glTFPrefix Text to use when prefixing a glTF file
- * @param dispose Dispose the exporter
- * @returns GLTFData with glTF file data
- */
- _generateGLTFAsync(glTFPrefix: string, dispose?: boolean): Promise<GLTFData>;
- /**
- * Creates a binary buffer for glTF
- * @returns array buffer for binary data
- */
- private _generateBinaryAsync;
- /**
- * Pads the number to a multiple of 4
- * @param num number to pad
- * @returns padded number
- */
- private _getPadding;
- /**
- * @hidden
- */
- _generateGLBAsync(glTFPrefix: string, dispose?: boolean): Promise<GLTFData>;
- /**
- * Sets the TRS for each node
- * @param node glTF Node for storing the transformation data
- * @param babylonTransformNode Babylon mesh used as the source for the transformation data
- */
- private setNodeTransformation;
- private getVertexBufferFromMesh;
- /**
- * Creates a bufferview based on the vertices type for the Babylon mesh
- * @param kind Indicates the type of vertices data
- * @param babylonTransformNode The Babylon mesh to get the vertices data from
- * @param binaryWriter The buffer to write the bufferview data to
- */
- private createBufferViewKind;
- /**
- * The primitive mode of the Babylon mesh
- * @param babylonMesh The BabylonJS mesh
- */
- private getMeshPrimitiveMode;
- /**
- * Sets the primitive mode of the glTF mesh primitive
- * @param meshPrimitive glTF mesh primitive
- * @param primitiveMode The primitive mode
- */
- private setPrimitiveMode;
- /**
- * Sets the vertex attribute accessor based of the glTF mesh primitive
- * @param meshPrimitive glTF mesh primitive
- * @param attributeKind vertex attribute
- * @returns boolean specifying if uv coordinates are present
- */
- private setAttributeKind;
- /**
- * Sets data for the primitive attributes of each submesh
- * @param mesh glTF Mesh object to store the primitive attribute information
- * @param babylonTransformNode Babylon mesh to get the primitive attribute data from
- * @param binaryWriter Buffer to write the attribute data to
- */
- private setPrimitiveAttributesAsync;
- /**
- * Creates a glTF scene based on the array of meshes
- * Returns the the total byte offset
- * @param babylonScene Babylon scene to get the mesh data from
- * @param binaryWriter Buffer to write binary data to
- */
- private createSceneAsync;
- /**
- * Creates a mapping of Node unique id to node index and handles animations
- * @param babylonScene Babylon Scene
- * @param nodes Babylon transform nodes
- * @param binaryWriter Buffer to write binary data to
- * @returns Node mapping of unique id to index
- */
- private createNodeMapAndAnimationsAsync;
- /**
- * Creates a glTF node from a Babylon mesh
- * @param babylonMesh Source Babylon mesh
- * @param binaryWriter Buffer for storing geometry data
- * @returns glTF node
- */
- private createNodeAsync;
- }
- /**
- * @hidden
- *
- * Stores glTF binary data. If the array buffer byte length is exceeded, it doubles in size dynamically
- */
- export class _BinaryWriter {
- /**
- * Array buffer which stores all binary data
- */
- private _arrayBuffer;
- /**
- * View of the array buffer
- */
- private _dataView;
- /**
- * byte offset of data in array buffer
- */
- private _byteOffset;
- /**
- * Initialize binary writer with an initial byte length
- * @param byteLength Initial byte length of the array buffer
- */
- constructor(byteLength: number);
- /**
- * Resize the array buffer to the specified byte length
- * @param byteLength
- */
- private resizeBuffer;
- /**
- * Get an array buffer with the length of the byte offset
- * @returns ArrayBuffer resized to the byte offset
- */
- getArrayBuffer(): ArrayBuffer;
- /**
- * Get the byte offset of the array buffer
- * @returns byte offset
- */
- getByteOffset(): number;
- /**
- * Stores an UInt8 in the array buffer
- * @param entry
- * @param byteOffset If defined, specifies where to set the value as an offset.
- */
- setUInt8(entry: number, byteOffset?: number): void;
- /**
- * Gets an UInt32 in the array buffer
- * @param entry
- * @param byteOffset If defined, specifies where to set the value as an offset.
- */
- getUInt32(byteOffset: number): number;
- getVector3Float32FromRef(vector3: Vector3, byteOffset: number): void;
- setVector3Float32FromRef(vector3: Vector3, byteOffset: number): void;
- getVector4Float32FromRef(vector4: Vector4, byteOffset: number): void;
- setVector4Float32FromRef(vector4: Vector4, byteOffset: number): void;
- /**
- * Stores a Float32 in the array buffer
- * @param entry
- */
- setFloat32(entry: number, byteOffset?: number): void;
- /**
- * Stores an UInt32 in the array buffer
- * @param entry
- * @param byteOffset If defined, specifies where to set the value as an offset.
- */
- setUInt32(entry: number, byteOffset?: number): void;
- }
- }
- declare module "babylonjs-serializers/glTF/2.0/glTFAnimation" {
- import { AnimationSamplerInterpolation, AnimationChannelTargetPath, AccessorType, IAnimation, INode, IBufferView, IAccessor } from "babylonjs-gltf2interface";
- import { Node } from "babylonjs/node";
- import { Nullable } from "babylonjs/types";
- import { Animation } from "babylonjs/Animations/animation";
- import { TransformNode } from "babylonjs/Meshes/transformNode";
- import { Scene } from "babylonjs/scene";
- import { _BinaryWriter } from "babylonjs-serializers/glTF/2.0/glTFExporter";
- /**
- * @hidden
- * Interface to store animation data.
- */
- export interface _IAnimationData {
- /**
- * Keyframe data.
- */
- inputs: number[];
- /**
- * Value data.
- */
- outputs: number[][];
- /**
- * Animation interpolation data.
- */
- samplerInterpolation: AnimationSamplerInterpolation;
- /**
- * Minimum keyframe value.
- */
- inputsMin: number;
- /**
- * Maximum keyframe value.
- */
- inputsMax: number;
- }
- /**
- * @hidden
- */
- export interface _IAnimationInfo {
- /**
- * The target channel for the animation
- */
- animationChannelTargetPath: AnimationChannelTargetPath;
- /**
- * The glTF accessor type for the data.
- */
- dataAccessorType: AccessorType.VEC3 | AccessorType.VEC4;
- /**
- * Specifies if quaternions should be used.
- */
- useQuaternion: boolean;
- }
- /**
- * @hidden
- * Utility class for generating glTF animation data from BabylonJS.
- */
- export class _GLTFAnimation {
- /**
- * @ignore
- *
- * Creates glTF channel animation from BabylonJS animation.
- * @param babylonTransformNode - BabylonJS mesh.
- * @param animation - animation.
- * @param animationChannelTargetPath - The target animation channel.
- * @param convertToRightHandedSystem - Specifies if the values should be converted to right-handed.
- * @param useQuaternion - Specifies if quaternions are used.
- * @returns nullable IAnimationData
- */
- static _CreateNodeAnimation(babylonTransformNode: TransformNode, animation: Animation, animationChannelTargetPath: AnimationChannelTargetPath, convertToRightHandedSystem: boolean, useQuaternion: boolean, animationSampleRate: number): Nullable<_IAnimationData>;
- private static _DeduceAnimationInfo;
- /**
- * @ignore
- * Create node animations from the transform node animations
- * @param babylonNode
- * @param runtimeGLTFAnimation
- * @param idleGLTFAnimations
- * @param nodeMap
- * @param nodes
- * @param binaryWriter
- * @param bufferViews
- * @param accessors
- * @param convertToRightHandedSystem
- */
- static _CreateNodeAnimationFromNodeAnimations(babylonNode: Node, runtimeGLTFAnimation: IAnimation, idleGLTFAnimations: IAnimation[], nodeMap: {
- [key: number]: number;
- }, nodes: INode[], binaryWriter: _BinaryWriter, bufferViews: IBufferView[], accessors: IAccessor[], convertToRightHandedSystem: boolean, animationSampleRate: number): void;
- /**
- * @ignore
- * Create node animations from the animation groups
- * @param babylonScene
- * @param glTFAnimations
- * @param nodeMap
- * @param nodes
- * @param binaryWriter
- * @param bufferViews
- * @param accessors
- * @param convertToRightHandedSystem
- */
- static _CreateNodeAnimationFromAnimationGroups(babylonScene: Scene, glTFAnimations: IAnimation[], nodeMap: {
- [key: number]: number;
- }, nodes: INode[], binaryWriter: _BinaryWriter, bufferViews: IBufferView[], accessors: IAccessor[], convertToRightHandedSystem: boolean, animationSampleRate: number): void;
- private static AddAnimation;
- /**
- * Create a baked animation
- * @param babylonTransformNode BabylonJS mesh
- * @param animation BabylonJS animation corresponding to the BabylonJS mesh
- * @param animationChannelTargetPath animation target channel
- * @param minFrame minimum animation frame
- * @param maxFrame maximum animation frame
- * @param fps frames per second of the animation
- * @param inputs input key frames of the animation
- * @param outputs output key frame data of the animation
- * @param convertToRightHandedSystem converts the values to right-handed
- * @param useQuaternion specifies if quaternions should be used
- */
- private static _CreateBakedAnimation;
- private static _ConvertFactorToVector3OrQuaternion;
- private static _SetInterpolatedValue;
- /**
- * Creates linear animation from the animation key frames
- * @param babylonTransformNode BabylonJS mesh
- * @param animation BabylonJS animation
- * @param animationChannelTargetPath The target animation channel
- * @param frameDelta The difference between the last and first frame of the animation
- * @param inputs Array to store the key frame times
- * @param outputs Array to store the key frame data
- * @param convertToRightHandedSystem Specifies if the position data should be converted to right handed
- * @param useQuaternion Specifies if quaternions are used in the animation
- */
- private static _CreateLinearOrStepAnimation;
- /**
- * Creates cubic spline animation from the animation key frames
- * @param babylonTransformNode BabylonJS mesh
- * @param animation BabylonJS animation
- * @param animationChannelTargetPath The target animation channel
- * @param frameDelta The difference between the last and first frame of the animation
- * @param inputs Array to store the key frame times
- * @param outputs Array to store the key frame data
- * @param convertToRightHandedSystem Specifies if the position data should be converted to right handed
- * @param useQuaternion Specifies if quaternions are used in the animation
- */
- private static _CreateCubicSplineAnimation;
- private static _GetBasePositionRotationOrScale;
- /**
- * Adds a key frame value
- * @param keyFrame
- * @param animation
- * @param outputs
- * @param animationChannelTargetPath
- * @param basePositionRotationOrScale
- * @param convertToRightHandedSystem
- * @param useQuaternion
- */
- private static _AddKeyframeValue;
- /**
- * Determine the interpolation based on the key frames
- * @param keyFrames
- * @param animationChannelTargetPath
- * @param useQuaternion
- */
- private static _DeduceInterpolation;
- /**
- * Adds an input tangent or output tangent to the output data
- * If an input tangent or output tangent is missing, it uses the zero vector or zero quaternion
- * @param tangentType Specifies which type of tangent to handle (inTangent or outTangent)
- * @param outputs The animation data by keyframe
- * @param animationChannelTargetPath The target animation channel
- * @param interpolation The interpolation type
- * @param keyFrame The key frame with the animation data
- * @param frameDelta Time difference between two frames used to scale the tangent by the frame delta
- * @param useQuaternion Specifies if quaternions are used
- * @param convertToRightHandedSystem Specifies if the values should be converted to right-handed
- */
- private static AddSplineTangent;
- /**
- * Get the minimum and maximum key frames' frame values
- * @param keyFrames animation key frames
- * @returns the minimum and maximum key frame value
- */
- private static calculateMinMaxKeyFrames;
- }
- }
- declare module "babylonjs-serializers/glTF/2.0/shaders/textureTransform.fragment" {
- /** @hidden */
- export var textureTransformPixelShader: {
- name: string;
- shader: string;
- };
- }
- declare module "babylonjs-serializers/glTF/2.0/Extensions/KHR_texture_transform" {
- import { ImageMimeType, ITextureInfo } from "babylonjs-gltf2interface";
- import { Texture } from "babylonjs/Materials/Textures/texture";
- import { IGLTFExporterExtensionV2 } from "babylonjs-serializers/glTF/2.0/glTFExporterExtension";
- import { _Exporter } from "babylonjs-serializers/glTF/2.0/glTFExporter";
- import "babylonjs-serializers/glTF/2.0/shaders/textureTransform.fragment";
- /**
- * @hidden
- */
- export class KHR_texture_transform implements IGLTFExporterExtensionV2 {
- private _recordedTextures;
- /** Name of this extension */
- readonly name: string;
- /** Defines whether this extension is enabled */
- enabled: boolean;
- /** Defines whether this extension is required */
- required: boolean;
- /** Reference to the glTF exporter */
- private _wasUsed;
- constructor(exporter: _Exporter);
- dispose(): void;
- /** @hidden */
- get wasUsed(): boolean;
- postExportTexture?(context: string, textureInfo: ITextureInfo, babylonTexture: Texture): void;
- preExportTextureAsync(context: string, babylonTexture: Texture, mimeType: ImageMimeType): Promise<Texture>;
- /**
- * Transform the babylon texture by the offset, rotation and scale parameters using a procedural texture
- * @param babylonTexture
- * @param offset
- * @param rotation
- * @param scale
- * @param scene
- */
- private _textureTransformTextureAsync;
- }
- }
- declare module "babylonjs-serializers/glTF/2.0/Extensions/KHR_lights_punctual" {
- import { Node } from "babylonjs/node";
- import { INode } from "babylonjs-gltf2interface";
- import { IGLTFExporterExtensionV2 } from "babylonjs-serializers/glTF/2.0/glTFExporterExtension";
- import { _Exporter } from "babylonjs-serializers/glTF/2.0/glTFExporter";
- /**
- * [Specification](https://github.com/KhronosGroup/glTF/blob/master/extensions/2.0/Khronos/KHR_lights_punctual/README.md)
- */
- export class KHR_lights_punctual implements IGLTFExporterExtensionV2 {
- /** The name of this extension. */
- readonly name: string;
- /** Defines whether this extension is enabled. */
- enabled: boolean;
- /** Defines whether this extension is required */
- required: boolean;
- /** Reference to the glTF exporter */
- private _exporter;
- private _lights;
- /** @hidden */
- constructor(exporter: _Exporter);
- /** @hidden */
- dispose(): void;
- /** @hidden */
- get wasUsed(): boolean;
- /** @hidden */
- onExporting(): void;
- /**
- * Define this method to modify the default behavior when exporting a node
- * @param context The context when exporting the node
- * @param node glTF node
- * @param babylonNode BabylonJS node
- * @returns nullable INode promise
- */
- postExportNodeAsync(context: string, node: INode, babylonNode: Node): Promise<INode>;
- }
- }
- declare module "babylonjs-serializers/glTF/2.0/Extensions/KHR_materials_sheen" {
- import { ITextureInfo, IMaterial } from "babylonjs-gltf2interface";
- import { IGLTFExporterExtensionV2 } from "babylonjs-serializers/glTF/2.0/glTFExporterExtension";
- import { _Exporter } from "babylonjs-serializers/glTF/2.0/glTFExporter";
- import { Material } from 'babylonjs/Materials/material';
- import { Texture } from 'babylonjs/Materials/Textures/texture';
- import { BaseTexture } from 'babylonjs/Materials/Textures/baseTexture';
- /**
- * @hidden
- */
- export class KHR_materials_sheen implements IGLTFExporterExtensionV2 {
- /** Name of this extension */
- readonly name: string;
- /** Defines whether this extension is enabled */
- enabled: boolean;
- /** Defines whether this extension is required */
- required: boolean;
- /** Reference to the glTF exporter */
- private _textureInfos;
- private _exportedTextures;
- private _wasUsed;
- constructor(exporter: _Exporter);
- dispose(): void;
- /** @hidden */
- get wasUsed(): boolean;
- private _getTextureIndex;
- postExportTexture?(context: string, textureInfo: ITextureInfo, babylonTexture: Texture): void;
- postExportMaterialAdditionalTextures?(context: string, node: IMaterial, babylonMaterial: Material): BaseTexture[];
- postExportMaterialAsync?(context: string, node: IMaterial, babylonMaterial: Material): Promise<IMaterial>;
- }
- }
- declare module "babylonjs-serializers/glTF/2.0/Extensions/index" {
- export * from "babylonjs-serializers/glTF/2.0/Extensions/KHR_texture_transform";
- export * from "babylonjs-serializers/glTF/2.0/Extensions/KHR_lights_punctual";
- export * from "babylonjs-serializers/glTF/2.0/Extensions/KHR_materials_sheen";
- }
- declare module "babylonjs-serializers/glTF/2.0/index" {
- export * from "babylonjs-serializers/glTF/2.0/glTFAnimation";
- export * from "babylonjs-serializers/glTF/2.0/glTFData";
- export * from "babylonjs-serializers/glTF/2.0/glTFExporter";
- export * from "babylonjs-serializers/glTF/2.0/glTFExporterExtension";
- export * from "babylonjs-serializers/glTF/2.0/glTFMaterialExporter";
- export * from "babylonjs-serializers/glTF/2.0/glTFSerializer";
- export * from "babylonjs-serializers/glTF/2.0/glTFUtilities";
- export * from "babylonjs-serializers/glTF/2.0/Extensions/index";
- }
- declare module "babylonjs-serializers/glTF/index" {
- export * from "babylonjs-serializers/glTF/glTFFileExporter";
- export * from "babylonjs-serializers/glTF/2.0/index";
- }
- declare module "babylonjs-serializers/stl/stlSerializer" {
- import { Mesh } from "babylonjs/Meshes/mesh";
- /**
- * Class for generating STL data from a Babylon scene.
- */
- export class STLExport {
- /**
- * Exports the geometry of a Mesh array in .STL file format (ASCII)
- * @param meshes list defines the mesh to serialize
- * @param download triggers the automatic download of the file.
- * @param fileName changes the downloads fileName.
- * @param binary changes the STL to a binary type.
- * @param isLittleEndian toggle for binary type exporter.
- * @returns the STL as UTF8 string
- */
- static CreateSTL(meshes: Mesh[], download?: boolean, fileName?: string, binary?: boolean, isLittleEndian?: boolean): any;
- }
- }
- declare module "babylonjs-serializers/stl/index" {
- export * from "babylonjs-serializers/stl/stlSerializer";
- }
- declare module "babylonjs-serializers/index" {
- export * from "babylonjs-serializers/OBJ/index";
- export * from "babylonjs-serializers/glTF/index";
- export * from "babylonjs-serializers/stl/index";
- }
- declare module "babylonjs-serializers/legacy/legacy-glTF2Serializer" {
- export * from "babylonjs-serializers/glTF/glTFFileExporter";
- export * from "babylonjs-serializers/glTF/2.0/index";
- }
- declare module "babylonjs-serializers/legacy/legacy-objSerializer" {
- export * from "babylonjs-serializers/OBJ/index";
- }
- declare module "babylonjs-serializers/legacy/legacy-stlSerializer" {
- export * from "babylonjs-serializers/stl/index";
- }
- declare module "babylonjs-serializers/legacy/legacy" {
- import "babylonjs-serializers/index";
- export * from "babylonjs-serializers/legacy/legacy-glTF2Serializer";
- export * from "babylonjs-serializers/legacy/legacy-objSerializer";
- export * from "babylonjs-serializers/legacy/legacy-stlSerializer";
- }
- declare module "babylonjs-serializers" {
- export * from "babylonjs-serializers/legacy/legacy";
- }
- declare module BABYLON {
- /**
- * Class for generating OBJ data from a Babylon scene.
- */
- export class OBJExport {
- /**
- * Exports the geometry of a Mesh array in .OBJ file format (text)
- * @param mesh defines the list of meshes to serialize
- * @param materials defines if materials should be exported
- * @param matlibname defines the name of the associated mtl file
- * @param globalposition defines if the exported positions are globals or local to the exported mesh
- * @returns the OBJ content
- */
- static OBJ(mesh: Mesh[], materials?: boolean, matlibname?: string, globalposition?: boolean): string;
- /**
- * Exports the material(s) of a mesh in .MTL file format (text)
- * @param mesh defines the mesh to extract the material from
- * @returns the mtl content
- */
- static MTL(mesh: Mesh): string;
- }
- }
- declare module BABYLON {
- /** @hidden */
- export var __IGLTFExporterExtension: number;
- /**
- * Interface for extending the exporter
- * @hidden
- */
- export interface IGLTFExporterExtension {
- /**
- * The name of this extension
- */
- readonly name: string;
- /**
- * Defines whether this extension is enabled
- */
- enabled: boolean;
- /**
- * Defines whether this extension is required
- */
- required: boolean;
- }
- }
- declare module BABYLON.GLTF2.Exporter {
- /** @hidden */
- export var __IGLTFExporterExtensionV2: number;
- /**
- * Interface for a glTF exporter extension
- * @hidden
- */
- export interface IGLTFExporterExtensionV2 extends IGLTFExporterExtension, IDisposable {
- /**
- * Define this method to modify the default behavior before exporting a texture
- * @param context The context when loading the asset
- * @param babylonTexture The Babylon.js texture
- * @param mimeType The mime-type of the generated image
- * @returns A promise that resolves with the exported texture
- */
- preExportTextureAsync?(context: string, babylonTexture: Texture, mimeType: ImageMimeType): Promise<Texture>;
- /**
- * Define this method to get notified when a texture info is created
- * @param context The context when loading the asset
- * @param textureInfo The glTF texture info
- * @param babylonTexture The Babylon.js texture
- */
- postExportTexture?(context: string, textureInfo: ITextureInfo, babylonTexture: BaseTexture): void;
- /**
- * Define this method to modify the default behavior when exporting texture info
- * @param context The context when loading the asset
- * @param meshPrimitive glTF mesh primitive
- * @param babylonSubMesh Babylon submesh
- * @param binaryWriter glTF serializer binary writer instance
- * @returns nullable IMeshPrimitive promise
- */
- postExportMeshPrimitiveAsync?(context: string, meshPrimitive: IMeshPrimitive, babylonSubMesh: SubMesh, binaryWriter: _BinaryWriter): Promise<IMeshPrimitive>;
- /**
- * Define this method to modify the default behavior when exporting a node
- * @param context The context when exporting the node
- * @param node glTF node
- * @param babylonNode BabylonJS node
- * @returns nullable INode promise
- */
- postExportNodeAsync?(context: string, node: INode, babylonNode: Node): Promise<INode>;
- /**
- * Define this method to modify the default behavior when exporting a material
- * @param material glTF material
- * @param babylonMaterial BabylonJS material
- * @returns nullable IMaterial promise
- */
- postExportMaterialAsync?(context: string, node: IMaterial, babylonMaterial: Material): Promise<IMaterial>;
- /**
- * Define this method to return additional textures to export from a material
- * @param material glTF material
- * @param babylonMaterial BabylonJS material
- * @returns List of textures
- */
- postExportMaterialAdditionalTextures?(context: string, node: IMaterial, babylonMaterial: Material): BaseTexture[];
- /** Gets a boolean indicating that this extension was used */
- wasUsed: boolean;
- /** Gets a boolean indicating that this extension is required for the file to work */
- required: boolean;
- /**
- * Called after the exporter state changes to EXPORTING
- */
- onExporting?(): void;
- }
- }
- declare module BABYLON.GLTF2.Exporter {
- /**
- * Utility methods for working with glTF material conversion properties. This class should only be used internally
- * @hidden
- */
- export class _GLTFMaterialExporter {
- /**
- * Represents the dielectric specular values for R, G and B
- */
- private static readonly _DielectricSpecular;
- /**
- * Allows the maximum specular power to be defined for material calculations
- */
- private static readonly _MaxSpecularPower;
- /**
- * Mapping to store textures
- */
- private _textureMap;
- /**
- * Numeric tolerance value
- */
- private static readonly _Epsilon;
- /**
- * Reference to the glTF Exporter
- */
- private _exporter;
- constructor(exporter: _Exporter);
- /**
- * Specifies if two colors are approximately equal in value
- * @param color1 first color to compare to
- * @param color2 second color to compare to
- * @param epsilon threshold value
- */
- private static FuzzyEquals;
- /**
- * Gets the materials from a Babylon scene and converts them to glTF materials
- * @param scene babylonjs scene
- * @param mimeType texture mime type
- * @param images array of images
- * @param textures array of textures
- * @param materials array of materials
- * @param imageData mapping of texture names to base64 textures
- * @param hasTextureCoords specifies if texture coordinates are present on the material
- */
- _convertMaterialsToGLTFAsync(babylonMaterials: Material[], mimeType: ImageMimeType, hasTextureCoords: boolean): Promise<void>;
- /**
- * Makes a copy of the glTF material without the texture parameters
- * @param originalMaterial original glTF material
- * @returns glTF material without texture parameters
- */
- _stripTexturesFromMaterial(originalMaterial: IMaterial): IMaterial;
- /**
- * Specifies if the material has any texture parameters present
- * @param material glTF Material
- * @returns boolean specifying if texture parameters are present
- */
- _hasTexturesPresent(material: IMaterial): boolean;
- /**
- * Converts a Babylon StandardMaterial to a glTF Metallic Roughness Material
- * @param babylonStandardMaterial
- * @returns glTF Metallic Roughness Material representation
- */
- _convertToGLTFPBRMetallicRoughness(babylonStandardMaterial: StandardMaterial): IMaterialPbrMetallicRoughness;
- /**
- * Computes the metallic factor
- * @param diffuse diffused value
- * @param specular specular value
- * @param oneMinusSpecularStrength one minus the specular strength
- * @returns metallic value
- */
- static _SolveMetallic(diffuse: number, specular: number, oneMinusSpecularStrength: number): number;
- /**
- * Sets the glTF alpha mode to a glTF material from the Babylon Material
- * @param glTFMaterial glTF material
- * @param babylonMaterial Babylon material
- */
- private static _SetAlphaMode;
- /**
- * Converts a Babylon Standard Material to a glTF Material
- * @param babylonStandardMaterial BJS Standard Material
- * @param mimeType mime type to use for the textures
- * @param images array of glTF image interfaces
- * @param textures array of glTF texture interfaces
- * @param materials array of glTF material interfaces
- * @param imageData map of image file name to data
- * @param hasTextureCoords specifies if texture coordinates are present on the submesh to determine if textures should be applied
- */
- _convertStandardMaterialAsync(babylonStandardMaterial: StandardMaterial, mimeType: ImageMimeType, hasTextureCoords: boolean): Promise<IMaterial>;
- private _finishMaterial;
- /**
- * Converts a Babylon PBR Metallic Roughness Material to a glTF Material
- * @param babylonPBRMetalRoughMaterial BJS PBR Metallic Roughness Material
- * @param mimeType mime type to use for the textures
- * @param images array of glTF image interfaces
- * @param textures array of glTF texture interfaces
- * @param materials array of glTF material interfaces
- * @param imageData map of image file name to data
- * @param hasTextureCoords specifies if texture coordinates are present on the submesh to determine if textures should be applied
- */
- _convertPBRMetallicRoughnessMaterialAsync(babylonPBRMetalRoughMaterial: PBRMetallicRoughnessMaterial, mimeType: ImageMimeType, hasTextureCoords: boolean): Promise<IMaterial>;
- /**
- * Converts an image typed array buffer to a base64 image
- * @param buffer typed array buffer
- * @param width width of the image
- * @param height height of the image
- * @param mimeType mimetype of the image
- * @returns base64 image string
- */
- private _createBase64FromCanvasAsync;
- /**
- * Generates a white texture based on the specified width and height
- * @param width width of the texture in pixels
- * @param height height of the texture in pixels
- * @param scene babylonjs scene
- * @returns white texture
- */
- private _createWhiteTexture;
- /**
- * Resizes the two source textures to the same dimensions. If a texture is null, a default white texture is generated. If both textures are null, returns null
- * @param texture1 first texture to resize
- * @param texture2 second texture to resize
- * @param scene babylonjs scene
- * @returns resized textures or null
- */
- private _resizeTexturesToSameDimensions;
- /**
- * Converts an array of pixels to a Float32Array
- * Throws an error if the pixel format is not supported
- * @param pixels - array buffer containing pixel values
- * @returns Float32 of pixels
- */
- private _convertPixelArrayToFloat32;
- /**
- * Convert Specular Glossiness Textures to Metallic Roughness
- * See link below for info on the material conversions from PBR Metallic/Roughness and Specular/Glossiness
- * @link https://github.com/KhronosGroup/glTF/blob/master/extensions/2.0/Khronos/KHR_materials_pbrSpecularGlossiness/examples/convert-between-workflows-bjs/js/babylon.pbrUtilities.js
- * @param diffuseTexture texture used to store diffuse information
- * @param specularGlossinessTexture texture used to store specular and glossiness information
- * @param factors specular glossiness material factors
- * @param mimeType the mime type to use for the texture
- * @returns pbr metallic roughness interface or null
- */
- private _convertSpecularGlossinessTexturesToMetallicRoughnessAsync;
- /**
- * Converts specular glossiness material properties to metallic roughness
- * @param specularGlossiness interface with specular glossiness material properties
- * @returns interface with metallic roughness material properties
- */
- private _convertSpecularGlossinessToMetallicRoughness;
- /**
- * Calculates the surface reflectance, independent of lighting conditions
- * @param color Color source to calculate brightness from
- * @returns number representing the perceived brightness, or zero if color is undefined
- */
- private _getPerceivedBrightness;
- /**
- * Returns the maximum color component value
- * @param color
- * @returns maximum color component value, or zero if color is null or undefined
- */
- private _getMaxComponent;
- /**
- * Convert a PBRMaterial (Metallic/Roughness) to Metallic Roughness factors
- * @param babylonPBRMaterial BJS PBR Metallic Roughness Material
- * @param mimeType mime type to use for the textures
- * @param images array of glTF image interfaces
- * @param textures array of glTF texture interfaces
- * @param glTFPbrMetallicRoughness glTF PBR Metallic Roughness interface
- * @param imageData map of image file name to data
- * @param hasTextureCoords specifies if texture coordinates are present on the submesh to determine if textures should be applied
- * @returns glTF PBR Metallic Roughness factors
- */
- private _convertMetalRoughFactorsToMetallicRoughnessAsync;
- private _getGLTFTextureSampler;
- private _getGLTFTextureWrapMode;
- private _getGLTFTextureWrapModesSampler;
- /**
- * Convert a PBRMaterial (Specular/Glossiness) to Metallic Roughness factors
- * @param babylonPBRMaterial BJS PBR Metallic Roughness Material
- * @param mimeType mime type to use for the textures
- * @param images array of glTF image interfaces
- * @param textures array of glTF texture interfaces
- * @param glTFPbrMetallicRoughness glTF PBR Metallic Roughness interface
- * @param imageData map of image file name to data
- * @param hasTextureCoords specifies if texture coordinates are present on the submesh to determine if textures should be applied
- * @returns glTF PBR Metallic Roughness factors
- */
- private _convertSpecGlossFactorsToMetallicRoughnessAsync;
- /**
- * Converts a Babylon PBR Metallic Roughness Material to a glTF Material
- * @param babylonPBRMaterial BJS PBR Metallic Roughness Material
- * @param mimeType mime type to use for the textures
- * @param images array of glTF image interfaces
- * @param textures array of glTF texture interfaces
- * @param materials array of glTF material interfaces
- * @param imageData map of image file name to data
- * @param hasTextureCoords specifies if texture coordinates are present on the submesh to determine if textures should be applied
- */
- _convertPBRMaterialAsync(babylonPBRMaterial: PBRMaterial, mimeType: ImageMimeType, hasTextureCoords: boolean): Promise<IMaterial>;
- private setMetallicRoughnessPbrMaterial;
- private getPixelsFromTexture;
- /**
- * Extracts a texture from a Babylon texture into file data and glTF data
- * @param babylonTexture Babylon texture to extract
- * @param mimeType Mime Type of the babylonTexture
- * @return glTF texture info, or null if the texture format is not supported
- */
- _exportTextureAsync(babylonTexture: BaseTexture, mimeType: ImageMimeType): Promise<Nullable<ITextureInfo>>;
- _exportTextureInfoAsync(babylonTexture: BaseTexture, mimeType: ImageMimeType): Promise<Nullable<ITextureInfo>>;
- /**
- * Builds a texture from base64 string
- * @param base64Texture base64 texture string
- * @param baseTextureName Name to use for the texture
- * @param mimeType image mime type for the texture
- * @param images array of images
- * @param textures array of textures
- * @param imageData map of image data
- * @returns glTF texture info, or null if the texture format is not supported
- */
- private _getTextureInfoFromBase64;
- }
- }
- declare module BABYLON {
- /**
- * Class for holding and downloading glTF file data
- */
- export class GLTFData {
- /**
- * Object which contains the file name as the key and its data as the value
- */
- glTFFiles: {
- [fileName: string]: string | Blob;
- };
- /**
- * Initializes the glTF file object
- */
- constructor();
- /**
- * Downloads the glTF data as files based on their names and data
- */
- downloadFiles(): void;
- }
- }
- declare module BABYLON {
- /**
- * Holds a collection of exporter options and parameters
- */
- export interface IExportOptions {
- /**
- * Function which indicates whether a babylon node should be exported or not
- * @param node source Babylon node. It is used to check whether it should be exported to glTF or not
- * @returns boolean, which indicates whether the node should be exported (true) or not (false)
- */
- shouldExportNode?(node: Node): boolean;
- /**
- * Function used to extract the part of node's metadata that will be exported into glTF node extras
- * @param metadata source metadata to read from
- * @returns the data to store to glTF node extras
- */
- metadataSelector?(metadata: any): any;
- /**
- * The sample rate to bake animation curves
- */
- animationSampleRate?: number;
- /**
- * Begin serialization without waiting for the scene to be ready
- */
- exportWithoutWaitingForScene?: boolean;
- }
- /**
- * Class for generating glTF data from a Babylon scene.
- */
- export class GLTF2Export {
- /**
- * Exports the geometry of the scene to .gltf file format asynchronously
- * @param scene Babylon scene with scene hierarchy information
- * @param filePrefix File prefix to use when generating the glTF file
- * @param options Exporter options
- * @returns Returns an object with a .gltf file and associates texture names
- * as keys and their data and paths as values
- */
- static GLTFAsync(scene: Scene, filePrefix: string, options?: IExportOptions): Promise<GLTFData>;
- private static _PreExportAsync;
- private static _PostExportAsync;
- /**
- * Exports the geometry of the scene to .glb file format asychronously
- * @param scene Babylon scene with scene hierarchy information
- * @param filePrefix File prefix to use when generating glb file
- * @param options Exporter options
- * @returns Returns an object with a .glb filename as key and data as value
- */
- static GLBAsync(scene: Scene, filePrefix: string, options?: IExportOptions): Promise<GLTFData>;
- }
- }
- declare module BABYLON.GLTF2.Exporter {
- /**
- * @hidden
- */
- export class _GLTFUtilities {
- /**
- * Creates a buffer view based on the supplied arguments
- * @param bufferIndex index value of the specified buffer
- * @param byteOffset byte offset value
- * @param byteLength byte length of the bufferView
- * @param byteStride byte distance between conequential elements
- * @param name name of the buffer view
- * @returns bufferView for glTF
- */
- static _CreateBufferView(bufferIndex: number, byteOffset: number, byteLength: number, byteStride?: number, name?: string): IBufferView;
- /**
- * Creates an accessor based on the supplied arguments
- * @param bufferviewIndex The index of the bufferview referenced by this accessor
- * @param name The name of the accessor
- * @param type The type of the accessor
- * @param componentType The datatype of components in the attribute
- * @param count The number of attributes referenced by this accessor
- * @param byteOffset The offset relative to the start of the bufferView in bytes
- * @param min Minimum value of each component in this attribute
- * @param max Maximum value of each component in this attribute
- * @returns accessor for glTF
- */
- static _CreateAccessor(bufferviewIndex: number, name: string, type: AccessorType, componentType: AccessorComponentType, count: number, byteOffset: Nullable<number>, min: Nullable<number[]>, max: Nullable<number[]>): IAccessor;
- /**
- * Calculates the minimum and maximum values of an array of position floats
- * @param positions Positions array of a mesh
- * @param vertexStart Starting vertex offset to calculate min and max values
- * @param vertexCount Number of vertices to check for min and max values
- * @returns min number array and max number array
- */
- static _CalculateMinMaxPositions(positions: FloatArray, vertexStart: number, vertexCount: number, convertToRightHandedSystem: boolean): {
- min: number[];
- max: number[];
- };
- /**
- * Converts a new right-handed Vector3
- * @param vector vector3 array
- * @returns right-handed Vector3
- */
- static _GetRightHandedPositionVector3(vector: Vector3): Vector3;
- /**
- * Converts a Vector3 to right-handed
- * @param vector Vector3 to convert to right-handed
- */
- static _GetRightHandedPositionVector3FromRef(vector: Vector3): void;
- /**
- * Converts a three element number array to right-handed
- * @param vector number array to convert to right-handed
- */
- static _GetRightHandedPositionArray3FromRef(vector: number[]): void;
- /**
- * Converts a new right-handed Vector3
- * @param vector vector3 array
- * @returns right-handed Vector3
- */
- static _GetRightHandedNormalVector3(vector: Vector3): Vector3;
- /**
- * Converts a Vector3 to right-handed
- * @param vector Vector3 to convert to right-handed
- */
- static _GetRightHandedNormalVector3FromRef(vector: Vector3): void;
- /**
- * Converts a three element number array to right-handed
- * @param vector number array to convert to right-handed
- */
- static _GetRightHandedNormalArray3FromRef(vector: number[]): void;
- /**
- * Converts a Vector4 to right-handed
- * @param vector Vector4 to convert to right-handed
- */
- static _GetRightHandedVector4FromRef(vector: Vector4): void;
- /**
- * Converts a Vector4 to right-handed
- * @param vector Vector4 to convert to right-handed
- */
- static _GetRightHandedArray4FromRef(vector: number[]): void;
- /**
- * Converts a Quaternion to right-handed
- * @param quaternion Source quaternion to convert to right-handed
- */
- static _GetRightHandedQuaternionFromRef(quaternion: Quaternion): void;
- /**
- * Converts a Quaternion to right-handed
- * @param quaternion Source quaternion to convert to right-handed
- */
- static _GetRightHandedQuaternionArrayFromRef(quaternion: number[]): void;
- static _NormalizeTangentFromRef(tangent: Vector4): void;
- }
- }
- declare module BABYLON.GLTF2.Exporter {
- /**
- * Converts Babylon Scene into glTF 2.0.
- * @hidden
- */
- export class _Exporter {
- /**
- * Stores the glTF to export
- */
- _glTF: IGLTF;
- /**
- * Stores all generated buffer views, which represents views into the main glTF buffer data
- */
- _bufferViews: IBufferView[];
- /**
- * Stores all the generated accessors, which is used for accessing the data within the buffer views in glTF
- */
- _accessors: IAccessor[];
- /**
- * Stores all the generated nodes, which contains transform and/or mesh information per node
- */
- private _nodes;
- /**
- * Stores all the generated glTF scenes, which stores multiple node hierarchies
- */
- private _scenes;
- /**
- * Stores all the generated mesh information, each containing a set of primitives to render in glTF
- */
- private _meshes;
- /**
- * Stores all the generated material information, which represents the appearance of each primitive
- */
- _materials: IMaterial[];
- _materialMap: {
- [materialID: number]: number;
- };
- /**
- * Stores all the generated texture information, which is referenced by glTF materials
- */
- _textures: ITexture[];
- /**
- * Stores all the generated image information, which is referenced by glTF textures
- */
- _images: IImage[];
- /**
- * Stores all the texture samplers
- */
- _samplers: ISampler[];
- /**
- * Stores all the generated animation samplers, which is referenced by glTF animations
- */
- /**
- * Stores the animations for glTF models
- */
- private _animations;
- /**
- * Stores the total amount of bytes stored in the glTF buffer
- */
- private _totalByteLength;
- /**
- * Stores a reference to the Babylon scene containing the source geometry and material information
- */
- _babylonScene: Scene;
- /**
- * Stores a map of the image data, where the key is the file name and the value
- * is the image data
- */
- _imageData: {
- [fileName: string]: {
- data: Uint8Array;
- mimeType: ImageMimeType;
- };
- };
- /**
- * Stores a map of the unique id of a node to its index in the node array
- */
- private _nodeMap;
- /**
- * Specifies if the Babylon scene should be converted to right-handed on export
- */
- _convertToRightHandedSystem: boolean;
- /**
- * Baked animation sample rate
- */
- private _animationSampleRate;
- private _options;
- private _localEngine;
- _glTFMaterialExporter: _GLTFMaterialExporter;
- private _extensions;
- private static _ExtensionNames;
- private static _ExtensionFactories;
- private _applyExtension;
- private _applyExtensions;
- _extensionsPreExportTextureAsync(context: string, babylonTexture: Texture, mimeType: ImageMimeType): Promise<Nullable<BaseTexture>>;
- _extensionsPostExportMeshPrimitiveAsync(context: string, meshPrimitive: IMeshPrimitive, babylonSubMesh: SubMesh, binaryWriter: _BinaryWriter): Promise<Nullable<IMeshPrimitive>>;
- _extensionsPostExportNodeAsync(context: string, node: INode, babylonNode: Node): Promise<Nullable<INode>>;
- _extensionsPostExportMaterialAsync(context: string, material: IMaterial, babylonMaterial: Material): Promise<Nullable<IMaterial>>;
- _extensionsPostExportMaterialAdditionalTextures(context: string, material: IMaterial, babylonMaterial: Material): BaseTexture[];
- _extensionsPostExportTextures(context: string, textureInfo: ITextureInfo, babylonTexture: BaseTexture): void;
- private _forEachExtensions;
- private _extensionsOnExporting;
- /**
- * Load glTF serializer extensions
- */
- private _loadExtensions;
- /**
- * Creates a glTF Exporter instance, which can accept optional exporter options
- * @param babylonScene Babylon scene object
- * @param options Options to modify the behavior of the exporter
- */
- constructor(babylonScene: Scene, options?: IExportOptions);
- dispose(): void;
- /**
- * Registers a glTF exporter extension
- * @param name Name of the extension to export
- * @param factory The factory function that creates the exporter extension
- */
- static RegisterExtension(name: string, factory: (exporter: _Exporter) => IGLTFExporterExtensionV2): void;
- /**
- * Un-registers an exporter extension
- * @param name The name fo the exporter extension
- * @returns A boolean indicating whether the extension has been un-registered
- */
- static UnregisterExtension(name: string): boolean;
- /**
- * Lazy load a local engine with premultiplied alpha set to false
- */
- _getLocalEngine(): Engine;
- private reorderIndicesBasedOnPrimitiveMode;
- /**
- * Reorders the vertex attribute data based on the primitive mode. This is necessary when indices are not available and the winding order is
- * clock-wise during export to glTF
- * @param submesh BabylonJS submesh
- * @param primitiveMode Primitive mode of the mesh
- * @param sideOrientation the winding order of the submesh
- * @param vertexBufferKind The type of vertex attribute
- * @param meshAttributeArray The vertex attribute data
- * @param byteOffset The offset to the binary data
- * @param binaryWriter The binary data for the glTF file
- */
- private reorderVertexAttributeDataBasedOnPrimitiveMode;
- /**
- * Reorders the vertex attributes in the correct triangle mode order . This is necessary when indices are not available and the winding order is
- * clock-wise during export to glTF
- * @param submesh BabylonJS submesh
- * @param primitiveMode Primitive mode of the mesh
- * @param sideOrientation the winding order of the submesh
- * @param vertexBufferKind The type of vertex attribute
- * @param meshAttributeArray The vertex attribute data
- * @param byteOffset The offset to the binary data
- * @param binaryWriter The binary data for the glTF file
- */
- private reorderTriangleFillMode;
- /**
- * Reorders the vertex attributes in the correct triangle strip order. This is necessary when indices are not available and the winding order is
- * clock-wise during export to glTF
- * @param submesh BabylonJS submesh
- * @param primitiveMode Primitive mode of the mesh
- * @param sideOrientation the winding order of the submesh
- * @param vertexBufferKind The type of vertex attribute
- * @param meshAttributeArray The vertex attribute data
- * @param byteOffset The offset to the binary data
- * @param binaryWriter The binary data for the glTF file
- */
- private reorderTriangleStripDrawMode;
- /**
- * Reorders the vertex attributes in the correct triangle fan order. This is necessary when indices are not available and the winding order is
- * clock-wise during export to glTF
- * @param submesh BabylonJS submesh
- * @param primitiveMode Primitive mode of the mesh
- * @param sideOrientation the winding order of the submesh
- * @param vertexBufferKind The type of vertex attribute
- * @param meshAttributeArray The vertex attribute data
- * @param byteOffset The offset to the binary data
- * @param binaryWriter The binary data for the glTF file
- */
- private reorderTriangleFanMode;
- /**
- * Writes the vertex attribute data to binary
- * @param vertices The vertices to write to the binary writer
- * @param byteOffset The offset into the binary writer to overwrite binary data
- * @param vertexAttributeKind The vertex attribute type
- * @param meshAttributeArray The vertex attribute data
- * @param binaryWriter The writer containing the binary data
- */
- private writeVertexAttributeData;
- /**
- * Writes mesh attribute data to a data buffer
- * Returns the bytelength of the data
- * @param vertexBufferKind Indicates what kind of vertex data is being passed in
- * @param meshAttributeArray Array containing the attribute data
- * @param binaryWriter The buffer to write the binary data to
- * @param indices Used to specify the order of the vertex data
- */
- writeAttributeData(vertexBufferKind: string, meshAttributeArray: FloatArray, byteStride: number, binaryWriter: _BinaryWriter): void;
- /**
- * Generates glTF json data
- * @param shouldUseGlb Indicates whether the json should be written for a glb file
- * @param glTFPrefix Text to use when prefixing a glTF file
- * @param prettyPrint Indicates whether the json file should be pretty printed (true) or not (false)
- * @returns json data as string
- */
- private generateJSON;
- /**
- * Generates data for .gltf and .bin files based on the glTF prefix string
- * @param glTFPrefix Text to use when prefixing a glTF file
- * @param dispose Dispose the exporter
- * @returns GLTFData with glTF file data
- */
- _generateGLTFAsync(glTFPrefix: string, dispose?: boolean): Promise<GLTFData>;
- /**
- * Creates a binary buffer for glTF
- * @returns array buffer for binary data
- */
- private _generateBinaryAsync;
- /**
- * Pads the number to a multiple of 4
- * @param num number to pad
- * @returns padded number
- */
- private _getPadding;
- /**
- * @hidden
- */
- _generateGLBAsync(glTFPrefix: string, dispose?: boolean): Promise<GLTFData>;
- /**
- * Sets the TRS for each node
- * @param node glTF Node for storing the transformation data
- * @param babylonTransformNode Babylon mesh used as the source for the transformation data
- */
- private setNodeTransformation;
- private getVertexBufferFromMesh;
- /**
- * Creates a bufferview based on the vertices type for the Babylon mesh
- * @param kind Indicates the type of vertices data
- * @param babylonTransformNode The Babylon mesh to get the vertices data from
- * @param binaryWriter The buffer to write the bufferview data to
- */
- private createBufferViewKind;
- /**
- * The primitive mode of the Babylon mesh
- * @param babylonMesh The BabylonJS mesh
- */
- private getMeshPrimitiveMode;
- /**
- * Sets the primitive mode of the glTF mesh primitive
- * @param meshPrimitive glTF mesh primitive
- * @param primitiveMode The primitive mode
- */
- private setPrimitiveMode;
- /**
- * Sets the vertex attribute accessor based of the glTF mesh primitive
- * @param meshPrimitive glTF mesh primitive
- * @param attributeKind vertex attribute
- * @returns boolean specifying if uv coordinates are present
- */
- private setAttributeKind;
- /**
- * Sets data for the primitive attributes of each submesh
- * @param mesh glTF Mesh object to store the primitive attribute information
- * @param babylonTransformNode Babylon mesh to get the primitive attribute data from
- * @param binaryWriter Buffer to write the attribute data to
- */
- private setPrimitiveAttributesAsync;
- /**
- * Creates a glTF scene based on the array of meshes
- * Returns the the total byte offset
- * @param babylonScene Babylon scene to get the mesh data from
- * @param binaryWriter Buffer to write binary data to
- */
- private createSceneAsync;
- /**
- * Creates a mapping of Node unique id to node index and handles animations
- * @param babylonScene Babylon Scene
- * @param nodes Babylon transform nodes
- * @param binaryWriter Buffer to write binary data to
- * @returns Node mapping of unique id to index
- */
- private createNodeMapAndAnimationsAsync;
- /**
- * Creates a glTF node from a Babylon mesh
- * @param babylonMesh Source Babylon mesh
- * @param binaryWriter Buffer for storing geometry data
- * @returns glTF node
- */
- private createNodeAsync;
- }
- /**
- * @hidden
- *
- * Stores glTF binary data. If the array buffer byte length is exceeded, it doubles in size dynamically
- */
- export class _BinaryWriter {
- /**
- * Array buffer which stores all binary data
- */
- private _arrayBuffer;
- /**
- * View of the array buffer
- */
- private _dataView;
- /**
- * byte offset of data in array buffer
- */
- private _byteOffset;
- /**
- * Initialize binary writer with an initial byte length
- * @param byteLength Initial byte length of the array buffer
- */
- constructor(byteLength: number);
- /**
- * Resize the array buffer to the specified byte length
- * @param byteLength
- */
- private resizeBuffer;
- /**
- * Get an array buffer with the length of the byte offset
- * @returns ArrayBuffer resized to the byte offset
- */
- getArrayBuffer(): ArrayBuffer;
- /**
- * Get the byte offset of the array buffer
- * @returns byte offset
- */
- getByteOffset(): number;
- /**
- * Stores an UInt8 in the array buffer
- * @param entry
- * @param byteOffset If defined, specifies where to set the value as an offset.
- */
- setUInt8(entry: number, byteOffset?: number): void;
- /**
- * Gets an UInt32 in the array buffer
- * @param entry
- * @param byteOffset If defined, specifies where to set the value as an offset.
- */
- getUInt32(byteOffset: number): number;
- getVector3Float32FromRef(vector3: Vector3, byteOffset: number): void;
- setVector3Float32FromRef(vector3: Vector3, byteOffset: number): void;
- getVector4Float32FromRef(vector4: Vector4, byteOffset: number): void;
- setVector4Float32FromRef(vector4: Vector4, byteOffset: number): void;
- /**
- * Stores a Float32 in the array buffer
- * @param entry
- */
- setFloat32(entry: number, byteOffset?: number): void;
- /**
- * Stores an UInt32 in the array buffer
- * @param entry
- * @param byteOffset If defined, specifies where to set the value as an offset.
- */
- setUInt32(entry: number, byteOffset?: number): void;
- }
- }
- declare module BABYLON.GLTF2.Exporter {
- /**
- * @hidden
- * Interface to store animation data.
- */
- export interface _IAnimationData {
- /**
- * Keyframe data.
- */
- inputs: number[];
- /**
- * Value data.
- */
- outputs: number[][];
- /**
- * Animation interpolation data.
- */
- samplerInterpolation: AnimationSamplerInterpolation;
- /**
- * Minimum keyframe value.
- */
- inputsMin: number;
- /**
- * Maximum keyframe value.
- */
- inputsMax: number;
- }
- /**
- * @hidden
- */
- export interface _IAnimationInfo {
- /**
- * The target channel for the animation
- */
- animationChannelTargetPath: AnimationChannelTargetPath;
- /**
- * The glTF accessor type for the data.
- */
- dataAccessorType: AccessorType.VEC3 | AccessorType.VEC4;
- /**
- * Specifies if quaternions should be used.
- */
- useQuaternion: boolean;
- }
- /**
- * @hidden
- * Utility class for generating glTF animation data from BabylonJS.
- */
- export class _GLTFAnimation {
- /**
- * @ignore
- *
- * Creates glTF channel animation from BabylonJS animation.
- * @param babylonTransformNode - BabylonJS mesh.
- * @param animation - animation.
- * @param animationChannelTargetPath - The target animation channel.
- * @param convertToRightHandedSystem - Specifies if the values should be converted to right-handed.
- * @param useQuaternion - Specifies if quaternions are used.
- * @returns nullable IAnimationData
- */
- static _CreateNodeAnimation(babylonTransformNode: TransformNode, animation: Animation, animationChannelTargetPath: AnimationChannelTargetPath, convertToRightHandedSystem: boolean, useQuaternion: boolean, animationSampleRate: number): Nullable<_IAnimationData>;
- private static _DeduceAnimationInfo;
- /**
- * @ignore
- * Create node animations from the transform node animations
- * @param babylonNode
- * @param runtimeGLTFAnimation
- * @param idleGLTFAnimations
- * @param nodeMap
- * @param nodes
- * @param binaryWriter
- * @param bufferViews
- * @param accessors
- * @param convertToRightHandedSystem
- */
- static _CreateNodeAnimationFromNodeAnimations(babylonNode: Node, runtimeGLTFAnimation: IAnimation, idleGLTFAnimations: IAnimation[], nodeMap: {
- [key: number]: number;
- }, nodes: INode[], binaryWriter: _BinaryWriter, bufferViews: IBufferView[], accessors: IAccessor[], convertToRightHandedSystem: boolean, animationSampleRate: number): void;
- /**
- * @ignore
- * Create node animations from the animation groups
- * @param babylonScene
- * @param glTFAnimations
- * @param nodeMap
- * @param nodes
- * @param binaryWriter
- * @param bufferViews
- * @param accessors
- * @param convertToRightHandedSystem
- */
- static _CreateNodeAnimationFromAnimationGroups(babylonScene: Scene, glTFAnimations: IAnimation[], nodeMap: {
- [key: number]: number;
- }, nodes: INode[], binaryWriter: _BinaryWriter, bufferViews: IBufferView[], accessors: IAccessor[], convertToRightHandedSystem: boolean, animationSampleRate: number): void;
- private static AddAnimation;
- /**
- * Create a baked animation
- * @param babylonTransformNode BabylonJS mesh
- * @param animation BabylonJS animation corresponding to the BabylonJS mesh
- * @param animationChannelTargetPath animation target channel
- * @param minFrame minimum animation frame
- * @param maxFrame maximum animation frame
- * @param fps frames per second of the animation
- * @param inputs input key frames of the animation
- * @param outputs output key frame data of the animation
- * @param convertToRightHandedSystem converts the values to right-handed
- * @param useQuaternion specifies if quaternions should be used
- */
- private static _CreateBakedAnimation;
- private static _ConvertFactorToVector3OrQuaternion;
- private static _SetInterpolatedValue;
- /**
- * Creates linear animation from the animation key frames
- * @param babylonTransformNode BabylonJS mesh
- * @param animation BabylonJS animation
- * @param animationChannelTargetPath The target animation channel
- * @param frameDelta The difference between the last and first frame of the animation
- * @param inputs Array to store the key frame times
- * @param outputs Array to store the key frame data
- * @param convertToRightHandedSystem Specifies if the position data should be converted to right handed
- * @param useQuaternion Specifies if quaternions are used in the animation
- */
- private static _CreateLinearOrStepAnimation;
- /**
- * Creates cubic spline animation from the animation key frames
- * @param babylonTransformNode BabylonJS mesh
- * @param animation BabylonJS animation
- * @param animationChannelTargetPath The target animation channel
- * @param frameDelta The difference between the last and first frame of the animation
- * @param inputs Array to store the key frame times
- * @param outputs Array to store the key frame data
- * @param convertToRightHandedSystem Specifies if the position data should be converted to right handed
- * @param useQuaternion Specifies if quaternions are used in the animation
- */
- private static _CreateCubicSplineAnimation;
- private static _GetBasePositionRotationOrScale;
- /**
- * Adds a key frame value
- * @param keyFrame
- * @param animation
- * @param outputs
- * @param animationChannelTargetPath
- * @param basePositionRotationOrScale
- * @param convertToRightHandedSystem
- * @param useQuaternion
- */
- private static _AddKeyframeValue;
- /**
- * Determine the interpolation based on the key frames
- * @param keyFrames
- * @param animationChannelTargetPath
- * @param useQuaternion
- */
- private static _DeduceInterpolation;
- /**
- * Adds an input tangent or output tangent to the output data
- * If an input tangent or output tangent is missing, it uses the zero vector or zero quaternion
- * @param tangentType Specifies which type of tangent to handle (inTangent or outTangent)
- * @param outputs The animation data by keyframe
- * @param animationChannelTargetPath The target animation channel
- * @param interpolation The interpolation type
- * @param keyFrame The key frame with the animation data
- * @param frameDelta Time difference between two frames used to scale the tangent by the frame delta
- * @param useQuaternion Specifies if quaternions are used
- * @param convertToRightHandedSystem Specifies if the values should be converted to right-handed
- */
- private static AddSplineTangent;
- /**
- * Get the minimum and maximum key frames' frame values
- * @param keyFrames animation key frames
- * @returns the minimum and maximum key frame value
- */
- private static calculateMinMaxKeyFrames;
- }
- }
- declare module BABYLON.GLTF2.Exporter {
- /** @hidden */
- export var textureTransformPixelShader: {
- name: string;
- shader: string;
- };
- }
- declare module BABYLON.GLTF2.Exporter.Extensions {
- /**
- * @hidden
- */
- export class KHR_texture_transform implements IGLTFExporterExtensionV2 {
- private _recordedTextures;
- /** Name of this extension */
- readonly name: string;
- /** Defines whether this extension is enabled */
- enabled: boolean;
- /** Defines whether this extension is required */
- required: boolean;
- /** Reference to the glTF exporter */
- private _wasUsed;
- constructor(exporter: _Exporter);
- dispose(): void;
- /** @hidden */
- get wasUsed(): boolean;
- postExportTexture?(context: string, textureInfo: ITextureInfo, babylonTexture: Texture): void;
- preExportTextureAsync(context: string, babylonTexture: Texture, mimeType: ImageMimeType): Promise<Texture>;
- /**
- * Transform the babylon texture by the offset, rotation and scale parameters using a procedural texture
- * @param babylonTexture
- * @param offset
- * @param rotation
- * @param scale
- * @param scene
- */
- private _textureTransformTextureAsync;
- }
- }
- declare module BABYLON.GLTF2.Exporter.Extensions {
- /**
- * [Specification](https://github.com/KhronosGroup/glTF/blob/master/extensions/2.0/Khronos/KHR_lights_punctual/README.md)
- */
- export class KHR_lights_punctual implements IGLTFExporterExtensionV2 {
- /** The name of this extension. */
- readonly name: string;
- /** Defines whether this extension is enabled. */
- enabled: boolean;
- /** Defines whether this extension is required */
- required: boolean;
- /** Reference to the glTF exporter */
- private _exporter;
- private _lights;
- /** @hidden */
- constructor(exporter: _Exporter);
- /** @hidden */
- dispose(): void;
- /** @hidden */
- get wasUsed(): boolean;
- /** @hidden */
- onExporting(): void;
- /**
- * Define this method to modify the default behavior when exporting a node
- * @param context The context when exporting the node
- * @param node glTF node
- * @param babylonNode BabylonJS node
- * @returns nullable INode promise
- */
- postExportNodeAsync(context: string, node: INode, babylonNode: Node): Promise<INode>;
- }
- }
- declare module BABYLON.GLTF2.Exporter.Extensions {
- /**
- * @hidden
- */
- export class KHR_materials_sheen implements IGLTFExporterExtensionV2 {
- /** Name of this extension */
- readonly name: string;
- /** Defines whether this extension is enabled */
- enabled: boolean;
- /** Defines whether this extension is required */
- required: boolean;
- /** Reference to the glTF exporter */
- private _textureInfos;
- private _exportedTextures;
- private _wasUsed;
- constructor(exporter: _Exporter);
- dispose(): void;
- /** @hidden */
- get wasUsed(): boolean;
- private _getTextureIndex;
- postExportTexture?(context: string, textureInfo: ITextureInfo, babylonTexture: Texture): void;
- postExportMaterialAdditionalTextures?(context: string, node: IMaterial, babylonMaterial: Material): BaseTexture[];
- postExportMaterialAsync?(context: string, node: IMaterial, babylonMaterial: Material): Promise<IMaterial>;
- }
- }
- declare module BABYLON {
- /**
- * Class for generating STL data from a Babylon scene.
- */
- export class STLExport {
- /**
- * Exports the geometry of a Mesh array in .STL file format (ASCII)
- * @param meshes list defines the mesh to serialize
- * @param download triggers the automatic download of the file.
- * @param fileName changes the downloads fileName.
- * @param binary changes the STL to a binary type.
- * @param isLittleEndian toggle for binary type exporter.
- * @returns the STL as UTF8 string
- */
- static CreateSTL(meshes: Mesh[], download?: boolean, fileName?: string, binary?: boolean, isLittleEndian?: boolean): any;
- }
- }
|