LogoLogo
What's NewDeveloper CommunitySupportStatus
  • 🚀Get Started
    • What is JourneyApps Platform?
    • Tutorial: Build your First App
      • 1. Introduction
      • 2. Create a new App
      • 3. OXIDE IDE Overview
      • 4. Hello World app
      • 5. The Data Model
      • 6. View Components
      • 7. Queries and Data Sync
      • 8. Simple Navigation
      • 9. View Stack
      • 10. Input Validation
      • 11. View Parameters
      • 12. Data Manipulation
      • 13. Responsive Apps
      • 14. Styling
      • 15. Lists
      • 16. GPS Capturing
      • 17. Relationships
      • 18. Multiple User Roles
      • 19. Deployment and Users
      • 20. Version Control
      • 21. CSV and APIs
      • 22. Conclusion
    • JourneyApps Platform Fundamentals
      • Creating a New App
        • Git-enabled Apps
      • What are Views?
      • What is the Data Model?
      • JourneyApps Syntax Basics
      • Access the Database (DB)
        • Manipulate DB Objects
        • Query DB Objects
      • View Navigation
        • Deep Linking
      • CloudCode Overview
      • OXIDE (Online IDE)
  • 💻Build your App
    • JourneyApps Syntax
      • Syntax Basics
      • Access the DB
      • View Navigation
      • Async & Await
      • TypeScript Apps (Beta)
        • runtime-build package
        • TypeScript App Troubleshooting
      • What's New in V4
        • Updating to the V4 API
    • Configure your Data Model
      • What is the data model?
      • Reference: model
        • field
        • belongs-to
        • has-many
        • index
      • Data Rules
        • Data Buckets
        • Sync Rules - Limit data synced to devices
        • Data ACLs - Limit access to data
        • Real-world example for Data Rules
        • ❔FAQs
        • Migrate to Data Rules
      • App Indexes
      • Webhooks
    • UI Components
      • All UI Components
        • actionSheet
        • Attachments
        • button
        • button-group
        • capture-coordinates
          • marker
          • marker-query
        • capture-file
        • capture-photo
        • capture-signature
        • card
          • accent
          • action
        • columns
          • column
        • component
        • context-menu
          • divider
          • item
        • CSV
        • date-input
        • datetime-input
        • dialog
          • body
        • display-3d-model
          • 📖display-3d-model Guides
            • Guide 1: Initialize and layout a 3D model in a view
            • Guide 2: Control playback position
            • Guide 3: Troubleshooting controls
        • display-coordinates
        • display-file
        • display-image
        • display-photo
        • display-signature
        • heading
        • html
          • HTML Advanced Topics
          • ❔HTML FAQs
          • 📖Guide: HTML & JourneyApps iFrame Client
        • icons
        • info
        • info-table
          • row
        • journey.photos (capture multiple photos)
        • JourneyPrinter (print PDFs)
        • grid
          • cell
          • 📖grid Examples
        • list
          • list-item
            • accent
            • asset
            • pills
              • pill
            • action
        • multiple-choice-checklist
        • navigation (Navigation drawer)
          • general-section
            • item
          • section
            • item
              • item
          • ❔navigation FAQs
        • notification
        • object-dropdown
        • object-list
          • action
        • object-repeat
        • object-table
          • action
          • column
            • action
            • edit-boolean
            • edit-date
            • edit-datetime
            • edit-integer
            • edit-number
            • edit-select
            • edit-text
            • edit-time
            • edit-typeahead
              • action
            • header-action
          • column-group
          • empty-action
          • 📖object-table Guides
            • Actions
            • Cell callouts
            • Column groups
            • Columns
            • Controlled object-table
            • Controls
            • Copy & paste data
            • Edit cells
            • Filters
            • Frozen columns
            • Fullscreen object-table
            • Mode
            • State
            • Styles
        • optionList
        • PhotonSync (transfer data offline)
        • power-bi
          • 📖Guide: PowerBI Embedding
        • scan-barcode
        • shortcut
        • sidebar
        • single-choice-dropdown
        • single-choice-radio
        • template
        • text-input
        • time-input
        • toggle
        • view
      • JS/TS Events
      • Show / Hide UI Components
      • View Templates
      • XML Fields (Attributes)
        • align-content
        • align-controls
        • align-label
        • bind
        • clear-button-visibility
        • control-order
        • disabled
        • error-message
        • icon-position
        • id
        • hide-if
        • modifier-text
        • label
        • label-case
        • label-color
        • on-change
        • on-press
        • placeholder
        • required
        • show-if
    • JS / TS APIs
      • Attachment
      • Bluetooth (Beta)
      • Broadcast
      • component
      • CSV
      • DB
      • HardwareBarcode
      • journey
        • journey.config
        • journey.container
        • journey.device
        • journey.diagnostics
        • journey.dialog
        • journey.files
        • journey.hardware
        • journey.photos
        • journey.runtime
        • journey.sensors
        • journey.viewStack
      • JourneyPrinter
      • KeyboardBarcode
      • LocalDB
      • NFC
      • OnlineDB
      • PhotonSync
      • SerialPort
      • ShortcutManager
      • TCPSocket
      • user
    • Extend your App with Custom Code
      • App packages
        • App packages overview
        • PDF report package
        • TypeScript library & unit tests
        • Manage External Dependencies
      • Custom HTML
    • Style & Customize your App
      • Style & configure UI components
        • Overview
        • Understand extendable themes
        • Use themes on a view
        • Theme specific components on a view
        • Examples
        • Debugging
        • ❔FAQs
      • Change your App Font
      • Custom Branding
        • Custom Container Features
        • Special Requirements for iOS Containers
    • Integrate your App
      • Backend integrations with CloudCode
      • Barcode Scanning
        • Barcode Scanning using Keyboard Emulation
        • Hardware Barcode Scanning
        • scan-barcode
      • Bluetooth Low Energy (BLE)
      • Broadcast API
      • HTTP requests (Fetch API)
      • JourneyApps Print (Android)
      • Maps and navigation
      • NFC
      • Opening external links/apps
      • Serial Port
      • TCP Sockets
    • Design Intuitive Apps
      • UX Guidelines
      • Write Effective Copy
  • 📱App Features
    • RealWear® Voice Control
      • Automatic Voice Commands
        • Automatic Voice Commands - Advanced
      • Manual Voice Commands
    • App, Runtime and Container Updates
    • Batch Operations (App)
    • Call JS/TS Functions from XML
    • Capture GPS Locations
    • Push Notifications
    • Translations
    • XML Format Strings
    • Webhooks (External)
  • 🌐CloudCode
    • CloudCode Overview
    • Trigger a CloudCode Task
      • Trigger CC with a Schedule
      • Trigger CC via a Webhook
      • Trigger CC from an App
      • Trigger CC from Another Task
      • Trigger CC via HTTP
    • Attachments in CloudCode
    • Timezones
    • Advanced CloudCode Topics
      • Access Multiple DBs in CloudCode Tasks
      • Batch API (CloudCode)
      • CloudCode Dependencies
      • Configure HTTPS in CloudCode
      • Deployment environment variables
      • Local CloudCode Development
      • PDF Reports using CloudCode
      • Shared CloudCode Tasks
      • Translations in CloudCode
  • 📥Backend API
    • Introduction
    • API Reference
      • Retrieve All Objects
      • Query Objects
      • Sort Results
      • Limit and Skip
      • Count Objects
      • Create a New Object
      • Retrieve a Single Object
      • Update a Single Object
      • Delete a Single Object
      • Batch Operations (v4 API)
      • Oplog API
      • Retrieve the App Data Model
      • Manage App Users and Sessions
      • Field Representation
      • Error Responses
    • API Limits
    • Update to the V4 API
  • ⚙️Technical
    • Data Synchronization Priority
    • Device Diagnostics
    • JSON1 Query Engine
    • Improve App Performance
    • Security Measures
    • Supported Platforms
      • Web Container
      • Windows Installer
    • Domain Whitelist
  • 🖥️OXIDE
    • Get started with OXIDE
      • OXIDE Overview
      • Components of OXIDE
    • Configure Testing Deployments
    • Edit and Manage Files
      • How to Navigate to a Function
      • Manage External Dependencies
    • Create and Manage App Containers
    • Debugging & Troubleshooting
      • Common Troubleshooting Pointers
      • App Diagnostics Reports
      • Build Logs
    • OXIDE Workspaces
      • OXIDE Trees
  • ❕Deprecated Features
    • Deprecated Features and Components
