API Docs for:

OBJModel

An OBJModel is a Model that loads itself from OBJ and MTL files.

Overview

  • Begins loading as soon as you set its src property to the location of an OBJ file.
  • Once loaded, contains an Mesh for each object. The Meshes can then be independently shown, hidden, colored, transformed etc.
  • Set src to a new file path at any time, to clear the OBJModel and load components from the new file.

OBJModel inherits these capabilities from its Group base class:

  • Allows you to access and manipulate the Meshes within it.
  • Can be transformed as a unit within World-space.
  • Can be a child within a parent Group.
  • Provides its World-space axis-aligned and object-aligned boundaries.

Examples

Usage

Let's load the conference room model (shown in the screenshot above):

var confRoom = new xeogl.OBJModel({
    id: "confRoom",
    src: "models/obj/conference/conference.obj"
});

Bind a callback to fire when the model has loaded:

confRoom.on("loaded", function() {
    // OBJModel has loaded!
});

That fires immediately if the OBJModel already happens to be loaded. You can also bind a callback to fire if loading fails:

confRoom.on("error", function(msg) {
    // Error occurred
});

To switch to a different OBJ file, simply update src:

confRoom.src = "models/obj/female02/female02.obj";

Fitting to view

var cameraFlight = new xeogl.CameraFlightAnimation();
cameraFlight.flyTo(confRoom);

Accessing components

Let's make everything transparent, except for the conference table and chairs:

for (var id in confRoom.meshes) {
   var mesh = confRoom.meshes[id];
   switch (id) {
       case "confRoom#mesh31":
       case "confRoom#mesh29":
       case "confRoom#mesh30":
           break;
       default: // Not a chair mesh
           mesh.material.alpha = 0.5;
           mesh.material.blendMode = "blend"
   }
}

Note the format of the Mesh IDs - an OBJModel prefixes its own ID to the IDs of its components:

<OBJModel ID>#<OBJ object/group ID>

Transforms

An OBJModel lets us transform its Meshes as a group:

var model = new xeogl.OBJModel({
    src: "models/obj/conference/conference.obj"
    position: [-35, 0, 0],
    rotation: [0, 45, 0],
    scale: [0.5, 0.5, 0.5]
});

model.position = [-20, 0, 0];

Let's move the white table top upwards:

var tableTop = confRoom.meshes["confRoom#mesh29"];
tableTop.position = [0, 150, 0];

Examples

Constructor

OBJModel

(
  • [scene]
  • [cfg]
)

