TinkerCell Core 1.0
TinkerCell's Core library providing all basic functionalities
Class List
Here are the classes, structs, unions and interfaces with brief descriptions:
Tinkercell::AbstractInputWindowClasses that inherit from this class can be used as GUI windows that provide interface to C programs (library files)
Tinkercell::AddControlPointCommandAn command that adds a new control point to a connection item; it has undo and redo functionality
Tinkercell::AddCurveSegmentCommandAn command that adds a new control point to a connection item; it has undo and redo functionality
Tinkercell::ArrowHeadItemA node graphics item that is used to draw arrow heads on connection items
Tinkercell::AssignHandleCommandThis command assigns handles to items
Tinkercell::C_API_SlotsA set of slots that are called by C libraries
Tinkercell::Change2DataCommand< T1, T2 >Changes two different data tables
Tinkercell::ChangeArrowHeadDistanceCommand for changing distance between arrowhead and objects
Tinkercell::ChangeBrushAndPenCommandThis command changes the pen and/or brush of an item
Tinkercell::ChangeBrushCommandThis command changes the brush of an item
Tinkercell::ChangeDataCommand< T >This template class allows undo and redo of a change made to a data table
Tinkercell::ChangeParentCommandThis command changes the parent of a graphics item (not handles)
Tinkercell::ChangePenCommandThis command changes the pen of an item
Tinkercell::ChangeZCommandThis command changes the pen of an item
Tinkercell::CodeEditor
Tinkercell::CommandTextEditA command-line type text box that other tools can use for scripting interface
Tinkercell::CompositeCommandThis command can be used to combine multiple commands into one command
Tinkercell::ConnectionFamilyThis class defines the family of a connection. Inherits from ItemFamily It contains a list ofConnectioGraphicsItems that is the default for this family of connections
Tinkercell::ConnectionGraphicsItemA graphics nodes item that draws connection between two or more nodes and the arrow heads at the ends
Tinkercell::ConnectionHandleThe handles are used to bring together data and graphics items. Connection Handle contains pointers to all the graphics items that belong to it, the tools that apply to this item, the data for this item, the family that it belongs with, and pointers to nodes connected (in and out)
Tinkercell::ConsoleWindowUsed to create an output window that can display outputs
Tinkercell::NodeGraphicsItem::ControlPointControl point with a pointer to a NodeGraphicsItem
Tinkercell::ConnectionGraphicsItem::ControlPointA control point with a pointer to a ConnectionGraphicsItem
Tinkercell::ControlPointA simple circle or square that is used for changing specific locations
Tinkercell::Core_FtoSFunction to Signal converter for MainWindow
Tinkercell::CThreadThis class is used to run specific functions inside a C dynamic library as a separate thread. The class can be used to load a library or just run a specific function inside an already loaded library. If the library is loaded by this class, the library will be unloaded upon completion on the function. To prevent the automatic unloading, use the setAutoUnload option. Only four types of functions are supported
Tinkercell::ConnectionGraphicsItem::CurveSegmentA set of control points and two arrow heads
Tinkercell::DataTable< T >DataTable is a 2D vector with row names and column names
Tinkercell::DroppableTabWidget
Tinkercell::GlobalSettingsThis class stores global variables such as project names, enables/disabled feature, etc. Use the following static bools to enable or disable features: ENABLE_HISTORY_WINDOW ENABLE_CONSOLE_WINDOW ENABLE_GRAPHING_TOOLS ENABLE_CODING_TOOLS ENABLE_ALIGNMENT_MENU ENABLE_COLOR_TOOLBAR ENABLE_ZOOM_TOOLBAR ENABLE_TEXT_TOOLBAR ENABLE_PYTHON ENABLE_RUBY ENABLE_OCTAVE ENABLE_LOADSAVE_TOOL
Tinkercell::GraphicsSceneThe primary task of the graphics scene is to draws items. All interactions with the GraphicsScene is done through MainWindow or NetworkHandle. NetworkHandle provides functions such as move, insert, and remove. MainWindow relays all the signals, such as mouse and key events, from the GraphicsScene. So, there is rarely a need to directly interact with the GraphicsScene
Tinkercell::GraphicsViewGraphicsView class that is used to view the contents of a GraphicsScene. The class inherits from QGraphicsView
Tinkercell::HistoryWindowThis is a small class extending QUndoView that manages a stack of undo commands
Tinkercell::InsertGraphicsCommandThis command performs an insert and allows redo/undo of that insert
Tinkercell::InsertHandlesCommandThis command inserts new handles to a NetworkHandle
Tinkercell::ItemDataThis class is used to store information about nodes or connections. It contains a hashtable of data tables, which is used by different tools to store specific data. The versions queue can be used to keep previous versions of the data
Tinkercell::ItemFamilyThis class defines the family of a node or connection. The class contains the icon for the family, family name, and minimal data that defines the family. Each family has a name, which is internally converted to an integer (ID) The ID is used to perform isA checks, thus avoiding repeated string matches
Tinkercell::ItemHandleThe ItemHandle represents a complete object in the network, whether it is a node or a connection. The ItemHandle contains the name of the object and pointers to all the QGraphicsItems that are used to represent the object. Tools associated with the object can be stored within the ItemHandle as well. The ItemHandle can also optionally contain an ItemFamily, which can be used to distinguish different types of nodes or connections, if needed. Each ItemHandle can contain one parent. Several functions are available for convinently getting the parents and children of an ItemHandle
Tinkercell::LineNumberArea
Tinkercell::LineTypeChangedCommand for changing line type of connections
Tinkercell::MainWindowMainWindow is the parent container for all the other widgets in TinkerCell The central widget in MainWindow is a tab widget. Each tab widget can hold a GraphicsView or a TextEditor. One of the main roles of MainWindow is to serve as a signal/slot hub for Tools
Tinkercell::MergeHandlesCommandThis command places all the graphics items inside one handle into the other
Tinkercell::MoveCommandThis command performs a move and allows redo/undo of that move
Tinkercell::MultithreadedSliderWidgetThis class is used to run specific functions inside a C dynamic library as a separate thread. Uses CThread to call the C functions
Tinkercell::NetworkHandleA class that is used to store a network. The network is a collection of Item Handles. The history stack is also a key component of a network. The network can either be represented as text using TextEditor or visualized with graphical items in the GraphicsScene. Each node and connection are contained in a handle, and each handle can either be represented as text or as graphics. The two main components of NetworkWindow are the SymbolsTable and HistoryStack This class provides functions for inserting items, removing items, and changing information inside the model
Tinkercell::NetworkWindow
Tinkercell::NodeFamilyThis class defines the family of a node. Inherits from ItemFamily. It contains a list of NodeGraphicsItems that is the default for this family of nodes
Tinkercell::NodeGraphicsItemA simple figure made from one or more polygons. The class can be represented in an XML file
Tinkercell::NodeHandleThe handles are used to bring together data and graphics items. Node Handle contains pointers to all the graphics items that belong to it, the tools that apply to this item, the data for this item, and the family that it belongs with
Tinkercell::OntologyA set of node and connection families. All functions are static
Tinkercell::PopupListWidgetDelegateDelegate used inside the SimpleInputWindow
Tinkercell::PopupListWidgetDelegateDialogDialog for list widget
Tinkercell::ProcessThreadThis class is used to run a process (command + args) as a separate thread as a separate thread
QUndoCommand
Tinkercell::RemoveControlPointCommandA command that removed control points. Allows undo and redo
Tinkercell::RemoveCurveSegmentCommandA command that removed control points. Allows undo and redo
Tinkercell::RemoveGraphicsCommandThis command performs an removal and allows redo/undo of that removal
Tinkercell::RemoveHandlesCommandThis command inserts new handles to a NetworkHandle
Tinkercell::RenameCommandThis command changes the name of the handle of an item. important: use full name of the items!
Tinkercell::ReplaceConnectedNodeCommandThis command replaces one node item in a connection item with another
Tinkercell::ReplaceNodeGraphicsCommandThis command can be used to replace the graphical representation of a node from an xml file
Tinkercell::ReverseUndoCommandThis command can be used to invert another undo command (i.e. flip the redo/undo)
Tinkercell::SetGraphicsSceneVisibilityCommandThis command is used to hide graphics items. Hidden graphics items will be part (unless their handles are also hidden) of the network but not visible on the screen
Tinkercell::SetHandleFamilyCommandThis command is used to hide graphics items. Hidden graphics items will be part (unless their handles are also hidden) of the network but not visible on the screen
Tinkercell::SetParentHandleCommandThis command assigns parent(s) to one or more handles
Tinkercell::NodeGraphicsItem::ShapeA closed polygon path made from arcs, lines, and beziers
Tinkercell::SimpleInputWindowUsed to create an input window that can receive user inputs for C plugins
Tinkercell::SymbolsTableThe symbols table is updated every time the scene or text editor changes. The symbols table contains the list of item names and ItemHandle pointers as well as names and pointers to each data entry in each item
Tinkercell::TextEditorThis is the window that allows used to construct networks using text, as opposed to graphics, which is done by GraphicsScene. The TextEditor requires a supporting tool that parses the text and calls the itemsInserted or itemsRemoved methods. Without a supporting parser tool, the TextEditor will not do anything
Tinkercell::TextGraphicsItemEditable text item
Tinkercell::TextUndoCommandThis command performs a text change
Tinkercell::ToolEverything other than the main window is a tool
Tinkercell::ToolGraphicsItemTools that are drawn on the scene instead of displayed as a window
Tinkercell::TransformCommandThis command changes the size, angle, and orientation of an item
Tinkercell::UnitA unit of measurement
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines