Changes between Version 8 and Version 9 of rp_xml_ele_flow


Ignore:
Timestamp:
Sep 12, 2013, 6:59:23 PM (4 years ago)
Author:
ldelgass
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • rp_xml_ele_flow

    v8 v9  
    1515           ...more...
    1616       </flow>
    17        <mesh>mygrid</mesh>
     17       <extents>3</extents>
     18       <mesh>unirect3d(mygrid)</mesh>
    1819       <values>...more...</values>
    1920    <component>
     
    4041           ...more...
    4142      </flow>
     43      <extents>3</extents>
    4244      <mesh>unirect3d(mygrid)</mesh>
    4345      <values>...more...</values>
     
    6971
    7072The '''{{{<particles>}}}''' element
    71 lets you define the particle color and size. You can also define the
     73lets you define the particle color, size and default visibility. You can also define the
    7274axis and position of the plane along the axis.
    7375
     
    8385    <color>lightgreen</color>
    8486    <position>10%</position>
    85     <size>1.0</size>
     87    <size>2.0</size>
     88    <hide>no</hide>
    8689  </particles>
    8790  <particles id="right">
     
    9194    <color>khaki</color>
    9295    <position>90%</position>
     96    <size>1.0</size>
     97    <hide>yes</hide>
    9398  </particles>
    9499</flow>
    95100}}}
    96101
    97 Flows may also contain boxes that defined a rectangular region.
     102Flows may also contain boxes that define a rectangular region.
    98103A flow can have any number of boxes.  The '''{{{<box>}}}''' element
    99 lets you define the color, position, and visibility of the box.
     104lets you define the color, corner positions, line width and default visibility of the box.
    100105
    101106Example of flow with a box:
     
    110115    <corner id="2">10 10 10</corner>
    111116    <color>lightgreen</color>
    112     <position>10%</position>
    113     <size>1.0</size>
     117    <linewidth>2</linewidth>
     118    <hide>no</hide>
    114119  </box>
    115120</flow>
     
    135140}}}
    136141
    137 Descriptions of each element:
     142Descriptions of each <flow> element:
    138143
    139144 '''{{{field.component.flow.axis}}}'''::
     
    144149 is the text displayed along the x-axis. 
    145150 '''{{{field.component.flow.position}}}'''::
    146  is the position of the streams plane along the defined axis.
     151 is the position of the streams plane along the defined axis as a percentage.
    147152 '''{{{field.component.flow.volume}}}'''::
    148153 is a boolean indicating if the vector field volume should be displayed. The default is yes.
    149154 '''{{{field.component.flow.outline}}}'''::
    150  is a boolean indicating if the outline around the vector field
    151 should be displayed. The default is no.
     155 is a boolean indicating if the outline around the vector field should be displayed. The default is no.
    152156 '''{{{field.component.flow.streams}}}'''::
    153157 is a boolean indicating if the streams planes should be displayed. The default is no.
     158 '''{{{field.component.flow.arrows}}}'''::
     159 is a boolean indicating if arrow glyphs should be displayed. The default is no.
     160 '''{{{field.component.flow.duration}}}'''::
     161 is the length of the flow animation.  The default is '1:00'.
     162 '''{{{field.component.flow.speed}}}'''::
     163 is the speed of the flow animation.  The default is '1x'.
     164
     165The elements within the <unirect3d> mesh are as follows:
     166
     167 '''{{{<xaxis><label>}}}'''::
     168 is the text displayed along the x-axis.
     169 '''{{{<xaxis><min>}}}'''::
     170 is the minimum x-coordinate.
    154171 '''{{{<xaxis><max>}}}'''::
    155172 is the maximum x-coordinate.
    156173 '''{{{<xaxis><numpoints>}}}'''::
    157174 is the number of uniformly spaced points on the x-axis.
     175 '''{{{<xaxis><units>}}}'''::
     176 are the units used on the x-axis.
    158177 '''{{{<yaxis><label>}}}'''::
    159178 is the text displayed along the y-axis. 
     
    164183 '''{{{<yaxis><numpoints>}}}'''::
    165184 is the number of uniformly spaced points on the y-axis.
     185 '''{{{<yaxis><units>}}}'''::
     186 are the units used on the y-axis.
     187 '''{{{<zaxis><label>}}}'''::
     188 is the text displayed along the z-axis. 
     189 '''{{{<zaxis><min>}}}'''::
     190 is the minimum z-coordinate.
     191 '''{{{<zaxis><max>}}}'''::
     192 is the maximum z-coordinate.
     193 '''{{{<zaxis><numpoints>}}}'''::
     194 is the number of uniformly spaced points on the z-axis.
     195 '''{{{<zaxis><units>}}}'''::
     196 are the units used on the z-axis.
    166197
    167198You can see working code in the [browser:trunk/examples examples] in the [browser:trunk/examples/flow flow example] or on the hub in the directory /apps/rappture/examples/flow.