OOF2: The Manual
At its heart, OOF2 is driven by a set of commands. These commands are arranged hierarchically into menus. A menu is a list of commands, or of submenus, or both. Don't confuse this sense of the word “menu” with the kind of pull-down menu that appears in a graphical user interface. The menus that appear in the OOF2 graphical user interface are derived from the underlying command menus, but there are commands that don't appear in pull-down menus. However, every action taken in the interface corresponds to a command, and the scripts that OOF2 saves and loads are simply lists of commands. Therefore, to find out how things really work, it's necessary to learn the menu commands. This section contains a reference page for each of the commands, arranged hierarchically.
OOF2 menu commands are Python expressions. OOF is a Python object representing the main menu. OOF.File is one of the submenus in the main menu, and OOF.File.Quit is a command (function) in the OOF.File menu. It can be called by putting parentheses after it: OOF.File.Quit(). If you like, you can drive OOF2 by entering commands directly in the Console window (but it's probably easier to use the GUI).
Most commands take arguments. which are listed in the manual on
the reference page for each command. Arguments must be specified
as Python keyword arguments, meaning that
they are of the form
value and appear
inside the parentheses after the command name,
OOF.Skeleton.New(name='bones', microstructure='example_ms', x_elements=12, y_elements=12, skeleton_geometry=TriSkeleton(arrangement='moderate'))
The order in which the arguments appear does not matter, but each
argument value must be the correct type. In this example,
y_elements are integers, and
TriSkeleton is an example of an OOF2
RegisteredClasses also take arguments, and
the same rules apply to them.
OOF Menu Items
- OOF.ActiveArea -- Create and manipulate Active Areas.
- OOF.ActivityViewer -- Control the Activity Viewer Window.
- OOF.Copyright -- Copyright information.
- OOF.Credits -- Credits information.
- OOF.Disclaimer -- Disclaimer information.
- OOF.ElementGroup -- Create and manage ElementGroups.
- OOF.ElementSelection -- Select elements in a Skeleton.
- OOF.File -- Commands for saving and loading data, and quitting.
- OOF.Graphics_n -- Commands dependent on a particular Graphics window.
- OOF.Image -- Operations involving Images.
- OOF.LayerEditor -- Construct and modify graphics layers.
- OOF.LoadData -- Commands used in data files.
- OOF.Material -- Create Materials and assign them to pixels.
- OOF.Mesh -- Tools for creating and manipulating Meshes.
-- Create and manipulate
- OOF.Named_Analysis -- Create analysis operations that can be saved and invoked by name
- OOF.NodeGroup -- Create and manage NodeGroups.
- OOF.NodeSelection -- Select nodes in a Skeleton.
- OOF.OrientationMap -- Commands for working with Orientation Maps.
- OOF.PixelGroup -- Create and manipulate pixel groups.
- OOF.PixelSelection -- Tools for selecting pixels.
- OOF.Property -- Create, modify, and delete material properties.
- OOF.SegmentGroup -- Create and manage SegmentGroups.
- OOF.SegmentSelection -- Select segments in a Skeleton.
- OOF.Settings -- Global settings
- OOF.Skeleton -- Create and modify mesh Skeletons.
- OOF.Subproblem -- Tools for creating and solving sections of meshes
- OOF.Windows -- Menus for opening and raising windows.