Search:     Advanced search

Graphics Routines

Article ID: 69
Last updated: 22 Sep, 2010
Views: 1322
Posted: 12 Jun, 2008
by Ramsey M.
Updated: 22 Sep, 2010
by Murray D.

Here is a list of available graphics routines:

procedure ImageRefresh
Description

Refreshes the current image.  This repaints to the screen to show any newly created items, notes, etc.  

 

Note: This procedure is automatically called after a script executes.

 
Example
ImageRefresh
 
function ImageWidth
Description

Returns the width of the current image.  If the image is a raster or bitmap image such as TIF, then this would be the width of the image in pixels.  If the image is a vector format (such as DXF, or DWG), then this value will vary depending on the default units in that drawing.

 

Note: This does not return the scaled width of the page.  If you would like the overall width of the page in Feet, then you will need to multiply it by the ScaleX variable.

Also, since pages can be scaled both horizontally and vertically to compensate for out-of-proportion scans, you will need to multiply any width or X variables by ScaleX, and any height or Y variables by ScaleY.

 
Example
PageWidthInFeet = ImageWidth * ScaleX
 
function ImageHeight
Description

Returns the height of the current image.  If the image is a raster or bitmap image such as TIF, then this would be the height of the image in pixels.  If the image is a vector format (such as DXF, or DWG), then this value will vary depending on the default units in that drawing.

 

Note: This does not return the scaled height of the page.  If you would like the overall height of the page in Feet, then you will need to multiply it by the ScaleY variable.

Also, since pages can be scaled both horizontally and vertically to compensate for out-of-proportion scans, you will need to multiply any width or X variables by ScaleX, and any height or Y variables by ScaleY.

 
Example

PageHeightInFeet = ImageHeight * ScaleY

 
function RandomColor
Description
Returns a new color.
 
Example
SetItemColor(CurrentItem, RandomColor)
 

This example would change the color of the currently selected item to a random color. Each time the script was executed it would return a different color.

 
function RGB(Red, Green, Blue)
Description
Returns a color.
 
Parameters
Red

This is a integer value to represent the value for Red in the color.

 
Green

This is a integer value to represent the value for Green in the color.

 
Blue

This is a integer value to represent the value for Blue in the color.

 
Example
SetItemColor(CurrentItem, RGB(230,230,250))
 

This example would change the color of the currently selected item to a lavender color.

 
This article was:  
Prev  Not what you're looking for? Suggest a topic  Next
Form and Component Routines     Item Property Routines