ArtiSynth User Interface Guide

Contents

• 1 Introduction
  • 1.1 User configuration folder
• 2 Loading, Simulating and Saving Models
  • 2.1 Loading from the model menu
  • 2.2 Loading directly by class
  • 2.3 Loading from a file
  • 2.4 Loading recent models
  • 2.5 Setting a startup model
    • 2.5.1 Specifying models from the command line
  • 2.6 Simulating a model
  • 2.7 Other toolbar controls
  • 2.8 Saving a model
  • 2.9 Setting the external classpath
  • 2.10 The ArtiSynth working folder
• 3 The Viewer
  • 3.1 Viewer Toolbar
  • 3.2 Viewpoint control
  • 3.3 Adding additional viewers
  • 3.4 World coordinate axes
  • 3.5 Orthographic vs. perspective projection
  • 3.6 Viewer grid
    • 3.6.1 Grid units
    • 3.6.2 Axis labeling
    • 3.6.3 Grid properties
  • 3.7 Clipping planes
    • 3.7.1 Adding and removing
    • 3.7.2 Moving
    • 3.7.3 Offsets
    • 3.7.4 Enabling/disabling
    • 3.7.5 Slicing mode
    • 3.7.6 Other features
  • 3.8 Indicating 3D positions with the mouse
  • 3.9 Viewer properties
    • 3.9.1 Viewer-specific properties
  • 3.10 Mouse Bindings
  • 3.11 Keyboard shortcuts
• 4 Component Navigation and Selection
  • 4.1 The component hierarchy
    • 4.1.1 Component names and numbers
    • 4.1.2 Component path names
  • 4.2 Navigation panel selection
    • 4.2.1 Large numbers of nameless components
  • 4.3 Viewer selection
    • 4.3.1 Click and box selection
    • 4.3.2 Elliptic selection
    • 4.3.3 Selection filtering
  • 4.4 Selection display
  • 4.5 Selecting parent and ancestor components
  • 4.6 Highlighting selected components
  • 4.7 Selecting FEM nodes
• 5 Model Manipulation
  • 5.1 Dragger fixtures
  • 5.2 Transformer tools
    • 5.2.1 Constrained transformation
    • 5.2.2 Transformer repositioning
    • 5.2.3 Changing the transformer base frame
    • 5.2.4 Flipping transformer axes forward
    • 5.2.5 Resizing transformers
  • 5.3 Pull manipulation
  • 5.4 Marker tool
• 6 Editing Properties
  • 6.1 Property panels
    • 6.1.1 Inheritable properties
  • 6.2 Render properties
    • 6.2.1 Render property settings
• 7 The Timeline
  • 7.1 Probes and waypoints
  • 7.2 Basic timeline structure
    • 7.2.1 Play controls
    • 7.2.2 Tracks
  • 7.3 Viewing and setting waypoints
    • 7.3.1 Waypoints
    • 7.3.2 Breakpoints
    • 7.3.3 Saving and loading
  • 7.4 Tracks and probes
    • 7.4.1 Creating, moving, and deleting tracks
    • 7.4.2 Muting tracks
    • 7.4.3 Expanding tracks
    • 7.4.4 Grouping tracks
  • 7.5 Numeric probe displays
    • 7.5.1 Setting the range and display properties
    • 7.5.2 Large displays
    • 7.5.3 Cloning displays and exporting plots
    • 7.5.4 Legends and visibility control
    • 7.5.5 Editing and scaling data
    • 7.5.6 Smoothing data
    • 7.5.7 Interpolation control
• 8 Saving and Loading Probes
  • 8.1 Saving and loading probe data
  • 8.2 Exporting numeric probe data
  • 8.3 Saving and loading all probes
• 9 Adding and Editing Numeric Probes
  • 9.1 Adding output probes
    • 9.1.1 Creating a simple probe
    • 9.1.2 General output probes
    • 9.1.3 Using the probe editor
  • 9.2 Adding input probes
    • 9.2.1 Creating a simple probe
    • 9.2.2 General input probes
    • 9.2.3 Using the probe editor
  • 9.3 Setting probe properties
• 10 Point Tracing
• 11 Settings and Preferences
  • 11.1 Settings
    • 11.1.1 Interaction
    • 11.1.2 Simulation
  • 11.2 Preferences
  • 11.3 Layout preferences
• 12 Jython Interaction and Scripting
  • 12.1 Querying ArtiSynth structures and models
  • 12.2 Object creation and importing classes
  • 12.3 Running simulations and scripting
  • 12.4 Using the script menu
  • 12.5 Selecting a script file
  • 12.6 Specifying scripts on the command line
  • 12.7 Built-in functions
• 13 Customizing the Model and Script Menus
  • 13.1 Model menu editor
  • 13.2 Script menu editor
  • 13.3 Menu entry types
    • 13.3.1 Model
    • 13.3.2 Package
    • 13.3.3 Demo file
    • 13.3.4 Script
    • 13.3.5 Script folder
    • 13.3.6 Submenu
    • 13.3.7 Label
    • 13.3.8 Separator
  • 13.4 Command line options
  • 13.5 Demo file text format
  • 13.6 XML Menu Format
    • 13.6.1 The root elements
    • 13.6.2 Model element
    • 13.6.3 Package element
    • 13.6.4 DemoFile element
    • 13.6.5 Script element
    • 13.6.6 ScriptFolder element
    • 13.6.7 Submenu element
    • 13.6.8 Label element
    • 13.6.9 Separator element
    • 13.6.10 Hiding elements
• 14 Making Movies
  • 14.1 Recorder tab
    • 14.1.1 Region to capture
    • 14.1.2 Record options
    • 14.1.3 Other options
  • 14.2 Encoder tab
    • 14.2.1 Encoder options
    • 14.2.2 Customizing the encoder command
  • 14.3 Output size options
  • 14.4 Advanced tab
  • 14.5 Saving movie preferences
  • 14.6 Installing FFmpeg
• 15 Control Panels
  • 15.1 Creating control panels
    • 15.1.1 Composite property widgets
    • 15.1.2 Widgets for subproperties
  • 15.2 Editing control panels
  • 15.3 Live updating
• 16 Component Editing
  • 16.1 Generic edit operations
    • 16.1.1 Deletion
    • 16.1.2 Duplication
    • 16.1.3 Undo
  • 16.2 Editing panels
  • 16.3 Specifying position, orientation, and scaling
  • 16.4 Editing MechModels
    • 16.4.1 Adding finite element models
    • 16.4.2 Adding rigid bodies
    • 16.4.3 Adding frame markers
    • 16.4.4 Adding particles
    • 16.4.5 Adding axial springs and muscles
    • 16.4.6 Adding rigid body connectors
    • 16.4.7 Attaching particles to particles
    • 16.4.8 Attaching particles to rigid bodies
    • 16.4.9 Collision handling
  • 16.5 Editing rigid bodies
    • 16.5.1 Geometry and inertia
  • 16.6 Editing FEM models
    • 16.6.1 Adding FEM markers
    • 16.6.2 Adding muscle bundles
  • 16.7 Editing muscle bundles
    • 16.7.1 Adding fibres
    • 16.7.2 Adding element references
    • 16.7.3 Automatically setting elements and directions
    • 16.7.4 Removing fibres and element references
  • 16.8 Editing muscle exciters
  • 16.9 Editing root models