UNPKG

three

Version:

JavaScript 3D library

2,041 lines (1,205 loc) 101 kB
/** * @author Kyle-Larson https://github.com/Kyle-Larson * @author Takahiro https://github.com/takahirox * @author Lewy Blue https://github.com/looeee * * Loader loads FBX file and generates Group representing FBX scene. * Requires FBX file to be >= 7.0 and in ASCII or >= 6400 in Binary format * Versions lower than this may load but will probably have errors * * Needs Support: * Morph normals / blend shape normals * * FBX format references: * https://wiki.blender.org/index.php/User:Mont29/Foundation/FBX_File_Structure * http://help.autodesk.com/view/FBX/2017/ENU/?guid=__cpp_ref_index_html (C++ SDK reference) * * Binary format specification: * https://code.blender.org/2013/08/fbx-binary-file-format-specification/ */ THREE.FBXLoader = ( function () { var fbxTree; var connections; var sceneGraph; function FBXLoader( manager ) { this.manager = ( manager !== undefined ) ? manager : THREE.DefaultLoadingManager; } FBXLoader.prototype = { constructor: FBXLoader, crossOrigin: 'anonymous', load: function ( url, onLoad, onProgress, onError ) { var self = this; var path = ( self.path === undefined ) ? THREE.LoaderUtils.extractUrlBase( url ) : self.path; var loader = new THREE.FileLoader( this.manager ); loader.setResponseType( 'arraybuffer' ); loader.load( url, function ( buffer ) { try { onLoad( self.parse( buffer, path ) ); } catch ( error ) { setTimeout( function () { if ( onError ) onError( error ); self.manager.itemError( url ); }, 0 ); } }, onProgress, onError ); }, setPath: function ( value ) { this.path = value; return this; }, setResourcePath: function ( value ) { this.resourcePath = value; return this; }, setCrossOrigin: function ( value ) { this.crossOrigin = value; return this; }, parse: function ( FBXBuffer, path ) { if ( isFbxFormatBinary( FBXBuffer ) ) { fbxTree = new BinaryParser().parse( FBXBuffer ); } else { var FBXText = convertArrayBufferToString( FBXBuffer ); if ( ! isFbxFormatASCII( FBXText ) ) { throw new Error( 'THREE.FBXLoader: Unknown format.' ); } if ( getFbxVersion( FBXText ) < 7000 ) { throw new Error( 'THREE.FBXLoader: FBX version not supported, FileVersion: ' + getFbxVersion( FBXText ) ); } fbxTree = new TextParser().parse( FBXText ); } // console.log( fbxTree ); var textureLoader = new THREE.TextureLoader( this.manager ).setPath( this.resourcePath || path ).setCrossOrigin( this.crossOrigin ); return new FBXTreeParser( textureLoader ).parse( fbxTree ); } }; // Parse the FBXTree object returned by the BinaryParser or TextParser and return a THREE.Group function FBXTreeParser( textureLoader ) { this.textureLoader = textureLoader; } FBXTreeParser.prototype = { constructor: FBXTreeParser, parse: function () { connections = this.parseConnections(); var images = this.parseImages(); var textures = this.parseTextures( images ); var materials = this.parseMaterials( textures ); var deformers = this.parseDeformers(); var geometryMap = new GeometryParser().parse( deformers ); this.parseScene( deformers, geometryMap, materials ); return sceneGraph; }, // Parses FBXTree.Connections which holds parent-child connections between objects (e.g. material -> texture, model->geometry ) // and details the connection type parseConnections: function () { var connectionMap = new Map(); if ( 'Connections' in fbxTree ) { var rawConnections = fbxTree.Connections.connections; rawConnections.forEach( function ( rawConnection ) { var fromID = rawConnection[ 0 ]; var toID = rawConnection[ 1 ]; var relationship = rawConnection[ 2 ]; if ( ! connectionMap.has( fromID ) ) { connectionMap.set( fromID, { parents: [], children: [] } ); } var parentRelationship = { ID: toID, relationship: relationship }; connectionMap.get( fromID ).parents.push( parentRelationship ); if ( ! connectionMap.has( toID ) ) { connectionMap.set( toID, { parents: [], children: [] } ); } var childRelationship = { ID: fromID, relationship: relationship }; connectionMap.get( toID ).children.push( childRelationship ); } ); } return connectionMap; }, // Parse FBXTree.Objects.Video for embedded image data // These images are connected to textures in FBXTree.Objects.Textures // via FBXTree.Connections. parseImages: function () { var images = {}; var blobs = {}; if ( 'Video' in fbxTree.Objects ) { var videoNodes = fbxTree.Objects.Video; for ( var nodeID in videoNodes ) { var videoNode = videoNodes[ nodeID ]; var id = parseInt( nodeID ); images[ id ] = videoNode.RelativeFilename || videoNode.Filename; // raw image data is in videoNode.Content if ( 'Content' in videoNode ) { var arrayBufferContent = ( videoNode.Content instanceof ArrayBuffer ) && ( videoNode.Content.byteLength > 0 ); var base64Content = ( typeof videoNode.Content === 'string' ) && ( videoNode.Content !== '' ); if ( arrayBufferContent || base64Content ) { var image = this.parseImage( videoNodes[ nodeID ] ); blobs[ videoNode.RelativeFilename || videoNode.Filename ] = image; } } } } for ( var id in images ) { var filename = images[ id ]; if ( blobs[ filename ] !== undefined ) images[ id ] = blobs[ filename ]; else images[ id ] = images[ id ].split( '\\' ).pop(); } return images; }, // Parse embedded image data in FBXTree.Video.Content parseImage: function ( videoNode ) { var content = videoNode.Content; var fileName = videoNode.RelativeFilename || videoNode.Filename; var extension = fileName.slice( fileName.lastIndexOf( '.' ) + 1 ).toLowerCase(); var type; switch ( extension ) { case 'bmp': type = 'image/bmp'; break; case 'jpg': case 'jpeg': type = 'image/jpeg'; break; case 'png': type = 'image/png'; break; case 'tif': type = 'image/tiff'; break; case 'tga': if ( typeof THREE.TGALoader !== 'function' ) { console.warn( 'FBXLoader: THREE.TGALoader is required to load TGA textures' ); return; } else { if ( THREE.Loader.Handlers.get( '.tga' ) === null ) { var tgaLoader = new THREE.TGALoader(); tgaLoader.setPath( this.textureLoader.path ); THREE.Loader.Handlers.add( /\.tga$/i, tgaLoader ); } type = 'image/tga'; break; } default: console.warn( 'FBXLoader: Image type "' + extension + '" is not supported.' ); return; } if ( typeof content === 'string' ) { // ASCII format return 'data:' + type + ';base64,' + content; } else { // Binary Format var array = new Uint8Array( content ); return window.URL.createObjectURL( new Blob( [ array ], { type: type } ) ); } }, // Parse nodes in FBXTree.Objects.Texture // These contain details such as UV scaling, cropping, rotation etc and are connected // to images in FBXTree.Objects.Video parseTextures: function ( images ) { var textureMap = new Map(); if ( 'Texture' in fbxTree.Objects ) { var textureNodes = fbxTree.Objects.Texture; for ( var nodeID in textureNodes ) { var texture = this.parseTexture( textureNodes[ nodeID ], images ); textureMap.set( parseInt( nodeID ), texture ); } } return textureMap; }, // Parse individual node in FBXTree.Objects.Texture parseTexture: function ( textureNode, images ) { var texture = this.loadTexture( textureNode, images ); texture.ID = textureNode.id; texture.name = textureNode.attrName; var wrapModeU = textureNode.WrapModeU; var wrapModeV = textureNode.WrapModeV; var valueU = wrapModeU !== undefined ? wrapModeU.value : 0; var valueV = wrapModeV !== undefined ? wrapModeV.value : 0; // http://download.autodesk.com/us/fbx/SDKdocs/FBX_SDK_Help/files/fbxsdkref/class_k_fbx_texture.html#889640e63e2e681259ea81061b85143a // 0: repeat(default), 1: clamp texture.wrapS = valueU === 0 ? THREE.RepeatWrapping : THREE.ClampToEdgeWrapping; texture.wrapT = valueV === 0 ? THREE.RepeatWrapping : THREE.ClampToEdgeWrapping; if ( 'Scaling' in textureNode ) { var values = textureNode.Scaling.value; texture.repeat.x = values[ 0 ]; texture.repeat.y = values[ 1 ]; } return texture; }, // load a texture specified as a blob or data URI, or via an external URL using THREE.TextureLoader loadTexture: function ( textureNode, images ) { var fileName; var currentPath = this.textureLoader.path; var children = connections.get( textureNode.id ).children; if ( children !== undefined && children.length > 0 && images[ children[ 0 ].ID ] !== undefined ) { fileName = images[ children[ 0 ].ID ]; if ( fileName.indexOf( 'blob:' ) === 0 || fileName.indexOf( 'data:' ) === 0 ) { this.textureLoader.setPath( undefined ); } } var texture; var extension = textureNode.FileName.slice( - 3 ).toLowerCase(); if ( extension === 'tga' ) { var loader = THREE.Loader.Handlers.get( '.tga' ); if ( loader === null ) { console.warn( 'FBXLoader: TGALoader not found, creating empty placeholder texture for', fileName ); texture = new THREE.Texture(); } else { texture = loader.load( fileName ); } } else if ( extension === 'psd' ) { console.warn( 'FBXLoader: PSD textures are not supported, creating empty placeholder texture for', fileName ); texture = new THREE.Texture(); } else { texture = this.textureLoader.load( fileName ); } this.textureLoader.setPath( currentPath ); return texture; }, // Parse nodes in FBXTree.Objects.Material parseMaterials: function ( textureMap ) { var materialMap = new Map(); if ( 'Material' in fbxTree.Objects ) { var materialNodes = fbxTree.Objects.Material; for ( var nodeID in materialNodes ) { var material = this.parseMaterial( materialNodes[ nodeID ], textureMap ); if ( material !== null ) materialMap.set( parseInt( nodeID ), material ); } } return materialMap; }, // Parse single node in FBXTree.Objects.Material // Materials are connected to texture maps in FBXTree.Objects.Textures // FBX format currently only supports Lambert and Phong shading models parseMaterial: function ( materialNode, textureMap ) { var ID = materialNode.id; var name = materialNode.attrName; var type = materialNode.ShadingModel; // Case where FBX wraps shading model in property object. if ( typeof type === 'object' ) { type = type.value; } // Ignore unused materials which don't have any connections. if ( ! connections.has( ID ) ) return null; var parameters = this.parseParameters( materialNode, textureMap, ID ); var material; switch ( type.toLowerCase() ) { case 'phong': material = new THREE.MeshPhongMaterial(); break; case 'lambert': material = new THREE.MeshLambertMaterial(); break; default: console.warn( 'THREE.FBXLoader: unknown material type "%s". Defaulting to MeshPhongMaterial.', type ); material = new THREE.MeshPhongMaterial( { color: 0x3300ff } ); break; } material.setValues( parameters ); material.name = name; return material; }, // Parse FBX material and return parameters suitable for a three.js material // Also parse the texture map and return any textures associated with the material parseParameters: function ( materialNode, textureMap, ID ) { var parameters = {}; if ( materialNode.BumpFactor ) { parameters.bumpScale = materialNode.BumpFactor.value; } if ( materialNode.Diffuse ) { parameters.color = new THREE.Color().fromArray( materialNode.Diffuse.value ); } else if ( materialNode.DiffuseColor && materialNode.DiffuseColor.type === 'Color' ) { // The blender exporter exports diffuse here instead of in materialNode.Diffuse parameters.color = new THREE.Color().fromArray( materialNode.DiffuseColor.value ); } if ( materialNode.DisplacementFactor ) { parameters.displacementScale = materialNode.DisplacementFactor.value; } if ( materialNode.Emissive ) { parameters.emissive = new THREE.Color().fromArray( materialNode.Emissive.value ); } else if ( materialNode.EmissiveColor && materialNode.EmissiveColor.type === 'Color' ) { // The blender exporter exports emissive color here instead of in materialNode.Emissive parameters.emissive = new THREE.Color().fromArray( materialNode.EmissiveColor.value ); } if ( materialNode.EmissiveFactor ) { parameters.emissiveIntensity = parseFloat( materialNode.EmissiveFactor.value ); } if ( materialNode.Opacity ) { parameters.opacity = parseFloat( materialNode.Opacity.value ); } if ( parameters.opacity < 1.0 ) { parameters.transparent = true; } if ( materialNode.ReflectionFactor ) { parameters.reflectivity = materialNode.ReflectionFactor.value; } if ( materialNode.Shininess ) { parameters.shininess = materialNode.Shininess.value; } if ( materialNode.Specular ) { parameters.specular = new THREE.Color().fromArray( materialNode.Specular.value ); } else if ( materialNode.SpecularColor && materialNode.SpecularColor.type === 'Color' ) { // The blender exporter exports specular color here instead of in materialNode.Specular parameters.specular = new THREE.Color().fromArray( materialNode.SpecularColor.value ); } var self = this; connections.get( ID ).children.forEach( function ( child ) { var type = child.relationship; switch ( type ) { case 'Bump': parameters.bumpMap = self.getTexture( textureMap, child.ID ); break; case 'DiffuseColor': parameters.map = self.getTexture( textureMap, child.ID ); break; case 'DisplacementColor': parameters.displacementMap = self.getTexture( textureMap, child.ID ); break; case 'EmissiveColor': parameters.emissiveMap = self.getTexture( textureMap, child.ID ); break; case 'NormalMap': parameters.normalMap = self.getTexture( textureMap, child.ID ); break; case 'ReflectionColor': parameters.envMap = self.getTexture( textureMap, child.ID ); parameters.envMap.mapping = THREE.EquirectangularReflectionMapping; break; case 'SpecularColor': parameters.specularMap = self.getTexture( textureMap, child.ID ); break; case 'TransparentColor': parameters.alphaMap = self.getTexture( textureMap, child.ID ); parameters.transparent = true; break; case 'AmbientColor': case 'ShininessExponent': // AKA glossiness map case 'SpecularFactor': // AKA specularLevel case 'VectorDisplacementColor': // NOTE: Seems to be a copy of DisplacementColor default: console.warn( 'THREE.FBXLoader: %s map is not supported in three.js, skipping texture.', type ); break; } } ); return parameters; }, // get a texture from the textureMap for use by a material. getTexture: function ( textureMap, id ) { // if the texture is a layered texture, just use the first layer and issue a warning if ( 'LayeredTexture' in fbxTree.Objects && id in fbxTree.Objects.LayeredTexture ) { console.warn( 'THREE.FBXLoader: layered textures are not supported in three.js. Discarding all but first layer.' ); id = connections.get( id ).children[ 0 ].ID; } return textureMap.get( id ); }, // Parse nodes in FBXTree.Objects.Deformer // Deformer node can contain skinning or Vertex Cache animation data, however only skinning is supported here // Generates map of Skeleton-like objects for use later when generating and binding skeletons. parseDeformers: function () { var skeletons = {}; var morphTargets = {}; if ( 'Deformer' in fbxTree.Objects ) { var DeformerNodes = fbxTree.Objects.Deformer; for ( var nodeID in DeformerNodes ) { var deformerNode = DeformerNodes[ nodeID ]; var relationships = connections.get( parseInt( nodeID ) ); if ( deformerNode.attrType === 'Skin' ) { var skeleton = this.parseSkeleton( relationships, DeformerNodes ); skeleton.ID = nodeID; if ( relationships.parents.length > 1 ) console.warn( 'THREE.FBXLoader: skeleton attached to more than one geometry is not supported.' ); skeleton.geometryID = relationships.parents[ 0 ].ID; skeletons[ nodeID ] = skeleton; } else if ( deformerNode.attrType === 'BlendShape' ) { var morphTarget = { id: nodeID, }; morphTarget.rawTargets = this.parseMorphTargets( relationships, DeformerNodes ); morphTarget.id = nodeID; if ( relationships.parents.length > 1 ) console.warn( 'THREE.FBXLoader: morph target attached to more than one geometry is not supported.' ); morphTargets[ nodeID ] = morphTarget; } } } return { skeletons: skeletons, morphTargets: morphTargets, }; }, // Parse single nodes in FBXTree.Objects.Deformer // The top level skeleton node has type 'Skin' and sub nodes have type 'Cluster' // Each skin node represents a skeleton and each cluster node represents a bone parseSkeleton: function ( relationships, deformerNodes ) { var rawBones = []; relationships.children.forEach( function ( child ) { var boneNode = deformerNodes[ child.ID ]; if ( boneNode.attrType !== 'Cluster' ) return; var rawBone = { ID: child.ID, indices: [], weights: [], transformLink: new THREE.Matrix4().fromArray( boneNode.TransformLink.a ), // transform: new THREE.Matrix4().fromArray( boneNode.Transform.a ), // linkMode: boneNode.Mode, }; if ( 'Indexes' in boneNode ) { rawBone.indices = boneNode.Indexes.a; rawBone.weights = boneNode.Weights.a; } rawBones.push( rawBone ); } ); return { rawBones: rawBones, bones: [] }; }, // The top level morph deformer node has type "BlendShape" and sub nodes have type "BlendShapeChannel" parseMorphTargets: function ( relationships, deformerNodes ) { var rawMorphTargets = []; for ( var i = 0; i < relationships.children.length; i ++ ) { var child = relationships.children[ i ]; var morphTargetNode = deformerNodes[ child.ID ]; var rawMorphTarget = { name: morphTargetNode.attrName, initialWeight: morphTargetNode.DeformPercent, id: morphTargetNode.id, fullWeights: morphTargetNode.FullWeights.a }; if ( morphTargetNode.attrType !== 'BlendShapeChannel' ) return; var targetRelationships = connections.get( parseInt( child.ID ) ); targetRelationships.children.forEach( function ( child ) { if ( child.relationship === undefined ) rawMorphTarget.geoID = child.ID; } ); rawMorphTargets.push( rawMorphTarget ); } return rawMorphTargets; }, // create the main THREE.Group() to be returned by the loader parseScene: function ( deformers, geometryMap, materialMap ) { sceneGraph = new THREE.Group(); var modelMap = this.parseModels( deformers.skeletons, geometryMap, materialMap ); var modelNodes = fbxTree.Objects.Model; var self = this; modelMap.forEach( function ( model ) { var modelNode = modelNodes[ model.ID ]; self.setLookAtProperties( model, modelNode ); var parentConnections = connections.get( model.ID ).parents; parentConnections.forEach( function ( connection ) { var parent = modelMap.get( connection.ID ); if ( parent !== undefined ) parent.add( model ); } ); if ( model.parent === null ) { sceneGraph.add( model ); } } ); this.bindSkeleton( deformers.skeletons, geometryMap, modelMap ); this.createAmbientLight(); this.setupMorphMaterials(); sceneGraph.traverse( function ( node ) { if ( node.userData.transformData ) { if ( node.parent ) node.userData.transformData.parentMatrixWorld = node.parent.matrix; var transform = generateTransform( node.userData.transformData ); node.applyMatrix( transform ); } } ); var animations = new AnimationParser().parse(); // if all the models where already combined in a single group, just return that if ( sceneGraph.children.length === 1 && sceneGraph.children[ 0 ].isGroup ) { sceneGraph.children[ 0 ].animations = animations; sceneGraph = sceneGraph.children[ 0 ]; } sceneGraph.animations = animations; }, // parse nodes in FBXTree.Objects.Model parseModels: function ( skeletons, geometryMap, materialMap ) { var modelMap = new Map(); var modelNodes = fbxTree.Objects.Model; for ( var nodeID in modelNodes ) { var id = parseInt( nodeID ); var node = modelNodes[ nodeID ]; var relationships = connections.get( id ); var model = this.buildSkeleton( relationships, skeletons, id, node.attrName ); if ( ! model ) { switch ( node.attrType ) { case 'Camera': model = this.createCamera( relationships ); break; case 'Light': model = this.createLight( relationships ); break; case 'Mesh': model = this.createMesh( relationships, geometryMap, materialMap ); break; case 'NurbsCurve': model = this.createCurve( relationships, geometryMap ); break; case 'LimbNode': case 'Root': model = new THREE.Bone(); break; case 'Null': default: model = new THREE.Group(); break; } model.name = THREE.PropertyBinding.sanitizeNodeName( node.attrName ); model.ID = id; } this.getTransformData( model, node ); modelMap.set( id, model ); } return modelMap; }, buildSkeleton: function ( relationships, skeletons, id, name ) { var bone = null; relationships.parents.forEach( function ( parent ) { for ( var ID in skeletons ) { var skeleton = skeletons[ ID ]; skeleton.rawBones.forEach( function ( rawBone, i ) { if ( rawBone.ID === parent.ID ) { var subBone = bone; bone = new THREE.Bone(); bone.matrixWorld.copy( rawBone.transformLink ); // set name and id here - otherwise in cases where "subBone" is created it will not have a name / id bone.name = THREE.PropertyBinding.sanitizeNodeName( name ); bone.ID = id; skeleton.bones[ i ] = bone; // In cases where a bone is shared between multiple meshes // duplicate the bone here and and it as a child of the first bone if ( subBone !== null ) { bone.add( subBone ); } } } ); } } ); return bone; }, // create a THREE.PerspectiveCamera or THREE.OrthographicCamera createCamera: function ( relationships ) { var model; var cameraAttribute; relationships.children.forEach( function ( child ) { var attr = fbxTree.Objects.NodeAttribute[ child.ID ]; if ( attr !== undefined ) { cameraAttribute = attr; } } ); if ( cameraAttribute === undefined ) { model = new THREE.Object3D(); } else { var type = 0; if ( cameraAttribute.CameraProjectionType !== undefined && cameraAttribute.CameraProjectionType.value === 1 ) { type = 1; } var nearClippingPlane = 1; if ( cameraAttribute.NearPlane !== undefined ) { nearClippingPlane = cameraAttribute.NearPlane.value / 1000; } var farClippingPlane = 1000; if ( cameraAttribute.FarPlane !== undefined ) { farClippingPlane = cameraAttribute.FarPlane.value / 1000; } var width = window.innerWidth; var height = window.innerHeight; if ( cameraAttribute.AspectWidth !== undefined && cameraAttribute.AspectHeight !== undefined ) { width = cameraAttribute.AspectWidth.value; height = cameraAttribute.AspectHeight.value; } var aspect = width / height; var fov = 45; if ( cameraAttribute.FieldOfView !== undefined ) { fov = cameraAttribute.FieldOfView.value; } var focalLength = cameraAttribute.FocalLength ? cameraAttribute.FocalLength.value : null; switch ( type ) { case 0: // Perspective model = new THREE.PerspectiveCamera( fov, aspect, nearClippingPlane, farClippingPlane ); if ( focalLength !== null ) model.setFocalLength( focalLength ); break; case 1: // Orthographic model = new THREE.OrthographicCamera( - width / 2, width / 2, height / 2, - height / 2, nearClippingPlane, farClippingPlane ); break; default: console.warn( 'THREE.FBXLoader: Unknown camera type ' + type + '.' ); model = new THREE.Object3D(); break; } } return model; }, // Create a THREE.DirectionalLight, THREE.PointLight or THREE.SpotLight createLight: function ( relationships ) { var model; var lightAttribute; relationships.children.forEach( function ( child ) { var attr = fbxTree.Objects.NodeAttribute[ child.ID ]; if ( attr !== undefined ) { lightAttribute = attr; } } ); if ( lightAttribute === undefined ) { model = new THREE.Object3D(); } else { var type; // LightType can be undefined for Point lights if ( lightAttribute.LightType === undefined ) { type = 0; } else { type = lightAttribute.LightType.value; } var color = 0xffffff; if ( lightAttribute.Color !== undefined ) { color = new THREE.Color().fromArray( lightAttribute.Color.value ); } var intensity = ( lightAttribute.Intensity === undefined ) ? 1 : lightAttribute.Intensity.value / 100; // light disabled if ( lightAttribute.CastLightOnObject !== undefined && lightAttribute.CastLightOnObject.value === 0 ) { intensity = 0; } var distance = 0; if ( lightAttribute.FarAttenuationEnd !== undefined ) { if ( lightAttribute.EnableFarAttenuation !== undefined && lightAttribute.EnableFarAttenuation.value === 0 ) { distance = 0; } else { distance = lightAttribute.FarAttenuationEnd.value; } } // TODO: could this be calculated linearly from FarAttenuationStart to FarAttenuationEnd? var decay = 1; switch ( type ) { case 0: // Point model = new THREE.PointLight( color, intensity, distance, decay ); break; case 1: // Directional model = new THREE.DirectionalLight( color, intensity ); break; case 2: // Spot var angle = Math.PI / 3; if ( lightAttribute.InnerAngle !== undefined ) { angle = THREE.Math.degToRad( lightAttribute.InnerAngle.value ); } var penumbra = 0; if ( lightAttribute.OuterAngle !== undefined ) { // TODO: this is not correct - FBX calculates outer and inner angle in degrees // with OuterAngle > InnerAngle && OuterAngle <= Math.PI // while three.js uses a penumbra between (0, 1) to attenuate the inner angle penumbra = THREE.Math.degToRad( lightAttribute.OuterAngle.value ); penumbra = Math.max( penumbra, 1 ); } model = new THREE.SpotLight( color, intensity, distance, angle, penumbra, decay ); break; default: console.warn( 'THREE.FBXLoader: Unknown light type ' + lightAttribute.LightType.value + ', defaulting to a THREE.PointLight.' ); model = new THREE.PointLight( color, intensity ); break; } if ( lightAttribute.CastShadows !== undefined && lightAttribute.CastShadows.value === 1 ) { model.castShadow = true; } } return model; }, createMesh: function ( relationships, geometryMap, materialMap ) { var model; var geometry = null; var material = null; var materials = []; // get geometry and materials(s) from connections relationships.children.forEach( function ( child ) { if ( geometryMap.has( child.ID ) ) { geometry = geometryMap.get( child.ID ); } if ( materialMap.has( child.ID ) ) { materials.push( materialMap.get( child.ID ) ); } } ); if ( materials.length > 1 ) { material = materials; } else if ( materials.length > 0 ) { material = materials[ 0 ]; } else { material = new THREE.MeshPhongMaterial( { color: 0xcccccc } ); materials.push( material ); } if ( 'color' in geometry.attributes ) { materials.forEach( function ( material ) { material.vertexColors = THREE.VertexColors; } ); } if ( geometry.FBX_Deformer ) { materials.forEach( function ( material ) { material.skinning = true; } ); model = new THREE.SkinnedMesh( geometry, material ); } else { model = new THREE.Mesh( geometry, material ); } return model; }, createCurve: function ( relationships, geometryMap ) { var geometry = relationships.children.reduce( function ( geo, child ) { if ( geometryMap.has( child.ID ) ) geo = geometryMap.get( child.ID ); return geo; }, null ); // FBX does not list materials for Nurbs lines, so we'll just put our own in here. var material = new THREE.LineBasicMaterial( { color: 0x3300ff, linewidth: 1 } ); return new THREE.Line( geometry, material ); }, // parse the model node for transform data getTransformData: function ( model, modelNode ) { var transformData = {}; if ( 'InheritType' in modelNode ) transformData.inheritType = parseInt( modelNode.InheritType.value ); if ( 'RotationOrder' in modelNode ) transformData.eulerOrder = getEulerOrder( modelNode.RotationOrder.value ); else transformData.eulerOrder = 'ZYX'; if ( 'Lcl_Translation' in modelNode ) transformData.translation = modelNode.Lcl_Translation.value; if ( 'PreRotation' in modelNode ) transformData.preRotation = modelNode.PreRotation.value; if ( 'Lcl_Rotation' in modelNode ) transformData.rotation = modelNode.Lcl_Rotation.value; if ( 'PostRotation' in modelNode ) transformData.postRotation = modelNode.PostRotation.value; if ( 'Lcl_Scaling' in modelNode ) transformData.scale = modelNode.Lcl_Scaling.value; if ( 'ScalingOffset' in modelNode ) transformData.scalingOffset = modelNode.ScalingOffset.value; if ( 'ScalingPivot' in modelNode ) transformData.scalingPivot = modelNode.ScalingPivot.value; if ( 'RotationOffset' in modelNode ) transformData.rotationOffset = modelNode.RotationOffset.value; if ( 'RotationPivot' in modelNode ) transformData.rotationPivot = modelNode.RotationPivot.value; model.userData.transformData = transformData; }, setLookAtProperties: function ( model, modelNode ) { if ( 'LookAtProperty' in modelNode ) { var children = connections.get( model.ID ).children; children.forEach( function ( child ) { if ( child.relationship === 'LookAtProperty' ) { var lookAtTarget = fbxTree.Objects.Model[ child.ID ]; if ( 'Lcl_Translation' in lookAtTarget ) { var pos = lookAtTarget.Lcl_Translation.value; // DirectionalLight, SpotLight if ( model.target !== undefined ) { model.target.position.fromArray( pos ); sceneGraph.add( model.target ); } else { // Cameras and other Object3Ds model.lookAt( new THREE.Vector3().fromArray( pos ) ); } } } } ); } }, bindSkeleton: function ( skeletons, geometryMap, modelMap ) { var bindMatrices = this.parsePoseNodes(); for ( var ID in skeletons ) { var skeleton = skeletons[ ID ]; var parents = connections.get( parseInt( skeleton.ID ) ).parents; parents.forEach( function ( parent ) { if ( geometryMap.has( parent.ID ) ) { var geoID = parent.ID; var geoRelationships = connections.get( geoID ); geoRelationships.parents.forEach( function ( geoConnParent ) { if ( modelMap.has( geoConnParent.ID ) ) { var model = modelMap.get( geoConnParent.ID ); model.bind( new THREE.Skeleton( skeleton.bones ), bindMatrices[ geoConnParent.ID ] ); } } ); } } ); } }, parsePoseNodes: function () { var bindMatrices = {}; if ( 'Pose' in fbxTree.Objects ) { var BindPoseNode = fbxTree.Objects.Pose; for ( var nodeID in BindPoseNode ) { if ( BindPoseNode[ nodeID ].attrType === 'BindPose' ) { var poseNodes = BindPoseNode[ nodeID ].PoseNode; if ( Array.isArray( poseNodes ) ) { poseNodes.forEach( function ( poseNode ) { bindMatrices[ poseNode.Node ] = new THREE.Matrix4().fromArray( poseNode.Matrix.a ); } ); } else { bindMatrices[ poseNodes.Node ] = new THREE.Matrix4().fromArray( poseNodes.Matrix.a ); } } } } return bindMatrices; }, // Parse ambient color in FBXTree.GlobalSettings - if it's not set to black (default), create an ambient light createAmbientLight: function () { if ( 'GlobalSettings' in fbxTree && 'AmbientColor' in fbxTree.GlobalSettings ) { var ambientColor = fbxTree.GlobalSettings.AmbientColor.value; var r = ambientColor[ 0 ]; var g = ambientColor[ 1 ]; var b = ambientColor[ 2 ]; if ( r !== 0 || g !== 0 || b !== 0 ) { var color = new THREE.Color( r, g, b ); sceneGraph.add( new THREE.AmbientLight( color, 1 ) ); } } }, setupMorphMaterials: function () { var self = this; sceneGraph.traverse( function ( child ) { if ( child.isMesh ) { if ( child.geometry.morphAttributes.position && child.geometry.morphAttributes.position.length ) { if ( Array.isArray( child.material ) ) { child.material.forEach( function ( material, i ) { self.setupMorphMaterial( child, material, i ); } ); } else { self.setupMorphMaterial( child, child.material ); } } } } ); }, setupMorphMaterial: function ( child, material, index ) { var uuid = child.uuid; var matUuid = material.uuid; // if a geometry has morph targets, it cannot share the material with other geometries var sharedMat = false; sceneGraph.traverse( function ( node ) { if ( node.isMesh ) { if ( Array.isArray( node.material ) ) { node.material.forEach( function ( mat ) { if ( mat.uuid === matUuid && node.uuid !== uuid ) sharedMat = true; } ); } else if ( node.material.uuid === matUuid && node.uuid !== uuid ) sharedMat = true; } } ); if ( sharedMat === true ) { var clonedMat = material.clone(); clonedMat.morphTargets = true; if ( index === undefined ) child.material = clonedMat; else child.material[ index ] = clonedMat; } else material.morphTargets = true; } }; // parse Geometry data from FBXTree and return map of BufferGeometries function GeometryParser() {} GeometryParser.prototype = { constructor: GeometryParser, // Parse nodes in FBXTree.Objects.Geometry parse: function ( deformers ) { var geometryMap = new Map(); if ( 'Geometry' in fbxTree.Objects ) { var geoNodes = fbxTree.Objects.Geometry; for ( var nodeID in geoNodes ) { var relationships = connections.get( parseInt( nodeID ) ); var geo = this.parseGeometry( relationships, geoNodes[ nodeID ], deformers ); geometryMap.set( parseInt( nodeID ), geo ); } } return geometryMap; }, // Parse single node in FBXTree.Objects.Geometry parseGeometry: function ( relationships, geoNode, deformers ) { switch ( geoNode.attrType ) { case 'Mesh': return this.parseMeshGeometry( relationships, geoNode, deformers ); break; case 'NurbsCurve': return this.parseNurbsGeometry( geoNode ); break; } }, // Parse single node mesh geometry in FBXTree.Objects.Geometry parseMeshGeometry: function ( relationships, geoNode, deformers ) { var skeletons = deformers.skeletons; var morphTargets = deformers.morphTargets; var modelNodes = relationships.parents.map( function ( parent ) { return fbxTree.Objects.Model[ parent.ID ]; } ); // don't create geometry if it is not associated with any models if ( modelNodes.length === 0 ) return; var skeleton = relationships.children.reduce( function ( skeleton, child ) { if ( skeletons[ child.ID ] !== undefined ) skeleton = skeletons[ child.ID ]; return skeleton; }, null ); var morphTarget = relationships.children.reduce( function ( morphTarget, child ) { if ( morphTargets[ child.ID ] !== undefined ) morphTarget = morphTargets[ child.ID ]; return morphTarget; }, null ); // Assume one model and get the preRotation from that // if there is more than one model associated with the geometry this may cause problems var modelNode = modelNodes[ 0 ]; var transformData = {}; if ( 'RotationOrder' in modelNode ) transformData.eulerOrder = getEulerOrder( modelNode.RotationOrder.value ); if ( 'InheritType' in modelNode ) transformData.inheritType = parseInt( modelNode.InheritType.value ); if ( 'GeometricTranslation' in modelNode ) transformData.translation = modelNode.GeometricTranslation.value; if ( 'GeometricRotation' in modelNode ) transformData.rotation = modelNode.GeometricRotation.value; if ( 'GeometricScaling' in modelNode ) transformData.scale = modelNode.GeometricScaling.value; var transform = generateTransform( transformData ); return this.genGeometry( geoNode, skeleton, morphTarget, transform ); }, // Generate a THREE.BufferGeometry from a node in FBXTree.Objects.Geometry genGeometry: function ( geoNode, skeleton, morphTarget, preTransform ) { var geo = new THREE.BufferGeometry(); if ( geoNode.attrName ) geo.name = geoNode.attrName; var geoInfo = this.parseGeoNode( geoNode, skeleton ); var buffers = this.genBuffers( geoInfo ); var positionAttribute = new THREE.Float32BufferAttribute( buffers.vertex, 3 ); preTransform.applyToBufferAttribute( positionAttribute ); geo.addAttribute( 'position', positionAttribute ); if ( buffers.colors.length > 0 ) { geo.addAttribute( 'color', new THREE.Float32BufferAttribute( buffers.colors, 3 ) ); } if ( skeleton ) { geo.addAttribute( 'skinIndex', new THREE.Uint16BufferAttribute( buffers.weightsIndices, 4 ) ); geo.addAttribute( 'skinWeight', new THREE.Float32BufferAttribute( buffers.vertexWeights, 4 ) ); // used later to bind the skeleton to the model geo.FBX_Deformer = skeleton; } if ( buffers.normal.length > 0 ) { var normalAttribute = new THREE.Float32BufferAttribute( buffers.normal, 3 ); var normalMatrix = new THREE.Matrix3().getNormalMatrix( preTransform ); normalMatrix.applyToBufferAttribute( normalAttribute ); geo.addAttribute( 'normal', normalAttribute ); } buffers.uvs.forEach( function ( uvBuffer, i ) { // subsequent uv buffers are called 'uv1', 'uv2', ... var name = 'uv' + ( i + 1 ).toString(); // the first uv buffer is just called 'uv' if ( i === 0 ) { name = 'uv'; } geo.addAttribute( name, new THREE.Float32BufferAttribute( buffers.uvs[ i ], 2 ) ); } ); if ( geoInfo.material && geoInfo.material.mappingType !== 'AllSame' ) { // Convert the material indices of each vertex into rendering groups on the geometry. var prevMaterialIndex = buffers.materialIndex[ 0 ]; var startIndex = 0; buffers.materialIndex.forEach( function ( currentIndex, i ) { if ( currentIndex !== prevMaterialIndex ) { geo.addGroup( startIndex, i - startIndex, prevMaterialIndex ); prevMaterialIndex = currentIndex; startIndex = i; } } ); // the loop above doesn't add the last group, do that here. if ( geo.groups.length > 0 ) { var lastGroup = geo.groups[ geo.groups.length - 1 ]; var lastIndex = lastGroup.start + lastGroup.count; if ( lastIndex !== buffers.materialIndex.length ) { geo.addGroup( lastIndex, buffers.materialIndex.length - lastIndex, prevMaterialIndex ); } } // case where there are multiple materials but the whole geometry is only // using one of them if ( geo.groups.length === 0 ) { geo.addGroup( 0, buffers.materialIndex.length, buffers.materialIndex[ 0 ] ); } } this.addMorphTargets( geo, geoNode, morphTarget, preTransform ); return geo; }, parseGeoNode: function ( geoNode, skeleton ) { var geoInfo = {}; geoInfo.vertexPositions = ( geoNode.Vertices !== undefined ) ? geoNode.Vertices.a : []; geoInfo.vertexIndices = ( geoNode.PolygonVertexIndex !== undefined ) ? geoNode.PolygonVertexIndex.a : []; if ( geoNode.LayerElementColor ) { geoInfo.color = this.parseVertexColors( geoNode.LayerElementColor[ 0 ] ); } if ( geoNode.LayerElementMaterial ) { geoInfo.material = this.parseMaterialIndices( geoNode.LayerElementMaterial[ 0 ] ); } if ( geoNode.LayerElementNormal ) { geoInfo.normal = this.parseNormals( geoNode.LayerElementNormal[ 0 ] ); } if ( geoNode.LayerElementUV ) { geoInfo.uv = []; var i = 0; while ( geoNode.LayerElementUV[ i ] ) { geoInfo.uv.push( this.parseUVs( geoNode.LayerElementUV[ i ] ) ); i ++; } } geoInfo.weightTable = {}; if ( skeleton !== null ) { geoInfo.skeleton = skeleton; skeleton.rawBones.forEach( function ( rawBone, i ) { // loop over the bone's vertex indices and weights rawBone.indices.forEach( function ( index, j ) { if ( geoInfo.weightTable[ index ] === undefined ) geoInfo.weightTable[ index ] = []; geoInfo.weightTable[ index ].push( { id: i, weight: rawBone.weights[ j ], } ); } ); } ); } return geoInfo; }, genBuffers: function ( geoInfo ) { var buffers = { vertex: [], normal: [], colors: [], uvs: [], materialIndex: [], vertexWeights: [], weightsIndices: [], }; var polygonIndex = 0; var faceLength = 0; var displayedWeightsWarning = false; // these will hold data for a single face var facePositionIndexes = []; var faceNormals = []; var faceColors = []; var faceUVs = []; var faceWeights = []; var faceWeightIndices = []; var self = this; geoInfo.vertexIndices.forEach( function ( vertexIndex, polygonVertexIndex ) { var endOfFace = false; // Face index and vertex index arrays are combined in a single array // A cube with quad faces looks like this: // PolygonVertexIndex: *24 { // a: 0, 1, 3, -3, 2, 3, 5, -5, 4, 5, 7, -7, 6, 7, 1, -1, 1, 7, 5, -4, 6, 0, 2, -5 // } // Negative numbers mark the end of a face - first face here is 0, 1, 3, -3 // to find index of last vertex bit shift the index: ^ - 1 if ( vertexIndex < 0 ) { vertexIndex = vertexIndex ^ - 1; // equivalent to ( x * -1 ) - 1 endOfFace = true; } var weightIndices = []; var weights = []; facePositionIndexes.push( vertexIndex * 3, vertexIndex * 3 + 1, vertexIndex * 3 + 2 ); if ( geoInfo.color ) { var data = getData( polygonVertexIndex, polygonIndex, vertexIndex, geoInfo.color ); faceColors.push( data[ 0 ], data[ 1 ], data[ 2 ] ); } if ( geoInfo.skeleton ) { if ( geoInfo.weightTable[ vertexIndex ] !== undefined ) { geoInfo.weightTable[ vertexIndex ].forEach( function ( wt ) { weights.push( wt.weight ); weightIndices.push( wt.id ); } ); } if ( weights.length > 4 ) { if ( ! displayedWeightsWarning ) { console.warn( 'THREE.FBXLoader: Vertex has more than 4 skinning weights assigned to vertex. Deleting additional weights.' ); displayedWeightsWarning = true; } var wIndex = [ 0, 0, 0, 0 ]; var Weight = [ 0, 0, 0, 0 ]; weights.forEach( function ( weight, weightIndex ) { var currentWeight = weight; var currentIndex = weightIndices[ weightIndex ]; Weight.forEach( function ( comparedWeight, comparedWeightIndex, comparedWeightArray ) { if ( currentWeight > comparedWeight ) { comparedWeightArray[ comparedWeightIndex ] = currentWeight; currentWeight = comparedWeight; var tmp = wIndex[ comparedWeightIndex ]; wIndex[ comparedWeightIndex ] = currentIndex; currentIndex = tmp; } } ); } ); weightIndices = wIndex; weights = Weight; } // if the weight array is shorter than 4 pad with 0s while ( weights.length < 4 ) { weights.push( 0 ); weightIndices.push( 0 ); } for ( var i = 0; i < 4; ++ i ) { faceWeights.push( weights[ i ] ); faceWeightIndices.push( weightIndices[ i ] ); } } if ( geoInfo.normal ) { var data = getData( polygonVertexIndex, polygonIndex, vertexIndex, geoInfo.normal ); faceNormals.push( data[ 0 ], data[ 1 ], data[ 2 ] ); } if ( geoInfo.material && geoInfo.material.mappingType !== 'AllSame' ) { var materialIndex = getData( polygonVertexIndex, polygonIndex, vertexIndex, geoInfo.material )[ 0 ]; } if ( geoInfo.uv ) { geoInfo.uv.forEach( function ( uv, i ) { var data = getData( polygonVertexIndex, polygonIndex, vertexIndex, uv ); if ( faceUVs[ i ] === undefined ) { faceUVs[ i ] = []; } faceUVs[ i ].push( data[ 0 ] ); faceUVs[ i ].push( data[ 1 ] ); } ); } faceLength ++; if ( endOfFace ) { self.genFace( buffers, geoInfo, facePositionIndexes, materialIndex, faceNormals, faceColors, faceUVs, faceWeights, faceWeightIndices, faceLength ); polygonIndex ++; faceLength = 0; // reset arrays for the next face facePositionIndexes = []; faceNormals = []; faceColors = []; faceUVs = []; faceWeights = []; faceWeightIndices = []; } } ); return buffers; }, // Generate data for a single face in a geometry. If the face is a quad then split it into 2 tris genFace: function ( buffers, geoInfo, facePositionIndexes, materialIndex, faceNormals, faceColors, faceUVs, faceWeights, faceWeightIndices, faceLength ) { for ( var i = 2; i < faceLength; i ++ ) { buffers.vertex.push( geoInfo.vertexPositions[ facePositionIndexes[ 0 ] ] ); buffers.vertex.push( geoInfo.vertexPositions[ facePositionIndexes[ 1 ] ] ); buffers.vertex.push( geoInfo.vertexPositions[ facePositionIndexes[ 2 ] ] ); buffers.vertex.push( geoInfo.vertexPositions[ facePositionIndexes[ ( i - 1 ) * 3 ] ] ); buffers.vertex.push( geoInfo.vertexPositions[ facePositionIndexes[ ( i - 1 ) * 3 + 1 ] ] ); buffers.vertex.push( geoInfo.vertexPositions[ facePositionIndexes[ ( i - 1 ) * 3 + 2 ] ] ); buffers.vertex.push( geoInfo.vertexPositions[ facePositionIndexes[ i * 3 ] ] ); buffers.vertex.push( geoInfo.vertexPositions[ facePositionIndexes[ i * 3 + 1 ] ] ); buffers.vertex.push( geoInfo.vertexPositions[ facePositionIndexes[ i * 3 + 2 ] ] ); if ( geoInfo.skeleton ) { buffers.vertexWeights.push( faceWeights[ 0 ] ); buffers.vertexWeights.push( faceWeights[ 1 ] ); buffers.vertexWeights.push( faceWeights[ 2 ] ); buffers.vertexWeights.push( faceWeights[ 3 ] ); buffers.vertexWeights.push( faceWeights[ ( i - 1 ) * 4 ] ); buffers.vertexWeights.push( faceWeights[ ( i - 1 ) * 4 + 1 ] ); buffers.vertexWeights.push( faceWeights[ ( i - 1 ) * 4 + 2 ] ); buffers.vertexWeights.push( faceWeights[ ( i - 1 ) * 4 + 3 ] ); buffers.vertexWeights.push( faceWeights[ i * 4 ] ); buffers.vertexWeights.push( faceWeights[ i * 4 + 1 ] ); buffers.vertexWeights.push( faceWeights[ i * 4 + 2 ] ); buffers.vertexWeights.push( faceWeights[ i * 4 + 3 ] ); buffers.weightsIndices.push( faceWeightIndices[ 0 ] ); buffers.weightsIndices.push( faceWeightIndices[ 1 ] ); buffers.weightsIndices.push( faceWeightIndices[ 2 ] ); buffers.weightsIndices.push( faceWeightIndices[ 3 ] ); buffers.weightsIndices.push( faceWeightIndices[ ( i - 1 ) * 4 ] ); buffers.weightsIndices.push( faceWeightIndices[ ( i - 1 ) * 4 + 1 ] ); buffers.weightsIndices.push( faceWeightIndices[ ( i - 1 ) * 4 + 2 ] ); buffers.weightsIndices.push( faceWeightIndices[ ( i - 1 ) * 4 + 3 ] ); buffers.weightsIndices.push( faceWeightIndices[ i * 4 ] ); buffers.weightsIndices.push( faceWeightIndices[ i * 4 + 1 ] ); buffers.weightsIndices.push( faceWeightIndices[ i * 4 + 2 ] ); buffers.weightsIndices.push( faceWeightIndices[ i * 4 + 3 ] ); } if ( geoInfo.color ) { buffers.colors.push( faceColors[ 0 ] ); buffers.colors.push( faceColors[ 1 ] ); buffers.colors.push( faceColors[ 2 ] ); buffers.colors.push( faceColors[ ( i - 1 ) * 3 ] ); buffers.colors.push( faceColors[ ( i - 1 ) * 3 + 1 ] ); buffers.colors.push( faceColors[ ( i - 1 ) * 3 + 2 ] ); buffers.colors.push( faceColors[ i * 3 ] ); buffers.colors.push( faceColors[ i * 3 + 1 ] ); buffers.colors.push( faceColors[ i * 3 + 2 ] ); } if ( geoInfo.material && geoInfo.material.mappingType !== 'AllSame' ) { buffers.materialIndex.push( materialIndex ); buffers.materialIndex.push( materialIndex ); buffers.materialIndex.push( materialIndex ); } if ( geoInfo.normal ) { buffers.normal.push( faceNormals[ 0 ] ); buffers.normal.push( faceNormals[ 1 ] ); buffers.normal.push( faceNormals[ 2 ] ); buffers.normal.push( faceNormals[ ( i - 1 ) * 3 ] ); buffers.normal.push( faceNormals[ ( i - 1 ) * 3 + 1 ] ); buffers.normal.push( faceNormals[ ( i - 1 ) * 3 + 2 ] ); buffers.normal.push( faceNormals[ i * 3 ] );