MapPackageModelWriter Class

A writer class for writing 3D models to a GeoPackage, using a Carmenta-specific extension.

Syntax

public class MapPackageModelWriter : MapPackageWriter

Remarks

MapPackageModelWriter can write georeferenced 3D models to a table in a GeoPackage. The resulting model tables contain Carmenta models – a Carmenta-specific extension to the GeoPackage format – and are optimized for display in a GlobeView using the property GlobeView.AuxiliaryGroundInput.

3D Tiles is the only input model type that is currently supported. To create a 3D Tiles MapPackageModelWriter, use the MapPackage.Create3DTilesModelWriter method on the MapPackage class.

The destination table name and conversion settings, including detail settings affecting the level-of-detail assignment of the resulting GeoPackage table, can be configured on the attached MapPackageModelTable. To convert the model data and write it into the destination table, call Convert.

To use the resulting model in a GlobeView configuration, add a ReadOperator to the GlobeView's auxiliaryGroundInput property, and add a MapPackageDataSet to the ReadOperator's dataSet property. Configure the MapPackageDataSet's path and filename properties to point to the GeoPackage file to which the model was written. Finally, set the MapPackageDataSet.TableName property to the table name used when writing the model, that is, MapPackageTable.Name.

If you used MapPackageModelTable.ExtraTileLevels to increase the maximum detail level of the models, you should also set the GlobeView.ExtraTileLevels property to the same value to let GlobeView load all detail levels.

To automatically deduce appropriate detail settings for the input model data, invoke DeduceDetailSettings before calling Convert.

You can also use Estimate to get calculate estimate of the resulting detail density per tile level given the current detail settings. This lets you test your settings without taking the full time to convert with Convert.

Example

// Convert a 3D Tiles data set to a GlobeView-friendly table in a GeoPackage.
// Assumes that tilesetJsonFile contains the path to a 3D Tiles tileset.json file.
static bool convert3dTilesToGeoPackage(string filename, string tilesetJsonFile)
{
    // Create new map package
    var mapPackage = new MapPackage(filename);

    // Create a model table
    var modelTable = new MapPackageModelTable("models");

    // Configure conversion.
    modelTable.ElevationOffset = 100.0; // Raises the model by 100m.

    // Configure detail settings.
    modelTable.ExtraTileLevels = 2;           // Creates two extra tile levels compared with default.
    modelTable.LevelOfDetailMultiplier = 1.5; // Makes each tile level 50% more detailed than default.

    // Create model writer
    var modelWriter = mapPackage.Create3DTilesModelWriter(modelTable, tilesetJsonFile);

    // Optional: deduce detail settings. This will overwrite the detail settings that were set above.
    modelWriter.DeduceDetailSettings();

    // It is possible to adjust detail settings after deduction:
    modelTable.ExtraTileLevels -= 1; // Remove the most detailed tile level.
    modelTable.LevelOfDetailMultiplier *= 0.8; // Slightly reduce detail density.

    // Convert 3D Tiles data using the settings configured above.
    bool result = modelWriter.Convert();
    mapPackage.Close();
    return result;
}

Inheritance Hierarchy

