Available display options for CAM Library. Mostly used when generating image files. More...
Functions | |
int | camlib_display_Filter (int nFlashes, int nPaths, int nPolygons, int nLines, int nText) |
Show or hide various figures by their types. More... | |
int | camlib_display_FillMode (int value) |
Set the fill mode for the design. Typically fill mode is used when outputting an image. More... | |
int | camlib_display_Polarity (int value) |
Set the display polarity for the design. Default is 0. More... | |
int | camlib_display_Overlay (int value) |
Set the display overlay for the design. Default is 0 (no overlay). More... | |
int | camlib_display_LevelOfDetail (int value) |
Allows CAM Library to only display figures in the exported images greater than the defined pixel size. Essientially whenever an image is exported if the figures appears smaller than the pixel value, they will be omitted from the image. More... | |
int | camlib_display_ZoomIn (int mouseX, int mouseY) |
Zoom in 2X magnification using the give coordinates as the center. More... | |
int | camlib_display_ZoomOut (int mouseX, int mouseY) |
Zoom out 0.5X magnification using the give coordinates as the center. More... | |
int | camlib_display_ZoomWindow (int nLeft, int nBottom, int nRight, int nTop) |
Zoom to a defined rectangular region. More... | |
int | camlib_display_ZoomAll () |
Zoom out to the extents of the active design. More... | |
int | camlib_display_ZoomPan (int XOffset, int YOffset) |
Zoom to a new center. The image magnification stays the same. More... | |
int | camlib_display_RefreshScreenImage () |
Generates a new "Screen Image" using the current viewport. Perfect for quickly generating an update snapshot screen image of the current viewport. Anytime the design viewport changes, such as zoom in/out, layers on/off, fill on/off use the command to quickly generate a new image. Requires that you first call camlib_display_RefreshScreenImage() and assign the refresh image path, width and height. More... | |
int | camlib_display_InitializeScreenImage (char *png_image_path, int nWidth, int nHeight) |
Assigns the "Screen Image" path, width, and height. Requires that you first initialize with camlib_display_RefreshScreenImage() before using camlib_display_RefreshScreenImage(). More... | |
int | camlib_display_GetViewportScreenImage (float &fX, float &fY, float &fPixelScale, char *sUnits) |
Retrieves the current "Screen Image" viewport (center, scale, and units) used by camlib_display_RefreshScreenImage(). More... | |
Available display options for CAM Library. Mostly used when generating image files.
int camlib_display_FillMode | ( | int | value | ) |
Set the fill mode for the design. Typically fill mode is used when outputting an image.
value | Fill mode to use when figures are displayed - defined by CAM_FillType. |
int camlib_display_Filter | ( | int | nFlashes, |
int | nPaths, | ||
int | nPolygons, | ||
int | nLines, | ||
int | nText | ||
) |
Show or hide various figures by their types.
nFlashes | If set to 0 Flashes will be hidden. If set to 1 Flashes will be visible. |
nPaths | If set to 0 Flashes will be hidden. If set to 1 Flashes will be visible. |
nPolygons | If set to 0 Flashes will be hidden. If set to 1 Flashes will be visible. |
nLines | If set to 0 Flashes will be hidden. If set to 1 Flashes will be visible. |
nText | If set to 0 Text will be hidden. If set to 1 Text will be visible. Only works with Text figures. In many CAM files, Text is simply drawn as paths/lines; in those situations this parameter has no effect. |
int camlib_display_GetViewportScreenImage | ( | float & | fX, |
float & | fY, | ||
float & | fPixelScale, | ||
char * | sUnits | ||
) |
Retrieves the current "Screen Image" viewport (center, scale, and units) used by camlib_display_RefreshScreenImage().
fX | X value for the viewport center of the Screen image. |
fY | Y value for the center of the Screen image. |
fPixelScale | Viewport scale used for the Screen image. |
sUnits | Viewport units used for the Screen image. |
int camlib_display_InitializeScreenImage | ( | char * | png_image_path, |
int | nWidth, | ||
int | nHeight | ||
) |
Assigns the "Screen Image" path, width, and height.
Requires that you first initialize with camlib_display_RefreshScreenImage() before using camlib_display_RefreshScreenImage().
png_image_path | Location of refresh image. |
nWidth | Width of refresh image. |
nHeight | Height of refresh image. |
int camlib_display_LevelOfDetail | ( | int | value | ) |
Allows CAM Library to only display figures in the exported images greater than the defined pixel size. Essientially whenever an image is exported if the figures appears smaller than the pixel value, they will be omitted from the image.
value | Assign the minimum size (in pixels) of an figure to be displayed in an exported image. Set to 0 for all figures to pass. |
int camlib_display_Overlay | ( | int | value | ) |
Set the display overlay for the design. Default is 0 (no overlay).
Essientially whenever there are multiple layers, any regions where overlap occurs will either be translucent (i.e see-through) or solid (opaque).
value | Set to 0 for Solid Opaque overlay. Set to 1 for a Translucent (see-through) overlay. |
int camlib_display_Polarity | ( | int | value | ) |
Set the display polarity for the design. Default is 0.
value | Set to 0 for a Black background on exported images. Set to 1 for a White background on exported images. |
int camlib_display_RefreshScreenImage | ( | ) |
Generates a new "Screen Image" using the current viewport. Perfect for quickly generating an update snapshot screen image of the current viewport. Anytime the design viewport changes, such as zoom in/out, layers on/off, fill on/off use the command to quickly generate a new image. Requires that you first call camlib_display_RefreshScreenImage() and assign the refresh image path, width and height.
int camlib_display_ZoomAll | ( | ) |
Zoom out to the extents of the active design.
int camlib_display_ZoomIn | ( | int | mouseX, |
int | mouseY | ||
) |
Zoom in 2X magnification using the give coordinates as the center.
mouseX | X value (in pixels) used for the center of the zoomed in region. |
mouseY | Y value (in pixels) used for the center of the zoomed in region. |
int camlib_display_ZoomOut | ( | int | mouseX, |
int | mouseY | ||
) |
Zoom out 0.5X magnification using the give coordinates as the center.
mouseX | X value (in pixels) used for the center of the zoomed out region. |
mouseY | Y value (in pixels) used for the center of the zoomed out region. |
int camlib_display_ZoomPan | ( | int | XOffset, |
int | YOffset | ||
) |
Zoom to a new center. The image magnification stays the same.
XOffset | X value for the new center. |
YOffset | Y value for the new center. |
int camlib_display_ZoomWindow | ( | int | nLeft, |
int | nBottom, | ||
int | nRight, | ||
int | nTop | ||
) |
Zoom to a defined rectangular region.
nLeft | Left value (in pixels) used for the rectangular region. |
nBottom | Bottom value (in pixels) used for the rectangular region. |
nRight | Right value (in pixels) used for the rectangular region. |
nTop | Top value (in pixels) used for the rectangular region. |