SclDraw

• line - to draw a line
• marker - to draw a marker
• polygon - to draw as a colour filled polygon - only if coplanar
• x, y, z, d1, d2, ... - to draw the specified point attribute
• <attribute name><alignment code> - draw the specified attribute at the point but offset according to the alignment codes <, >, ^, v, * to indicate left, right, top, bottom or centre justified respectively in any meaningful combination
• <attribute name>/<spacing>/<text size> - to draw the specified attribute at a defined frequency along a segment at a text height in real world units
• arrow/<spacing>/<text size> - to draw a special arrow marker at a defined frequency along a segment at a text height in real world units

Note: the spelling determines the colour to be used for various characteristics. Multiple HGS_color definitions can be used, each to define the colour of different aspects if they must be different. Colour names may be any of the crayola colour names or colour name combinations used in Surpac or, an RGB colour can be used if required.

RGB colour names can be defined by replacing the colour name in the examples with something of the form R=value G=value B=value where value ranges between 0 and 1.

• faces=colour name
• edges=colour name
• lines=colour name
• text=colour name
• faces=colour name
• faces=(diffuse=colour name,specular=colour name, transmission=colour name,gloss=factor)
• lines=edges=faces=text= colour name

• ----
• - -
• ....
• -.-.
• -..-..
• -...
• -- --
• center
• phantom

The symbolic representation for the line may have an optional prefix to define how the line ends and optional suffix to define how line joins (at changes in direction) are represented. Permitted line end and join symbols are:

• | - a butt line end cap
• [ - a square line end cap
• ( - a round line end cap
• ] - a bevel line join
• > - a mitre line join
• ) - a round line join

The line end and join styles are generally not noticeable unless thick lines are used.

• solid
• ##
• ||
• ==
• \\
• //
• ::
• <><>
• [][]

• *
• x
• +
• .

Hollow marker symbols are:

• []
• ()
• <>
• |>
• <|
• /\
• /_\

The basic and hollow marker symbols can be combined to give interesting combinations like:

• (.)
• (x)
• [*]
• |*>
• (())
• <+>
• and so on.

• name=<font name>
• size=<font size>
• slant=<slant angle>

Text font names are variable but names that usually always exist include:

• roman
• sans serif
• typewriter
• stroked
• Newfield
• Enfield
• Brooktondale

Font size is defined as a number and units. The number is any valid floating point number. The units, using a mnemonic code, determine how the size is used. Permitted unit codes for font size are:

• oru - object relative units i.e. real world units
• sru - subscreen relative units - a fraction of the height of the containing window
• point - As in units used by type setters, i.e. 12 point font.
• pixels - Expressed directly in pixels, i.e. 10 pixels high

Slant angle is a single floating point number that permits the slant of the text, i.e. the angle off vertical, to be defined. A text slant of 0 will give vertical text while a value of 10 degrees will give an italic looking font. The slant angle must be between -75 and + 75 degrees.

# 
# This example requires files called draw1.str and draw1.dtm that
# contain at least string 1 and 2 each with multiple segments and
# triobjects 1 and 2.
# 
# The example shows how SclDraw and SclErase can be used.
# 
# 
SclCreateSwa swa "main graphics layer"
$swa SclSwaOpenFile "draw1.dtm"
SclFunction "ZOOM ALL" {}
$swa SclGetStrings strings
# Draw all strings as lines using RGB colour definition
puts "Press a key to draw all strings as lines using RGB colour definition"
SclPause
$strings SclDraw "style=ssi_method=line,HGS_color=line=text=marker=R=1 G=0 B=1"
puts "Press a key to erase the strings"
SclPause
$strings SclErase
# Draw all strings 1 and 2 only as lines with markers using a colour name
puts "Press a key to draw strings 1 & 2 as lines with markers using a colour name"
SclPause
$strings SclDraw "range=1,2" "style=ssi_method=line|marker,HGS_color=line=green,HGS_color=marker=blue"
# just erase string 2
puts "Press a key to erase string 2"
SclPause
$strings SclErase 2
puts "press a key to clear the screen"
SclPause
SclFunction "CLEAR SCREEN" {}
# draw segment string 1 with markers and Z values
puts "Press a key to draw string 1 with markers and Z values"
SclPause
$swa SclCreateString string 1
$string SclDraw "style=ssi_method=marker|z*,HGS_color=marker=pink,HGS_color=text=black,\
HGS_text_font=name=roman|size=0.02 sru"
# window in to have a closer look at the text
SclFunction "WINDOW IN" {}
# zoom all to see everything again
SclFunction "ZOOM ALL" {}
puts "Press a key to erase segment 2 of string 1"
SclPause
$string SclErase 1
puts "press a key to clear the screen"
SclPause
SclFunction "CLEAR SCREEN" {}
# drawing and erasing of a single segment
puts "Press a key to draw segment 1 of string 1"
SclPause
$string SclCreateSegment segment 0
$segment SclDraw 
puts "Press a key to erase segment 1 of string 1"
SclPause
$segment SclErase 
$swa SclGetTriobjects triobjects
# draw triobjects with different face and edge colours
puts "Press a key to draw all triobjects with different face and edge colour and face pattern"
SclPause
$triobjects SclDraw "style=HGS_color=face=green,HGS_color=edge=pink,HGS_face_pattern=##"
puts "Press a key to erase triobject 2"
SclPause
$triobjects SclErase 2
puts "press a key to clear the screen"
SclPause
SclFunction "CLEAR SCREEN" {}