Live API example help

super_girl · October 20, 2023, 10:51am

Hi! I’ve made great progress since yesterday

I’m tyring to get the live api example working.

In the linked document, lines 1&2 are as follows:

#include "example_config.h"
#include "example_export.h"

I can’t find these two files (& neither can the compiler).

I think that

example_config.h

will be generated by the make file, on line 44, but as I’m new to all this, I’m not sure how to make that happen (sorry)

  # Generate version info header:
  configure_file(example_config.h.in example_config.h)

I can’t find any other references to

example_export.h

I’m working in Visual Studio 2022

any ideas for me? Thanks!

tt_su · November 7, 2023, 12:38pm

That example project relies on CMake. And those files are generated when CMake configures the project.

Have you looked at the how to build CMake project pages?

github.com

SketchUp/sketchup-live-c-api/blob/main/README.md#cmake-example-project

# SketchUp Live C API Examples

_These examples are for usage within the SketchUp desktop application. They will not work for usage in other applications._

The [SketchUp C API](https://extensions.sketchup.com/sketchup-sdk) is mainly used for the following:

* Read/Write `.skp` files in applications other than SketchUp.
* Create Importers/Exporters for SketchUp.

A third usage, officially supported since SketchUp 2019.2 it allows _read only_ access to the open SketchUp model via [Ruby C extensions](https://github.com/SketchUp/ruby-c-extension-examples).

This is a guide demonstrating how to setup and build your own Ruby C extension that uses the SketchUp C API to read from the active model.

## General Instructions

`<SDK_PATH>` is the location where the SDK package is extracted.

### Windows

* Add `<SDK_PATH>\headers` to the include paths.

This file has been truncated. show original

tt_su · November 7, 2023, 12:39pm

Alternatively, we have a more general section for Visual Studio instructions without any CMake:

github.com

SketchUp/sketchup-live-c-api/blob/main/docs/visual-studio.md

# Visual Studio

The base for this is a [Ruby C Extension](https://github.com/SketchUp/ruby-c-extension-examples).

* Open the `Properties Pages` for the project.

## Include Headers

* Add `<SDK_PATH>\headers` to `C/C++ / General / Additional Include Directories`

![](images/vs-include-headers-pick.png)

![](images/vs-include-headers.png)

## Linking

**Important!** You *must* link against `sketchup.lib` when using the Live C API. If you link against `SketchUpAPI.lib` it might appear to work in many case, but it will at some point lead to crashes or invalid models.

Beware that if you use symbols introduced in a newer version on an older SketchUp version it will not work. Consider linking against the SDK binary matching the version of the oldest SketchUp version you support, that way you catch missing symbols during compile-time.

This file has been truncated. show original