|
Helium software searches the "Report" subfolder for the initialization (*.ini) files and looks through all such files. Initialization files related to exporting report data for polished diamonds should have the following format.
[General]
ReportType=Export
VisibleName=<Submenu item name>
[FileNames]
Executable=<Full path to the third-party executable>
ParameterValues=<File name for the result>
[<Simple PictureID>]
FileNameEMF=<File name for the picture in the EMF format>
FileNameBMP=<File name for the picture in the BMP format>
FileNamePNG=<File name for the picture in the PNG format>
FileNameGIF=<File name for the picture in the GIF format>
Width=<Maximum raster picture width in pixels>
Height=<Maximum raster picture height in pixels>
………………………………………………
………………………………………………
[Picture<N>]
PictureID=POLISH_MODEL_REPORT
FileNameEMF=<File name for the picture in the EMF format>
FileNameBMP=<File name for the picture in the BMP format>
FileNamePNG=<File name for the picture in the PNG format>
FileNameGIF=<File name for the picture in the GIF format>
Width=<Maximum raster picture width in pixels>
Height=<Maximum raster picture height in pixels>
X=<Angle of rotation around X axis in degrees>
Y=<Angle of rotation around Y axis in degrees>
Z=<Angle of rotation around Z axis in degrees>
InvisibleEdges=<The way of drawing invisible edges >
VisibleSidesInColor=<The way of coloring of visible sides>
VisibleEdgesColorR=<The color of visible edges in RGB>
VisibleEdgesColorG=<The color of visible edges in RGB>
VisibleEdgesColorB=<The color of visible edges in RGB>
InvisibleEdgesColorR=<The color of invisible edges in RGB>
InvisibleEdgesColorG=<The color of invisible edges in RGB>
InvisibleEdgesColorB=<The color of invisible edges in RGB>
AspectRatioX=<Desired proportions of the picture>
AspectRatioY=<Desired proportions of the picture>
………………………………………………
[Picture<N>]
PictureID=POLISH_ANGLES_REPORT
FileNameEMF=<File name for the picture in the EMF format>
FileNameBMP=<File name for the picture in the BMP format>
FileNamePNG=<File name for the picture in the PNG format>
FileNameGIF=<File name for the picture in the GIF format>
Width=<Maximum raster picture width in pixels>
Height=<Maximum raster picture height in pixels>
PavilionView=<Pavilion (1) or crown (0) view of the stone>
PictureType=<The way of drawing picture>
Colored=<0 or 1>
FontSize=<Font size in percents>
AspectRatioX=<Desired proportions of the picture>
AspectRatioY=<Desired proportions of the picture>
………………………………………………
[Picture<N>]
PictureID=POLISH_SIDES_REPORT
FileNameEMF=<File name for the picture in the EMF format>
FileNameBMP=<File name for the picture in the BMP format>
FileNamePNG=<File name for the picture in the PNG format>
FileNameGIF=<File name for the picture in the GIF format>
Width=<Maximum raster picture width in pixels>
Height=<Maximum raster picture height in pixels>
Colored=<0 or 1>
PavilionView=<Pavilion (1) or crown (0) view of the stone>
PictureType=<The way of drawing picture>
Precision=<Number of digits after decimal point>
FontSize=<Font size in percents>
AspectRatioX=<Desired proportions of the picture>
AspectRatioY=<Desired proportions of the picture>
………………………………………………
[Picture<N>]
PictureID=PROFILE_VIEW_REPORT
FileNameEMF=<File name for the picture in the EMF format>
FileNameBMP=<File name for the picture in the BMP format>
FileNamePNG=<File name for the picture in the PNG format>
FileNameGIF=<File name for the picture in the GIF format>
Width=<Maximum raster picture width in pixels>
Height=<Maximum raster picture height in pixels>
Colored=<0 or 1>
FontSize=<Font size in percents>
AspectRatioX=<Desired proportions of the picture>
AspectRatioY=<Desired proportions of the picture>
TitleLengthGirdleFacet=<Title for Length Girdle Facet>
TitleDepthGirdleFacet=<Title for Depth Girdle Facet>
………………………………………………
Keys of the [General] and [FileNames] sections
These sections are mandatory.
CuttingType: This key is mandatory. It should have the "Export" string for this type of report.
VisibleName: This key is mandatory. The value of this key will be shown in the "Export Report Data" submenu.
Executable: This key is mandatory. It should have the fully qualified name of the third-party executable that will be launched after the generation of all files. This program may read the generated files and pass the report data from them into external report generation engines.
ParameterValues: This key is mandatory. It should have the name of the resulting text file. If the file name is not fully qualified, the resulting file will be created in the folder relative to the "Report" folder, where this INI file is placed. The resulting file will have the format of the Windows initialization file with the single section named [NumericalParameters]:
[NumericalParameters]
MODEL_NAME=Simple
WEIGHT_CT=0.27
TOTAL_DEPTH_MM=2.225
TOTAL_DEPTH_PC=59.92
DIAMETER_MM=4.611
TABLE_MM=2.934
CROWN_HEIGHT_PC=12.63
………………………………………………
[<Simple PictureID>] sections
These sections are optional and specify the attributes of report pictures. Each picture in the report has its own tag (or ID in other words) that is specified in the section name. See the sample report templates for the list of available picture ID's. All tags should be written in capital letters. Most of the pictures may be generated using black-and-white or color scheme. Pictures in different color schemes have different IDs. This is useful for preparing the report for printing on black-and-white or color printer. Usually the picture looks more acceptable to the eye if it is printed on corresponding printer.
FileNameEMF: This key is optional. It should have the file name for the picture in the Windows Enhanced-Format Metafile. If this key is not specified, the corresponding EMF file will not be created or updated.
FileNameBMP, FileNamePNG, FileNameGIF: This key is optional. It should have the file name for the picture in the Windows Bitmap Format (BMP) or Portable Network Graphics Format (PNG) or Graphics Interchange Format (GIF). The Helium software creates uncompressed true-color BMP images, compressed true-color PNG images and compressed 8-bit color GIF images. If this key is not specified, the corresponding file will not be created or updated. If this key is specified, two more keys should be specified also: Width, Height.
Width, Height: These keys should be specified if the FileNameBMP or FileNamePNG or FileNameGIF key is present. They specify the maximum width and height of the raster image with the report picture in pixels. The actual picture will fit into the given dimensions preserving the aspect ratio.
[Picture] sections
These sections are optional and specify the attributes
of report pictures that require additional attributes relative to
the [<Simple PictureID>] section. The number in the section
name does not have a special meaning. It just enumerates sections.
Helium software supports up to 50 sections of this type.
PictureID: This key is mandatory.
It should contain the tag of the picture POLISH_MODEL_REPORT
or POLISH_ANGLES_REPORT or POLISH_SIDES_REPORT or
PROFILE_VIEW_REPORT written in capital letters.
The picture with the POLISH_MODEL_REPORT tag contains a simple model
of the polished diamond without inscriptions above it. Picture attributes
allow to specify whether to draw invisible edges or not, orientation
of the model, color and aspect ration of the picture.
The picture with the POLISH_ANGLES_REPORT tag contains a model of
the polished diamond with facet angles inscribed above the model.
Picture attributes allow to specify the orientation of the model,
what angles to write, font size, aspect ratio and color of the picture.
The picture with the POLISH_SIDES_REPORT tag contains a model of
the semi-polished diamond with information about all facets inscribed
above the model. Picture attributes allow to specify the orientation
of the model, what information to write (angles/heights), precision,
font size, aspect ratio and color of the picture.
The picture with the PROFILE_VIEW_REPORT tag contains a side view
of the model of the polished diamond with the values of basic parameters
inscribed above the model. Picture attributes allow to specify the
font size, aspect ratio and color of the picture.
FileNameEMF: This key is optional. It should have the file name for the picture in the Windows Enhanced-Format Metafile. If this key is not specified, the corresponding EMF file will not be created or updated.
FileNameBMP: This key is optional. It should have the file name for the picture in the Windows Bitmap Format. The Helium software creates uncompressed true-color images. If this key is not specified, the corresponding BMP file will not be created or updated. If this key is specified, two more keys should be specified also: Width, Height.
Width, Height: These keys should be specified if the FileNameBMP key is present. They specify the maximum width and height of the BMP image with the report picture in pixels. The actual picture will fit into the given dimensions preserving the aspect ratio. These keys affect the generation of the BMP image only.
If both the FileNameEMF and the FileNameBMP keys are not specified, the picture will not be created.
X, Y, Z: These keys are optional. If such key is not specified it is assumed to be zero. It is the angle of rotation of the 3D model around X, Y, Z axis in degrees before making the final image. This attribute allows to create various views of the same model.
InvisibleEdges: This key is optional. It specifies the way of drawing invisible edges of the 3D model. Possible values are: 0 - invisible edges are not drawn, 1 - invisible edges are drawn without refraction, 2 - invisible edges are drawn taking refraction of the light into consideration. If this key is not specified it is assumed to be equal to 1.
VisibleSidesInColor: This key
is optional. It specifies the way of coloring of visible edges.
Possible values are: 0 - black and white scheme (for example, extra
facets will be drawn in gray color), 1 - color scheme (for example,
extra facets will be drawn in blue color). If this key is not specified
it is assumed to be equal to 0.
VisibleEdgesColorR, VisibleEdgesColorG, VisibleEdgesColorB: These keys are optional. If such key is not specified it is assumed to be zero. They specify the RGB color for drawing visible edges of the 3D model.
InvisibleEdgesColorR, InvisibleEdgesColorG, InvisibleEdgesColorB: These keys are optional. If such key is not specified it is assumed to be zero. They specify the RGB color for drawing invisible edges of the 3D model.
AspectRatioX, AspectRatioY: These keys are optional. If such key is not specified it is assumed to be zero. They specify the desired proportions of the generated picture. If the actual proportions of the picture differ from the specified, blank margins are added.
PictureType: This key specifies
the way of drawing the picture.
If PictureID is POLISH_ANGLES_REPORT then possible values for this
parameter are: 0 - invisible edges are drawn taking refraction into
account, slope angles of main facets are written near facets; 1
- invisible edges are not drawn, slope angles of all facets are
written; 2 - invisible edges are not drawn, azimuth angles of all
facets are written; 3 - invisible edges are not drawn, deviation
of slope angles from the average are written; 4 - invisible edges
are not drawn, deviation of azimuth angles from ideal are written;
5 - invisible edges are not drawn, slope angles of main facets are
written near facets together with the maximum inscribed circle and
section of the model with the plane in which the circle lies; 6
- invisible edges are not drawn, slope angles of main facets are
written above facets together with the maximum inscribed circle
and section of the model with the plane in which the circle lies.
If PictureID is POLISH_SIDES_REPORT then possible values for this
parameter are: 0 - slope angles of all facets are drawn; 1- azimuth
angles of all facets are drawn; 2 - heights in % of all facets are
drawn; 3 - heights in mm of all facets are drawn.
Colored: This key is optional. Default value: 0. The program generates black and white pictures if it is 0 and colored otherwise.
FontSize: This key is optional. Default value: 100. This parameter adjusts the font height on the picture. It specifies the ratio between desired and default font size. For example, if FontSize=200, all text on the picture will be twice higher than default.
Precision: This key is optional. Default value: 2. This parameter is applicable to pictures with PictureID=POLISH_SIDES_REPORT. It specifies the number of decimal digits used when writing facet angles or heights.
TitleLengthGirdleFacet, TitleDepthGirdleFacet: These keys are optional. They specify the text that will be written on the picture above the corresponding parameter values. When the font size is large the default text may appear too big to fit the picture and you may want to change it.
|
