Clash Detection SDK Documentation

We strongly recommend you to watch the Getting Started video before working with Clash Detection.

Explore documentation and video tutorial for the Clash Detection SDK online:

• Introduction, Video Tutorial & Installation
• How to Work with the UI
• How to Work with the Clash Detection Viewport API
• How to Work with the Clash Detection Bake API
• Clash Detection Core Python Developer Documentation

Additional Resources

• Omniverse Kit SDK Manual

License

Development using the Omniverse Kit SDK is subject to the licensing terms detailed here.

Data Collection & Use

Overview

NVIDIA Omniverse Kit Clash Detection Samples collects anonymous usage data to help improve software performance and aid in diagnostic purposes.

Rest assured, no personal information such as user email, name or any other PII field is collected.

Purpose

Omniverse Kit Samples starts collecting data when you begin interaction with our provided software.

It includes:

1. Installation and configuration details such as version of operating system, applications installed : Allows us to recognize usage trends & patterns
2. Hardware Details such as CPU, GPU, monitor information : Allows us to optimize settings in order to provide best performance
3. Product session and feature usage : Allows us to understand user journey and product interaction to further enhance workflows

Error and crash logs : Allows us to improve performance & stability for troubleshooting and diagnostic purposes of our software

Instructions to turn-off telemetry

If you wish to opt-out of physx and/or clashdetection only telemetry data collection, set the following persistent settings to false in the .kit app file (persistent settings are retained so deleting them is not enough)

[settings]
telemetry.enableAnonymousData = false

This setting can also be overridden by defining and setting the OMNI_TELEMETRY_DISABLE_ANONYMOUS_DATA environment variable to '1' for the kit process. The docs around it can be found here. This env. var is intended to be used when launching a container whose app enables the /telemetry/enableAnonymousData setting in its config files. It's the suggested way to opt out of anonymous telemetry for a containerized app.

Contributing

We provide this project as-is and are currently not accepting outside contributions.