Planning tool configuration

The planning tool is configured in this section. In the finished app, this can be accessed via icon nature people in the Tools & Extensions section. The functionality of the tool in the VC Map is described here.

Clicking on icon edit opens the Plugin Editor window, which shows the available configuration.

General Settings

Option	Description
Service URL	The URL of the VC Planner backend.
Project Id	The ID of the planning project defined in the VC Planner backend.
Map Id	The ID of the planning map defined in the VC Planner backend.

Option

Description

Service URL

The URL of the VC Planner backend.

Project Id

The ID of the planning project defined in the VC Planner backend.

Map Id

The ID of the planning map defined in the VC Planner backend.

Advanced Settings

Option	Description
Lock Interval	Defines the time interval (in ms) at which the lock on features currently being edited is maintained. The default value is 100000 ms (1min 40s).
Content tree weight	Defines the weight for the placement of the "Planning" group in the Contents window of the VC Map app. The default value is -1, which places the item at the end of the content window. A value of 1 places it at the beginning of the content window. URL
Terrain URL	Alternative URL for terrain that is queried if the active terrain in the map client is not accessible from the VC Planner backend.
FME extension	Defines whether the planning tool uses the FME extension.
Model authentication	Must be enabled if the VC Planner also uses model authentication. This additional layer of security can be applied for highly sensitive data by requiring a cookie for access. This prevents any type of access (e.g., visualization, downloading, or copying).
Default Feature Info	Predefined Feature Info to be used for the metadata of planning objects.
Use password validation	Allows defining a set of rules that must be followed when creating a new password in the Planner frontend. For additional information, refer to the official package documentation. Exclude user name from password: Prevents users from including their username in the password. Attention: For this setting to work, the links in your enrollment emails must be configured accordingly. See the VC Planner backend documentation for further details.

Option

Description

Lock Interval

Defines the time interval (in ms) at which the lock on features currently being edited is maintained. The default value is 100000 ms (1min 40s).

Content tree weight

Defines the weight for the placement of the "Planning" group in the Contents window of the VC Map app. The default value is -1, which places the item at the end of the content window. A value of 1 places it at the beginning of the content window. URL

Terrain URL

Alternative URL for terrain that is queried if the active terrain in the map client is not accessible from the VC Planner backend.

FME extension

Defines whether the planning tool uses the FME extension.

Model authentication

Must be enabled if the VC Planner also uses model authentication. This additional layer of security can be applied for highly sensitive data by requiring a cookie for access. This prevents any type of access (e.g., visualization, downloading, or copying).

Default Feature Info

Predefined Feature Info to be used for the metadata of planning objects.

Use password validation

Allows defining a set of rules that must be followed when creating a new password in the Planner frontend.
For additional information, refer to the official package documentation.
Exclude user name from password: Prevents users from including their username in the password. Attention: For this setting to work, the links in your enrollment emails must be configured accordingly. See the VC Planner backend documentation for further details.

Object libraries

Option Description

Option	Description
Add new object library	Title: The title used to display the object library. URL: URL to the catalog.json of the object library. A relative URL `object-library/${name}/catalog.json` is sufficient for adding libraries hosted by the VC Planner. Alternatively, an absolute URL `https://example.myhost.de/objectlibrary/mylibrary/catalog.json` to an object library on another server is possible. If selfhosting object libraries, ensure the propert CORS headers are set or the resources is hosted alongside the VC Map application. Closed at the beginning: Defines whether an object library is displayed collapsed on startup.
object-library/${name}/catalog.json	Defines the URL of the standard object libraries available in the planning tool.
Activate standard library	Activates or deactivates a standard library in the planning tool.
Further interaction options	Edit object library: Adjusting the settings of the object library. Remove object library: Removing the object library from the planning tool.

Add new object library icon addElement

Title: The title used to display the object library.

URL: URL to the catalog.json of the object library.
A relative URL `object-library/${name}/catalog.json` is sufficient for adding libraries hosted by the VC Planner. Alternatively, an absolute URL https://example.myhost.de/objectlibrary/mylibrary/catalog.json to an object library on another server is possible.
If selfhosting object libraries, ensure the propert CORS headers are set or the resources is hosted alongside the VC Map application.

Closed at the beginning: Defines whether an object library is displayed collapsed on startup.

object-library/${name}/catalog.json

Defines the URL of the standard object libraries available in the planning tool.

Activate standard library icon checkbox

Activates or deactivates a standard library in the planning tool.

Further interaction options icon overflowMenu

Edit object library: Adjusting the settings of the object library.
Remove object library: Removing the object library from the planning tool.

Style

Option	Description
Fill	A click on the Fill icon opens a window where the color and transparency of the fill of the objects to be drawn can be adjusted.
Stroke	Clicking the Stroke icon opens a window where you can adjust the line width, color and transparency of the lines of the objects to be drawn.
Symbol	Clicking the Symbol icon opens a window where predefined shapes and icons can be selected as an alternative representation of the point marker. Radius, lines and fill style can also be adjusted for the shapes, or transparency and size for the icons.
Text	When selecting the geometry type Point, the additional option of text input is available. A point can therefore be set directly with a label.