Powered by GitBook
On this page
  • Overview
  • Load and display the 3D model in your view
  • Play and pause the 3D model animation
  • Move the playhead forwards, backwards or set it to a specific point
  • Complete view code
  1. Build your App
  2. UI Components
  3. All UI Components
  4. display-3d-model
  5. display-3d-model Guides

Guide 2: Control playback position

PreviousGuide 1: Initialize and layout a 3D model in a viewNextGuide 3: Troubleshooting controls

Last updated 2 years ago

Overview

In this guide, we'll show a few common controls that allow users to control the playback of a 3D model animation in the display-3d-model component. This includes the ability to:

  • Start playing and pausing a 3D model animation

  • Moving the playback position forwards or backwards

  • Setting the playback position to a specified point

The view we'll build will look as follows:

Developer notes:

Load and display the 3D model in your view

Play and pause the 3D model animation

To play and/or pause the 3D model animation, we'll add the following buttons to our view XML:

main.view.xml
<?xml version="1.0" encoding="UTF-8"?>
<view title="3D Model Viewer">
    <var name="animation_file" type="attachment" media="any" />
    <var name="scale" type="number" />
    
    <grid column-count="4">
        <cell column-span="3">
            <display-3d-model
                id="example"
                bind="animation_file"
                scale="scale"
                autoplay="false"
                material-vertex-groups="false"
            />
        </cell>
        <cell>
            <heading>Playback:</heading>
            <button-group>
                <button hide-if="$:isPlaying" label="Play" icon="fa-play" on-press="$:playAnimation()" validate="false" />
                <button show-if="$:isPlaying" label="Pause" icon="fa-pause" on-press="$:pauseAnimation()" validate="false" />
            </button-group>

            <heading>Update 3D model:</heading>
            <capture-file bind="animation_file" label=".fbx.zip file" downloadable="true" />
        </cell>
    </grid>
