[name]
Supporting classes for file loaders.
Sub-Classes
[page:LoaderSupport.Builder]
[page:LoaderSupport.LoadedMeshUserOverride]
[page:LoaderSupport.Commons]
[page:LoaderSupport.PrepData]
[page:LoaderSupport.Callbacks]
[page:LoaderSupport.WorkerDirector]
[page:LoaderSupport.WorkerSupport]
Example
[example:webgl_loader_obj2_meshspray] - Example using [page:LoaderSupport.LoaderWorkerDirector] and [page:LoaderSupport.LoaderWorkerSupport].
Classes
Builder
Constructor
Builder()
Builds one or many THREE.Mesh from one raw set of Arraybuffers, materialGroup descriptions and further parameters.
Supports vertex, vertexColor, normal, uv and index buffers.
Methods
TODO
LoadedMeshUserOverride
Constructor
LoadedMeshUserOverride( [page:Boolean disregardMesh], [page:THREE.BufferGeometry bufferGeometry], [page:THREE.Material material] )
[page:Boolean disregardMesh] - Tell implementation to completely disregard this mesh
[page:Boolean alteredMesh] - Tell implementation that mesh(es) have been altered or added
Object to return by callback onMeshAlter. Used to disregard a certain mesh or to return one to many meshes.
Methods
TODO
Commons()
Base class to be used by loaders.
Methods
TODO
PrepData
Constructor
PrepData( [page:String modelName] )
[page:String modelName] - Overall name of the model
Configuration instructions to be used by run method.
Methods
[method:null setStreamMeshesTo] ( [page:Object3D streamMeshesTo] )
[page:Object3D streamMeshesTo] - Object already attached to scenegraph where new meshes will be attached to
Set the node where the loaded objects will be attached directly.
[method:null setMaterialPerSmoothingGroup] ( [page:boolean materialPerSmoothingGroup] )
[page:boolean materialPerSmoothingGroup]
Tells whether a material shall be created per smoothing group.
[method:null setUseIndices]( [page:Boolean useIndices] )
[page:Boolean useIndices] - Default is false
Instructs loaders to create indexed [page:BufferGeometry].
[method:null setDisregardNormals]( [page:Boolean disregardNormals] )
[page:Boolean disregardNormals]
Tells whether normals should be completely disregarded and regenerated.
[method:Callbacks getCallbacks]()
Returns all callbacks as [page:LoaderSupport.Callbacks].
[method:null setCrossOrigin]( [page:String crossOrigin] )
[page:String crossOrigin] - CORS value
Sets the CORS string to be used.
[method:null addResource]( [page:LoaderSupport.ResourceDescriptor resource] )
[page:LoaderSupport.ResourceDescriptor resource]
Add a resource description.
[method:null setUseAsync]( [page:Boolean useAsync] )
[page:Boolean useAsync]
If true uses async loading with worker, if false loads data synchronously.
Callbacks
Constructor
Callbacks()
Callbacks utilized by loaders and builder.
Methods
TODO
WorkerDirector
Constructor
WorkerDirector( [page:String classDef], [page:LoaderSupport.ConsoleLogger logger] )
[page:String classDef] - Class definition to be used for construction
[page:LoaderSupport.ConsoleLogger logger] - logger to be used
Orchestrate loading of multiple OBJ files/data from an instruction queue with a configurable amount of workers (1-16).
- Workflow:
- prepareWorkers
- enqueueForRun
- processQueue
- deregister
[method:null prepareWorkers]( [page:WWOBJLoader2.Callbacks globalCallbacks], [page:Number maxQueueSize], [page:Number maxWebWorkers] )
[page:LoaderSupport.Callbacks globalCallbacks] - Register global callbacks used by all web workers
[page:Number maxQueueSize] - Set the maximum size of the instruction queue (1-1024)
[page:Number maxWebWorkers] - Set the maximum amount of workers (1-16)
Create or destroy workers according limits. Set the name and register callbacks for dynamically created web workers.
[method:null enqueueForRun]( [page:LoaderSupport.PrepData runParams] )
[page:LoaderSupport.PrepData runParams]
Store run instructions in internal instructionQueue.
[method:null processQueue]()
Process the instructionQueue until it is depleted.
[method:null deregister]()
Terminate all workers.
[method:null getMaxQueueSize]()
Returns the maximum length of the instruction queue.
[method:null getMaxWebWorkers]()
Returns the maximum number of workers.
[method:null setCrossOrigin]( [page:String crossOrigin] )
[page:String crossOrigin] - CORS value
Sets the CORS string to be used.
WorkerSupport()
WorkerSupport
Methods
TODO
Source
[link:https://github.com/mrdoob/three.js/blob/master/examples/js/loaders/LoaderSupport.js examples/js/loaders/LoaderSupport.js]