# UtilsShims.CommonInitData

[common-core/src/utils/shims](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/modules/common_core_src_utils_shims).CommonInitData

Init data parameter which can be used in configurator AND planner

## Hierarchy

* **`CommonInitData`**

  ↳ [`InitDataDefinition`](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/interfaces/common_core_src_utils_shims.initdatadefinition)

## Table of contents

### Properties

* [autoQuality](#autoquality)
* [colors](#colors)
* [customShading](#customshading)
* [customShadingMoc](#customshadingmoc)
* [debug](#debug)
* [debugGeometry](#debuggeometry)
* [envMapIntensity](#envmapintensity)
* [envMapRotation](#envmaprotation)
* [envMapUrl](#envmapurl)
* [id](#id)
* [isItem](#isitem)
* [legacyLight](#legacylight)
* [linearAoFilter](#linearaofilter)
* [maxLightSources](#maxlightsources)
* [meshSelection](#meshselection)
* [offset](#offset)
* [precisionCm](#precisioncm)
* [precisionInch](#precisioninch)
* [restrictionLevel](#restrictionlevel)
* [sceneLight](#scenelight)
* [shading](#shading)
* [showArButton](#showarbutton)
* [startTag](#starttag)
* [stats](#stats)
* [typeChangeTag](#typechangetag)
* [unit](#unit)
* [unitStringType](#unitstringtype)
* [usePriceService](#usepriceservice)

## Properties

### autoQuality

• `Optional` **autoQuality**: `boolean`

**`Description`**

If set to true the configurator will make sure every device has great user experience with fluid frame rate.\
If set to false the configurator will always show the highest quality possible.\
That could lead to stutter and other problems on low-end devices. We advise you to only turn off "autoQuality" if you really know what you are doing.\
usage: autoQuality=false

**`Groups`**

scene-settings

***

### colors

• `Optional` **colors**: [`ColorsIn3dScene`](https://docs.roomle.com/rubens/rubens-sdk/modules/common_core_src_utils_shims#colorsin3dscene)

**`Description`**

Can be used to personalize colors used in the 3D scene

**`Groups`**

scene-settings

***

### customShading

• `Optional` **customShading**: [`CustomShadingParameters`](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/interfaces/configurator_core_src_configurator._internal_.customshadingparameters)

**`Description`**

Customized shading properties for the overall appearance

**`Groups`**

scene-settings

***

### customShadingMoc

• `Optional` **customShadingMoc**: [`CustomShadingParameters`](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/interfaces/configurator_core_src_configurator._internal_.customshadingparameters)

**`Description`**

Customized shading properties for the overall appearance in MOC

**`Groups`**

scene-settings

***

### debug

• `Optional` **debug**: `boolean`

**`Description`**

This flag enables:

* Scripter debug logs (e.g. which parameter is not assigned to a parameter group)
* Free camera movement (no restrictions, camera stays after reload, panning using Shift key)

***

### debugGeometry

• `Optional` **debugGeometry**: `boolean`

**`Description`**

This flag enables:

* External object docking vector debug geometry

***

### envMapIntensity

• `Optional` **envMapIntensity**: `number`

**`Description`**

Set the intensity of the environment map

**`Groups`**

scene-settings

***

### envMapRotation

• `Optional` **envMapRotation**: `number`

**`Description`**

Set the rotation of the environment map in radians, between 0 and 2 \* PI, rotates counter-clockwise

**`Groups`**

scene-settings

***

### envMapUrl

• `Optional` **envMapUrl**: `string`

**`Description`**

Url to an exr or hdr env map

**`Groups`**

scene-settings

***

### id

• `Optional` **id**: `string`

**`Description`**

The item id or configuration id of the item which should be loaded.\
Examples:\
Configuration id: usm:frame:2449773A7F54278EBB61A67A10EF6A10E8BB6F38BE775B028AC050B438414507\
Item id: usm:frame

***

### isItem

• `Optional` **isItem**: `boolean`

**`Deprecated`**

**`Description`**

Set if the currently loaded id is an item or a configuration.\
In the new configurator UI this is determined automatically based on the id.

***

### legacyLight

• `Optional` **legacyLight**: `boolean`

**`Description`**

Use old light setting instead of env maps

**`Groups`**

scene-settings

***

### linearAoFilter

• `Optional` **linearAoFilter**: `boolean`

**`Description`**

Activates the linear AO filter mode to reduce AO anti-aliasing artifacts

**`Groups`**

scene-settings

***

### maxLightSources

• `Optional` **maxLightSources**: `number`

**`Description`**

Set the maximum number of light sources extracted from the environment map

**`Groups`**

scene-settings

***

### meshSelection

• `Optional` **meshSelection**: `boolean`

**`Description`**

When mesh selection is enabled, the meshes of the object are used directly for highlighting.\
Setting it to false could be useful for square/rectangular (shelf) items.

***

### offset

• `Optional` **offset**: [`CanvasOffset`](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/interfaces/common_core_src_common_interfaces.canvasoffset)

**`Deprecated`**

**`Description`**

Change the offset of the camera. For example if you add a margin left (0.1 means 10%) then\
the item moves to the right.\
This value is overridden in the new configurator UI.

***

### precisionCm

• `Optional` **precisionCm**: `string`

**`Description`**

Set how many positions after the decimal point should be shown.\
For example:\
123,45 -> precisionCm=2 -> 123,45\
123,45 -> precisionCm=1 -> 123,5\
123,45 -> precisionCm=0 -> 124

***

### precisionInch

• `Optional` **precisionInch**: `string`

**`Description`**

Set how many positions after the decimal point should be shown.\
For example:\
8' 1.68" -> precisionCm=2 -> 8' 1.68"\
8' 1.68" -> precisionCm=1 -> 8' 1.7"\
8' 1.68" -> precisionCm=0 -> 8' 2"

***

### restrictionLevel

• `Optional` **restrictionLevel**: `number`

**`Description`**

restrictionLevel defines visibility of parameters and possible children

***

### sceneLight

• `Optional` **sceneLight**: [`DefaultEnvironmentSceneType`](https://docs.roomle.com/rubens/rubens-sdk/modules/configurator_core_src_configurator._internal_#defaultenvironmentscenetype)

**`Description`**

Generate environment map from a scene instead of env maps\
use all\_around for an surrounding light\
use front for a mainly frontal light

**`Groups`**

scene-settings

***

### shading

• `Optional` **shading**: [`SceneShadingType`](https://docs.roomle.com/rubens/rubens-sdk/modules/configurator_core_src_configurator._internal_#sceneshadingtype)

**`Description`**

General shading properties for the overall appearance\
default: for planner and a configurator with colorful, metallic or wooden materials\
bright: for a configurator with white and bright materials

**`Groups`**

scene-settings

***

### showArButton

• `Optional` **showArButton**: `boolean`

**`Deprecated`**

**`Description`**

Set if the AR button should be shown.\
In the new configurator UI this is in the configurator settings object called buttons.

***

### startTag

• `Optional` **startTag**: `string`

**`Deprecated`**

**`Description`**

Add a tag id which is used to show different variations when opening the configurator

***

### stats

• `Optional` **stats**: `boolean`

**`Description`**

if set to true it shows a little overlay with performance stats

***

### typeChangeTag

• `Optional` **typeChangeTag**: `string`

**`Description`**

Add a tag id which is used to show different variations for the current item/configuration

**`Deprecated`**

***

### unit

• `Optional` **unit**: `string`

**`Description`**

Defines which unit should be used for measurements/dimensions\
Options: 'cm', 'mm', 'inchfeet'

***

### unitStringType

• `Optional` **unitStringType**: `string`

**`Description`**

How the current unit should be formatted\
Options:

* 'none': No unit string added, for example '200'
* 'long': Long unit string, for example '200 meters'
* 'short': Short unit string, for example '200 m'

***

### usePriceService

• `Optional` **usePriceService**: `boolean`

**`Description`**

If set to true, prices are calculated using the Roomle price service.\
For more information ask your Roomle contact.