Skip to content

Class: Res

Resource management classes for textures, materials, models, and preset bodies.

Constructors

Properties

Methods

Constructors

constructor

new Res()

Defined in

src/assets/Res.ts:44

Properties

normalTexture

normalTexture: Uint8ArrayTexture

normal texture

Defined in

src/assets/Res.ts:362


maskTexture

maskTexture: Uint8ArrayTexture

Defined in

src/assets/Res.ts:363


whiteTexture

whiteTexture: Uint8ArrayTexture

Defined in

src/assets/Res.ts:364


blackTexture

blackTexture: Uint8ArrayTexture

Defined in

src/assets/Res.ts:365


redTexture

redTexture: Uint8ArrayTexture

Defined in

src/assets/Res.ts:366


blueTexture

blueTexture: Uint8ArrayTexture

Defined in

src/assets/Res.ts:367


greenTexture

greenTexture: Uint8ArrayTexture

Defined in

src/assets/Res.ts:368


yellowTexture

yellowTexture: Uint8ArrayTexture

Defined in

src/assets/Res.ts:369


grayTexture

grayTexture: Uint8ArrayTexture

Defined in

src/assets/Res.ts:370


defaultSky

defaultSky: HDRTextureCube

Defined in

src/assets/Res.ts:372


defaultGUITexture

defaultGUITexture: GUITexture

Defined in

src/assets/Res.ts:374


defaultGUISprite

defaultGUISprite: GUISprite

Defined in

src/assets/Res.ts:375

Methods

getGltf

getGltf(url): GLTF_Info

Parameters

NameType
urlstring

Returns

GLTF_Info

Defined in

src/assets/Res.ts:55


addTexture

addTexture(url, texture): void

add a texture with reference of url

Parameters

NameTypeDescription
urlstringfile path
textureTexturesource texture

Returns

void

Defined in

src/assets/Res.ts:64


getTexture

getTexture(url): Texture

get texture by url

Parameters

NameTypeDescription
urlstringfile path

Returns

Texture

Defined in

src/assets/Res.ts:73


addMat

addMat(name, mat): Map<string, Material>

add a material with reference of name

Parameters

NameTypeDescription
namestringmaterial name
matMaterialtarget material

Returns

Map<string, Material>

Defined in

src/assets/Res.ts:82


getMat

getMat(name): Material

get material by name

Parameters

NameTypeDescription
namestringmaterial name

Returns

Material

Defined in

src/assets/Res.ts:91


addPrefab

addPrefab(name, rootScene): void

add prefab with reference name

Parameters

NameTypeDescription
namestringprefab name
rootSceneObject3Droot object of prefab

Returns

void

Defined in

src/assets/Res.ts:100


getPrefab

getPrefab(name): Object3D

get prefab by name

Parameters

NameTypeDescription
namestringprefab name

Returns

Object3D

Defined in

src/assets/Res.ts:109


addAtlas

addAtlas(name, atlas): void

Parameters

NameType
namestring
atlasGUIAtlasTexture

Returns

void

Defined in

src/assets/Res.ts:114


getAtlas

getAtlas(name): GUIAtlasTexture

Parameters

NameType
namestring

Returns

GUIAtlasTexture

Defined in

src/assets/Res.ts:119


getGUISprite

getGUISprite(id): GUISprite

Parameters

NameType
idstring

Returns

GUISprite

Defined in

src/assets/Res.ts:123


loadGltf

loadGltf(url, loaderFunctions?): Promise<Object3D>

load a gltf file

Parameters

NameTypeDescription
urlstringthe url of file
loaderFunctions?LoaderFunctionscallback

Returns

Promise<Object3D>

Defined in

src/assets/Res.ts:138


loadObj

loadObj(url, loaderFunctions?): Promise<Object3D>

load obj file

Parameters

NameTypeDescription
urlstringobj file path
loaderFunctions?LoaderFunctionscallback

Returns

Promise<Object3D>

Defined in

src/assets/Res.ts:165


loadB3DM

loadB3DM(url, loaderFunctions?, userData?): Promise<Object3D>

load b3dm file by url

Parameters

NameTypeDescription
urlstringpath of file
loaderFunctions?LoaderFunctionscallback
userData?any-

