loader overview

---

Table of contents

• utils
• Gg3dLoader (class)
  • loadGgGlbFiles (method)
  • loadGgGlbResources (method)
  • loadGgGlb (method)
  • filesCache (property)
  • loadResultCache (property)
• LoadOptions (type alias)
• LoadResourcesResult (type alias)
• LoadResult (type alias)
• LoadResultWithProps (type alias)

---

utils

Gg3dLoader (class)

Signature

export declare class Gg3dLoader<VTypeDoc, PTypeDoc> {
  constructor(protected readonly world: Gg3dWorld)
}

loadGgGlbFiles (method)

Signature

public async loadGgGlbFiles(path: string, useCache: boolean = false): Promise<[ArrayBuffer, GgMeta]>

loadGgGlbResources (method)

Signature

public async loadGgGlbResources(
    path: string,
    cachingStrategy: CachingStrategy = CachingStrategy.Nothing,
  ): Promise<LoadResourcesResult<VTypeDoc, PTypeDoc>>

loadGgGlb (method)

Signature

public async loadGgGlb(
    path: string,
    options: Partial<LoadOptions> = defaultLoadOptions,
  ): Promise<LoadResultWithProps<VTypeDoc, PTypeDoc>>

filesCache (property)

Signature

readonly filesCache: any

loadResultCache (property)

Signature

readonly loadResultCache: any

LoadOptions (type alias)

Signature

export type LoadOptions = {
  // whether to cache anything
  // "Nothing" does not cache anything
  // "Files" caches GLB+Meta file contents
  // "Entities" clones and saves parsed from GLB+Meta objects and bodies
  cachingStrategy: CachingStrategy
  // initial position
  position: Point3
  // initial rotation
  rotation: Point4
  // process dummies with flag is_prop
  loadProps: boolean
  // path where to find prop scenes
  propsPath?: string
}

LoadResourcesResult (type alias)

Signature

export type LoadResourcesResult<
  VTypeDoc extends VisualTypeDocRepo3D = VisualTypeDocRepo3D,
  PTypeDoc extends PhysicsTypeDocRepo3D = PhysicsTypeDocRepo3D
> = {
  resources: { object3D: VTypeDoc['displayObject'] | null; body: PTypeDoc['rigidBody'] | null }[]
  meta: GgMeta
}

LoadResult (type alias)

Signature

export type LoadResult<
  VTypeDoc extends VisualTypeDocRepo3D = VisualTypeDocRepo3D,
  PTypeDoc extends PhysicsTypeDocRepo3D = PhysicsTypeDocRepo3D
> = {
  entities: Entity3d<VTypeDoc, PTypeDoc>[]
  meta: GgMeta
}

LoadResultWithProps (type alias)

Signature

export type LoadResultWithProps<
  VTypeDoc extends VisualTypeDocRepo3D = VisualTypeDocRepo3D,
  PTypeDoc extends PhysicsTypeDocRepo3D = PhysicsTypeDocRepo3D
> = LoadResult<VTypeDoc, PTypeDoc> & { props?: LoadResult<VTypeDoc, PTypeDoc>[] }