In this tutorial, you will learn how to successfully run the LuciadLightspeed samples from NetBeans.

Prerequisites for the IDE integration

In the project configuration procedure, it is assumed that you already installed the following software:

Creating a Luciadlightspeed development project in NetBeans

  1. Start NetBeans and create a new project: go to File > New project from the main menu. The New Project screen opens.

  2. Select Java in the Categories pane and Java Project with Existing Sources from the Projects pane, and click Next.

  3. In the Project Folder text box, select the folder that contains the LuciadLightspeed installation folder (one level up from the installation folder), and choose a Project Name. Click Next.

  4. Click the Add Folder…​ button next to the Source Package Folders field, and open the LuciadLightspeed_<version>\samples\src from the Browse Source Packages Folder window.

  5. Click Next, and click Finish on the Includes & Excludes window without changing anything. NetBeans starts creating the new project.

Completing the project configuration

Before you can run the samples, you need to make sure that all project dependencies are in place, such as the LuciadLightspeed license file and the project resources. It is also strongly recommended to enable annotation processing in your project. LuciadLightspeed uses annotations to register services with a registry, and provide instant application services.

  1. In the Projects navigation pane on the left, right-click the project you just created, and select Properties.

  2. In the Project Properties window, go to the Libraries category in the left-hand pane. Make sure that a version 1.8 JDK or higher is selected in the Java Platform: dropdown menu.

  3. On the Compile tab, click Add JAR/Folder to start adding the license file and project resources.

  4. Select the development.jar file from the LuciadLightspeed_<version>\licenses folder, and click Open. The license file is displayed in the Compile-time Libraries field.

  5. Click Add Library to define the LuciadLightspeed library.

  6. In the Add Library window, click the Create button. Enter a library name that includes LuciadLightspeed and the version number, and click OK.

  7. In the Customize library window, click Add JAR/Folder, and browse to the LuciadLightspeed_<version>\lib folder.

  8. Select all the *.jar files you can find at that folder level, and click Add JAR/Folder to display the JAR files in the Customize Library window.

  9. Click the OK and Add Library buttons to return to the Compile tab in the project Properties window. The LuciadLightspeed library has been added to the list.

  10. Click Add JAR/Folder, go to the LuciadLightspeed_<version>\config folder and select it, and click Open.

  11. Repeat the previous step to add the LuciadLightspeed_<version>\samples\resources folder. The config and samples\resources folders are added to the list in the Compile-time Libraries field.

  12. Go to Build > Compiling in the left-hand pane, de-select the Compile on Save and Run Compilation in external VM check boxes, and select the Enable Annotation Processing check box.

  13. Click Add next to the Annotation Processors field. Enter com.luciad.util.service.TLcdServiceAnnotationProcessor in the Annotation Processor FQN: field, and click OK.

  14. Click OK to let NetBeans re-configure the project. To make sure each project setting is taken into account, right-click the project, and select Clean and build before proceeding.

Defining a run configuration for the LuciadLightspeed samples

Luciad strongly recommends specifying a number of Virtual Machine (VM) options before running your samples. They will ensure that your samples run smoothly, and perform well. You can specify the VM options in the run configuration for your LuciadLightspeed project.

  1. In the Projects navigation pane on the left, right-click the project, and select Properties.

  2. Go to the Run category in the left-hand pane.

  3. Enter the VM options below in the VM Options field, and click OK.


    For Java 1.8 versions, you should also specify these options:


    To run JavaFX samples on Java 11 or higher, you should also specify these options:

    --add-modules javafx.controls,javafx.web,javafx.swing
    --module-path /path/to/your/javafx-sdk/lib

    From now on, your samples will use the specified VM options when you run them.

Integrating the LuciadLightspeed Javadoc into your project

NetBeans can show you the Javadoc for a LuciadLightspeed API code element when you click the code element and press Ctrl+Space. To activate the Javadoc feature for the LuciadLightspeed Javadoc:

  1. In the Projects navigation pane on the left, right-click the project, and select Properties.

  2. Go to the Libraries category in the left-hand pane.

  3. On the Compile tab, select the LuciadLightspeed library you created earlier, and click Edit.

  4. In the Customize Library window, go to the Javadoc tab, and click Add Zip/Folder.

  5. Navigate to the LuciadLightspeed_<version>\ docs\reference\LuciadLightspeed folder, select it, and click Add ZIP/Folder.

  6. Click OK twice to leave the Customize Library window and the Project Properties window. NetBeans now retrieves and shows the Javadoc whenever you click a LuciadLightspeed API element, and press Ctrl + Space.

You are done! Now you can run the sample of your choice and start developing.

Test running a sample

In your NetBeans LuciadLightspeed project, you can run the sample executable files with the runsampleiconnb icon.

You can test your IDE setup by running the shapes example:

  1. Expand the samples.lightspeed.shapes package in the Source Packages directory in the project project navigation pane on the left.

  2. Right-click on and select Run File from the context menu. The sample starts in this window.