Window
Container
ContainerDrawables
MainWindow
Dialog
Panel
Canvas
PlottingPanel
GroupBox
Container elements and base classes
Containers package includes the container elements and the base classes that the library developer has to extend to create new container elements.
| Name | Description |
|---|---|
| Window
|
Base class of the classes describing windows |
| Container
|
Base class of the panels that doesn't host drawable elements |
| ContainerDrawables
|
Base class of the panels that host drawable elements |
| MainWindow
|
Main window |
| Dialog
|
Dialog window |
| Panel
|
Panel |
| Canvas
|
Drawing panel |
| PlottingPanel
|
Plotting panel |
| GroupBox
|
Interactive.src.ViewElements.Containers.WindowBase class of the classes describing windows
Window class is inherited from classes describing interactive graphic elements that create windows.
This class inherits from the IContainer class.
It contains the declaration of the parameters needed to specify the window title, its width and position.
Extends from Interfaces.IContainer (Interfaces of the classes describing containers that can't host drawable elements).
| Name | Description |
|---|---|
| LayoutPolicy | Layout policy |
| title | Text displayed as title |
| xPosition | X coordinate of the window upper left corner in pixels |
| yPosition | Y coordinate of the window upper left corner in pixels |
| Width | Window width in pixels |
| Height | Window height in pixels |
| size[2] | Window size in pixels |
| Name | Description |
|---|---|
| pLLeft | Connector of non drawable components - Parent information |
| cLRight | Connector of non drawable components - Child information |
| cLLeft | Connector of non drawable components - Parent information |
Interactive.src.ViewElements.Containers.ContainerBase class of the panels that doesn't host drawable elements
Container class is inherited from classes describing interactive graphic elements
that create panels which can't host drawables elements.
This class inherits from the IContainer class.
Extends from Interfaces.IContainer (Interfaces of the classes describing containers that can't host drawable elements).
| Name | Description |
|---|---|
| LayoutPolicy | Layout policy |
| Name | Description |
|---|---|
| pLLeft | Connector of non drawable components - Parent information |
| cLRight | Connector of non drawable components - Child information |
| cLLeft | Connector of non drawable components - Parent information |
Interactive.src.ViewElements.Containers.ContainerDrawablesBase class of the panels that host drawable elements
ContainerDrawables class is inherited from classes describing interactive graphic elements
that create panels which can only host drawables elements.
This class inherits from the IContainerDrawable class.
Extends from Interfaces.IContainerDrawables (Interfaces of the classes describing containers that only can host drawable elements).
| Name | Description |
|---|---|
| pLLeft | Connector of non drawable components - Parent information |
| cLLeft | Connector of non drawable components - Parent information |
| cRight | Connector of drawable components - Child information |
Interactive.src.ViewElements.Containers.MainWindowMain window
Creates a window where containers and interactive controls can be placed.
The view can contain only one MainFrame object.
The user can stop the simulation by closing this window.
This class inherits from Window class.
Extends from Window (Base class of the classes describing windows).
| Name | Description |
|---|---|
| LayoutPolicy | Layout policy |
| title | Text displayed as title |
| xPosition | X coordinate of the window upper left corner in pixels |
| yPosition | Y coordinate of the window upper left corner in pixels |
| Width | Window width in pixels |
| Height | Window height in pixels |
| size[2] | Window size in pixels |
| Name | Description |
|---|---|
| pLLeft | Connector of non drawable components - Parent information |
| cLRight | Connector of non drawable components - Child information |
| cLLeft | Connector of non drawable components - Parent information |
Interactive.src.ViewElements.Containers.DialogDialog window
This class, like MainFrame,
creates a window where containers and interactive controls can be placed.
This class has only two differences with MainFrame class:
simulation run doesn't stop by closing this window and there can be more than one Dialog object.
This class inherits from Window class.
Extends from Window (Base class of the classes describing windows).
| Name | Description |
|---|---|
| LayoutPolicy | Layout policy |
| title | Text displayed as title |
| xPosition | X coordinate of the window upper left corner in pixels |
| yPosition | Y coordinate of the window upper left corner in pixels |
| Width | Window width in pixels |
| Height | Window height in pixels |
| size[2] | Window size in pixels |
| varName | String variable that can be linked to the corresponding variable of a check-box in order to show and hide the window by clicking on the check-box |
| Name | Description |
|---|---|
| pLLeft | Connector of non drawable components - Parent information |
| cLRight | Connector of non drawable components - Child information |
| cLLeft | Connector of non drawable components - Parent information |
Interactive.src.ViewElements.Containers.PanelPanel
Panel model creates a panel where containers, basic elements and interactive controls can be placed.
This class inherits from Container class.
Extends from Container (Base class of the panels that doesn't host drawable elements).
| Name | Description |
|---|---|
| LayoutPolicy | Layout policy |
| row | Sets the row where the element is located if the parent has the Grid layout policy |
| column | Sets the column where the element is located if the parent has the Grid layout policy |
| rowSpan | Sets the number of rows the element spans (only appliable if the parent has the Grid layout policy |
| columnSpan | Sets the number of columns the element spans (only appliable if the parent has the Grid layout policy |
| Name | Description |
|---|---|
| pLLeft | Connector of non drawable components - Parent information |
| cLRight | Connector of non drawable components - Child information |
| cLLeft | Connector of non drawable components - Parent information |
Interactive.src.ViewElements.Containers.CanvasDrawing panel
DrawingPanel model creates a 3-dimensional container that only can contain drawable objects.
This class inherits from ContainerDrawables class.
Extends from ContainerDrawables (Base class of the panels that host drawable elements).
| Name | Description |
|---|---|
| row | Sets the row where the element is located if the parent has the Grid layout policy |
| column | Sets the column where the element is located if the parent has the Grid layout policy |
| rowSpan | Sets the number of rows the element spans (only appliable if the parent has the Grid layout policy |
| columnSpan | Sets the number of columns the element spans (only appliable if the parent has the Grid layout policy |
| setCamera | 1: the camera is positioned with the user settings; 0: the camera is automatically positioned to view every actor at initial time |
| position[3] | Where the camera is located |
| focalPoint[3] | Where the camera is pointing |
| viewUp[3] | Which direction is up |
| viewAngle | The camera view angle controls perspective effects |
| Name | Description |
|---|---|
| pLLeft | Connector of non drawable components - Parent information |
| cLLeft | Connector of non drawable components - Parent information |
| cRight | Connector of drawable components - Child information |
Interactive.src.ViewElements.Containers.PlottingPanelPlotting panel
PlottingPanel model creates a two-dimensional container with coordinate axes
that only can contain drawable objects.
This class inherits from ContainerDrawables class.
Extends from ContainerDrawables (Base class of the panels that host drawable elements).
| Name | Description |
|---|---|
| title | Title to display at the top |
| titleX | Label of the X axis |
| titleY | Label of the Y axis |
| logx | 1: plotting of Log of x-values |
| plotColor | Plot Color |
| placeLegend | true=>a legend is placed |
| legendPosition | Legend position |
| checkableLegend | true=>the traces can be shown/hide by clicking the corresponding legend item |
| autoscalex | true=> x axis autoscales |
| autoscaley | true=> y axis autoscales |
| row | Sets the row where the element is located if the parent has the Grid layout policy |
| column | Sets the column where the element is located if the parent has the Grid layout policy |
| rowSpan | Sets the number of rows the element spans (only appliable if the parent has the Grid layout policy |
| columnSpan | Sets the number of columns the element spans (only appliable if the parent has the Grid layout policy |
| Name | Description |
|---|---|
| pLLeft | Connector of non drawable components - Parent information |
| cLLeft | Connector of non drawable components - Parent information |
| cRight | Connector of drawable components - Child information |
Interactive.src.ViewElements.Containers.GroupBox
A GroupBox provides a frame, a title, and displays various other widgets inside itself.
This class inherits from Container class.
Extends from Container (Base class of the panels that doesn't host drawable elements).
| Name | Description |
|---|---|
| LayoutPolicy | Layout policy |
| title | Frame title |
| flat | By default a group box has a surrounding frame, with the title being placed on the upper frame line. In flat mode the right, left and bottom frame lines are omitted, and only the thin line at the top is drawn |
| row | Sets the row where the element is located if the parent has the Grid layout policy |
| column | Sets the column where the element is located if the parent has the Grid layout policy |
| rowSpan | Sets the number of rows the element spans (only appliable if the parent has the Grid layout policy |
| columnSpan | Sets the number of columns the element spans (only appliable if the parent has the Grid layout policy |
| Name | Description |
|---|---|
| pLLeft | Connector of non drawable components - Parent information |
| cLRight | Connector of non drawable components - Child information |
| cLLeft | Connector of non drawable components - Parent information |