</view>

In the view JS, we'll initialize a global variable for isPlaying which is used to dynamically show and hide the play and pause buttons.

main.js
var isPlaying = false;

// This function is called when the app navigates to this view (using a link)
function init() {
    // initialize any data here that should be available when the view is shown
    view.scale = 0.1;
}

Next, we'll need to define the logic for playing and pausing the animation. In the view JS, we'll add two functions and add a playheadPosition variable to track the elapsed playback time:

main.js
var isPlaying = false;
var playheadPosition = 0;

// This function is called when the app navigates to this view (using a link)
function init() {
    // initialize any data here that should be available when the view is shown
    view.scale = 0.1;
}

// This function is called when the user returns to this view from another view
function resume(from) { }


function playAnimation() {
    console.log("Playing animation")
    
    // Set the component's playhead to the specified playhead position
    component.display3dModel({ id: "example" }).setPlayhead(playheadPosition);
    // Start the animation from the defined playhead
    component.display3dModel({ id: "example" }).animationStart();
    // Hide the "Play" button and show the "Pause" button
    isPlaying = true;
}

function pauseAnimation() {
    console.log("Pausing animation")
    
    // Stop playing the animation
    component.display3dModel({ id: "example" }).animationStop();
    // Show the "Play" button
    isPlaying = false;

    // Store the current playhead position
    playheadPosition = component.display3dModel({ id: "example" }).getPlayhead();
}

Move the playhead forwards, backwards or set it to a specific point

Here we are adding controls to move the animation playhead position forwards and backwards by a set amount, as well as directly specifying the playhead position.

We'll update the relevant part of the view XML code to the following:

main.view.xml
<?xml version="1.0" encoding="UTF-8"?>
<view title="3D Model Viewer">
    ...
    
    <grid column-count="4">
        <cell column-span="3">
            ...
        </cell>
        <cell>
            <heading>Playback:</heading>
            <button label="Set Time" subtext="Current: {$:timeElapsed}" icon="fa-stopwatch" on-press="$:setPlayhead()" validate="false" />
            <button-group>
                <button label="Backwards" icon="fa-fast-backward" on-press="$:skipAnimation(-10000)" validate="false" />
                <button label="Forward" icon="fa-fast-forward" on-press="$:skipAnimation(10000)" validate="false" />
            </button-group>
            <button-group>
                <button hide-if="$:isPlaying" label="Play" icon="fa-play" on-press="$:playAnimation()" validate="false" />
                <button show-if="$:isPlaying" label="Pause" icon="fa-pause" on-press="$:pauseAnimation()" validate="false" />
            </button-group>

            ...
        </cell>
    </grid>
