TDSLoader | ngx3js

Tdsloader See the ngx3js docs page for details.

Examples

webgl / loader / 3ds

Hierarchy

I3JS.Loader
- TDSLoader

Constructors

constructor

new TDSLoader(manager?: I3JS.LoadingManager): I3JS.TDSLoader
new TDSLoader(manager?: I3JS.LoadingManager, options?: any): I3JS.TDSLoader

Inherited from Loader.constructor
- Defined in lib/threejs-library/types/three/examples/loaders.ts:2497
Creates a new Loader.

Parameters
- Optional manager: I3JS.LoadingManager
  
  The loadingManager for the loader to use. Default is THREE.DefaultLoadingManager.
Returns I3JS.TDSLoader
Inherited from Loader.constructor
- Defined in lib/threejs-library/types/three/loaders.ts:611
Creates a new Loader.

Parameters
- Optional manager: I3JS.LoadingManager
  
  The loadingManager for the loader to use. Default is THREE.DefaultLoadingManager.
- Optional options: any
Returns I3JS.TDSLoader

Properties

crossOrigin

crossOrigin: string

The crossOrigin string to implement CORS for loading the url from a different domain that allows CORS. Default is anonymous.

default: 'anonymous'

debug

debug: boolean

group

group: I3JS.Group

manager

manager: I3JS.LoadingManager

The loadingManager the loader is using. Default is DefaultLoadingManager.

materials

materials: I3JS.Material[]

meshes

meshes: I3JS.Mesh<I3JS.BufferGeometry, I3JS.Material | I3JS.Material[]>[]

path

path: string

The base path from which the asset will be loaded. Default is the empty string.

default: ''

position

position: number

requestHeader

requestHeader: {}

The request header used in HTTP request. See .setRequestHeader. Default is empty object.

default: {}

Type declaration

[header: string]: string

resourcePath

resourcePath: string

The base path from which additional resources like textures will be loaded. Default is the empty string.

default: ''

withCredentials

withCredentials: boolean

Whether the XMLHttpRequest uses credentials. See .setWithCredentials. Default is false.

default:: false

Methods

debugMessage

debugMessage(message: object): void

- Defined in lib/threejs-library/types/three/examples/loaders.ts:2527
Parameters
- message: object
Returns void

endChunk

endChunk(chunk: object): void

- Defined in lib/threejs-library/types/three/examples/loaders.ts:2528
Parameters
- chunk: object
Returns void

load

load(url: string, onLoad: (object: I3JS.Group) => void, onProgress?: (event: ProgressEvent<EventTarget>) => void, onError?: (event: ErrorEvent) => void): void

- Defined in lib/threejs-library/types/three/examples/loaders.ts:2512
Begin loading from url.

Parameters
- url: string
  
  The path or URL to the file.
- onLoad: (object: I3JS.Group) => void
  
  Will be called when load completes.
  - - (object: I3JS.Group): void
    - Parameters
      - object: I3JS.Group
      Returns void
- Optional onProgress: (event: ProgressEvent<EventTarget>) => void
  
  Will be called while load progresses.
  - - (event: ProgressEvent<EventTarget>): void
    - Parameters
      - event: ProgressEvent<EventTarget>
      Returns void
- Optional onError: (event: ErrorEvent) => void
  
  Will be called when load errors.
  - - (event: ErrorEvent): void
    - Parameters
      - event: ErrorEvent
      Returns void
Returns void

loadAsync

loadAsync(url: string, onProgress?: (event: ProgressEvent<EventTarget>) => void): Promise<I3JS.Group>

Overrides Loader.loadAsync
- Defined in lib/threejs-library/types/three/examples/loaders.ts:2524
Begin loading from url.

Parameters
- url: string
  
  The path or URL to the file.
- Optional onProgress: (event: ProgressEvent<EventTarget>) => void
  
  Will be called while load progresses.
  - - (event: ProgressEvent<EventTarget>): void
    - Parameters
      - event: ProgressEvent<EventTarget>
      Returns void
Returns Promise<I3JS.Group>

nextChunk

nextChunk(data: DataView, chunk: object): void

- Defined in lib/threejs-library/types/three/examples/loaders.ts:2529
Parameters
- data: DataView
- chunk: object
Returns void

parse

parse(arraybuffer: ArrayBuffer, path: string): I3JS.Group

- Defined in lib/threejs-library/types/three/examples/loaders.ts:2525
Parameters
- arraybuffer: ArrayBuffer
- path: string
Returns I3JS.Group

readByte

readByte(data: DataView): number

- Defined in lib/threejs-library/types/three/examples/loaders.ts:2530
Parameters
- data: DataView
Returns number

readChunk

readChunk(data: DataView): object

- Defined in lib/threejs-library/types/three/examples/loaders.ts:2531
Parameters
- data: DataView
Returns object

readColor

readColor(data: DataView): I3JS.Color

- Defined in lib/threejs-library/types/three/examples/loaders.ts:2532
Parameters
- data: DataView
Returns I3JS.Color

readDWord

readDWord(data: DataView): number

- Defined in lib/threejs-library/types/three/examples/loaders.ts:2533
Parameters
- data: DataView
Returns number

readFaceArray

readFaceArray(data: DataView, mesh: I3JS.Mesh<I3JS.BufferGeometry, I3JS.Material | I3JS.Material[]>): void

- Defined in lib/threejs-library/types/three/examples/loaders.ts:2534
Parameters
- data: DataView
- mesh: I3JS.Mesh<I3JS.BufferGeometry, I3JS.Material | I3JS.Material[]>
Returns void

readFile

readFile(arraybuffer: ArrayBuffer, path: string): void

