API
API|
@babylonjs/loaders|
OBJFileLoader

Class OBJFileLoader

OBJ file type loader. This is a babylon scene loader plugin.

Implements

Index
constructor
extensions name COMPUTE_NORMALS ENCODING IMPORT_VERTEX_COLORS INVERT_Y MATERIAL_LOADING_FAILS_SILENTLY OPTIMIZE_NORMALS OPTIMIZE_WITH_UV SKIP_MATERIALS USE_LEGACY_BEHAVIOR UV_SCALING WAIT_FOR_TEXTURES
INVERT_TEXTURE_Y
canDirectLoad importMeshAsync loadAssetContainerAsync loadAsync
extensions: any = OBJFileLoaderMetadata.extensions

Defines the extension the plugin is able to load.

name: any = OBJFileLoaderMetadata.name

Defines the name of the plugin.

COMPUTE_NORMALS: boolean = false

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

ENCODING: string = "auto"

Defines the character encoding used to decode OBJ and MTL files.

IMPORT_VERTEX_COLORS: boolean = false

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

INVERT_Y: boolean = false

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

MATERIAL_LOADING_FAILS_SILENTLY: boolean = true

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

Defaults to true for backwards compatibility.

OPTIMIZE_NORMALS: boolean = false

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.

OPTIMIZE_WITH_UV: boolean = true

Defines if UVs are optimized by default during load.

SKIP_MATERIALS: boolean = false

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

USE_LEGACY_BEHAVIOR: boolean = false

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

UV_SCALING: any = ...

Defines custom scaling of UV coordinates of loaded meshes.

WAIT_FOR_TEXTURES: boolean = false

Wait for referenced textures to finish loading before completing the OBJ load. Defaults to false for backwards compatibility.

  • Imports one or more meshes from the loaded OBJ data and adds them to the scene

    Parameters

    • meshesNames: any

      a string or array of strings of the mesh names that should be loaded from the file

    • scene: Scene

      the scene the meshes should be added to

    • data: any

      the OBJ data to load

    • rootUrl: string

      root url to load from

    Returns Promise<ISceneLoaderAsyncResult>

    a promise containing the loaded meshes, particles, skeletons and animations

  • Load into an asset container.

    Parameters

    • scene: Scene

      The scene to load into

    • data: string | ArrayBuffer

      The data to import

    • rootUrl: string

      The root url for scene and resources

    Returns Promise<AssetContainer>

    The loaded asset container

  • Imports all objects from the loaded OBJ data and adds them to the scene

    Parameters

    • scene: Scene

      the scene the objects should be added to

    • data: string | ArrayBuffer

      the OBJ data to load

    • rootUrl: string

      root url to load from

    Returns Promise<void>

    a promise which completes when objects have been loaded to the scene