Returns

Promise<Object3D>

Defined in

src/assets/Res.ts:188


loadI3DM

loadI3DM(url, loaderFunctions?, userData?): Promise<Object3D>

load i3dm file by url

Parameters

NameTypeDescription
urlstringpath of i3dm file
loaderFunctions?LoaderFunctionscallback
userData?any-

Returns

Promise<Object3D>

Defined in

src/assets/Res.ts:205


loadTexture

loadTexture(url, loaderFunctions?, flipY?): Promise<Texture>

load texture by url

Parameters

NameTypeDescription
urlstringtexture path
loaderFunctions?LoaderFunctionscallback
flipY?booleanuse flip y or not

Returns

Promise<Texture>

Defined in

src/assets/Res.ts:223


loadHDRTexture

loadHDRTexture(url, loaderFunctions?): Promise<Texture>

load a hdr texture

Parameters

NameTypeDescription
urlstringtexture url
loaderFunctions?LoaderFunctionscallback

Returns

Promise<Texture>

Defined in

src/assets/Res.ts:240


loadHDRTextureCube

loadHDRTextureCube(url, loaderFunctions?): Promise<Texture>

load hdr cube texture

Parameters

NameTypeDescription
urlstringfile url
loaderFunctions?LoaderFunctionscallback

Returns

Promise<Texture>

Defined in

src/assets/Res.ts:258


loadLDRTextureCube

loadLDRTextureCube(url, loaderFunctions?): Promise<Texture>

load ldr cube texture

Parameters

NameTypeDescription
urlstringfile path
loaderFunctions?LoaderFunctionscallback

Returns

Promise<Texture>

Defined in

src/assets/Res.ts:274


loadTextureCubeMaps

loadTextureCubeMaps(urls): Promise<Texture>

load texture data from array of web url. make sure there are six images in a group, and the order is: nx, px, py, ny, nz, pz

Parameters

NameType
urlsstring[]

Returns

Promise<Texture>

Defined in

src/assets/Res.ts:290


loadTextureCubeStd

loadTextureCubeStd(url, loaderFunctions?): Promise<Texture>

load texture data from url. the image is assembled from six images into cross shaped image.

Parameters

NameTypeDescription
urlstringthe path of image
loaderFunctions?LoaderFunctions-

Returns

Promise<Texture>

Defined in

src/assets/Res.ts:307


loadJSON

loadJSON(url, loaderFunctions?): Promise<void | object>

load json data from url.

Parameters

NameTypeDescription
urlstringthe path of image
loaderFunctions?LoaderFunctions-

Returns

Promise<void | object>

Defined in

src/assets/Res.ts:321


loadFont

loadFont(url, loaderFunctions?, userData?): Promise<FontInfo>

load font file by url

Parameters

NameTypeDescription
urlstringfont file url
loaderFunctions?LoaderFunctionscallback
userData?any-

Returns

Promise<FontInfo>

Defined in

src/assets/Res.ts:339


loadAtlas

loadAtlas(url, loaderFunctions?): Promise<FontInfo>

load a atlas file by url

Parameters

NameTypeDescription
urlstringfile path
loaderFunctions?LoaderFunctionscallback

Returns

Promise<FontInfo>

Defined in

src/assets/Res.ts:353


createTexture

createTexture(width, height, r, g, b, a, name?): Uint8ArrayTexture

create a texture

Parameters

NameTypeDescription
widthnumberwidth of texture
heightnumberheight of texture
rnumbercomponent-red
gnumbercomponent-green
bnumbercomponent-blue
anumbercomponent-alpha(0 for transparent,1 for opaque)
name?stringname string

Returns

Uint8ArrayTexture

Defined in

src/assets/Res.ts:388


fillColor

fillColor(array, w, h, r, g, b, a): void

fill slod color to this texture

Parameters

NameTypeDescription
arrayanydata of texture
wnumberwidth of texture
hnumberheight of texture
rnumbercomponent-red
gnumbercomponent-green
bnumbercomponent-blue
anumbercomponent-alpha(0 for transparent,1 for opaque)

Returns

void

Defined in

src/assets/Res.ts:412