- Defined in lib/threejs-library/types/three/examples/loaders.ts:2535
Parameters
- arraybuffer: ArrayBuffer
- path: string
Returns void

readFloat

readFloat(data: DataView): number

- Defined in lib/threejs-library/types/three/examples/loaders.ts:2536
Parameters
- data: DataView
Returns number

readInt

readInt(data: DataView): number

- Defined in lib/threejs-library/types/three/examples/loaders.ts:2537
Parameters
- data: DataView
Returns number

readMap

readMap(data: DataView, path: string): I3JS.Texture

- Defined in lib/threejs-library/types/three/examples/loaders.ts:2538
Parameters
- data: DataView
- path: string
Returns I3JS.Texture

readMaterialEntry

readMaterialEntry(data: DataView, path: string): void

- Defined in lib/threejs-library/types/three/examples/loaders.ts:2541
Parameters
- data: DataView
- path: string
Returns void

readMaterialGroup

readMaterialGroup(data: DataView): object

- Defined in lib/threejs-library/types/three/examples/loaders.ts:2542
Parameters
- data: DataView
Returns object

readMesh

readMesh(data: DataView): I3JS.Mesh<I3JS.BufferGeometry, I3JS.Material | I3JS.Material[]>

- Defined in lib/threejs-library/types/three/examples/loaders.ts:2539
Parameters
- data: DataView
Returns I3JS.Mesh<I3JS.BufferGeometry, I3JS.Material | I3JS.Material[]>

readMeshData

readMeshData(data: DataView, path: string): void

- Defined in lib/threejs-library/types/three/examples/loaders.ts:2540
Parameters
- data: DataView
- path: string
Returns void

readNamedObject

readNamedObject(data: DataView): void

- Defined in lib/threejs-library/types/three/examples/loaders.ts:2543
Parameters
- data: DataView
Returns void

readShort

readShort(data: DataView): number

- Defined in lib/threejs-library/types/three/examples/loaders.ts:2544
Parameters
- data: DataView
Returns number

readString

readString(data: DataView, maxLength: number): string

- Defined in lib/threejs-library/types/three/examples/loaders.ts:2545
Parameters
- data: DataView
- maxLength: number
Returns string

readWord

readWord(data: DataView): number

- Defined in lib/threejs-library/types/three/examples/loaders.ts:2546
Parameters
- data: DataView
Returns number

resetPosition

resetPosition(): void

- Defined in lib/threejs-library/types/three/examples/loaders.ts:2547
Returns void

setCrossOrigin

setCrossOrigin(crossOrigin: string): I3JS.TDSLoader

Inherited from Loader.setCrossOrigin
- Defined in lib/threejs-library/types/three/loaders.ts:663
Parameters
- crossOrigin: string
  
  The crossOrigin string to implement CORS for loading the url from a different domain that allows CORS.
Returns I3JS.TDSLoader

setPath

setPath(path: string): I3JS.TDSLoader

Inherited from Loader.setPath
- Defined in lib/threejs-library/types/three/loaders.ts:674
Parameters
- path: string
  
  Set the base path for the asset.
Returns I3JS.TDSLoader

setRequestHeader

setRequestHeader(requestHeader: {}): I3JS.TDSLoader

Inherited from Loader.setRequestHeader
- Defined in lib/threejs-library/types/three/loaders.ts:685
Parameters
- requestHeader: {}
  
  key: The name of the header whose value is to be set. value: The value to set as the body of the header. Set the request header used in HTTP request.
  - [header: string]: string
Returns I3JS.TDSLoader

setResourcePath

setResourcePath(resourcePath: string): I3JS.TDSLoader

Inherited from Loader.setResourcePath
- Defined in lib/threejs-library/types/three/loaders.ts:679
Parameters
- resourcePath: string
  
  Set the base path for dependent resources like textures.
Returns I3JS.TDSLoader

setWithCredentials

setWithCredentials(value: boolean): I3JS.TDSLoader

Inherited from Loader.setWithCredentials
- Defined in lib/threejs-library/types/three/loaders.ts:669
Whether the XMLHttpRequest uses credentials such as cookies, authorization headers or TLS client certificates. See XMLHttpRequest.withCredentials. Note that this has no effect if you are loading files locally or from the same domain.

Parameters
- value: boolean
Returns I3JS.TDSLoader

Examples

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional manager: I3JS.LoadingManager

Returns I3JS.TDSLoader

Parameters

Optional manager: I3JS.LoadingManager

Optional options: any

Returns I3JS.TDSLoader

Properties

crossOrigin

debug

group

manager

materials

meshes

path

position

requestHeader

Type declaration

[header: string]: string

resourcePath

withCredentials

Methods

debugMessage

Parameters

message: object

Returns void

endChunk

Parameters

chunk: object

Returns void

load

Parameters

url: string

onLoad: (object: I3JS.Group) => void

Parameters

object: I3JS.Group

Returns void

Optional onProgress: (event: ProgressEvent<EventTarget>) => void

Parameters

event: ProgressEvent<EventTarget>

Returns void

Optional onError: (event: ErrorEvent) => void

Parameters

event: ErrorEvent

Returns void

Returns void

loadAsync

Parameters

url: string

Optional onProgress: (event: ProgressEvent<EventTarget>) => void

Parameters

event: ProgressEvent<EventTarget>

Returns void

Returns Promise<I3JS.Group>

nextChunk

Parameters

data: DataView

chunk: object

Returns void

parse

Parameters

arraybuffer: ArrayBuffer

path: string

Returns I3JS.Group

readByte

Parameters

data: DataView

Returns number

readChunk

Parameters

data: DataView

Returns object