Before you start the installation, verify that your system complies with the LuciadCPillar Hardware and software requirements.

Installing LuciadCPillar for C# development

To install LuciadCPillar and compile the C# samples:

  1. Extract the LuciadCPillar_Pro-Windows.zip archive.

  2. Extract the LuciadCPillar_Pro_Documentation.zip archive.

  3. Extract the LuciadCPillar_Pro_Data.zip archive.

  4. Copy your LuciadCPillar license file, named luciadcpillar_development.txt, into the folder licenses.

  5. Open the x64 Native Tools Command Prompt that came installed with the Visual Studio version you are working in.

  6. Go to the extracted folder.

  7. Go to the folder csharp: 

    >cd csharp

  8. Create a folder build, and step into that folder: 

    >mkdir build
>cd build

  9. Generate the Visual Studio solution.

    1. Make sure that the environment variable PATH includes the directory containing nuget.exe. Alternatively, you can specify it on the cmake command line by adding the parameter -DCMAKE_PROGRAM_PATH=c:\directory\containing\nuget. See the next step for a command line example.

    2. Use CMake to generate the Visual Studio solution with the generator related to your Visual Studio version. These are some examples of cmake commands: 

      >cmake ../ -G "Visual Studio 16 2019" -A x64 -DCMAKE_PROGRAM_PATH="C:\directory\containing\nuget"

      or

      >cmake ../ -G "Visual Studio 17 2022" -A x64 -DCMAKE_PROGRAM_PATH="C:\directory\containing\nuget"

  10. Open the generated solution file csharp/build/AllSamplesCSharp.sln with Visual Studio.

  11. Select ALL_BUILD in the Solution Explorer under CMakePredefinedTargets, go to Build > Configuration Manager, and select the desired Active solution configuration.

  12. Right-click ALL_BUILD in the Solution Explorer, and click Build to build all samples.

  13. Select the sample you want to run. For instance, to select csharp_sample_wpf:

    1. Right click on csharp_sample_wpf in the Solution Explorer.

    2. Select Set as StartUp Project.

  14. Run the application, by clicking the Start button for example.

Using NuGet

A LuciadCPillar release includes a NuGet package, Luciad.CPillar.SDK, in the csharp/packages folder, that you can publish to a private package feed. After publishing, you can include LuciadCPillar in your project just like any other package.

The supplied NuGet package just contains the LuciadCPillar API. If you want to use the integration code or sample code in your project, you can also turn the samples into NuGet Packages:

  1. Install the samples as described in Installing LuciadCPillar for C# development. Select the Release configuration to build them.

  2. Go to the sample directory in csharp/build/samples and run the following command: 

    >nuget pack <nuspec file name>

    The sample directory now has a NuGet package, which you can add to your local feed.

For your convenience, there is a batch script, generateNugetPackagesOfSamples.bat, in the csharp folder. It creates a NuGet package for each sample and puts it in the csharp/packages folder. This script requires that you completed building the release configuration.

Troubleshooting

See troubleshooting for commonly encountered problems.