classes
action menu_action save_name view
color menu_tool select view_count
color_all point_mark show
color_list point_mark_remove size
flush printfile unmap
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.
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.
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.
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.
Shape
SYNTAX
.flush()
DESCRIPTION
Redraws all views into this scene.
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.)
Shape
SYNTAX
.select()
DESCRIPTION
Colors red the currently accessed section.
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.
Shape
SYNTAX
.color(i)
DESCRIPTION
colors the currently selected section according to color index
(index same as specified in Graph class). If there are several
sections to color is is more efficient to make a SectionList and
use .color_list
Shape
SYNTAX
.color_all(i)
DESCRIPTION
colors all the sections
Shape
SYNTAX
.color_list(SectionList, i)
DESCRIPTION
colors the sections in the list
Shape
SYNTAX
.point_mark(objvar, colorindex)
DESCRIPTION
draw a little mark 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)
Shape
SYNTAX
.point_mark_remove([objvar])
DESCRIPTION
With no arg, removes all the point process marks.
Shape
SYNTAX
.save_name("name")
DESCRIPTION
The objectvar
used to save the scene when the print window
manager is used to save a session.
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.
Shape
SYNTAX
.printfile("filename")
DESCRIPTION
prints the first view of the graph as an encapsulated post script
file
Shape
SEE ALSO
menu_action
Shape
SEE ALSO
menu_tool
neuron/neuron/classes/shape.hel : Dec 19 1996