display-3d-model
The
display-3d-model
UI component embeds and displays 3D models (in .fbx
format) for a user to interact with. Version compatibility
display-3d-model
was introduced in version 4.84.0 of the JourneyApps Runtime.Current Limitations
display-3d-model
currently only supports.fbx
files and these files need to be zipped when bound to the component. E.g.my-animation.fbx.zip
- 3D models with textures are not currently supported.
- It is not possible to toggle hidden layers, groups, or elements.

main.view.xml
<!-- The attachment needs to be a zipped FBX file, e.g. my-animation.fbx.zip -->
<var name="scene" type="attachment" media="any" />
<display-3d-model bind="scene" scale="0.1" />
main.js
function init() {
var animation = DB.animation.first();
view.scene = animation.scene;
}
For more examples, see our guides:
Once a model is loaded in
display-3d-model
, a user can interact with it by using their mouse or by using controls that programmatically manipulate the 3D model.- Rotate the scene: Users can drag their mouse around in the 3D model. The scene will rotate around the current center of the viewer.
- Pan / translate the scene: While holding the shift key, users can drag their mouse around. Dragging left and right will pan the scene horizontally, while dragging up and down will pan the scene vertically.
Developers can set up controls (e.g. a
button-group
containing multiple buttons linked to JS/TS functions) that allow users to manipulate various attributes of the 3D model. Configurable attributes and component methods are described further below in this document. Examples of controls that a user might need include:
Example: Programmatic controls
main.view.xml
<var name="scene" type="attachment" media="any" />
<var name="scale" type="number" />
<display-3d-model id="example" bind="scene" scale="scale" />
<button-group mode="row">
<!-- Controls to allow users to increase or decrease the scale -->
<button label="-" on-press="$:scaleDown()"/>
<button label="+" on-press="$:scaleUp()"/>
<!-- Controls to allow users to start/stop animation -->
<button label="Start Animation" on-press="$:startAnimation()"/>
<button label="Stop Animation" on-press="$:stopAnimation()"/>
</button-group>
function init() {
var animation = DB.animation.first();
view.scene = animation.scene;
view.scale = 0.1; // Set the default scale
}
function scaleUp(){
view.scale *= 10; // Increase scale by 10
}
function scaleDown(){
view.scale /= 10; // Decrease scale by 10
}
function startAnimation(){
component.display3dModel({id: "example"}).animationStart();
}
function stopAnimation(){
component.display3dModel({id: "example"}).animationStop();
}
The table below summarizes the available attributes and component methods for
display-3D-model
grouped according to their primary or most common function. Each of the listed attributes is described later in this document.Function | Attributes |
---|---|
Geometry | |
Animation | |
Camera | |
Styling & Display | |
Troubleshooting |
- Performance consideration: In general, the larger the file the worse the performance will be, especially on a mobile device (such as a RealWear HMT). File size will be directly proportional to the number of polygons and the number and characteristics of the materials included in the model (even if those materials are not actually used)
- As a rule of thumb, aim for a file size of under 5 MB. Practically this may mean unnecessary high fidelity elements should be removed from their original models to reduce the polygon count, and by extension the file size.
- Unused (and non visible) materials should be removed from models before they are exported to FBX to limit the file size.
- Materials: The use of materials is generally supported however, trial and error in terms of which materials work well is recommended.
Optional
Type:
Number
Default: 1.0
Specify the scale of the model.
Optional
Type:
boolean
Default:
true
Specify whether the model animation should automatically start playing when the model is loaded.
Optional
Type:
string
(#hex value)Default:
#a0a0a0
Specify the background color of the component.
Optional
Type:
string
- can be a named color or #HEX valueDefault:
#546e7a
(Light theme); #90a4ae
(Dark theme)Specify the border color of the component.
Optional
Type:
boolean
Default:
false
Enable or disable the bounding box of the model.
Optional
Type:
boolean
Default:
false
Optional
Type:
boolean
Default:
true
Enable or disable double-sided materials.
Optional
Type:
boolean
Default:
true
Enable or disable the floor of the model.
Optional
Type:
boolean
Default:
true
Enable or disable a background fog effect.
Optional
Type:
Number
Default: 700 px
Specify the height of the component in pixel.
Optional
Type:
string
(#hex value)Default:
#546e7a
(Light theme); #90a4ae
(Dark theme)Specify the color of the loader animation that displays when the component loads a model.
Optional
Type:
boolean
Default:
true
Specify whether the model animation should play in a loop.
Optional
Type:
boolean
Default:
true
Enable or disable the material vertex groups.
Optional
Type:
Number
Default: 0
Specify the offset of the x-axis.
Optional
Type:
Number
Default: 0
Specify the offset of the y-axis.
Optional
Type:
Number
Default: 0
Specify the offset of the z-axis.
Optional
Default: unset
Triggered when: A user clicks on the model
Event parameter:
$meshes
Return value: An array of objects
main.view.xml
<var name="scene" type="attachment" media="any" />
<display-3d-model bind="scene" scale="0.1" on-pick-mesh="$:onPick($meshes)" />
main.js
function onPick(meshArray) {
for (var i = 0; i < meshArray.length; i++){
console.log(meshArray[i]);
// Example:
// Object{name: "Plane"}
}
}
Optional
Type:
boolean
Default:
false
Enable or disable debug info about the model such as the frames rendered per second. These are displayed in the top-left corner of the component if available.
Optional
Type:
boolean
Default:
false
Enable or disable the wireframe of the model.
The following component methods are available when an
id
is assigned to the component and component.display3dModel({id:'my-id'})
is called from JS/TS:This method starts the animation of a model.
This method stops the animation of a model.
Returns:
Array
, e.g. [0,408.6,0]
Generates an array with offsets for each axis (x,y,z) that centers the model on-screen.
Example:
main.view.xml
<var name="scene" type="attachment" media="any" />
<var name="offsetx" type="number" />
<var name="offsety" type="number" />
<var name="offsetz" type="number" />
<display-3d-model id="example" bind="scene" offset-x="offsetx" offset-y="offsety" offset-z="offsetz" />
<button label="Center" on-press="$:computeOffsets()" />
main.js
function computeOffsets() {
var offsets = component.display3dModel({id: "example"}).computeCenterOffset();
view.offsetx = offsets[0];
view.offsety = offsets[1];
view.offsetz = offsets[2];
}
Parameter:
Number
that represents the scaleGenerates a scale value that when used, will scale the model to an acceptable size in the current 3D viewport that will show the entire mesh.
Note: This is useful because not all 3D models use the same scale factor.
Example:
main.view.xml
<var name="scene" type="attachment" media="any" />
<display-3d-model id="example" bind="scene" scale="scale" />
<button label="Fit" on-press="$:computeScale()" />
main.js
function computeScale() {
var scaleFactor = 550;
view.scale = component.display3dModel({id: "example"}).computeScaleFactor(scaleFactor);
}
Returns: The current camera position as an
Object
, e.g. {position: [100.00000000000001, 200, 299.99999999999994], rotation: [-0.1505711418828577, 0.1583076573177903, 0.024434332593631213, 0.9755357401230101]}
Parameter: The specified camera position as an
Object
, e.g. {position: [100.00000000000001, 200, 299.99999999999994], rotation: [-0.1505711418828577, 0.1583076573177903, 0.024434332593631213, 0.9755357401230101]}
Tip: This method is also useful when creating 3D step-based workflows (because the camera animates to a specified position).
Returns: The playback position in milliseconds.
Gets the playback position.
Parameter: The playback position in milliseconds.
Sets the playback position.
Programmatically scroll until the
display-3d-model
component is visible in the view.
Last modified 6mo ago