KitchenDraw SDK 2
Show / Hide Table of Contents

Method ExportCatalogImageFromScript

ExportCatalogImageFromScript(string, string, HandingType, double, double, double, bool, ViewMode, string, int, int, string, bool, int, int)

Exports an image representing a block created from a given script.

Declaration
public void ExportCatalogImageFromScript(string catalogFilename, string script, Scene.Object.HandingType handingType, double dimensionX, double dimensionY, double dimensionZ, bool opened, Scene.ViewMode viewMode, string imageFilename, int imageWidth, int imageHeight, string backgroundColor = "255,255,255", bool transparent = true, int jpegQuality = 80, int antialiasing = 1)
Parameters
Type Name Description
string catalogFilename

Filename of the catalog which contains the item.

string script

Script that defines the block.

Scene.Object.HandingType handingType

Handing of the block.

double dimensionX

Width of the block, in the catalog measurement units.

double dimensionY

Depth of the block, in the catalog measurement units.

double dimensionZ

Height of the block, in the catalog measurement units.

bool opened

Indicates whether the block should be represented in its open visual state.

Scene.ViewMode viewMode

Specifies which view mode to use for the image generation.

string imageFilename

Filename of the file to create.

int imageWidth

Width of the generated image.

int imageHeight

Height of the generated image.

string backgroundColor
bool transparent
int jpegQuality
int antialiasing
Remarks

See ExportImage(string, int, int, bool, string, int, int) for details on the rest of parameters.

This method creates a temporary block in the given catalog from the given script. Then, it attaches an article to that block with the given dimensions and handing. An image of the temporary block is exported eventually.

In this article
Back to top Generated by DocFX