LogoLogo
  • User Manual
  • Chapters
    • Welcome
      • Acknowledgments
      • History
      • Sisyphean Effort
    • Quick Start Guide
      • Installation
      • Defining a Show Directory
      • Controllers
      • Layout and Background Image definition
      • Model Definition
      • Model Group Definition
      • Creating a New Sequence
        • Adding Models to a View
      • Adding Effects
      • Saving the Sequence
      • Backup and Exit
      • Testing
    • Installation
      • Upgrade
      • Windows
      • Macintosh
      • Linux
    • Controllers Tab
      • Controllers
      • Show Directory
      • Controllers Settings
        • USB Controller
        • Ethernet Controller
        • NULL Controller
        • Controller Visualizer
    • Layout Tab
      • Layout
      • Models
        • Model Settings
          • Setting Start Channels
        • Arches Model
        • Channel Block Model
        • Candy Cane Model
        • Circle Model
        • Cube Model
        • Custom Model
        • DMX Model
          • DMX Moving Head Advance
        • Image Model
        • Icicles Model
        • Matrix Model
        • PolyLine Model
        • Single Line Model
        • Sphere Model
        • Spinner Model
        • Star Model
        • Tree Model
        • Window Frame Model
        • Wreath Model
      • Download/Import Models
      • Model Groups
      • Objects
      • Layout Preview
      • Editing Layout Preview
      • Moving Model/Objects
      • SubModels
    • Sequencer Tab
      • Sequencer
      • Rendering
      • Timeline and Waveform
      • Adding An Effect
      • Changing An Effect
        • Changing Color Settings
      • Layers
        • Layer Blending
        • Layer Settings
      • Timing Tracks
      • Render All
      • Windows
      • Value Curves
      • Effect Presets
      • Views
      • Models
      • Singing Faces
        • Adding Word to User Dictionary
      • Pixel Editor
      • Shortcuts
    • Menus
      • File
        • New Sequence
        • Preferences
          • Backup
          • View
          • Effects Grid
          • Sequences
          • Output
          • Colors
          • Other
        • Sequence Settings
        • Backup and Recovery
      • Edit
      • Tools
        • Test
        • Convert
        • Generate Custom Model
        • FPP Connect
      • View
        • Windows
        • Perspectives
      • Audio
      • Import
      • Help
    • Advanced Features
  • Effects
    • Built-in Effects
      • Off
      • On
      • Adjust
      • Bars
      • Butterfly
      • Candle
      • Circles
      • Color Wash
      • Curtain
      • DMX
      • Duplicate
      • Faces
      • Fan
      • Fill
      • Fire
      • Fireworks
      • Galaxy
      • Garlands
      • Glediator
      • Guitar
      • Kaleidoscope
      • Life
      • Lightning
      • Lines
      • Liquid
      • Marquee
      • Meteors
      • Morph
      • Moving Head
      • Music
      • Piano
      • Pictures
      • Pinwheel
      • Plasma
      • Ripple
      • Servo
      • Shader
      • Shape
      • Shimmer
      • Shockwave
      • Single Strand
      • Snowflakes
      • Snow Storm
      • Spirals
      • Spirograph
      • State
      • Strobe
      • Tendrils
      • Text
      • Tree
      • Twinkle
      • Video
      • VU Meter
      • Warp
      • Wave
  • Appendicies
    • Glossary
    • Keyboard Shortcuts
  • Tutorials
    • Configure Matrix Panels
    • Coming from LOR
    • Editing xLights_rgb.xml
Powered by GitBook
On this page
Export as PDF
  1. Chapters
  2. Quick Start Guide

Model Definition

PreviousLayout and Background Image definitionNextModel Group Definition

Last updated 4 years ago

Model Definition

In this section, we will define a Model, a Model Group, and add the model to the Model Group. Model and Model Group definitions are persistent, are to be defined once and can then be used in all your sequences.

As an example, I am creating an Arch model and will call it ‘Arch 1’. The arch is about 2.5 metres long and as such is made up of 25 RGB pixels.

Click on the Layout tab, then click on the Arches icon. The selected icon will have a blue square around it.

Then click anywhere on the Canvas and drag slightly. An image of an arch will be displayed and an Arch model called ‘Arches’ (the default name that is assigned to the model may be slightly different) will be created with a default set of model settings.

Change the Model name to ‘Arch-1’. Click the Tab or Enter Key to set the new name.

Change the Nodes Per Arch value to 25.

Set the controller to "Main Controller" or whatever name you set in the controller tab.

Set the Controller Connection Port to 1. This is the port of the controller the model will be physically connected too.

The Start and End channel will be automatically calculated by xLights based on the model settings and the controller settings selected.

If you are adding a second model to the same controller port, set the model chain order to determine the model order on the controller output.

You can change the model name or any settings by typing over/editing the settings field. For some settings, click in the settings field, to the right of the setting name.

After changing an settings, use the Tab or Enter key to confirm the change.

Use the blue dots around the model to resize and rotate it if required. To move the model click and drag it to the desired location. The green dot should at the left side of the screen. When it is aligned horizontally, a red line is displayed between the green and blue dots.

The starting location of the model can be changed to the 'Blue' or 'Green' square.

Click on the Save button (just below the Models button) to save the work that you have done so far. This includes the Model definition and its position on the Layout.

The 'Save' button will appear red when unsaved changes are present.