Class QuarksLoader

Loader for quarks particle system.

Hierarchy

  • ObjectLoader
    • QuarksLoader

Constructors

constructor

Properties

crossOrigin manager path requestHeader resourcePath withCredentials DEFAULT_MATERIAL_NAME

Methods

linkReference load loadAsync parse parseAnimations parseAsync parseGeometries parseImages parseImagesAsync parseMaterials parseObject parseTextures setCrossOrigin setPath setRequestHeader setResourcePath setWithCredentials

Constructors

constructor

Properties

crossOrigin

crossOrigin: string

Default

'anonymous'

manager

manager: LoadingManager

path

path: string

Default

''

requestHeader

requestHeader: { [header: string]: string }

Default

{}

resourcePath

resourcePath: string

Default

''

withCredentials

withCredentials: boolean

Default

false

StaticDEFAULT_MATERIAL_NAME

DEFAULT_MATERIAL_NAME: string

Methods

linkReference

  • linkReference(object: Object3D): void

  • Links the references of the particle system. It's used to link the references of sub particle systems.

    Parameters

    • object: Object3D

      the target object to link the references.

    Returns void

load

  • load(
        url: string,
        onLoad?: (data: Object3D) => void,
        onProgress?: (event: ProgressEvent) => void,
        onError?: (err: unknown) => void,
    ): void

  • Parameters

    • url: string
    • OptionalonLoad: (data: Object3D) => void
    • OptionalonProgress: (event: ProgressEvent) => void
    • OptionalonError: (err: unknown) => void

    Returns void

loadAsync

  • loadAsync(
        url: string,
        onProgress?: (event: ProgressEvent) => void,
    ): Promise<Object3D>

  • Parameters

    • url: string
    • OptionalonProgress: (event: ProgressEvent) => void

    Returns Promise<Object3D>

parse

  • parse<T extends Object3D>(json: any, onLoad?: (object: Object3D) => void): T

  • Parses the json data to create a quarks particle system.

    Type Parameters

    • T extends Object3D

    Parameters

    • json: any

      the json data to parse.

    • OptionalonLoad: (object: Object3D) => void

      the callback function to be called after the object is loaded.

    Returns T

parseAnimations

  • parseAnimations(json: unknown): { [key: string]: AnimationClip }

  • Parameters

    • json: unknown

    Returns { [key: string]: AnimationClip }

parseAsync

  • parseAsync(json: unknown): Promise<Object3D>

  • Parameters

    • json: unknown

    Returns Promise<Object3D>

parseGeometries

  • parseGeometries(
        json: unknown,
    ): { [key: string]: BufferGeometry | InstancedBufferGeometry }

  • Parameters

    • json: unknown

    Returns { [key: string]: BufferGeometry | InstancedBufferGeometry }

parseImages

  • parseImages(json: unknown, onLoad?: () => void): { [key: string]: Source }

  • Parameters

    • json: unknown
    • OptionalonLoad: () => void

    Returns { [key: string]: Source }

parseImagesAsync

  • parseImagesAsync(json: unknown): Promise<{ [key: string]: Source }>

  • Parameters

    • json: unknown

    Returns Promise<{ [key: string]: Source }>

parseMaterials

  • parseMaterials(
        json: unknown,
        textures: { [key: string]: Texture },
    ): { [key: string]: Material }

  • Parameters

    • json: unknown
    • textures: { [key: string]: Texture }

    Returns { [key: string]: Material }

parseObject

  • parseObject(
        data: any,
        geometries: { [uuid: string]: BufferGeometry },
        materials: { [uuid: string]: Material },
        textures: { [uuid: string]: Texture },
        animations: { [uuid: string]: AnimationClip },
    ): Object3D

  • Parameters

    • data: any
    • geometries: { [uuid: string]: BufferGeometry }
    • materials: { [uuid: string]: Material }
    • textures: { [uuid: string]: Texture }
    • animations: { [uuid: string]: AnimationClip }

    Returns Object3D

parseTextures

  • parseTextures(
        json: unknown,
        images: { [key: string]: Source },
    ): { [key: string]: Texture }

  • Parameters

    • json: unknown
    • images: { [key: string]: Source }

    Returns { [key: string]: Texture }

setCrossOrigin

  • setCrossOrigin(crossOrigin: string): this

  • Parameters

    • crossOrigin: string

    Returns this

setPath

  • setPath(path: string): this

  • Parameters

    • path: string

    Returns this

setRequestHeader

  • setRequestHeader(requestHeader: { [header: string]: string }): this

  • Parameters

    • requestHeader: { [header: string]: string }

    Returns this

setResourcePath

  • setResourcePath(resourcePath: string): this

  • Parameters

    • resourcePath: string

    Returns this

setWithCredentials

  • setWithCredentials(value: boolean): this

  • Parameters

    • value: boolean

    Returns this

Settings

Member Visibility

On This Page

Constructors
Properties
Methods