</view>

In the view JS, we'll define the skipAnimation and setPlayhead functions:

main.js
function setPlayhead() {
    // Allow the user to enter a new position in ms
    var position = journey.dialog.input({
        title: 'Set Playhead position',
        message: "Enter the value in ms",
        inputValue: playheadPosition.toString(),
    });


    if (position != null) {
        // Store the new position 
        playheadPosition = Number(position);
        // Show the "Play" button
        isPlaying = false;
    }
}

function skipAnimation(timeValue) {
    // Update the playhead position
    playheadPosition = playheadPosition + timeValue;

    // Automatically start/continue playing from this new position
    playAnimation();
}

Complete view code

Below is the complete View XML and JS code used in this guide:

main.view.xml
<?xml version="1.0" encoding="UTF-8"?>
<view title="3D Model Viewer">
    <var name="animation_file" type="attachment" media="any" />
    <var name="scale" type="number" />
    
    <grid column-count="4">
        <cell column-span="3">
            <display-3d-model
                id="example"
                bind="animation_file"
                scale="scale"
                autoplay="false"
                
                material-vertex-groups="false"
            />
        </cell>
        <cell>
            <heading>Playback:</heading>
            <button label="Set Time" subtext="Current: {$:playheadPosition}" icon="fa-stopwatch" on-press="$:setPlayhead()" validate="false" />
            <button-group>
                <button label="Backwards" icon="fa-fast-backward" on-press="$:skipAnimation(-10000)" validate="false" />
                <button label="Forward" icon="fa-fast-forward" on-press="$:skipAnimation(10000)" validate="false" />
            </button-group>
            <button-group>
                <button hide-if="$:isPlaying" label="Play" icon="fa-play" on-press="$:playAnimation()" validate="false" />
                <button show-if="$:isPlaying" label="Pause" icon="fa-pause" on-press="$:pauseAnimation()" validate="false" />
            </button-group>

            <heading>Update 3D model:</heading>
            <capture-file bind="animation_file" label=".fbx.zip file" downloadable="true" />
        </cell>
    </grid>
</view>
main.js
var isPlaying = false;
var playheadPosition = 0;

// This function is called when the app navigates to this view (using a link)
function init() {
    // initialize any data here that should be available when the view is shown
    view.scale = 0.1;
}

// This function is called when the user returns to this view from another view
function resume(from) { }

function setPlayhead() {
    // Allow the user to enter a new position in ms
    var position = journey.dialog.input({
        title: 'Set Playhead position',
        message: "Enter the value in ms",
        inputValue: playheadPosition.toString(),
    });


    if (position != null) {
        // Store the new position 
        playheadPosition = Number(position);
        // Show the "Play" button
        isPlaying = false;
    }
}

function skipAnimation(timeValue) {
    // Update the playhead position
    playheadPosition = playheadPosition + timeValue;

    // Automatically start/continue playing from this new position
    playAnimation();
}

function playAnimation() {
    console.log("Playing animation")
    
    // Set the component's playhead to the specified playhead position
    component.display3dModel({ id: "example" }).setPlayhead(playheadPosition);
    // Start the animation from the defined playhead
    component.display3dModel({ id: "example" }).animationStart();
    // Hide the "Play" button and show the "Pause" button
    isPlaying = true;
}

function pauseAnimation() {
    console.log("Pausing animation")
    
    // Stop playing the animation
    component.display3dModel({ id: "example" }).animationStop();
    // Show the "Play" button
    isPlaying = false;

    // Store the current playhead position
    playheadPosition = component.display3dModel({ id: "example" }).getPlayhead();
}

Please refer to the . The same notes apply to this guide.

Please refer to . We'll use the same foundations from the first guide in the below guide.

Note that we have set the attribute to false, since we want users to be able to control the playback manually. We have also added an attribute, which is used by to identify the component in the view XML.

Note that the above functions, to start and stop the animation playback, make use of multiple of display-3d-model.

💻
📖
developer notes in the first guide
this section in the first guide
autoplay
id
component methods
component methods