Option

Description

Fill

A click on the Fill icon opens a window where the color and transparency of the fill of the objects to be drawn can be adjusted.

Stroke

Clicking the Stroke icon opens a window where you can adjust the line width, color and transparency of the lines of the objects to be drawn.

Symbol

Clicking the Symbol icon opens a window where predefined shapes and icons can be selected as an alternative representation of the point marker. Radius, lines and fill style can also be adjusted for the shapes, or transparency and size for the icons.

Text

When selecting the geometry type Point, the additional option of text input is available. A point can therefore be set directly with a label.

Vector properties

Option	Description
Altitude mode	Drape on surface: Drawn objects are projected onto all surfaces (e.g., terrain, buildings, or 3D meshes) and draped according to the surface geometry. The individual vertices of a feature can have different height values. Drape on terrain: Drawn objects are projected onto the terrain and draped according to the terrain surface. The individual vertices of a feature may have different height values. Other map content can overlap the drawn object. Drape on objects: Drawn objects are only projected onto the surfaces of objects and draped according to the respective surface geometry. The individual vertices of a feature may have different height values. (Partial) areas that intersect only with the terrain are hidden. Absolute: Each vertex of the object is defined and rendered based on its 3D position. 2D features require the 'Ground level' in order to be displayed in 'Absolute' altitude mode mode. Relative to surface: Drawn objects are projected onto all surfaces (e.g., terrain, buildings, or 3D meshes) and additionally offset by the 'Height above ground' value. With this option, the feature is not draped along the surface geometry, so all vertices have the same height value. Relative to terrain: Drawn objects are projected onto the terrain and additionally offset by the 'Height above ground' value. With this option, the feature is not draped along the terrain surface, so all vertices have the same height value. Other map content can overlap the drawn object. Relative to objects: Drawn objects are only projected onto object surfaces and additionally offset by the 'Height above ground' value. With this option, the feature is not draped along the object surface, so all vertices have the same height value. (Partial) areas that intersect only with the terrain are hidden.
Height above ground	A vertical offset relative to the terrain that can be used with relative altitude modes. The default value is 0.
Ground level	A fixed value that defines the absolute height for the vertices of this feature. This value is required to display features using the "Absolute" altitude mode. Geometries using relative altitude modes are rendered at this height. For these modes, the default value corresponds to the elevation of the currently enabled terrain in the VC Map. This setting has no effect on features using other altitude modes.
Scale by distance	Determines or sets scaling properties of objects based on the distance of the object to the camera. Values are interpolated between the specified distances, while the object’s scaling outside these intervals is clamped to the nearest limit. If this option is disabled, no scaling is applied.
Eye offset	Reads or sets the Cartesian 3D offset applied to objects in eye coordinates. Eye coordinates form a left-handed coordinate system where the x-axis points to the right, the y-axis points upward, and the z-axis points into the screen. They use the same units as world coordinates, typically meters.
Allow picking	Specifies whether features can be picked, for example to display Feature Infos.
Classification	None: This is the default setting. No classification is undertaken and and therefore, the object is rendered normally. Both: The object is used to classify both terrain and 3D Tiles (3D Mesh, building data sets, etc.). The intersections of the object in question and the terrain or a 3D Tile are highlighted. 3D Tiles: The object is used to classify 3D Tiles. The intersections of the object in question and a 3D Tile are highlighted. Terrain: The object is used to classify the terrain. The intersections of the object in question and the terrain are highlighted.
Above ground
Extrusion	Defines the default extrusion height of drawn objects.
Storeys	Defines the default number of storeys for drawn objects. Requires either 'Extrusion' or 'Storey height(s)'.
Storey height(s)	Specifies one or more storey height values. The sequence starts with the ground floor. If the number of 'Storey height(s)' is less than the number of 'Storeys', the last value is repeated until all floors are defined or the 'Extrusion' height is reached.
Below ground
Skirts	Defines the default extrusion depth of objects below ground level.
Storeys	Defines the default number of storeys below ground. Requires either 'Skirts' or 'Storey height(s)'.
Storey height(s)	Specifies one or more storey height values for underground levels. The sequence starts with the first basement level. If the number of 'Storey height(s)' is less than the number of 'Storeys', the last value is repeated until all floors are defined or the skirt depth is reached.
Model URL	Specifies the relative path to the default model used for point objects. The supported formats is GLTF ('.gltf', '.glb').
Model scale	Defines the default scaling along the x-, y-, and z-axes. Values greater than 1.0 enlarge the model, while values less than 1.0 reduce its size.
Model heading	The model heading defines the horizontal rotation of the object around its vertical axis.
Model pitch	The model pitch describes the rotation of the object around its lateral axis (tilting forward or backward).
Model roll	The model roll describes the rotation of the object around its longitudinal axis (rolling to the left or right).
Model auto scale	If enabled, the model is automatically scaled based on the zoom level. When zooming in, the model becomes smaller. When zooming out, it becomes larger. As a result, the model appears to remain the same size to the viewer.
Base URL	A base URL used to resolve relative model URLs. Expects HTTP or HTTPS requests.

