geometrize::exporter Namespace Reference

Enumerations
enum	ShapeDataFormat { ShapeDataFormat::JSON, ShapeDataFormat::CUSTOM_ARRAY }

Functions
bool	exportGIF (const std::vector< geometrize::ShapeResult > &data, std::uint32_t inputWidth, std::uint32_t inputHeight, std::uint32_t outputWidth, std::uint32_t outputHeight, const std::function< bool(std::size_t)> &frameSkipPredicate, const std::string &filePath)
	exportGIF Exports shape data to a GIF image. More...
bool	exportBitmap (const geometrize::Bitmap &bitmap, const std::string &filePath)
	exportBitmap Exports the Geometrize bitmap data to an image format that Qt supports (depending on the file extension). More...
bool	exportImage (const QImage &image, const std::string &filePath)
	exportImage Exports the image data to an image format that Qt supports (depending on the file extension). More...
bool	exportImages (const std::vector< QImage > &images, const std::string &targetDir, const std::string &baseFilename, const std::string &fileExtension)
	exportImages Exports the image data to an image format that Qt supports (depending on the file extension). More...
QImage	renderSvgShapeDataToImage (const std::vector< geometrize::ShapeResult > &shapes, const std::uint32_t inputWidth, const std::uint32_t inputHeight, const std::uint32_t outputWidth, const std::uint32_t outputHeight)
	renderSvgShapeDataToImage Renders the given shape data to an image via an SVG. More...
bool	exportRasterizedSvg (const std::vector< geometrize::ShapeResult > &shapes, std::uint32_t inputWidth, std::uint32_t inputHeight, std::uint32_t outputWidth, std::uint32_t outputHeight, const std::string &filePath)
	exportRasterizedSvg Exports the shape data as an image by rasterizing an SVG rendered from the shape data. More...
bool	exportRasterizedSvgs (const std::vector< geometrize::ShapeResult > &shapes, std::uint32_t inputWidth, std::uint32_t inputHeight, std::uint32_t outputWidth, std::uint32_t outputHeight, const std::string &targetDir, const std::string &baseFilename, const std::string &fileExtension)
	exportRasterizedSvgs Exports the shape data to images by rasterizing SVGs rendered from the shape data. Exports one image for each shape i.e. an image with one shape, two shapes, three shapes. More...
std::string	exportShapeData (const std::vector< geometrize::ShapeResult > &data, ShapeDataFormat format)
	exportShapeData Exports shape data to a specified format (JSON or a custom textual array format). More...
std::string	exportCanvasWebpage (const std::vector< geometrize::ShapeResult > &data)
	exportCanvasWebpage Exports shape data to a HTML5 canvas-based webpage. More...
std::string	exportWebGLWebpage (const std::vector< geometrize::ShapeResult > &data)
	exportWebGLWebpage Exports shape data to a WebGL-based webpage. More...

Enumeration Type Documentation

ShapeDataFormat

enum geometrize::exporter::ShapeDataFormat

strong

Enumerator
JSON
CUSTOM_ARRAY

{
    JSON,
    CUSTOM_ARRAY
};

Function Documentation

exportBitmap()

bool geometrize::exporter::exportBitmap	(	const geometrize::Bitmap &	bitmap,
		const std::string &	filePath
	)

exportBitmap Exports the Geometrize bitmap data to an image format that Qt supports (depending on the file extension).

Parameters

bitmap	The image data to save as an image file.
filePath	The full path to the image file target (include the filename and file extension).

Returns

True if the image was saved, else false.

{
    const QImage image{geometrize::image::createImage(bitmap)};
    return exportImage(image, filePath);
}

Here is the call graph for this function:

Here is the caller graph for this function:

exportCanvasWebpage()

std::string geometrize::exporter::exportCanvasWebpage

(

const std::vector< geometrize::ShapeResult > &

data

)

exportCanvasWebpage Exports shape data to a HTML5 canvas-based webpage.

Parameters

data	The shape data to export.

Returns

A string containing the content of the canvas-based webpage.

{
    return exportWebpage(":/web_export/templates/web_export_template.html", ":/web_export/templates/backend_canvas.js", data);
}

Here is the caller graph for this function:

exportGIF()

