AutoLISP / Visual LISP - Part 1

Robert Green
CAD-Manager.com

AutoLISP/Visual LISP Part 1

Robert Green
My background
ME degree from Georgia Tech
AutoCAD user since 1985
AutoLISP programmer since 1990
Cadalyst columnist since 1998
Self confessed computer geek
Coming to you from Atlanta GA so

AutoLISP/Visual LISP Part 1

Robert Green
Lets learn some
LISP yyall!
all!

AutoLISP/Visual LISP Part 1

Robert Green
Course guide (password = LISP1)

AutoLISP/Visual LISP Part 1

Robert Green
Asking a question

AutoLISP/Visual LISP Part 1

Robert Green
Some fundamentals
LISP LISt Processor
Everything is in lists

AutoLISP/Visual LISP Part 1

Robert Green
Some history
LISP is an old language
It was open source (cheap)
It made sense for AutoCAD because
AutoCAD entitles are lists
It runs without compiling (simple)
It made sense at the time (cheap)

AutoLISP/Visual LISP Part 1

Robert Green
Some advice
AutoLISP is still very valid!
A HUGE base of LISP code exists
LISP shareware is abundant
LISP does many y things
g very y easily
y as
compared to VB/VBA
LISP is weak on dialog controls
LISP is weak on graphical interfaces
View it as an 80/20 language

AutoLISP/Visual LISP Part 1

Robert Green
Key files and why they matter
LSP
Load in order
What to mess with
What not to!

AutoLISP/Visual LISP Part 1

Robert Green
All those wacky file names
ACAD20XX.LSP (XX is version)
ACAD.LSP
ACAD20XXDOC.LSP (XX is version)
ACADDOC.LSP
MENUNAME.MNL
Help
p

AutoLISP/Visual LISP Part 1

Robert Green
What do they do
They load on startup of AutoCAD
They load in a certain order (listed on
previous slide)
Some have code in them and some dont
(ACADDOC.LSP and ACAD.LSP dont as an
example)
They reside in the SUPPORT folder

AutoLISP/Visual LISP Part 1

Robert Green
So what should I do
Use ACADDOC.LSP to get started
You create your own ACADDOC.LSP so
you cant really mess it up
It loads with every
y new drawingg
Put in in the SUPPORT folder and start
hacking away
If you mess up too bad, just delete!

AutoLISP/Visual LISP Part 1

Robert Green
Syntax Basics
Lists and Arguments
Rules of AutoLISP
Variables
Functions
Accessing the command line
Special characters
User input

AutoLISP/Visual LISP Part 1

Robert Green
Lists and Arguments
(+ 20 30)
Here the + is a FUNCTION and the two numbers are
ARGUMENTS
(command line 0,0 1,1 )
Here COMMAND is the function,
function all others are ARGUMENTS

AutoLISP/Visual LISP Part 1