Option

Description

Altitude mode

Drape on surface: Drawn objects are projected onto all surfaces (e.g., terrain, buildings, or 3D meshes) and draped according to the surface geometry. The individual vertices of a feature can have different height values.
Drape on terrain: Drawn objects are projected onto the terrain and draped according to the terrain surface. The individual vertices of a feature may have different height values. Other map content can overlap the drawn object.
Drape on objects: Drawn objects are only projected onto the surfaces of objects and draped according to the respective surface geometry. The individual vertices of a feature may have different height values. (Partial) areas that intersect only with the terrain are hidden.
Absolute: Each vertex of the object is defined and rendered based on its 3D position. 2D features require the 'Ground level' in order to be displayed in 'Absolute' altitude mode mode.
Relative to surface: Drawn objects are projected onto all surfaces (e.g., terrain, buildings, or 3D meshes) and additionally offset by the 'Height above ground' value. With this option, the feature is not draped along the surface geometry, so all vertices have the same height value.
Relative to terrain: Drawn objects are projected onto the terrain and additionally offset by the 'Height above ground' value. With this option, the feature is not draped along the terrain surface, so all vertices have the same height value. Other map content can overlap the drawn object.
Relative to objects: Drawn objects are only projected onto object surfaces and additionally offset by the 'Height above ground' value. With this option, the feature is not draped along the object surface, so all vertices have the same height value. (Partial) areas that intersect only with the terrain are hidden.

Height above ground

A vertical offset relative to the terrain that can be used with relative altitude modes. The default value is 0.

Ground level

A fixed value that defines the absolute height for the vertices of this feature.
This value is required to display features using the "Absolute" altitude mode.
Geometries using relative altitude modes are rendered at this height. For these modes, the default value corresponds to the elevation of the currently enabled terrain in the VC Map.
This setting has no effect on features using other altitude modes.

Scale by distance

Determines or sets scaling properties of objects based on the distance of the object to the camera. Values are interpolated between the specified distances, while the object’s scaling outside these intervals is clamped to the nearest limit.
If this option is disabled, no scaling is applied.

Eye offset

Reads or sets the Cartesian 3D offset applied to objects in eye coordinates. Eye coordinates form a left-handed coordinate system where the x-axis points to the right, the y-axis points upward, and the z-axis points into the screen. They use the same units as world coordinates, typically meters.

Allow picking

Specifies whether features can be picked, for example to display Feature Infos.

Classification

None: This is the default setting. No classification is undertaken and and therefore, the object is rendered normally.
Both: The object is used to classify both terrain and 3D Tiles (3D Mesh, building data sets, etc.). The intersections of the object in question and the terrain or a 3D Tile are highlighted.
3D Tiles: The object is used to classify 3D Tiles. The intersections of the object in question and a 3D Tile are highlighted.
Terrain: The object is used to classify the terrain. The intersections of the object in question and the terrain are highlighted.

Above ground

Extrusion

Defines the default extrusion height of drawn objects.

Storeys

Defines the default number of storeys for drawn objects. Requires either 'Extrusion' or 'Storey height(s)'.

Storey height(s)

Specifies one or more storey height values. The sequence starts with the ground floor. If the number of 'Storey height(s)' is less than the number of 'Storeys', the last value is repeated until all floors are defined or the 'Extrusion' height is reached.

Below ground

Skirts

Defines the default extrusion depth of objects below ground level.

Storeys

Defines the default number of storeys below ground. Requires either 'Skirts' or 'Storey height(s)'.

Storey height(s)

Specifies one or more storey height values for underground levels. The sequence starts with the first basement level. If the number of 'Storey height(s)' is less than the number of 'Storeys', the last value is repeated until all floors are defined or the skirt depth is reached.

Model URL

Specifies the relative path to the default model used for point objects. The supported formats is GLTF ('.gltf', '.glb').

Model scale

Defines the default scaling along the x-, y-, and z-axes. Values greater than 1.0 enlarge the model, while values less than 1.0 reduce its size.

Model heading

The model heading defines the horizontal rotation of the object around its vertical axis.

Model pitch

The model pitch describes the rotation of the object around its lateral axis (tilting forward or backward).

Model roll

The model roll describes the rotation of the object around its longitudinal axis (rolling to the left or right).

Model auto scale

If enabled, the model is automatically scaled based on the zoom level. When zooming in, the model becomes smaller. When zooming out, it becomes larger. As a result, the model appears to remain the same size to the viewer.

Base URL

A base URL used to resolve relative model URLs. Expects HTTP or HTTPS requests.