Options
All
  • Public
  • Public/Protected
  • All
Menu

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

Hierarchy

  • OBJFileLoader

Implements

Index

Constructors

  • Creates loader for .OBJ files

    Parameters

    • Optional loadingOptions: OBJLoadingOptions

      options for loading and parsing OBJ/MTL files.

    Returns OBJFileLoader

Properties

extensions: string

Defines the extension the plugin is able to load.

name: string

Defines the name of the plugin.

COMPUTE_NORMALS: boolean

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

IMPORT_VERTEX_COLORS: boolean

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

INVERT_Y: boolean

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

MATERIAL_LOADING_FAILS_SILENTLY: boolean

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

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

Defines if UVs are optimized by default during load.

SKIP_MATERIALS: boolean

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

UV_SCALING: Vector2

Defines custom scaling of UV coordinates of loaded meshes.

Accessors

  • get INVERT_TEXTURE_Y(): boolean
  • set INVERT_TEXTURE_Y(value: boolean): void
  • Invert Y-Axis of referenced textures on load

    Returns boolean

  • Invert Y-Axis of referenced textures on load

    Parameters

    • value: boolean

    Returns void

Methods

  • canDirectLoad(): boolean
  • If the data string can be loaded directly.

    Returns boolean

    if the data can be loaded directly

  • 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

      The data to import

    • rootUrl: string

      The root url for scene and resources

    Returns Promise<AssetContainer>

    The loaded asset container

  • loadAsync(scene: Scene, data: string, rootUrl: string): Promise<void>
  • 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

      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

Legend

  • Constructor
  • Property
  • Method
  • Property
  • Method
  • Static property
  • Static method
  • Inherited constructor

Settings

Theme