Robert Green
Some Rules
For every ( there is an equal and opposite ) Isaac Newton
Like this: (setq A 3.0)
Not like this: ((setq
q A 3.0))
)) or ((setq
q A 3.0

Same goes for quote marks!

Like this: (setq name Robert Green)
N t lik
Not like thi
this: (setq
( t name Robert
R b t GGreen))
(setq name Robert Green)

When formatting numbers always avoid invalid

invalid dotted pairs
pairs
Like this: (setq A 0.5)
Not like this: (setq A .5)

AutoLISP/Visual LISP Part 1

Robert Green
The New Math
Standard AutoLISP Result
8+4 ((+ 8 4) 12
8 + 2.3 (+ 8 2.3) 10.3
5.0 4.0 ((/ 5.0 4.0)) 1.25
5 4.0 (/ 5 4.0) 1.25
5.0 4 ((/ 5.0 4)) 1.25
54 (/ 5 4) 1

AutoLISP/Visual LISP Part 1

Robert Green
The New Math (cont)
Standard AutoLISP Result
(8 + 4) * 3 ((* ((+ 8 4) 3) 36

((3.0 * 5.0)) 4.0 ((/ ((* 3.0 5.0)) 4.0)) 3.75

((4 + 4)) * 3)) 2

(( ((/ ((* (+
( 4 4)) 3)) 2)) 12

AutoLISP/Visual LISP Part 1

Robert Green
The Command Line
How would you work normally?
Draw a line between two user points
Type in LINE to start the line command
Click POINT for first point location
Click
Cli k POINT for
f second d point
i t location
l ti
Type in ENTER to halt the command

InAutoLISP: (command line pause pause )

PAUSE instruction waits for the user
The is equal to hitting the ENTER key.
Why? Because thats they way it is

AutoLISP/Visual LISP Part 1

Robert Green
Whats Going On Here?
(command viewres y 5000)
(command -color
color BYLAYER)
BYLAYER )
(command -linetype set BYLAYER )
((command menu menuname.mnc))
(command viewres y pause)

Thats not so bad intuitive actually

AutoLISP/Visual LISP Part 1

Robert Green
Variables and Data Types
Real
Integer
String
User input

AutoLISP/Visual LISP Part 1

Robert Green
Variables and data types
SETQ (SET eQual)
(setq VALUE 12.7) real number
(setq VALUE 1) integer number
((setq
q VALUE Happy)
ppy ) string
g variable
(setq VALUE 1.0) - ?
((setq
q VIEWRES_VALUE
_ 5000)) - ?

AutoLISP/Visual LISP Part 1

Robert Green
Variables and Commands
(setq VIEWRES_VALUE 5000)
(
(command viewres y
y viewres_value))
What would happen in this case?
(setq VIEWRES_VALUE Happy Bday!)
(command viewres y viewres_value)
What would happen in this case?
Variable
V i bl
TYPES and d how
h they
th interact
i t t with
ith
commands are key

AutoLISP/Visual LISP Part 1

Robert Green
User Input
(getdist \nInput a distance: )
(getreal \nInput
\nInput a real number: ))
(getint \nInput number of items: )
(g
(getstringg \nInput
p text: ))
Whats the \n a line feed
Why?
y
Just because

AutoLISP/Visual LISP Part 1

Robert Green
User Input (reference handout)
(setq user_dist (getdist \nInput a distance: ))
(setq user_real (getreal \nInput a real number: ))
( t user_int
(setq i t (getint
( ti t \nInput
\ I t an integer
i t number:
b ))
(setq user_string (getstring \nInput text: ))
((setq
q wheel_dia (g
(getdist \nEnter wheel diameter: ))
))
(setq spokes (getint \nEnter number of spokes: ))

Get the idea

AutoLISP/Visual LISP Part 1

Robert Green
User functions
Speed for the user
Lower support for you
A win-win scenario
Lets put everything weve
l
learnedd into
i t action
ti tot build
b ild
some functions.

AutoLISP/Visual LISP Part 1

Robert Green
User Function Examples

((defun C:ZA ()
(command .zoom a)
(p
(princ)
)
)

AutoLISP/Visual LISP Part 1

Robert Green
User Function Examples
(defun C:VR ()
(command viewres y 5000)
)

(defun C:BL ()
(command -color BYLAYER)
(command -linetype set BYLAYER )
(princ)
)

AutoLISP/Visual LISP Part 1

Robert Green
Fillet Zero Function
Fillet Zero
((defun c:fz ()
(setvar filletrad 0.0)
((command .fillet pause
p pause))
p
(princ)
)

AutoLISP/Visual LISP Part 1

Robert Green
Improved Fillet Zero
(defun c:fz ()
((setqq old_filletrad (g
(getvar filletrad))
))
(setvar filletrad 0.0)
((command .fillet pause
p pause))
p
(setvar filletrad old_filletrad)
(p
(princ)
)
)

AutoLISP/Visual LISP Part 1

Robert Green
Auto Purge Function
Auto Purge
((defun c:atp
p ()
(command -purge a * n .qsave)
(p
(princ)
)
)

AutoLISP/Visual LISP Part 1

Robert Green
More Bits and Bytes
y

Undefine
Dot form
Redefine
Alerts
Al t
CMDECHO

AutoLISP/Visual LISP Part 1

Robert Green
Undefining
(command .undefine LINE)
((command .undefine TORUS))
Dont want them messing with a command?
Just undefine it

Now yyou can SUBTRACT from the AutoCAD

Command set in your ACADDOC.LSP file.

AutoLISP/Visual LISP Part 1

Robert Green
The DOT form
Invoke commands like this: .LINE
Note the dot . character?
This allows you to invoke a command whether it
has been undefined or not!
This is our little secret right ...

AutoLISP/Visual LISP Part 1

Robert Green
Redefining
(command .redefine LINE)
((command .redefine TORUS))
Want to be sure that a command is active?
Just redefine it

Now yyou can UNSUBTRACT from the

AutoCAD Command set with ease.

AutoLISP/Visual LISP Part 1

Robert Green
Undefining revisted
What if your users find out about REDEFINE and
start REDEFINING y your UNDEFINES?
Just undefine the redefine like this:
(command .undefine REDEFINE)
Thatll show em

AutoLISP/Visual LISP Part 1

Robert Green
Redefining
You can undefine a command and redefine it
like this:
(command .undefine TORUS)
(defun C:TORUS ()
(alert Dont use that command!)
(princ)
)

Now you do whatever you want!

AutoLISP/Visual LISP Part 1

Robert Green
What Does This Do?
(command .undefine QSAVE)
((defun c:qsave
q ()
(command -purge b * n)
((command .qsave)
q )
(princ)
)

AutoLISP/Visual LISP Part 1

Robert Green
Alerting the user
You can send a message to the user like this:

(alert Message goes here)

AutoLISP/Visual LISP Part 1

Robert Green
Command echo (CMDECHO)
Run in STEALTH mode like this:
(defun C:BL ()
(setvar cmdecho 0)
(command -color BYLAYER)
(
(command d -linetype
li t set
t BYLAYER )
(setvar cmdecho 1)
(princ)
)

AutoLISP/Visual LISP Part 1

Robert Green
Conditional operators
These functions allow
your p
y program
g to think
and react to user input.
Loops and branches form
the basis for the
conditional operators we
well
ll
look at.

AutoLISP/Visual LISP Part 1

Robert Green
IF it all starts here

(IF (TEST EXPRESSION)

(TRUE CASE)
((FALSE CASE))
)

AutoLISP/Visual LISP Part 1

Robert Green
IF Pseudo Code
A user is prompted for an integer variable
called SPOKES
If the variable has a value less than 20 then
print LESS THAN 20 to the screen
If the variable has a value greater than or
equal to 20 then print MORE THAN 20 to
the screen
th

AutoLISP/Visual LISP Part 1

Robert Green
IF Real Code
(setq spokes (getint \nEnter number of spokes: ))
(if (< spokes 20)
(alert LESS THAN 20) ; true case
(alert MORE THAN 20) ; false case
)

Note how a decision is made using a branching logic

structure

AutoLISP/Visual LISP Part 1

Robert Green
COND IF on steroids

(COND
( (TEST EXPRESSION 1) (OUTCOME) )
( (TEST EXPRESSION 2) (OUTCOME) )
( (TEST EXPRESSION 3) (OUTCOME) )
)

AutoLISP/Visual LISP Part 1

Robert Green
COND Pseudo Code
A user is prompted for an integer variable
called SPOKES
If the variable has a value less than 10 then
print SMALL WHEEL to the screen
If the variable is between 10 and 15 print
MEDIUM WHEEL
If the variable is g
greater than 15 print
p
LARGE WHEEL

AutoLISP/Visual LISP Part 1

Robert Green
COND Real Code
(setq spokes (getint \nEnter number of spokes: ))
(cond
( (< spokes 10) (alert SMALL
SMALL WHEEL
WHEEL)) )
( (and (>= spokes 10) (<= spokes 15))
(alert MEDIUM WHEEL)
)
( (> spokes 15) (alert LARGE WHEEL) )
)

This is just like an IF but with more than two possible

logic branches

AutoLISP/Visual LISP Part 1

Robert Green
WHILE Looping logic

(OBTAIN VARIABLE)
(WHILE (TEST EXPRESSION ON VARIABLE)
(Statement 1)
.
(Statement N)
)

AutoLISP/Visual LISP Part 1

Robert Green
WHILE Pseudo Code
Prompt the user for a number of spokes but
the number of spokes
p needs to be no less
than 20 for our purposes.
We need to make sure the user gives us a
valid integer number greater than or equal
to 20

AutoLISP/Visual LISP Part 1

Robert Green
WHILE Real Code

(setq spokes 0)
(while (< spokes 20)
(setq spokes (getint \nEnter number of spokes: ))
)

The WHILE function loops around until the test case is satisfied

AutoLISP/Visual LISP Part 1

Robert Green
Lets Try a Problem
Using the concepts weve
learned so far for branching
g
and looping logic.
We ll use the pseudo code
Well
approach to build our logic
as we go.

AutoLISP/Visual LISP Part 1

Robert Green
Example Problem (Pseudo Code)
Prompt the user for a number of spokes
Be sure they give you at least 8 spokes but not
more than 24 spokes
Write SMALL MEDIUM or LARGE to the screen
based on the rules we used in the COND
example

Hint:
Use WHILE to qualify the input, use
COND to evaluate the cases

AutoLISP/Visual LISP Part 1

Robert Green
Example Problem (Real Code)
(setq spokes 0)
(while (or (< spokes 8) (> spokes 24))
(setq spokes (getint \nEnter number of spokes [from 8 to 24]: ))
)

(cond
( ((< spokes
p 10)) ((alert SMALL WHEEL)) )
( (and (>= spokes 10) (<= spokes 15)) (alert MEDIUM WHEEL) )
( (> spokes 15) (alert LARGE WHEEL) )
)

AutoLISP/Visual LISP Part 1

Robert Green
Points and Lists
How do points work?
How can we d
H decompose
points and put them back
together again?

AutoLISP/Visual LISP Part 1

Robert Green
Get some points like this
(setq pt1 (getpoint \nSelect a point: ))
(setq pt2 (getpoint \nSelect
\nSelect a point: ))
))

You now have two 3D ppoints stored in the

variables PT1 and PT2

AutoLISP/Visual LISP Part 1

Robert Green
CAR, CADR and CADDR
Decompose points into their X, Y and Z
coordinates like this:
The X value of PT1 would be: (car pt1)
The Y value of PT1 would be: (cadr pt1)
The Z value of PT1 would be: (caddr pt1)

Why? CAR and CDR concatenation

Just memorize these functions

AutoLISP/Visual LISP Part 1

Robert Green
LIST: Pseudo Code
Youd like to draw a circle with an origin point
that is at the X coordinate of PT1 and the Y and
Z coordinate of PT2 (points supplied by the
user).
Further, the radius of the circle should have a
value of 11.5

AutoLISP/Visual LISP Part 1

Robert Green
LIST: Real Code
(setq pt1 (getpoint \nSelect a point: ))
(setq pt2 (getpoint \nSelect
\nSelect a point: ))
))
(command .circle
((list (car
( pt1)
p ) (cadr
( pt2)
p ) (caddr
( pt2))
p ))
11.5
)

Hint: LIST is simply

pyappoint in this case

AutoLISP/Visual LISP Part 1

Robert Green
Lets Try A Couple More Problems
Lets ramp up the
complexity
p y a bit using
g
techniques we already
know.
Ill throw in some
(command) line access to
spice it up a bit.

AutoLISP/Visual LISP Part 1

Robert Green
 Lets Draw a Wheel: Pseudo Code
Lets now beef up our wheel creating program by
adding a few more requirements. Heres the pseudo
code
d for
f the
th example:l
Prompt the user for a point for the wheel center
For small wheels use spoke length of 8,8 medium gets
10 and large gets 12
Draw a first spoke at the center point
Array the first spoke with the appropriate number of
spokes

AutoLISP/Visual LISP Part 1

Robert Green
Lets Draw a Wheel: Real Code
(setq spokes 0)
(while (or (< spokes 8) (> spokes 24))
(setq spokes (getint "\nEnter number of spokes [from 8 to 24]: "))
)
(setq wheel_center (getpoint "\nSelect center point of wheel: "))
(cond
( ((< spokes
p 10)) ((command ".line" wheel_center "@8<0"
@ ""))
))
( (and (>= spokes 10) (<= spokes 15)) (command ".line" wheel_center "@10<0" ""))
( (> spokes 15) (command ".line" wheel_center "@12<0" ""))
)
(command "-array
array" "last"
last "" "p"
p wheel_center
wheel center spokes "360"
360 "y")
y)

AutoLISP/Visual LISP Part 1

Robert Green
The Array syntax?
How did I know how to write the ARRAY logic?
Here are a few hints:
Use the ARRAY
ARRAY command so you interact with the command prompt not
a dialog box
Use the LAST object drawn to build the selection set
Use the to close the selections
Use the WHEEL_CENTER
WHEEL CENTER and SPOKES variables to pass
user input to the command line
Go through the command manually to get the sequencing
and write it down

AutoLISP/Visual LISP Part 1

Robert Green
A Better Wheel: Pseudo Code
How would you change the program to
assign
g all the spokes
p to the layer
y SPOKES
which has a color of YELLOW?

AutoLISP/Visual LISP Part 1

Robert Green
A Better Wheel: Real Code
(defun c:wheel ()
(setq spokes 0)
(while (or (< spokes 8) (> spokes 24))
(
(setq spokes
k ((getint
i "\nEnter
"\ E number
b off spokes
k [f[from 8 to 24]:
24] "))
)
(setq wheel_center (getpoint "\nSelect center point of wheel: "))
((setqq old_layer
y (g(getvar clayer))
y ))
(command "-layer" "make" "wheels" "color" "yellow" "" "")
(cond
( (< spokes 10) (command ".line" wheel_center "@8<0" ""))
( (and (>= spokes 10) (<= spokes 15)) (command ".line
line" wheel_center
wheel center "@10<0"
@10<0 ""))
))
( (> spokes 15) (command ".line" wheel_center "@12<0" ""))
)
(command "-array" "last" "" "p" wheel_center spokes "360" "y")
(setvar clayer old_layer)
(princ)
)

AutoLISP/Visual LISP Part 1

Robert Green
Working with Sets
Working with sets of
objects.
j
SSGET

AutoLISP/Visual LISP Part 1

Robert Green
Using SSGET (Pseudo Code)
Lets say that you wanted to build a program
that would find all the circles in y
your drawing.
g

First, lets draw a circle in AutoCAD and use

the GE function from the previous section to
get an idea of how the circle is constructed.

AutoLISP/Visual LISP Part 1

Robert Green
The association list
Heres the resulting list from a circle entity:

((-1 . <Entity name: 7efa0390>) (0 . "CIRCLE") (330 .

<Entity name: 7ef9ecf8>) (5 . "14A") (100 . "AcDbEntity")
(67 . 0) (410 . "Model")
Model ) (8 . "0")
0 ) (100 . "AcDbCircle")
AcDbCircle ) (10
39.9536 25.0516 0.0) (40 . 8.1027) (210 0.0 0.0 1.0))

Note the pair (0 . "CIRCLE") which indicates entity type

and (8 . "0") which indicates the layer.

AutoLISP/Visual LISP Part 1

Robert Green
 Use SSGET to Filter
Heres an example of finding all circles:
(setq circle_set (ssget "x" '((0 . "CIRCLE")) ))

Note the dotted pair (0 . "CIRCLE")

AutoLISP/Visual LISP Part 1

Robert Green
 Use SSGET for multiple Filters
Heres an example of finding circles on layer GEOM:
(setq circle_set (ssget "x" '((0 . "CIRCLE")
(8 . "GEOM"))
GEOM )) )
)

Note: Its all about using dotted pairs to stack up

filtering criteria like entity type or layers

AutoLISP/Visual LISP Part 1

Robert Green
What would this find?
(setq circle_set
((ssget
g "x" '((0
(( . "CIRCLE")) (62
( . 2))
)) )
)

