---
title: "ObjectSettings"
product: "LumiScan VGR"
component: "lumiscan-vgr"
version: "1.8.4"
display_version: "1.8.4.6"
latest_version: true
language: "en"
url: "https://docs.hdvisionsystems.com/en/lumiscan-vgr/1.8.4/api/settings/object-settings.html"
---

# ObjectSettings – LumiScan VGR

Corresponds to an object that we want to detect.

Note that we can also define abstract objects such as features of composed parts or classification results (e.g. "emptyContainer").

## Member Functions

- **`ObjectSettings()`:** == Member Variables

- **`id`:** `std::string`, default: `\{""\}` *JSON Type*: string +*Requirement*: Must be unique and not empty. Identifier for the object.

- **`plcId`:** `int`, default: `\{-1\}` *JSON Type*: (optional) int Identifier for the object that will be transmitted to the PLC (see HDV_ObjectId).

- **`cadPath`:** `std::optional< std::filesystem::path >`, default: `\{""\}` *JSON Type*: (optional) string +*Requirement*: Must be a path to a regular file. File path to the CAD file of the object. This model is used for visualization and collision purposes.

- **`depthEstimation`:** `std::optional< DepthEstimationSettings >` *JSON Type*: (optional) DepthEstimationSettings object

- **`detection2d`:** `Detection2DSettings` *JSON Type*: Detection2DSettings object

- **`detection3d`:** `std::shared_ptr< Detection3DSettingsBase >` *JSON Type*: (optional) Detection3DSettingsBase object

- **`gripPoints`:** `std::vector< GripPointSettings >` *JSON Type*: (optional) array of GripPointSettings object