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
  • Add and initialize attributes
  • Adding controls (buttons)
  • Complete view code
  1. Build your App
  2. UI Components
  3. All UI Components
  4. display-3d-model
  5. display-3d-model Guides

Guide 3: Troubleshooting controls

PreviousGuide 2: Control playback positionNextdisplay-coordinates

Last updated 2 years ago

Overview

In this simple guide, we'll show a few common controls that let users toggle various attributes of a 3D model in the display-3d-model component. A common use case for this is troubleshooting: there may be certain parts of a model animation or a particular scene in a model where it is useful to have e.g. a bounding box or show the wireframe, and in other parts a user would want to hide them. This includes the ability to toggle the , , , , and or of the model.

The view we'll build will look as follows:

Developer notes:

Load and display the 3D model in your view

Add and initialize attributes

We'll start by adding boolean variables for all the troubleshooting attributes we want the user to be able to toggle. We'll also add these attributes to the display-3d-model:

main.view.xml
<view title="3D Model Viewer">
    <var name="animation_file" type="attachment" media="any" />   
    <var name="scale" type="number" />

    <var name="bounding_box" type="boolean" />
    <var name="debug_normals" type="boolean" />
    <var name="double_sided" type="boolean" />
    <var name="material_vertex" type="boolean" />
    <var name="stats" type="boolean" />
    <var name="wireframe" type="boolean" />
    
    <grid column-count="4">
        <cell column-span="3">
            <display-3d-model
                bind="animation_file"
                scale="scale"

                bounding-box="bounding_box"
                debug-normals="debug_normals"
                double-sided-materials="double_sided"
                material-vertex-groups="material_vertex"
                stats="stats"
                wireframe="wireframe"
                
            />
        </cell>
        <cell>
            <heading>Update 3D model:</heading>
            <capture-file bind="animation_file" label=".fbx.zip file" downloadable="true" />
        </cell>
    </grid>

</view>

We'll initialize each of the attributes in the init() function - here we're initializing all to false but that can of course be updated to true where it makes sense:

main.js
// 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;

    // Troubleshooting controls defaults
    view.bounding_box = false;
    view.debug_normals = false;
    view.double_sided = false;
    view.material_vertex = false;
    view.stats = false;
    view.wireframe = false;

}

Adding controls (buttons)

Now we need to give the user the ability to toggle these attributes. We'll do this by adding a button for each, and adding a function that toggles the boolean:

main.view.xml
<view title="3D Model Viewer">
    <var name="animation_file" type="attachment" media="any" />   
    ...
    
    <grid column-count="4">
        <cell column-span="3">
            ...
        </cell>
        <cell>
            <heading>Troubleshooting Controls</heading>
            <button label="Toggle bounding box" on-press="$:toggleBool('bounding_box')" subtext="Current: {$:view.bounding_box}" validate="false" />
            <button label="Toggle debug normals" on-press="$:toggleBool('debug_normals')" subtext="Current: {$:view.debug_normals}" validate="false" />
            <button label="Toggle double-sided materials" on-press="$:toggleBool('double_sided')" subtext="Current: {$:view.double_sided}" validate="false" />
            <button label="Toggle material vertex groups" on-press="$:toggleBool('material_vertex')" subtext="Current: {$:view.material_vertex}" validate="false" />
            <button label="Toggle stats" on-press="$:toggleBool('stats')" subtext="Current: {$:view.stats}" validate="false" />
            <button label="Toggle wireframe" on-press="$:toggleBool('wireframe')" subtext="Current: {$:view.wireframe}" validate="false" />
            
            <heading>Update 3D model:</heading>
            <capture-file bind="animation_file" label=".fbx.zip file" downloadable="true" />
        </cell>
    </grid>

</view>

Each button calls a toggleBool() function, which takes a string as a parameter. We'll add a very simple function to our view's JS, which sets the dynamically specified view variable to its inverse value:

main.js
function toggleBool(varName) {
    // Set the view variable to its inverse
    view[varName] = !view[varName];
}

Complete view code

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

main.view.xml
<view title="3D Model Viewer">
    <var name="animation_file" type="attachment" media="any" />   
    <var name="scale" type="number" />

    <var name="bounding_box" type="boolean" />
    <var name="debug_normals" type="boolean" />
    <var name="double_sided" type="boolean" />
    <var name="material_vertex" type="boolean" />
    <var name="stats" type="boolean" />
    <var name="wireframe" type="boolean" />
    
    <grid column-count="4">
        <cell column-span="3">
            <display-3d-model
                bind="animation_file"
                scale="scale"

                bounding-box="bounding_box"
                debug-normals="debug_normals"
                double-sided-materials="double_sided"
                material-vertex-groups="material_vertex"
                stats="stats"
                wireframe="wireframe"
                
            />
        </cell>
        <cell>
            <heading>Troubleshooting Controls</heading>
            <button label="Toggle bounding box" on-press="$:toggleBool('bounding_box')" subtext="Current: {$:view.bounding_box}" validate="false" />
            <button label="Toggle debug normals" on-press="$:toggleBool('debug_normals')" subtext="Current: {$:view.debug_normals}" validate="false" />
            <button label="Toggle double-sided materials" on-press="$:toggleBool('double_sided')" subtext="Current: {$:view.double_sided}" validate="false" />
            <button label="Toggle material vertex groups" on-press="$:toggleBool('material_vertex')" subtext="Current: {$:view.material_vertex}" validate="false" />
            <button label="Toggle stats" on-press="$:toggleBool('stats')" subtext="Current: {$:view.stats}" validate="false" />
            <button label="Toggle wireframe" on-press="$:toggleBool('wireframe')" subtext="Current: {$:view.wireframe}" validate="false" />
            
            <heading>Update 3D model:</heading>
            <capture-file bind="animation_file" label=".fbx.zip file" downloadable="true" />
        </cell>
    </grid>

</view>
main.js
// 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;

    // Troubleshooting controls defaults
    view.bounding_box = false;
    view.debug_normals = false;
    view.double_sided = false;
    view.material_vertex = false;
    view.stats = false;
    view.wireframe = false;

}

function toggleBool(varName) {
    // Set the view variable to its inverse
    view[varName] = !view[varName];
}

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.

💻
📖
bounding-box
debug-normals
double-sided-materials
material-vertex-groups
stats
wireframe
developer notes in the first guide
this section in the first guide