System.Object (not available in C#)
  EngineObject
    MapPackageWriter
      MapPackageModelWriter

Platforms

Windows, Linux, Android

MapPackageModelWriter Members

The MapPackageModelWriter type has the following members.

Properties

Name	Description
IsDisposed	Gets a value that tells whether the current MapPackageModelWriter has been disposed. Inherited from EngineObject
IsWorking Deprecated	Gets a value indicating if the writer is currently working on some other thread. Inherited from MapPackageWriter
NativeHandle	Gets the native Carmenta Engine kernel object the current MapPackageModelWriter represents. Inherited from EngineObject
OptimizeMeshTextures	Gets or sets a flag indicating if an optimization of mesh textures should be performed when converting the input model data.
Table	The MapPackageTable to create and write to in the GeoPackage. Inherited from MapPackageWriter

Methods

Name	Description
Abort	Aborts a write operation and deletes the table from the GeoPackage. Inherited from MapPackageWriter
Clone	Creates a copy of an object. Inherited from EngineObject
Convert	Converts the input model data and writes the result to the GeoPackage table.
DeduceDetailSettings	Automatically deduces appropriate level-of-detail settings for the input model data.
Dispose	Releases the reference to the native Carmenta Engine kernel instance the EngineObject represents. Inherited from EngineObject
Equals	Determines whether this instance is equal to another. Inherited from EngineObject
Estimate	Estimates resulting detail level of a conversion using Convert.
Progress	Get information on the progress of the conversion.

MapPackageModelWriter Class

A writer class for writing 3D models to a GeoPackage, using a Carmenta-specific extension.

Syntax

C++

class MapPackageModelWriter : public MapPackageWriter

C++ Smart Pointer Declaration

typedef Ptr<MapPackageModelWriter> MapPackageModelWriterPtr;

Remarks

3D Tiles is the only input model type that is currently supported. To create a 3D Tiles MapPackageModelWriter, use the MapPackage::create3DTilesModelWriter method on the MapPackage class.

To use the resulting model in a GlobeView configuration, add a ReadOperator to the GlobeView's auxiliaryGroundInput property, and add a MapPackageDataSet to the ReadOperator's dataSet property. Configure the MapPackageDataSet's path and filename properties to point to the GeoPackage file to which the model was written. Finally, set the MapPackageDataSet::tableName property to the table name used when writing the model, that is, MapPackageTable::name.

If you used MapPackageModelTable::extraTileLevels to increase the maximum detail level of the models, you should also set the GlobeView::extraTileLevels property to the same value to let GlobeView load all detail levels.

To automatically deduce appropriate detail settings for the input model data, invoke deduceDetailSettings before calling convert.

You can also use estimate to get calculate estimate of the resulting detail density per tile level given the current detail settings. This lets you test your settings without taking the full time to convert with convert.

Example

C++

// Convert a 3D Tiles data set to a GlobeView-friendly table in a GeoPackage.
// Assumes that tilesetJsonFile contains the path to a 3D Tiles tileset.json file.
bool convert3dTilesToGeoPackage(const char* filename, const char* tilesetJsonFile)
{
    // Create new map package.
    MapPackagePtr mapPackage = new MapPackage(filename);

    // Create a model table.
    MapPackageModelTablePtr modelTable = new MapPackageModelTable("models");

    // Configure conversion.
    modelTable->elevationOffset(100.0); // Raises the model by 100m.

    // Configure detail settings.
    modelTable->extraTileLevels(2);           // Creates two extra tile levels compared with default.
    modelTable->levelOfDetailMultiplier(1.5); // Makes each tile level 50% more detailed than default.

    // Create model writer.
    MapPackageModelWriterPtr modelWriter = mapPackage->create3DTilesModelWriter(modelTable, tilesetJsonFile);

    // Optional: deduce detail settings. This will overwrite the detail settings that were set above.
    modelWriter->deduceDetailSettings();

    // It is possible to adjust detail settings after deduction:
    modelTable->extraTileLevels(modelTable->extraTileLevels() - 1); // Remove the most detailed tile level.
    modelTable->levelOfDetailMultiplier(modelTable->levelOfDetailMultiplier * 0.8); // Slightly reduce detail density.

    // Convert 3D Tiles data using the settings configured above.
    bool result = modelWriter->convert();
    mapPackage->close();
    return result;
}

Inheritance Hierarchy

EngineObject
MapPackageWriter
MapPackageModelWriter

Platforms

Windows, Linux, Android

MapPackageModelWriter Members

The MapPackageModelWriter type has the following members.

Properties

Name	Description
isWorking Deprecated	Gets a value indicating if the writer is currently working on some other thread. Inherited from MapPackageWriter
optimizeMeshTextures	Gets or sets a flag indicating if an optimization of mesh textures should be performed when converting the input model data.
table	The MapPackageTable to create and write to in the GeoPackage. Inherited from MapPackageWriter

Methods

Name	Description
abort	Aborts a write operation and deletes the table from the GeoPackage. Inherited from MapPackageWriter
clone	Creates a copy of an object. Inherited from EngineObject
convert	Converts the input model data and writes the result to the GeoPackage table.
deduceDetailSettings	Automatically deduces appropriate level-of-detail settings for the input model data.
equals	Determines whether this instance is equal to another. Inherited from EngineObject
estimate	Estimates resulting detail level of a conversion using convert.
progress	Get information on the progress of the conversion.

MapPackageModelWriter Class

A writer class for writing 3D models to a GeoPackage, using a Carmenta-specific extension.

Syntax

Java

public class MapPackageModelWriter extends MapPackageWriter

Remarks

3D Tiles is the only input model type that is currently supported. To create a 3D Tiles MapPackageModelWriter, use the MapPackage.create3DTilesModelWriter method on the MapPackage class.

To use the resulting model in a GlobeView configuration, add a ReadOperator to the GlobeView's auxiliaryGroundInput property, and add a MapPackageDataSet to the ReadOperator's dataSet property. Configure the MapPackageDataSet's path and filename properties to point to the GeoPackage file to which the model was written. Finally, set the MapPackageDataSet.tableName property to the table name used when writing the model, that is, MapPackageTable.name.

If you used MapPackageModelTable.extraTileLevels to increase the maximum detail level of the models, you should also set the GlobeView.extraTileLevels property to the same value to let GlobeView load all detail levels.

To automatically deduce appropriate detail settings for the input model data, invoke deduceDetailSettings before calling convert.

Example

Java

// Convert a 3D Tiles data set to a GlobeView-friendly table in a GeoPackage.
// Assumes that tilesetJsonFile contains the path to a 3D Tiles tileset.json file.
static boolean convert3dTilesToGeoPackage(String filename, String tilesetJsonFile)
{
    // Create new map package.
    MapPackage mapPackage = new MapPackage(filename);

    // Create a model table.
    MapPackageModelTable modelTable = new MapPackageModelTable("models");

    // Configure conversion.
    modelTable.elevationOffset(100.0); // Raises the model by 100m.

    // Configure detail settings.
    modelTable.extraTileLevels(2);           // Creates two extra tile levels compared with default.
    modelTable.levelOfDetailMultiplier(1.5); // Makes each tile level 50% more detailed than default.

    // Create model writer
    MapPackageModelWriter modelWriter = mapPackage.create3DTilesModelWriter(modelTable, tilesetJsonFile);

    // Optional: deduce detail settings. This will overwrite the detail settings that were set above.
    modelWriter.deduceDetailSettings();

    // It is possible to adjust detail settings after deduction:
    modelTable.extraTileLevels(modelTable.extraTileLevels() - 1); // Remove the most detailed tile level.
    modelTable.levelOfDetailMultiplier(modelTable.levelOfDetailMultiplier * 0.8); // Slightly reduce detail density.

    // Convert 3D Tiles data using the settings configured above.
    boolean result = modelWriter.convert();
    mapPackage.close();
    return result;
}

Inheritance Hierarchy

System::Object (not available in Java)
  EngineObject
    MapPackageWriter
      MapPackageModelWriter

Platforms

Windows, Linux, Android

MapPackageModelWriter Members

The MapPackageModelWriter type has the following members.

Properties

Name	Description
isDisposed	Gets a value that tells whether the current MapPackageModelWriter has been disposed. Inherited from EngineObject
isWorking Deprecated	Gets a value indicating if the writer is currently working on some other thread. Inherited from MapPackageWriter
optimizeMeshTextures	Gets or sets a flag indicating if an optimization of mesh textures should be performed when converting the input model data.
table	The MapPackageTable to create and write to in the GeoPackage. Inherited from MapPackageWriter

Methods

Name	Description
abort	Aborts a write operation and deletes the table from the GeoPackage. Inherited from MapPackageWriter
clone	Creates a copy of an object. Inherited from EngineObject
convert	Converts the input model data and writes the result to the GeoPackage table.
deduceDetailSettings	Automatically deduces appropriate level-of-detail settings for the input model data.
dispose	Releases the reference to the native Carmenta Engine kernel instance the EngineObject represents. Inherited from EngineObject
equals	Determines whether this instance is equal to another. Inherited from EngineObject
estimate	Estimates resulting detail level of a conversion using convert.
progress	Get information on the progress of the conversion.

MapPackageModelWriter Class

A writer class for writing 3D models to a GeoPackage, using a Carmenta-specific extension.

Syntax

Python

class MapPackageModelWriter ( MapPackageWriter )

Remarks

3D Tiles is the only input model type that is currently supported. To create a 3D Tiles MapPackageModelWriter, use the MapPackage.create3DTilesModelWriter method on the MapPackage class.

To use the resulting model in a GlobeView configuration, add a ReadOperator to the GlobeView's auxiliaryGroundInput property, and add a MapPackageDataSet to the ReadOperator's dataSet property. Configure the MapPackageDataSet's path and filename properties to point to the GeoPackage file to which the model was written. Finally, set the MapPackageDataSet.tableName property to the table name used when writing the model, that is, MapPackageTable.name.

To automatically deduce appropriate detail settings for the input model data, invoke deduceDetailSettings before calling convert.

Example

Python

# Convert a 3D Tiles data set to a GlobeView-friendly table in a GeoPackage.
# Assumes that tilesetJsonFile contains the path to a 3D Tiles tileset.json file.
def convert3dTilesToGeoPackage(filename, tilesetJsonFile):
    # Create new map package.
    mapPackage = MapPackage(filename)

    # Create a model table.
    modelTable = MapPackageModelTable("models")

    # Configure conversion.
    modelTable.elevationOffset = 100.0       # Raises the model by 100m.

    # Configure detail settings.
    modelTable.extraTileLevels = 2           # Creates two extra tile levels compared with default.
    modelTable.levelOfDetailMultiplier = 1.5 # Makes each tile level 50% more detailed than default.

    # Create model writer
    modelWriter = mapPackage.create3DTilesModelWriter(modelTable, tilesetJsonFile)

    # Optional: deduce detail settings. This will overwrite the detail settings that were set above.
    modelWriter.deduceDetailSettings()

    # It is possible to adjust detail settings after deduction:
    modelTable.extraTileLevels -= 1 # Remove the most detailed tile level.
    modelTable.levelOfDetailMultiplier *= 0.8     # Slightly reduce detail density.

    # Convert 3D Tiles data using the settings configured above.
    result =  modelWriter.convert()
    mapPackage.close()
    return result

Inheritance Hierarchy

EngineObject
MapPackageWriter
MapPackageModelWriter

Platforms

Windows, Linux, Android

MapPackageModelWriter Members

The MapPackageModelWriter type has the following members.

Properties

Name	Description
isWorking Deprecated	Gets a value indicating if the writer is currently working on some other thread. Inherited from MapPackageWriter
optimizeMeshTextures	Gets or sets a flag indicating if an optimization of mesh textures should be performed when converting the input model data.
table	The MapPackageTable to create and write to in the GeoPackage. Inherited from MapPackageWriter

Methods

Name	Description
abort	Aborts a write operation and deletes the table from the GeoPackage. Inherited from MapPackageWriter
clone	Creates a copy of an object. Inherited from EngineObject
convert	Converts the input model data and writes the result to the GeoPackage table.
deduceDetailSettings	Automatically deduces appropriate level-of-detail settings for the input model data.
equals	Determines whether this instance is equal to another. Inherited from EngineObject
estimate	Estimates resulting detail level of a conversion using convert.
progress	Get information on the progress of the conversion.

MapPackageModelWriter Class

In this article

Syntax

Remarks

Example

Inheritance Hierarchy

Platforms

See Also

Reference

MapPackageModelWriter Members

MapPackageModelWriter Class

In this article

Syntax

Remarks

Example

Inheritance Hierarchy

Platforms

See Also

Reference

MapPackageModelWriter Members

MapPackageModelWriter Class

In this article

Syntax

Remarks

Example

Inheritance Hierarchy

Platforms

See Also

Reference

MapPackageModelWriter Members

MapPackageModelWriter Class

In this article

Syntax

Remarks

Example

Inheritance Hierarchy

Platforms

See Also

Reference

MapPackageModelWriter Members