bool geometrize::exporter::exportGIF	(	const std::vector< geometrize::ShapeResult > &	data,
		std::uint32_t	inputWidth,
		std::uint32_t	inputHeight,
		std::uint32_t	outputWidth,
		std::uint32_t	outputHeight,
		const std::function< bool(std::size_t)> &	frameSkipPredicate,
		const std::string &	filePath
	)

exportGIF Exports shape data to a GIF image.

Parameters

data	The shape data to export.
inputWidth	The width of the canvas each frame will be rendered to.
inputHeight	The height of the canvas each frame will be rendered to.
outputWidth	The width of the image each frame will be rasterized into.
outputHeight	The height of the image each frame will be rasterized into.
filePath	The full path to the GIF image file target (include the filename and .gif extension).

Returns

True if the GIF was saved, else false.

{
    blk::BurstLinker gif;
    if(!gif.init(filePath.c_str(), outputWidth, outputHeight, 0, std::max(1U, std::thread::hardware_concurrency()))) {
        assert(0 && "Failed to initialize BurstLinker GIF export");
        return false;
    }
 
    // Could start by adding the final result
    //addFrame(data, inputWidth, inputHeight, outputWidth, outputHeight, 400, gif);
 
    for(std::uint32_t i = 0; i < data.size(); i++) {
        if(frameSkipPredicate(i)) {
            continue;
        }
 
        std::uint32_t delayMs = i == 0 ? 0 : std::max(20, static_cast<std::int32_t>(1000 / (i + 1)));
        if(i == data.size() - 1U) {
            delayMs = 2000; // Extra delay at end of animation
        }
 
        const std::vector<geometrize::ShapeResult> shapes(data.begin(), data.begin() + i);
        addFrame(shapes, inputWidth, inputHeight, outputWidth, outputHeight, delayMs, gif);
    }
 
    gif.release();
    return true;
}

Here is the caller graph for this function:

exportImage()

bool geometrize::exporter::exportImage	(	const QImage &	image,
		const std::string &	filePath
	)

exportImage Exports the image data to an image format that Qt supports (depending on the file extension).

Parameters

image	The image to save as an image file.
filePath	The full path to the image file target (include the filename and file extension).

Returns

True if the image was saved, else false.

{
    return image.save(QString::fromStdString(filePath));
}

Here is the caller graph for this function:

exportImages()

bool geometrize::exporter::exportImages	(	const std::vector< QImage > &	images,
		const std::string &	targetDir,
		const std::string &	baseFilename,
		const std::string &	fileExtension
	)

exportImages Exports the image data to an image format that Qt supports (depending on the file extension).

Parameters

images	The images to save as image files.
targetDir	The target directory.
baseFilename	The base file name.
fileExtension	The file extension (".jpg", ".png").

Returns

True if the images were saved, else false.

{
    for(std::size_t i = 0; i < images.size(); i++) {
        const std::string path{targetDir + baseFilename + "_" + std::to_string(i) + fileExtension};
        if(!images[i].save(QString::fromStdString(path))) {
            return false;
        }
    }
    return true;
}

exportRasterizedSvg()

bool geometrize::exporter::exportRasterizedSvg	(	const std::vector< geometrize::ShapeResult > &	shapes,
		std::uint32_t	inputWidth,
		std::uint32_t	inputHeight,
		std::uint32_t	outputWidth,
		std::uint32_t	outputHeight,
		const std::string &	filePath
	)

exportRasterizedSvg Exports the shape data as an image by rasterizing an SVG rendered from the shape data.

Parameters

shapes	The shape data to export.
inputWidth	The width of the canvas the SVG will be rendered to.
inputHeight	The height of the canvas the SVG will be rendered to.
outputWidth	The width of the image the SVG will be rasterized into.
outputHeight	The height of the image the SVG will be rasterized into.
filePath	The full path to the image file target (include the filename and file extension).

Returns

True if the image was saved, else false.

{
    const QImage image{geometrize::exporter::renderSvgShapeDataToImage(shapes, inputWidth, inputHeight, outputWidth, outputHeight)};
    return geometrize::exporter::exportImage(image, filePath);
}

Here is the call graph for this function:

Here is the caller graph for this function:

exportRasterizedSvgs()

