 |
SCENE C++ API
2.1.0
|
|
SCENE C++ API
2.1.0
|
Container collecting settings for the WebShare Cloud data export. More...
#include <lswebsharesettings.h>
Inheritance diagram for LSWebShareSettings:Public Types | |
| enum | MAP_TYPE : uint8_t |
| Enumeration for the map type. | |
Public Member Functions | |
| bool | setStandardProjectSettings (const ref_ptr< const LSProject > &project) |
| Sets the following settings based on the properties of the provided SCENE project: ID, Display name, Description, Keywords, Latitude, Longitude, Preview image path. More... | |
| bool | setDataDirectory (const LSString &dataDirectory) |
| Sets the folder path where the WebShare Cloud data should be created. More... | |
| bool | setMapType (const MAP_TYPE type) |
| Sets the map type of the overview map. More... | |
| bool | setMapBackgroundColor (const double r, const double g, const double b) |
| Sets the background color of the overview map. More... | |
| bool | setMapForegroundColor (const double r, const double g, const double b) |
| Sets the foreground color of the overview map. More... | |
| bool | addLayerBox (const ref_ptr< const LSObject > &layerBox) |
| Adds a clipping boxes to be used for a multilayer overview map. More... | |
| bool | addLayoutPlan (const ref_ptr< const LSObject > &layoutPlan) |
| Adds a layout plan to be used as additional map layers for the overview map. More... | |
| bool | setApplyClippingBoxes (const bool applyClippingBoxes) |
| Sets that clipping boxes should be applied to a single map layer overview map. More... | |
| bool | setCreateScanOverlays (const bool createScanOverlays) |
| Sets that overlay map layers for each scan should be created. More... | |
| bool | setExportHdPanorama (const bool exportHdPanorama) |
| Sets that HD versions (8192 pixels) of the panorama images should be created if the individual scans are large enough. More... | |
| bool | setExportHdDistance (const bool exportHdDistance) |
| Sets that HD versions (8192 pixels) of the distance images should be created if the individual scans are large enough. More... | |
| bool | setExportColor (const bool exportColor) |
| Sets that the colorized versions of the panorama images should be created if the individual scan is available in color. More... | |
| bool | setExportGray (const bool exportGray) |
| Sets that the gray scale versions of the panorama images should be created if the reflection values of the individual scan are available. More... | |
| bool | setId (const LSString &id) |
| Sets the project identifier. More... | |
| bool | setDisplayName (const LSString &displayName) |
| Sets the project display name. More... | |
| bool | setDescription (const LSString &description) |
| Sets the project description. More... | |
| bool | setKeywords (const LSString &keywords) |
| Sets the project keywords in the form of a comma separated string of keywords, e.g. More... | |
| bool | setLatitude (const double latitude) |
| Sets the latitude of the project on Earth. More... | |
| bool | setLongitude (const double longitude) |
| Sets the longitude of the project on Earth. More... | |
| bool | setImagePath (const LSString &imagePath) |
| Sets the file path to the project preview image. More... | |
| bool | setIsPublic (const bool isPublic) |
| Sets that the project should be flagged as public. More... | |
| bool | setFeatured (const bool featured) |
| Sets that the project should be flagged as featured and be shown in the feature box. More... | |
| bool | setProgressType (const PROGRESS_TYPE type) |
| Sets the type of the progress information. More... | |
| bool | check () const |
| Carries out a complete check of all attributes. More... | |
| Public Member Functions inherited from LSAttributeContainer | |
| LSString | getTypeName () const |
| Gets the type name of this instance. More... | |
| LSString | getName () const |
| Gets the name of the container. More... | |
| LSResult::Result | setName (LSString name) |
| Sets the name of the container. More... | |
| LSString | getUuid () const |
| Returns the unique id of the container. More... | |
| LSString | assignUuid () |
| Assigns a unique id to the container if the container does not not yet have a unique id. More... | |
| unsigned int | getNumAttributes () const |
| Get the number of attributes in the container. More... | |
| LSString | getAttributeName (unsigned int index) const |
| Get the name of an attribute in the container. More... | |
| unsigned int | getAttributeIndex (LSString name) const |
| Get the index of an attribute in the container. More... | |
| LSAttribute | getAttribute (unsigned int index) const |
| Get an attribute based on its index. More... | |
| LSAttribute | getAttribute (LSString name) const |
| Get an attribute based on its name. More... | |
| LSResult::Result | setAttribute (unsigned int index, const LSAttribute &attribute) |
| Set an attribute based on its index. More... | |
| LSResult::Result | setAttribute (LSString name, const LSAttribute &attribute) |
| Set an attribute based on its name. More... | |
| LSResult::Result | addCustomAttribute (LSString name, const LSAttribute &attribute) |
| Add a new custom attribute to the container. More... | |
| bool | removeCustomAttribute (LSString name) |
| Remove a custom attribute from the container. More... | |
| unsigned int | getNumFields () const |
| Returns the number of fields in the container. More... | |
| ref_ptr< LSAttributeContainer > | getField (unsigned int index) const |
| Returns the field at position n in the container. More... | |
| ref_ptr< LSAttributeContainer > | getField (const LSString &name) const |
| Returns the field with the given name. More... | |
| LSResult::Result | addField (const LSString &name, const LSString &typeName, ref_ptr< LSAttributeContainer > &fieldOut) |
| Add a field to the container. More... | |
| bool | rmField (const LSString &name) |
| Removes the field with a given name from the container. More... | |
Static Public Member Functions | |
| static ref_ptr< LSWebShareSettings > | create () |
Additional Inherited Members | |
| Protected Member Functions inherited from LSRefType | |
| void | ref () const |
| Increments the internal reference counter. More... | |
| void | unref () const |
| Decrements the internal reference counter. More... | |
Container collecting settings for the WebShare Cloud data export.
All set methods return if setting the value was successful.
|
static |
Sets the following settings based on the properties of the provided SCENE project: ID, Display name, Description, Keywords, Latitude, Longitude, Preview image path.
| bool setDataDirectory | ( | const LSString & | dataDirectory | ) |
Sets the folder path where the WebShare Cloud data should be created.
Default value = L"". In this case, the standard export folder in the project's revision folder is used. If the directory already exists, it must be empty.
| bool setMapType | ( | const MAP_TYPE | type | ) |
Sets the map type of the overview map.
!!!!! Standalone apps currently only support the MAP_TYPE::MT_SCENE map type !!!!! Other map types are not supported since standalone apps can't open a 3D view. If the map type is set to MAP_TYPE::MT_SCENE, applyClippingBoxes must be false and layerBoxes must be empty since that map type does not support clipping boxes currently. Default value = MAP_TYPE::MT_SCENE.
| bool setMapBackgroundColor | ( | const double | r, |
| const double | g, | ||
| const double | b | ||
| ) |
Sets the background color of the overview map.
Not used by the map type MAP_TYPE::MT_SCENE. The provided RGB values must be in the [0 to 1] interval with [0,0,0] as black and [1,1,1] as white. Default value = [1,1,1] (white).
| bool setMapForegroundColor | ( | const double | r, |
| const double | g, | ||
| const double | b | ||
| ) |
Sets the foreground color of the overview map.
Only used by the map type MAP_TYPE::MT_SCENE. The provided RGB values must be in the [0 to 1] interval with [0,0,0] as black and [1,1,1] as white. Default value = [0,0,0] (black).
Adds a clipping boxes to be used for a multilayer overview map.
If none is provided, the whole map will be created in a single map layer. Currently, only clipping boxes with the ClippingMode 0 (keep inside) are allowed. Call this method multiple times for different layout boxes. You may not add layer boxes to a map of type MAP_TYPE::MT_SCENE since that map type does not support clipping boxes currently.
Adds a layout plan to be used as additional map layers for the overview map.
| bool setApplyClippingBoxes | ( | const bool | applyClippingBoxes | ) |
Sets that clipping boxes should be applied to a single map layer overview map.
You may not set this value to true for a map of type MAP_TYPE::MT_SCENE since that map type does not support clipping boxes currently. Default value = false.
| bool setCreateScanOverlays | ( | const bool | createScanOverlays | ) |
Sets that overlay map layers for each scan should be created.
Default value = false.
| bool setExportHdPanorama | ( | const bool | exportHdPanorama | ) |
Sets that HD versions (8192 pixels) of the panorama images should be created if the individual scans are large enough.
Default value = false.
| bool setExportHdDistance | ( | const bool | exportHdDistance | ) |
Sets that HD versions (8192 pixels) of the distance images should be created if the individual scans are large enough.
Default value = false.
| bool setExportColor | ( | const bool | exportColor | ) |
Sets that the colorized versions of the panorama images should be created if the individual scan is available in color.
At least one of exportColor and exportGray must be true. Default value = true.
| bool setExportGray | ( | const bool | exportGray | ) |
Sets that the gray scale versions of the panorama images should be created if the reflection values of the individual scan are available.
Default value = false.
| bool setId | ( | const LSString & | id | ) |
Sets the project identifier.
This method must be called before starting the export since the default value L"" is invalid. All characters must be in [a-z0-9-] and the maximal length is 40 characters.
| bool setDisplayName | ( | const LSString & | displayName | ) |
Sets the project display name.
The maximal length is 60 bytes. This method must be called before starting the export since the default value L"" is invalid.
| bool setDescription | ( | const LSString & | description | ) |
Sets the project description.
The maximal length is 65535 bytes. Default value = L"".
| bool setKeywords | ( | const LSString & | keywords | ) |
Sets the project keywords in the form of a comma separated string of keywords, e.g.
L"factory, house, power station". The maximal length is 255 bytes. Default value = L"".
| bool setLatitude | ( | const double | latitude | ) |
Sets the latitude of the project on Earth.
The provided value must be in the range [-90 to 90]. Default value = 0.
| bool setLongitude | ( | const double | longitude | ) |
Sets the longitude of the project on Earth.
The provided value must be in the range [-180 to 180]. Default value = 0.
| bool setImagePath | ( | const LSString & | imagePath | ) |
Sets the file path to the project preview image.
Default value = L"". In this case, one of the panorama images will be used as project image. Otherwise, the file path must point to a valid file.
| bool setIsPublic | ( | const bool | isPublic | ) |
Sets that the project should be flagged as public.
This setting is not used by the SCENE 2go viewer. Default value = false.
| bool setFeatured | ( | const bool | featured | ) |
Sets that the project should be flagged as featured and be shown in the feature box.
Default value = false.
| bool setProgressType | ( | const PROGRESS_TYPE | type | ) |
Sets the type of the progress information.
PROGRESS_TYPE::PT_NONE = No progress information in any case. PROGRESS_TYPE::PT_DEFAULT = Display the default progress information for the app type: Normal SCENE progress bar for plugin apps. No progress bar for standalone apps. Default value = PROGRESS_TYPE::PT_DEFAULT.
| bool check | ( | ) | const |
Carries out a complete check of all attributes.
This includes a consistency check involving several attributes, e.g. that at least one of exportColor and exportGray is set to true.