Hint: Nobody has this stuff memorized, you

can find information on the formats in
AutoCADs Developers Help section or use
the GE function to figure it out.

AutoLISP/Visual LISP Part 1

Robert Green
 What would these statements do?

(setq circle_set (ssget "x" '((0 . "CIRCLE") (62 . 2)) ))

(command "erase"
erase circle_set
circle set ""))

Note: You can use the set with any AutoCAD command with
the convenience of storing the sets as variables that you can
create with filters.

AutoLISP/Visual LISP Part 1

Robert Green
 What would these statements do?

(setq circle_set (ssget "x" '((0 . "CIRCLE") (62 . 2)) ))

(command "change" circle_set "p" "la" "temp" "")

AutoLISP/Visual LISP Part 1

Robert Green
Challenge:

Could you write a program that would ask the user for a layer
name then
th change
h allll objects
bj t ffound
d on th
thatt llayer ((assuming
i
it exists) to the layer NEW that has a color of GREEN?

Pseudo code:
Prompt for layer name
Find objects on layer
Use LAYER to create new layer
Use CHANGE to change objects

AutoLISP/Visual LISP Part 1

Robert Green
More Bits and Bytes
Loading programs
Centralized loading
VLIDE environment
Compiling

AutoLISP/Visual LISP Part 1

Robert Green
VLIDE environment
You can write code in the VLIDE window like
this:

AutoLISP/Visual LISP Part 1

Robert Green
Compile your code
Use the VLIDE environment like this:
(vlisp-compile st
st c:\\test\\myprog
c:\\test\\myprog.lsp
lsp))

Youll g
get MYPROG.FAS as a result

AutoLISP/Visual LISP Part 1

Robert Green
Load compiled code
Use a LOAD statement like this:
(load c:\\test\\myprog
c:\\test\\myprog.fas
fas))

Now y
your LSP code is secure!
Be sure not to lose your LSP code though!

AutoLISP/Visual LISP Part 1

Robert Green
 Questions?

AutoLISP / Visual LISP - Part 1

Robert Green
CAD-Manager.com

AutoLISP/Visual LISP Part 1

Robert Green