bool geometrize::exporter::exportRasterizedSvgs	(	const std::vector< geometrize::ShapeResult > &	shapes,
		std::uint32_t	inputWidth,
		std::uint32_t	inputHeight,
		std::uint32_t	outputWidth,
		std::uint32_t	outputHeight,
		const std::string &	targetDir,
		const std::string &	baseFilename,
		const std::string &	fileExtension
	)

exportRasterizedSvgs Exports the shape data to images by rasterizing SVGs rendered from the shape data. Exports one image for each shape i.e. an image with one shape, two shapes, three shapes.

Parameters

shapes	The shape data to export.
inputWidth	The width of the canvas the SVG will be rendered to.
inputHeight	The height of the canvas the SVG will be rendered to.
outputWidth	The width of the image the SVG will be rasterized into.
outputHeight	The height of the image the SVG will be rasterized into.
targetDir	The target directory.
baseFilename	The base file name.
fileExtension	The file extension (".jpg", ".png").

Returns

True if the images were saved, else false.

{
    for(std::size_t i = 0; i < shapes.size(); i++) {
        const std::string path{targetDir + "/" + baseFilename + "_" + std::to_string(i) + fileExtension};
 
        const std::vector<geometrize::ShapeResult> shapeSubset(shapes.begin(), shapes.begin() + i);
        if(!exportRasterizedSvg(shapeSubset, inputWidth, inputHeight, outputWidth, outputHeight, path)) {
            return false;
        }
    }
    return true;
}

Here is the call graph for this function:

Here is the caller graph for this function:

exportShapeData()

std::string geometrize::exporter::exportShapeData	(	const std::vector< geometrize::ShapeResult > &	data,
		ShapeDataFormat	format
	)

exportShapeData Exports shape data to a specified format (JSON or a custom textual array format).

Parameters

data	The shape data to export.
format	The format to save to data in.

Returns

A string containing the exported shape data, empty if the format was unrecognized.

{
    switch(format) {
    case ShapeDataFormat::JSON:
        return exporter::exportShapeJson(data);
    case ShapeDataFormat::CUSTOM_ARRAY:
        return exporter::exportShapeArray(data);
    }
 
    assert(0 && "Unsupported shape data format specified, will default to exporting JSON");
    return exporter::exportShapeJson(data);
}

Here is the caller graph for this function:

exportWebGLWebpage()

std::string geometrize::exporter::exportWebGLWebpage

(

const std::vector< geometrize::ShapeResult > &

data

)

exportWebGLWebpage Exports shape data to a WebGL-based webpage.

Parameters

data	The shape data to export.

Returns

A string containing the content of the WebGL-based webpage.

{
    return exportWebpage(":/web_export/templates/web_export_template.html", ":/web_export/templates/backend_threejs.js", data);
}

Here is the caller graph for this function:

renderSvgShapeDataToImage()

QImage geometrize::exporter::renderSvgShapeDataToImage	(	const std::vector< geometrize::ShapeResult > &	shapes,
		const std::uint32_t	inputWidth,
		const std::uint32_t	inputHeight,
		const std::uint32_t	outputWidth,
		const std::uint32_t	outputHeight
	)

renderSvgShapeDataToImage Renders the given shape data to an image via an SVG.

Parameters

shapes	The shape data to render.
inputWidth	The width of the canvas the SVG will be rendered to.
inputHeight	The height of the canvas the SVG will be rendered to.
outputWidth	The width of the image the SVG will be rasterized into.
outputHeight	The height of the image the SVG will be rasterized into.

Returns

The image the shape data was rendered to.

{
    const std::string data{geometrize::exporter::exportSVG(shapes, inputWidth, inputHeight)};
    const QByteArray arrayData(data.c_str(), static_cast<int>(data.length()));
    QSvgRenderer renderer;
    renderer.load(arrayData);
 
    if(!renderer.isValid()) {
        assert(0 && "SVG renderer is in an invalid state");
        return QImage();
    }
 
    QPainter painter;
    QImage image(outputWidth, outputHeight, QImage::Format_RGBA8888);
    image.fill(0);
 
    painter.begin(&image);
    renderer.render(&painter);
    painter.end();
 
    return image;
}

Here is the caller graph for this function: