Shape

classes
   action         flush          observe        show           
   beginline      label          point_mark     size           
   color          len_scale      point_mark_remove  unmap      
   color_all      line           printfile      view           
   color_list     mark           push_selected  view_count     
   erase          menu_action    rotate         
   erase_all      menu_tool      save_name      
   exec_menu      nearest        select
Class for making a Shape window for executing a user defined action when a section is clicked on. (When the section mode is selected from the mouse menu.) An argument of 0 will prevent default mapping of the window. If the first arg is a SectionList (then a second arg of 0 will prevent default mapping) then only the sections in the list are drawn. Shape is redrawn automatically whenever length or diameter of a section changes.

view

Shape

SYNTAX

.view(mleft, mbottom, mwidth, mheight, sleft, stop,
swidth, sheight)

DESCRIPTION

maps a view of the Shape scene. m stands for model coordinates, s stands for screen pixel coordinates where 0,0 is the top left corner of the screen.

size

Shape

SYNTAX

.size(mleft, mright, mbottom, mtop)
...

DESCRIPTION

Model coordinates for the scene. This is the "whole scene" size. Since, the aspect ratio for shape views is unity, the bounding box expressed by the arguments may not fit exactly on the screen window. The scale factor is decreased so that the first view window displays the entire bounding box with the center of the bounding box in the center of the view.

See size for other, more rarely use argument sequences.

show

Shape

SYNTAX

shape.show(mode)

DESCRIPTION

mode = 0
displays diameters
mode = 1
displays centroid. ie line through all the 3d points.
mode = 2
displays schematic. ie line through 1st and last 2d points of each section.

flush

Shape

SYNTAX

.flush()

DESCRIPTION

Redraws all views into this scene.

observe

Shape

SYNTAX

shape.observe()
shape.observe(sectionlist)

DESCRIPTION

Replace the list of observed sections in the Shape with the specified list. With no arguments, all sections are observed.

EXAMPLES

In the context of the pyramidal cell demo of neurondemo the following will change the Shape shown in the point process manager to show only the soma and the main part of the primary dendrite. 
objref sl
sl = new SectionList()
soma sl.append()
dendrite_1[8] sl.append()
Shape[0].observe(sl)

view_count

Shape

SYNTAX

.view_count()

DESCRIPTION

Returns number of views into this scene. (stdrun.hoc removes scenes from the flush_list and graphList[] when this goes to 0. If no other objectvar points to the scene, it will be freed.)

select

Shape

SYNTAX

.select()

DESCRIPTION

Colors red the currently accessed section.

action

Shape

SYNTAX

.action("command")

DESCRIPTION

command is executed whenever the user clicks on a section. The clicked section is pushed before execution and popped after. hoc_ac_ contains the arc position 0 - 1 of the nearest node.

color

Shape

SYNTAX

section shape.color(i)

DESCRIPTION

colors the currently accessed section according to color index (index same as specified in Graph class). If there are several sections to color it is more efficient to make a SectionList and use .color_list

color_all

Shape

SYNTAX

.color_all(i)

DESCRIPTION

colors all the sections

color_list

Shape

SYNTAX

.color_list(SectionList, i)

DESCRIPTION

colors the sections in the list

point_mark

Shape

SYNTAX

.point_mark(objvar, colorindex)
.point_mark(objvar, colorindex, style)
.point_mark(objvar, colorindex, style, size)

DESCRIPTION

draw a little filled circle with indicated color where the point process referenced by objvar is located. Note, if you subsequently relocate the point process or destroy it the proper thing will happen to the mark. (at least after a flush)

The optional arguments specify the style and size as in the mark method of Graph . This extension was contributed by Yichun Wei yichunwe@usc.edu.

point_mark_remove

Shape

SYNTAX

.point_mark_remove([objvar])

DESCRIPTION

With no arg, removes all the point process marks.

save_name

Shape

SYNTAX

.save_name("name")

DESCRIPTION

The objectvar used to save the scene when the print window manager is used to save a session.

unmap

Shape

SYNTAX

.unmap()

DESCRIPTION

dismisses all windows that are a direct view into this scene. (does not unmap boxes containing scenes.) unmap is called automatically when no hoc object variable references the Shape.

printfile

Shape

SYNTAX

.printfile("filename")

DESCRIPTION

prints the first view of the graph as an encapsulated post script file

menu_action

Shape

SEE ALSO

menu_action

exec_menu

Shape

SEE ALSO

exec_menu

erase

Shape

SEE ALSO

erase

erase_all

Shape

DESCRIPTION

Erases everything in the Shape, including all PointMarks and Sections.

SEE ALSO

erase_all observe point_mark

beginline

Shape

SEE ALSO

beginline

line

Shape

SEE ALSO

line

mark

Shape

SEE ALSO

mark

label

Shape

SEE ALSO

label

menu_tool

Shape

SYNTAX

s.menu_tool("label", "procname")

DESCRIPTION

Same as menu_tool for the Graph class. When procname is called it is given four arguments: type, x, y, keystate. Type = 1,2,3 means move, press, release respectively and x and are in model coordinates. Keystate reflects the state of control (bit 1), shift (bit 2), and meta (bit 3) keys, ie control and shift down has a value of 3.

SEE ALSO

menu_tool nearest push_selected

EXAMPLES

The following example will work if executed in the context of the pyramidal cell demo of the neurondemo. It colors red the section you click nearest and prints the name and position of the selected section as well as the mouse distance the selection. 
objref ss
ss = Shape[0]
proc p() {local d, a
        if ($1 == 2) {
                ss.color_all(1)
                d = ss.nearest($2,$3) 
                a = ss.push_selected()
                if (a >= 0) {
                        ss.select()
                        printf("%g from %s(%g)\n", d, secname(), a)
                        pop_section()
                }
        }
}
ss.menu_tool("test", "p")
ss.exec_menu("test")

nearest

Shape

SYNTAX

d = shape.nearest(x, y)

DESCRIPTION

returns the distance (in model coordinates) to the nearest section. The section becomes the selected section of the Shape. It is NOT pushed onto the section stack and it is NOT colored. The nearest arc position of the selected section as well as the section is available from push_section .

push_selected

Shape

SYNTAX

arc = shape.push_selected()
if (arc >= 0) {
pop_section()
}

DESCRIPTION

If there is a selection for the Shape class, then it is pushed onto the section stack (becomes the currently accessed section) and the arc position (0 to 1) returned. If no section is selected the function returns -1 and no section is pushed.

Note that it is important that a pop_section be executed if a section is pushed onto the stack.

BUGS

The arc position is relevant only if the section was selected using nearest . Note, e.g., that select does not set the arc position.

len_scale

Shape

SYNTAX

section shape.len_scale(scl)

DESCRIPTION

The drawing of the section length (currently accessed section) in the Shape scene is scaled by the factor. Diameter is drawn normally. Note that this does not change the physical length of the section but only its appearance in this Shape instance.

rotate

Shape

SYNTAX

shape.rotate()
shape.rotate(xorg, yorg, zorg, xrad, yrad, zrad)

DESCRIPTION

With no args the view is in the xy plane. With args, incrementally rotate about the indicated origin by the amount given in radians around the current view coordinates (order is sequentially about x,y,z axes)

neuron/neuron/classes/shape.hel : May 13 2012