Parameters:

  • [scene] Scene optional

    Parent Scene - creates this OBJModel in the default Scene when omitted.

  • [cfg] optional

    Configs

    • [id] String optional

      Optional ID, unique among all components in the parent Scene, generated automatically when omitted.

    • [entityType] String optional

      Optional entity classification when using within a semantic data model. See the Object documentation for usage.

    • [meta] String:Object optional

      Optional map of user-defined metadata to attach to this OBJModel.

    • [src] String optional

      Path to an OBJ file. You can set this to a new file path at any time, which will cause the OBJModel to load components from the new file (after first destroying any components loaded from a previous file path).

    • [quantizeGeometry=true] Boolean optional

      When true, quantizes geometry to reduce memory and GPU bus usage.

    • [combineGeometry=true] Boolean optional

      When true, combines geometry vertex buffers to improve rendering performance.

    • [ghosted=false] Boolean optional

      When true, sets all the OBJModel's Meshes initially ghosted.

    • [highlighted=false] Boolean optional

      When true, sets all the OBJModel's Meshes initially highlighted.

    • [outline=false] Boolean optional

      When true, sets all the OBJModel's Meshes initially outlined.

    • [edgeThreshold=2] Number optional

      When ghosting, this is the threshold angle between normals of adjacent triangles, below which their shared wireframe edge is not drawn.

    • [transform] Number | String | Transform optional

      A Local-to-World-space (modelling) Transform to attach to this OBJModel. Must be within the same Scene as this STLModel. Internally, the given Transform will be inserted above each top-most Transform that the STLModel attaches to its Meshes.

    • [splitMeshes=true] Boolean optional

      When true, creates a separate Mesh for each group of faces that share the same vertex colors. Only works with binary STL.|

    • [position=[0,0,0] Float32Array optional

      The STLModel's local 3D position.

    • [scale=[1,1,1] Float32Array optional

      The STLModel's local scale.

    • [rotation=[0,0,0] Float32Array optional

      The STLModel's local rotation, as Euler angles given in degrees.

    • [matrix=[1,0,0,0,0,1,0,0,0,0,1,0,0,0,0,1] Float32Array optional

      The STLModel's local transform matrix. Overrides the position, scale and rotation parameters.

Methods

angleVec3

(
  • v
  • w
)
Number

Gets the angle between two vectors

Parameters:

Returns:

Number:

clear

()

Destroys all Components in this Model.

create

(
  • [cfg]
)

Convenience method for creating a Component within this Component's Scene.

The method is given a component configuration, like so:

var material = myComponent.create({
     type: "xeogl.PhongMaterial",
     diffuse: [1,0,0],
     specular: [1,1,0]
}, "myMaterial");

Parameters:

  • [cfg] optional

    Configuration for the component instance.

Returns:

:

destroy

()

Destroys this component.

Fires a destroyed event on this Component.

Automatically disassociates this component from other components, causing them to fall back on any defaults that this component overrode on them.

TODO: describe effect with respect to #create

error

(
  • message
)

Logs an error for this component to the JavaScript console.

The console message will have this format: [ERROR] [<component type> =<component id>: <message>

Also fires the message as an error event on the parent Scene.

Parameters:

  • message String

    The message to log

fire

(
  • event
  • value
  • [forget=false]
)

Fires an event on this component.

Notifies existing subscribers to the event, optionally retains the event to give to any subsequent notifications on the event as they are made.

Parameters:

  • event String

    The event type name

  • value Object

    The event parameters

  • [forget=false] Boolean optional

    When true, does not retain for subsequent subscribers

hasSubs

(
  • event
)
Boolean

Returns true if there are any subscribers to the given event on this component.

Parameters:

  • event String

    The event

Returns:

Boolean:

True if there are any subscribers to the given event on this component.

isType

(
  • type
)
Boolean

Tests if this component is of the given type, or is a subclass of the given type.

The type may be given as either a string or a component constructor.

This method works by walking up the inheritance type chain, which this component provides in property Component/superTypes:property, returning true as soon as one of the type strings in the chain matches the given type, of false if none match.

Examples:

var myRotate = new xeogl.Rotate({ ... });

myRotate.isType(xeogl.Component); // Returns true for all xeogl components
myRotate.isType("xeogl.Component"); // Returns true for all xeogl components
myRotate.isType(xeogl.Rotate); // Returns true
myRotate.isType(xeogl.Transform); // Returns true
myRotate.isType("xeogl.Transform"); // Returns true
myRotate.isType(xeogl.Mesh); // Returns false, because xeogl.Rotate does not (even indirectly) extend xeogl.Mesh

Parameters:

  • type String | Function

    Component type to compare with, eg "xeogl.PhongMaterial", or a xeogl component constructor.

Returns:

Boolean:

True if this component is of given type or is subclass of the given type.

load

(
  • model
  • src
  • [ok]
)
static

Loads OBJ and MTL from file(s) into a Model.

Parameters:

  • model Model

    Model to load into.

  • src String

    Path to OBJ file.

  • [ok] Function optional

    Completion callback.

log

(
  • message
)

Logs a console debugging message for this component.

The console message will have this format: [LOG] [<component type> <component id>: <message>

Also fires the message as a log event on the parent Scene.

Parameters:

  • message String

    The message to log

lookAtMat4v

(
  • pos
  • target
  • up
  • dest
)
Mat4

Returns a 4x4 'lookat' viewing transform matrix.

Parameters:

  • pos Object

    vec3 position of the viewer

  • target Object

    vec3 point the viewer is looking at

  • up Object

    vec3 pointing "up"

  • dest Object

    mat4 Optional, mat4 matrix will be written into

Returns:

Mat4:

dest if specified, a new mat4 otherwise

off

(
  • subId
)

Cancels an event subscription that was previously made with Component#on() or Component#once().

Parameters:

  • subId String

    Publication subId

on

(
  • event
  • callback
  • [scope=this]
)
String

Subscribes to an event on this component.

The callback is be called with this component as scope.

Parameters:

  • event String

    The event

  • callback Function

    Called fired on the event

  • [scope=this] Object optional

    Scope for the callback

Returns:

String:

Handle to the subscription, which may be used to unsubscribe with {@link #off}.

once

(
  • event
  • callback
  • [scope=this]
)

Subscribes to the next occurrence of the given event, then un-subscribes as soon as the event is subIdd.

This is equivalent to calling Component#on(), and then calling Component#off() inside the callback function.

Parameters:

  • event String

    Data event to listen to

  • callback Function(data)

    Called when fresh data is available at the event

  • [scope=this] Object optional

    Scope for the callback

parse

(
  • model
  • objText
  • [mtlText]
  • [basePath]
)
static

Parses OBJ and MTL text strings into a Model.

Parameters:

  • model Model

    Model to load into.

  • objText String

    OBJ text string.

  • [mtlText] String optional

    MTL text string.

  • [basePath] String optional

    Base path for external resources.

removeChild

(
  • object
)

Removes the given child.

Parameters:

  • object Object

    Child to remove.

removeChildren

()

Removes all children.

rotate

(
  • angle
)

Rotates about the given local axis by the given increment.

Parameters:

  • angle Number

    Angle increment in degrees.

rotateX

(
  • angle
)

Rotates about the local X-axis by the given increment.

Parameters:

  • angle Number

    Angle increment in degrees.

rotateY

(
  • angle
)

Rotates about the local Y-axis by the given increment.

Parameters:

  • angle Number

    Angle increment in degrees.

rotateZ

(
  • angle
)

Rotates about the local Z-axis by the given increment.

Parameters:

  • angle Number

    Angle increment in degrees.

scaleMat4c

(
  • x
  • y
  • z
  • m
)

Efficiently post-concatenates a scaling to the given matrix.

Parameters:

translate

(
  • axis
  • distance
)

Translates along local space vector by the given increment.

Parameters:

  • axis Float32Array

    Normalized local space 3D vector along which to translate.

  • distance Number

    Distance to translate along the vector.

translateX

(
  • distance
)

Translates along the local X-axis by the given increment.

Parameters:

  • distance Number

    Distance to translate along the X-axis.

warn

(
  • message
)

Logs a warning for this component to the JavaScript console.

The console message will have this format: [WARN] [<component type> =<component id>: <message>

Also fires the message as a warn event on the parent Scene.

Parameters:

  • message String

    The message to log

Properties

aabb

Float32Array final

World-space 3D axis-aligned bounding box (AABB).

Represented by a six-element Float32Array containing the min/max extents of the axis-aligned volume, ie. [xmin, ymin,zmin,xmax,ymax, zmax].

aabbVisible

Boolean

Indicates if the 3D World-space axis-aligned bounding box (AABB) is visible.

Default: false

castShadow

Boolean

Indicates if casting shadows.

Default: true

center

Float32Array final

World-space 3D center.

childIDs

Array final

IDs of child Objects.

childMap

final

Child Objects mapped to their IDs.

children

Array final

Array of child Objects.

clippable

Boolean

Indicates if clippable.

Clipping is done by the Scene's Clips component.

Default: true

collidable

Boolean

Indicates if included in boundary calculations.

Default: true

colorize

Float32Array

RGB colorize color, multiplies by the rendered fragment color.

Default: [1.0, 1.0, 1.0]

components

String:Component

All contained Components, mapped to their IDs.

culled

Boolean

Indicates if culled from view.

Only rendered when visible is true and culled is false.

Default: false

DEGTORAD

Number

The number of radiians in a degree (0.0174532925).

destroyed

Boolean

True as soon as this Component has been destroyed

edges

Boolean

Indicates if edges are emphasized.

Default: false

entities

String:Object final

Objects in this Model that have entity types, mapped to their IDs.

Each Object is registered in this map when its entityType is set to value.

entityIds

Array of String final

Convenience array of IDs in entities.

entityType

String final

Optional entity classification when using within a semantic data model.

See the Object documentation on "Applying a semantic data model" for usage.

Default: null

entityTypeIds

Array of String final

Convenience array of entity type IDs in entityTypes.

entityTypes

String:{String:xeogl.Component} final

For each entity type, a map of IDs to Objects of that entity type.

Each Object is registered in this map when its entityType is assigned a value.

ghosted

Boolean

Indicates if ghosted.

Each ghosted Object is registered in its Scene's ghostedEntities map while its entityType is set to a value.

Default: false

guid

String final

Globally unique identifier.

This is unique not only within the Scene, but throughout the entire universe.

Only defined when given to the constructor.

guidObjects

String:Object final

Objects in this Model that have GUIDs, mapped to their GUIDs.

Each Object is registered in this map when its guid is assigned a value.

highlighted

Boolean

Indicates if highlighted.

Each highlighted Object is registered in its Scene's highlightedEntities map while its entityType is set to a value.

Default: false

id

String final

Unique ID for this Component within its parent Scene.

matrix

Float32Array

Local matrix.

Default: [1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1]

meshes

String:xeogl.Mesh final

All contained Meshes, mapped to their IDs.

metadata

Object

Arbitrary, user-defined metadata on this component.

model

Model final

The Model which contains this Component, if any.

Will be null if this Component is not in a Model.

numChildren

Number final

Number of child Objects.

numComponents

Number

Number of contained Components.

objects

String:Object final

All contained Objects, mapped to their IDs.

opacity

Number

Opacity factor, multiplies by the rendered fragment alpha.

This is a factor in range [0..1].

Default: 1.0

outlined

Boolean

Indicates if outlined.

Default: false

parent

Group

The parent.

The parent Group may also be set by passing the Object to the Group/Model's Group/addChild:method method.

pickable

Boolean

Whether or not to allow picking.

Picking is done via calls to Scene#pick().

Default: true

position

Float32Array

Local translation.

Default: [0,0,0]

quaternion

Float32Array

Local rotation quaternion.

Default: [0,0,0, 1]

RADTODEG

Number

The number of degrees in a radian.

receiveShadow

Boolean

Indicates if receiving shadows.

Default: true

rotation

Float32Array

Local rotation, as Euler angles given in degrees, for each of the X, Y and Z axis.

Default: [0,0,0]

scale

Float32Array

Local scale.

Default: [1,1,1]

scene

Scene final

The parent Scene that contains this Component.

selected

Boolean

Indicates if selected.

Each selected Object is registered in its Scene's selectedEntities map while its entityType is set to a value.

Default: false

src

String

Path to a Wavefront OBJ file.

You can set this to a new file path at any time, which will cause the OBJModel to load components from the new file (after first destroying any components loaded from a previous file path).

Also loads materials from any MTL files referenced in the OBJ.

Fires a src event on change.

type

String final

JavaScript class name for this Component.

For example: "xeogl.AmbientLight", "xeogl.MetallicMaterial" etc.

types

String:{String:xeogl.Component}

A map of maps; for each contained Component type, a map to IDs to Component instances, eg.

"xeogl.Geometry": {
       "alpha": <xeogl.Geometry>,
       "beta": <xeogl.Geometry>
     },
"xeogl.Rotate": {
       "charlie": <xeogl.Rotate>,
       "delta": <xeogl.Rotate>,
       "echo": <xeogl.Rotate>,
     },
//...

visible

Boolean

Indicates if visible.

Only rendered when visible is true and culled is false.

Each visible Object is registered in its Scene's visibleEntities map while its entityType is set to a value.

Default: true

worldMatrix

Float32Array

The World matrix.

worldNormalMatrix

Float32Array

This World normal matrix.

Default: [1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1]

Events

destroyed

Fired when this Component is destroyed.

loaded

Fired whenever this OBJModel has finished loading components from the OBJ file specified by src.

src

Fired whenever this OBJModel's src property changes.

Event Payload:

  • value Object

    The property's new value