API
API|
@babylonjs/loaders|
OBJLoadingOptions

Type Alias OBJLoadingOptions

Options for loading OBJ/MTL files

type OBJLoadingOptions = {
    computeNormals: boolean;
    encoding?: string;
    importVertexColors: boolean;
    invertTextureY: boolean;
    invertY: boolean;
    materialLoadingFailsSilently: boolean;
    optimizeNormals: boolean;
    optimizeWithUV: boolean;
    skipMaterials: boolean;
    useLegacyBehavior: boolean;
    UVScaling: WebXRSpatialLayerType;
    waitForTextures?: boolean;
}
Index
computeNormals encoding? importVertexColors invertTextureY invertY materialLoadingFailsSilently optimizeNormals optimizeWithUV skipMaterials useLegacyBehavior UVScaling waitForTextures?
computeNormals: boolean

Compute the normals for the model, even if normals are present in the file.

encoding?: string

Defines the character encoding used to decode OBJ and MTL files. Use "auto" to detect UTF-8/UTF-16 and fall back to GB18030, or provide an encoding label supported by TextDecoder. Defaults to "auto".

importVertexColors: boolean

Include in meshes the vertex colors available in some OBJ files. This is not part of OBJ standard.

invertTextureY: boolean

Invert Y-Axis of referenced textures on load

invertY: boolean

Invert model on y-axis (does a model scaling inversion)

materialLoadingFailsSilently: boolean

When a material fails to load OBJ loader will silently fail and onSuccess() callback will be triggered.

optimizeNormals: boolean

Optimize the normals for the model. Lighting can be uneven if you use OptimizeWithUV = true because new vertices can be created for the same location if they pertain to different faces. Using OptimizehNormals = true will help smoothing the lighting by averaging the normals of those vertices.

optimizeWithUV: boolean

Defines if UVs are optimized by default during load.

skipMaterials: boolean

Skip loading the materials even if defined in the OBJ file (materials are ignored).

useLegacyBehavior: boolean

Loads assets without handedness conversions. This flag is for compatibility. Use it only if absolutely required. Defaults to false.

UVScaling: WebXRSpatialLayerType

Defines custom scaling of UV coordinates of loaded meshes.

waitForTextures?: boolean

Wait for referenced textures to finish loading before completing the OBJ load. When enabled, texture loading failures follow materialLoadingFailsSilently. Defaults to false for backwards compatibility.