Skip to content

Class: UVMapper ​

Defined in: packages/minerender/src/UVMapper.ts:45

Maps Minecraft face coordinates to Three.js UVs and builds per-model texture atlases.

Constructors ​

Constructor ​

ts
new UVMapper(): UVMapper;

Returns ​

UVMapper

Methods ​

addCubeFaceUvToArray() ​

ts
static addCubeFaceUvToArray(
   array, 
   faceIndex, 
   originalTextureSize, 
   actualTextureSize, 
   originalCoords
): void;

Defined in: packages/minerender/src/UVMapper.ts:76

Parameters ​

ParameterType
arraynumber[]
faceIndexnumber
originalTextureSizeDoubleArray
actualTextureSizeDoubleArray
originalCoordsQuadArray

Returns ​

void


createAtlas() ​

ts
static createAtlas(originalModel): Promise<Maybe<TextureAtlas>>;

Defined in: packages/minerender/src/UVMapper.ts:294

Combines model textures and animation metadata into an atlas. Mapped UVs are stored on copies of the model's elements, available through the returned atlas. Returns undefined for models without a texture map.

Parameters ​

ParameterType
originalModelModel

Returns ​

Promise<Maybe<TextureAtlas>>


facesToUv() ​

ts
static facesToUv(
   faces, 
   originalTextureSize, 
   actualTextureSize
): Float32BufferAttribute;

Defined in: packages/minerender/src/UVMapper.ts:132

Parameters ​

ParameterType
facesModelFaces
originalTextureSizeDoubleArray
actualTextureSizeDoubleArray

Returns ​

Float32BufferAttribute


facesToUvArray() ​

ts
static facesToUvArray(
   faces, 
   originalTextureSize, 
   actualTextureSize
): number[];

Defined in: packages/minerender/src/UVMapper.ts:128

Parameters ​

ParameterType
facesModelFaces
originalTextureSizeDoubleArray
actualTextureSizeDoubleArray

Returns ​

number[]


fillMissingTextureKeys() ​

ts
static fillMissingTextureKeys<T>(textures, target): object;

Defined in: packages/minerender/src/UVMapper.ts:214

Type Parameters ​

Type Parameter
T

Parameters ​

ParameterType
texturesModelTextures
target{ [k: string]: T; }

Returns ​

object


getAtlas() ​

ts
static getAtlas(model): Promise<Maybe<TextureAtlas>>;

Defined in: packages/minerender/src/UVMapper.ts:207

Returns the shared atlas for a keyed, merged model, creating it on first use.

Parameters ​

ParameterType
modelModel

Returns ​

Promise<Maybe<TextureAtlas>>


lockUvs() ​

ts
static lockUvs(
   geometry, 
   faces, 
   atlas, 
   rotation
): void;

Defined in: packages/minerender/src/UVMapper.ts:168

Parameters ​

ParameterType
geometryBoxGeometry
facesModelFaces
atlasTextureAtlas
rotationEuler

Returns ​

void


rotateSingleUv() ​

ts
static rotateSingleUv(
   __namedParameters, 
   __namedParameters, 
   radians
): DoubleArray;

Defined in: packages/minerender/src/UVMapper.ts:56

Parameters ​

ParameterType
__namedParametersDoubleArray
__namedParametersDoubleArray
radiansnumber

Returns ​

DoubleArray


setAtlasUvBounds() ​

ts
static setAtlasUvBounds(
   geometry, 
   faces, 
   atlas
): void;

Defined in: packages/minerender/src/UVMapper.ts:137

Bounds texture sampling to texel centres without changing cropped face UVs.

Parameters ​

ParameterType
geometryBoxGeometry
facesModelFaces
atlasTextureAtlas

Returns ​

void


setCubeFaceUvAttribute() ​

ts
static setCubeFaceUvAttribute(
   attributes, 
   faceIndex, 
   originalTextureSize, 
   actualTextureSize, 
   originalCoords
): void;

Defined in: packages/minerender/src/UVMapper.ts:102

Parameters ​

ParameterType
attributesBufferAttribute
faceIndexnumber
originalTextureSizeDoubleArray
actualTextureSizeDoubleArray
originalCoordsQuadArray

Returns ​

void


setCubeFaceUvInArray() ​

ts
static setCubeFaceUvInArray(
   array, 
   faceIndex, 
   __namedParameters
): void;

Defined in: packages/minerender/src/UVMapper.ts:80

Parameters ​

ParameterType
arraynumber[]
faceIndexnumber
__namedParametersQuadArray

Returns ​

void


setCubeFaceUvInAttribute() ​

ts
static setCubeFaceUvInAttribute(
   attributes, 
   faceIndex, 
   __namedParameters
): void;

Defined in: packages/minerender/src/UVMapper.ts:107

Parameters ​

ParameterType
attributesBufferAttribute
faceIndexnumber
__namedParametersQuadArray

Returns ​

void


setCubeUvs() ​

ts
static setCubeUvs(
   geometry, 
   originalTextureSize, 
   actualTextureSize, 
   faces
): void;

Defined in: packages/minerender/src/UVMapper.ts:114

Parameters ​

ParameterType
geometryBoxGeometry
originalTextureSizeDoubleArray
actualTextureSizeDoubleArray
facesModelFaces

Returns ​

void


setFaceUvInArray() ​

ts
static setFaceUvInArray(
   array, 
   faceIndex, 
   uvs
): void;

Defined in: packages/minerender/src/UVMapper.ts:98

Parameters ​

ParameterType
arraynumber[]
faceIndexnumber
uvsQuadArray<DoubleArray>

Returns ​

void


setFaceUvInArrayV() ​

ts
static setFaceUvInArrayV(
   array, 
   faceIndex, 
   uvs
): void;

Defined in: packages/minerender/src/UVMapper.ts:84

Parameters ​

ParameterType
arraynumber[]
faceIndexnumber
uvsQuadArray<Vector2>

Returns ​

void