GENERATE_GFX

GENERATE_GFX generates graphics of a model.

Syntax

CC "Modeling" GENERATE_GFX	[ id | modelid:idValue ]
							[ mode:Mode ] [ RegionParams | PagesParams ]
							[ destination:Destination ] [ FileParams ] .


Mode :	"region" | "pages" .


RegionParams :	[ scale:intValue ] .


PagesParams :	[ layout:strValue ] [ orientation:OrientationValue ]
				[ factor:intValue | fitonepage 
				 pages-height:intValue | pages-width:intValue ]
				[ dpi:intValue ] .


OrientationValue :	"portrait" | "landscape" .


Destination :	"file" | "clipboard" .


FileParams :	filename:strValue gfx-format:GfxFormat .


GfxFormat :	"bmp1" | "bmp24" | "bmp" | "pcx8" | "pcx24" | "pcx" 
	"jpg" | "png" | "emf" | "svg" | "svg-web" .


-->RESULT ecode:intValue .

Parameters

• id(modifier, optional) -
• modelid (idValue, optional) - the ID of the model of which gfx shall be generated is passed via modelid. If no modelid is specified, the currently active model is used.
• mode (enumValue, optional) - Mode, with mode:"region" the gfx is generated for the current gfx region. If no gfx region is active in the model window, the whole drawing area is used. With mode:"pages" one gfx file is generated for each page of the drawing area. Therefore the filename must contain "XXYY" which is replaced by the page coordinates for each generated page gfx. One of: "region" | "pages"
• destination (enumValue, optional) Destination, the destination of a gfx generation can be a file or the system's clipboard. For destination:"file" the name (filename) and the format (gfx-format) of the file can be specified. One of: "file" | "clipboard"
• scale (intValue, optional) - the size of the gfx can be influenced via the scale parameter, where 100 means original size (100%), which is also the default value.
• layout (strValue, optional) - the size of a page is defined by the used page layout, which can be specified with layout and orientation. If no layout is specified, the current page layout of the model is used.
• orientation (enumValue, optional) - OrientationValue; one of: "portrait" | "landscape"
• factor (intValue, optional) - defines the scaling mode.
• fitonepage (modifier, optional) - defines the scaling mode.
• pages-height (intValue, optional) - defines the scaling mode.
• pages-width (intValue, optional) - defines the scaling mode.
• filename (strValue) -
• gfx-format (enumValue) - GfxFormat, one of: "bmp1" | "bmp24" | "bmp" | "pcx8" | "pcx24" | "pcx" | "jpg" | "png" | "emf" | "svg" | "svg-web"
• dpi (intValue, optional) -

Returns

• ecode (intValue) - Contains the error code or is 0 in case of success.

Details

The size of the gfx is determined by the page size, the scaling mode and the dpi value.

Gfx formats
"bmp1" Windows Bitmap (monochrome)
"bmp24" Windows Bitmap (24 bit)
"bmp" Windows Bitmap (24 bit)
"pcx8" ZSoft PC-Paintbrush (8bit palette)
"pcx24" ZSoft PC-Paintbrush (24 bit)
"pcx" ZSoft PC-Paintbrush (24 bit)
"jpg" JPEG graphics format
"png" Portable Network Graphics
"emf" Windows Enhanced MetaFile
"svg" Scalable Vector Graphics
"svg-web" Scalable Vector Graphics (for web; with additional type information)

See Also

Examples

Example 1

CC "Modeling" EXEC_GFX_DLG mode:"region" scale:50
    destination:"file" filename:"c:\\ei.png" gfx-format:"png"

Example 2

CC "Modeling" EXEC_GFX_DLG mode:"pages"
    layout:"Full page" orientation:"landscape" factor:100 dpi:72
    destination:"file" filename:"c:\\eiXXYY.png" gfx-format:"png"

Versions and Changes

Available since ADOxx 1.3