Skip to content

GitLab

Commit 221ec4f4 authored by Florian Hölzl's avatar Florian Hölzl
Browse files

help for advanced operator panels 

refs 907
parent e41fc7d6
Hide whitespace changes
Inline Side-by-side
org.fortiss.af3.rcp.application/trunk/html/operatorpanels_advanced.html 0 → 100644
View file @ 221ec4f4
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<!--
Documentation of advanced Operator Panel items.
@author hoelzl
@author $Author$
@version $Rev$
@ConQAT.Rating GREEN Hash: 3AFBF8C56016F51D583B0752DAF8159F
-->
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
<title>Advanced OperatorPanel items in AutoFOCUS3 (AF3)</title>
</head>
<body>
<h2><u><font color="#336699">Advanced Operator Panels Items</font></u></h2>
The following explanations assume that you are familiar with the basics of
<A HREF="operatorpanels.html">Using Operator Panels</A>.
Use the <B>Operator Panel Example</B> model from the file menu to access the model used here.
This tutorial covers the following operator panel items:
<I>2D Area Input</I>, <I>2D Graph Viewer</I>, <I>3D Viewer</I>
<br>
<br>
<img src ="./pictures/opa-items.png">
<br>
<br>
<h4><font color="#336699">2D Area Input</font></h4>
<P>
The 2D area input item allows to user to move a cursor within a rectangular or quadratic area
and thereby select two input values at the same time.<BR>
For example, this input item can be used to model a steering stick or joystick.<BR>
<P>
The area input works for three different types: <I>boolean</I>, <I>int</I>, and <I>double</I>.<BR>
The following picture shows the simulation view of the area input item for each type.<BR>
During the simulation the black circular cursor can be moved by <B>dragging</B> the mouse across the input area.<BR>
<br>
<br>
<img src ="./pictures/opa-area-input-sim.png">
<br>
<br>
<B>Double-clicking</B> in one of the grid areas makes the cursor jump to the minimum, center, and maximum value of the area input.<BR>
For example, the center grid of the int type item makes the cursor jump to the (0,0) location, while the upper-right grid makes it jump to the (100, 100) location.<BR>
<P>
For the boolean type item the exact location of the cursor is not relevant, only the grid is evaluated and interpreted as one of the
three possible port values: <I>false</I>, <I>NoVal</I>, or <I>true</I>.<BR>
For the int and double type item the exact position of the cursor is interpreted with the respective interval (-100 to 100, or 0.0 to 1.0).<BR>
<P>
The following picture shows the property section of the area input item:
<br>
<br>
<img src ="./pictures/opa-area-input-prop.png">
<br>
<br>
In the <B>type</B> field the item type is specified. Enter <I>boolean</I>, <I>int</I>, or <I>double</I> here.<BR>
In the <B>output</B> field the port values are assigned by using the user input stored in the <I>_this_X</I> and <I>_this_Y</I> variables.<BR>
Here, you can scale the input to the values required by the application or you can use the raw value and add another component to your system, which does the scaling.<BR>
Note that the display of the area input will always show the values depicted above, not the values you compute for output ports.<BR>
Therefore, the second option is possibly the more intuitive one, since the user will see his entered values directly on the output channels.<BR>
<h4><font color="#336699">2D Graph Viewer</font></h4>
The 2D Graph Viewer output item allows to plot numeric values with an oscilloscope-like display.<BR>
The following picture shows the simulation output of the 2D graph viewer item.
Note that it may take a few seconds to initialize the OpenGL font, the first time you open this simulation view.
<br>
<br>
<img src ="./pictures/opa-graph-viewer-sim.png">
<br>
<br>
The input to this component over time is a counter from 0 to 360 degree, which is plotted in the graph view from -180 to +180.<BR>
The following picture of the property section of the 2D graph viewer item shows how this output is computed:<BR>
<br>
<br>
<img src ="./pictures/opa-graph-viewer-prop.png">
<br>
<br>
In the <B>type</B> field the item type is specified. Enter <I>boolean</I>, <I>int</I>, or <I>double</I> here.<BR>
In the <B>sample value</B> field the displayed value is computed from the input port values.<BR>
The <B>samples per grid</B> value specifies how many time steps should be displayed in each horizontal section of the grid.<BR>
The <B>levels per grid</B> value specifies how many value units should be displayed in each vertical section of the grid.<BR>
In the <B>line color</B> field you can specify the red, green, and blue color component of the line color (each value is between 0.0 and 1.0).<BR>
In the <B>number of horizontal grids</B> field you specify how many grid fields should be displayed horizontally. Adapt this value to the size you have chosen for the panel item. Enter one to get rid of the grid. <BR>
In the <B>number of vertical grids</B> field you specify how many grid fields should be displayed vertically above and below the horizontal axis. In the example there are four grids above and four below the origin line. Again, enter one to get rid of the grid.<BR>
<h4><font color="#336699">3D Object Viewer</font></h4>
</body>
</html>
\ No newline at end of file
org.fortiss.af3.rcp.application/trunk/toc.xml
View file @ 221ec4f4
...@@ -30,8 +30,10 @@ ...@@ -30,8 +30,10 @@
</topic> </topic>
<topic href="html/mode_automaton.html" label="Mode Automatons"> <topic href="html/mode_automaton.html" label="Mode Automatons">
</topic> </topic>
<topic href="html/operatorpanels.html" label="Operator Panels"> <topic href="html/operatorpanels.html" label="Operator Panels (basic)">
</topic> </topic>
<topic href="html/operatorpanels_advanced.html" label="Operator Panels (advanced)">
</topic>
<topic href="html/platform_architecture.html" label="Platform Architectures"> <topic href="html/platform_architecture.html" label="Platform Architectures">
</topic> </topic>
<topic href="html/simulation_with_af3.html" label="Simulation"> <topic href="html/simulation_with_af3.html" label="Simulation">
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment