SolidsWW Flash Applet Sample Problem 1

From WeBWorK
(Difference between revisions)
Jump to: navigation, search
 
(44 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
== Flash Applets embedded in WeBWorK questions solidsWW Example ==
 
== Flash Applets embedded in WeBWorK questions solidsWW Example ==
 
+
[[where to find WeBWorK problems like this]]
 
<h2>Sample Problem with solidsWW.swf embedded</h2>
 
<h2>Sample Problem with solidsWW.swf embedded</h2>
 
<p style="background-color:#eeeeee;border:black solid 1px;padding:3px;">
 
<p style="background-color:#eeeeee;border:black solid 1px;padding:3px;">
 
<em>This sample problem shows how to use this versatile applet.</em>
 
<em>This sample problem shows how to use this versatile applet.</em>
 
</p>
 
</p>
 +
<p style="background-color:#93BED2;border:black solid 1px;padding:3px;">This applet and WeBWorK problem are based upon work supported by the National Science Foundation under Grant Number DUE-0941388.</p>
 +
<p style="background-color:#ffccff;border:black solid 1px;padding:3px;">Click here to see a problem like this in action:  [https://testcourses.webwork.maa.org/webwork2/FlashAppletDemos/variousAppletProblems/17/?user=practice1&effectiveUser=practice1&key=vrjq1ko4hk98yC4sUICzlnTp1SYpTTJU&displayMode=MathJax&showOldAnswers=0 testcourses.webwork.maa.org/webwork2/FlashAppletDemos]</p>
 
<p>
 
<p>
 
A standard WeBWorK PG file with an embedded applet has six sections:
 
A standard WeBWorK PG file with an embedded applet has six sections:
Line 33: Line 35:
 
[[Things to consider in developing WeBWorK problems with embedded Flash applets]]
 
[[Things to consider in developing WeBWorK problems with embedded Flash applets]]
 
</p>
 
</p>
<table cellspacing="0" cellpadding="2" border="0">
+
 
<tr valign="top">
+
{| style=" background-color:#ffffff;" cellpadding="5" cellspacing="0" border="1"
<th> PG problem file </th>
+
! scope="col"  width="50%"| PG problem file
<th> Explanation </th>
+
! scope="col" width="50%"| Explanation
</tr>
+
|- style=" background-color:#ddddff;"
<tr valign="top">
+
| <pre>
<td style="background-color:#ddddff;border:black 1px dashed;">
+
<pre>
+
 
##DESCRIPTION
 
##DESCRIPTION
 
##  Solids of Revolution
 
##  Solids of Revolution
Line 58: Line 58:
 
## Section1('')
 
## Section1('')
 
## Problem1('')
 
## Problem1('')
########################################################################
+
##########################################
# This work is supported in part by the National Science Foundation  
+
# This work is supported in part by the  
 +
# National Science Foundation  
 
# under the grant DUE-0941388.
 
# under the grant DUE-0941388.
########################################################################
+
##########################################
 
</pre>
 
</pre>
</td>
+
| <p>
<td style="background-color:#ccccff; padding:7px;">
+
<p>
+
 
This is the <strong>tagging and description</strong> section of the problem.  Note that any line that begins with a "#" character is a <em>comment</em> for other authors who read the problem, and is not interpreted by WeBWorK.   
 
This is the <strong>tagging and description</strong> section of the problem.  Note that any line that begins with a "#" character is a <em>comment</em> for other authors who read the problem, and is not interpreted by WeBWorK.   
 
</p>
 
</p>
Line 76: Line 75:
 
[http://hobbes.la.asu.edu/Holt/keywords.html list of keywords].  The list of keywords should be comma separated and quoted (e.g., KEYWORDS('calculus','derivatives')).
 
[http://hobbes.la.asu.edu/Holt/keywords.html list of keywords].  The list of keywords should be comma separated and quoted (e.g., KEYWORDS('calculus','derivatives')).
 
</p>
 
</p>
</td>
+
|- style="background-color:#ddffdd;"
</tr>
+
| <pre>
<tr valign="top">
+
<td style="background-color:#ddffdd;border:black 1px dashed;">
+
<pre>
+
 
DOCUMENT();         
 
DOCUMENT();         
  
Line 89: Line 85:
 
);
 
);
 
</pre>
 
</pre>
</td>
+
| <p>
<td style="background-color:#ccffcc;padding:7px;">
+
<p>
+
 
This is the <strong>initialization section</strong> of the problem.  The first executed line of the problem <strong>must</strong> be the <code>DOCUMENT();</code> command.  Note that every command <em>must end with a semicolon</em>.
 
This is the <strong>initialization section</strong> of the problem.  The first executed line of the problem <strong>must</strong> be the <code>DOCUMENT();</code> command.  Note that every command <em>must end with a semicolon</em>.
 
</p>
 
</p>
Line 97: Line 91:
 
The <code>loadMacros</code> command loads information that works behind the scenes.  For our purposes we can usually just load the macros shown here and not worry about things further.
 
The <code>loadMacros</code> command loads information that works behind the scenes.  For our purposes we can usually just load the macros shown here and not worry about things further.
 
</p>
 
</p>
</td>
+
|- style="background-color:#ffffdd;"
</tr>
+
| <pre>
<tr valign="top">
+
<td style="background-color:#ffffdd;border:black 1px dashed;">
+
<pre>
+
 
TEXT(beginproblem());
 
TEXT(beginproblem());
 
$showPartialCorrectAnswers = 1;
 
$showPartialCorrectAnswers = 1;
Line 112: Line 103:
 
$func1 = "$a*sin(pi*y/8)+2";
 
$func1 = "$a*sin(pi*y/8)+2";
 
$func2 = "$b*sin(pi*y/2)+2";
 
$func2 = "$b*sin(pi*y/2)+2";
$xmax = max(Compute("$a+2"),Compute("$b+2"),9);
+
$xmax = max(Compute("$a+2"),
 +
  Compute("$b+2"),9);
 
$shapeType = 'circle';
 
$shapeType = 'circle';
  
$correctAnswer =Compute("64*$a+4*pi*$a^2+32*pi");
+
$correctAnswer =
 +
  Compute("64*$a+4*pi*$a^2+32*pi");
 
</pre>
 
</pre>
</td>
+
| <p>
<td style="background-color:#ffffcc;padding:7px;">
+
<p>
+
 
This is the <strong>problem set-up section</strong> of the problem.   
 
This is the <strong>problem set-up section</strong> of the problem.   
 
</p>
 
</p>
Line 125: Line 116:
 
The solidsWW.swf applet will accept a piecewise defined function either in terms of x or in terms of y.  We set <code>$xy</code> equal to y to define the function in terms of y.  The two pieces of the function are defined in the variables <code>$func1</code> and <code>$func2</code>, though any variable names beginning with the $ character will do.  The applet also needs a maximum x-value for the profile graph.  Usually you will want the <code>$shapeType</code> to be 'circle' as it is here, but other types are accepted by the applet including: 'ellipse', 'rectangle' and 'poly'.  For 'ellipse' and 'rectangle' you will need to set the ratio of the side lengths.  For 'poly' you will need to set the number of sides of the regular polygon.  They are also set in the code for this problem, but the information is ignored by the applet.
 
The solidsWW.swf applet will accept a piecewise defined function either in terms of x or in terms of y.  We set <code>$xy</code> equal to y to define the function in terms of y.  The two pieces of the function are defined in the variables <code>$func1</code> and <code>$func2</code>, though any variable names beginning with the $ character will do.  The applet also needs a maximum x-value for the profile graph.  Usually you will want the <code>$shapeType</code> to be 'circle' as it is here, but other types are accepted by the applet including: 'ellipse', 'rectangle' and 'poly'.  For 'ellipse' and 'rectangle' you will need to set the ratio of the side lengths.  For 'poly' you will need to set the number of sides of the regular polygon.  They are also set in the code for this problem, but the information is ignored by the applet.
 
</p>
 
</p>
</td>
+
|- style="background-color:#ccffff;"
</tr>
+
| <pre>
<tr valign="top">
+
#########################################
<td style="background-color:#ccffff;border:black 1px dashed;">
+
<pre>
+
##########################################################################
+
 
#  How to use the solidWW applet.
 
#  How to use the solidWW applet.
#    Purpose:  The purpose of this applet is to help with visualization of
+
#    Purpose:  The purpose of this applet  
 +
#      is to help with visualization of
 
#      solids
 
#      solids
#    Use of applet:  The applet state consists of the following fields:
+
#    Use of applet:  The applet state  
#    xmax - the maximum x-value.  ymax is 7/5ths of xmax.  the minima
+
#      consists of the following fields:
 +
#    xmax - the maximum x-value.   
 +
#        ymax is 6/5ths of xmax.  the minima
 
#        are both zero.
 
#        are both zero.
#    captiontxt - the initial text in the info box in the applet
+
#    captiontxt - the initial text in  
#    shapeType - circle, ellipse, poly, rectangle
+
#        the info box in the applet
 +
#    shapeType - circle, ellipse,  
 +
#        poly, rectangle
 
#    piece: consisting of func and cut
 
#    piece: consisting of func and cut
 
#      this is a function defined piecewise.  
 
#      this is a function defined piecewise.  
#        func is a string for the function and
+
#        func is a string for the function  
#        cut is the right endpoint of the interval over which it is defined
+
#        and cut is the right endpoint  
 +
#        of the interval over which it is  
 +
#        defined
 
#      there can be any number of pieces
 
#      there can be any number of pieces
 
#     
 
#     
##########################################################################
+
#########################################
 
#  What does the applet do?
 
#  What does the applet do?
 
#    The applet draws three graphs:  
 
#    The applet draws three graphs:  
#      a solid in 3d that the student can rotate with the mouse
+
#      a solid in 3d that the student can  
#      the cross-section of the solid (you'll probably want this to be
+
#          rotate with the mouse
#          a circle
+
#      the cross-section of the solid  
#      the radius of the solid which varies with the height
+
#          (you'll probably want this to  
##############################################################################
+
#          be a circle
 +
#      the radius of the solid which  
 +
#          varies with the height
 +
#########################################
 +
</pre>
 +
| <p>
 +
<p>
 +
This is the <strong>Applet link section</strong> of the problem. 
 +
</p><br>
 +
<p>
 +
Those portions of the code that begin the line with <code>#</code>
 +
are comments and can be omitted or replaced with comments
 +
appropriate to your particular problem.
 +
</p>
 +
|- style="background-color:#ccffff;"
 +
| <pre>
 
     ###################################
 
     ###################################
 
     # Create  link to applet  
 
     # Create  link to applet  
Line 158: Line 168:
 
     $appletName = "solidsWW";
 
     $appletName = "solidsWW";
 
     $applet =  FlashApplet(
 
     $applet =  FlashApplet(
       codebase              => findAppletCodebase("$appletName.swf"),
+
       codebase               
       appletName            => $appletName,
+
        => findAppletCodebase
       appletId              => $appletName,
+
            ("$appletName.swf"),
       setStateAlias        => 'setXML',
+
       appletName             
       getStateAlias        => 'getXML',
+
        => $appletName,
       setConfigAlias        => 'setConfig',
+
       appletId               
       maxInitializationAttempts => 10,  # number of attempts to initialize applet
+
        => $appletName,
       #answerBoxAlias        => 'answerBox',
+
       setStateAlias         
       height               => '550',
+
        => 'setXML',
       width                 => '595',
+
       getStateAlias         
       bgcolor               => '#ffffff',
+
        => 'getXML',
       debugMode             =>  0,
+
       setConfigAlias         
       submitActionScript  =>   ''
+
        => 'setConfig',
 +
       maxInitializationAttempts  
 +
        => 10,   
 +
       #answerBoxAlias         
 +
        => 'answerBox',
 +
       height     => '550',
 +
       width     => '595',
 +
       bgcolor   => '#e8e8e8',
 +
       debugMode =>  0,
 +
       submitActionScript  => ''
 
     );
 
     );
 +
</pre>
 +
| <p>
 +
<p>You must include the section that follows <code># Create 
 +
link to applet</code>.  If you are embedding a different
 +
applet, from the solidsWW applet, put your applet name in
 +
place of 'solidsWW' in the line <code>$appletName = "solidsWW";</code>. 
 +
Enter the height of the applet in the line <code>height => '550',</code>
 +
in place of 550 and the width in the line  <code>width => '595',</code>
 +
in place of 595.
 +
</p>
 +
|- style="background-color:#ccffff;"
 +
| <pre>
  
 
###################################
 
###################################
    # Configure applet
+
# Configure applet
    ###################################
+
###################################
 
   
 
   
    # configuration consists of hintState, question type, and random seed,
 
    # and x-coordinates of four points where jumps, discontinuities or cusps
 
    # occur.
 
 
     $applet->configuration(qq{<xml><plot>
 
     $applet->configuration(qq{<xml><plot>
 
<xy>$xy</xy>
 
<xy>$xy</xy>
<captiontxt>'Compute the volume of the figure shown.'</captiontxt>
+
<captiontxt>'Compute the  
<shape shapeType='$shapeType' sides='3' ratio='1.5'/>
+
          volume of the figure shown.'
 +
        </captiontxt>
 +
<shape shapeType='$shapeType'  
 +
          sides='3' ratio='1.5'/>
 
<xmax>$xmax</xmax>
 
<xmax>$xmax</xmax>
 
         <theColor>0x0000ff</theColor>
 
         <theColor>0x0000ff</theColor>
Line 193: Line 224:
 
     $applet->initialState(qq{<xml><plot>
 
     $applet->initialState(qq{<xml><plot>
 
<xy>$xy</xy>
 
<xy>$xy</xy>
<captiontxt>'Compute the volume of the figure shown.'</captiontxt>
+
<captiontxt>'Compute the  
<shape shapeType='$shapeType' sides='3' ratio='1.5'/>
+
          volume of the figure shown.'
 +
        </captiontxt>
 +
<shape shapeType='$shapeType'  
 +
          sides='3' ratio='1.5'/>
 
<xmax>$xmax</xmax>
 
<xmax>$xmax</xmax>
 
         <theColor>0x0000ff</theColor>
 
         <theColor>0x0000ff</theColor>
Line 203: Line 237:
 
</plot></xml>});
 
</plot></xml>});
  
TEXT( MODES(TeX=>'object code', HTML=>$applet->insertAll(
+
TEXT( MODES(TeX=>'object code',  
 +
  HTML=>$applet->insertAll(
 
   debug=>0,
 
   debug=>0,
 
   includeAnswerBox=>0,
 
   includeAnswerBox=>0,
Line 209: Line 244:
  
 
</pre>
 
</pre>
</td></tr>
+
| <p>
 
+
The lines <code>$applet->configuration(qq{<xml><plot></code> <code><xy>$xy</xy></code> <code><captiontxt>'Compute the volume of the figure shown.'</captiontxt></code> <code><shape shapeType='$shapeType' sides='3' ratio='1.5'/></code> <code><xmax>$xmax</xmax></code> <code><theColor>0x0000ff</theColor></code> <code><profile></code> <code><piece func='$func1' cut='8'/></code> <code><piece func='$func2' cut='10'/></code> <code></profile></code> <code></plot></xml>});</code>
<td style="background-color:#ccffff;padding:7px;">
+
and
<p>  
+
<code>$applet->initialState(qq{<xml><plot></code> <code><xy>$xy</xy></code> <code><captiontxt>'Compute the volume of the figure shown.'</captiontxt></code> <code><shape shapeType='$shapeType' sides='3' ratio='1.5'/></code> <code><xmax>$xmax</xmax></code> <code><theColor>0x0000ff</theColor></code> <code><profile></code> <code><piece func='$func1' cut='8'/></code> <code><piece func='$func2' cut='10'/></code> <code></profile></code> <code></plot></xml>});</code> configure the applet.  </p>
This is the <strong>Applet link section</strong> of the problem.  
+
</p><br>
+
 
<p>
 
<p>
Those portions of the code that begin the line with <code>#</code> are comments and can be omitted or replaced with comments appropriate to your particular problem.
+
The configuration of the applet is done in xml. 
 +
The argument of the function is set to the value held in the variable
 +
<code>$xy</code>, the captiontxt that appears initially in the information box
 +
in the applet is set to <code>Compute the volume of the figure shown.</code>,
 +
the shapeType is set to the variable <code>$shapeType</code>, sides and ratio
 +
are ignored when the shapeType is set to circle, the color is set in hexadecimal
 +
with the xml code <code><theColor>0x0000ff</theColor></code> (this can be omitted  
 +
and a default color will be used), the piecewise function is defined with the lines
 +
<code><piece func='$func1' cut='8'/></code><code><piece func='$func2' cut='10'/></code>
 +
where <code>$func1</code> and <code>$func2</code> define the function and
 +
cut specifies the right endpoint for which the given function definition applies. 
 +
The function definition may have a single piece or more pieces in its definition.
 
</p>
 
</p>
<p>You must include the section that follows <code># Create  link to applet</code>.  If you are embedding a different applet, from the solidsWW applet, put your applet name in place of 'solidsWW' in the line <code>$appletName = "solidsWW";</code>.  Enter the height of the applet in the line <code>height => '550',</code> in place of 550 and the width in the line  <code>width => '595',</code> in place of 595.
 
</p><br>
 
<p>  The lines <code>$applet->configuration(qq{<xml><plot></code><code>
 
<xy>$xy</xy></code><code>
 
<captiontxt>'Compute the volume of the figure shown.'</captiontxt></code><code>
 
<shape shapeType='$shapeType' sides='3' ratio='1.5'/></code><code>
 
<xmax>$xmax</xmax></code><code>
 
        <theColor>0x0000ff</theColor></code><code>
 
<profile></code><code>
 
  <piece func='$func1' cut='8'/></code><code>
 
          <piece func='$func2' cut='10'/></code><code>
 
</profile></code><code>
 
</plot></xml>});
 
    </code> and <code>$applet->initialState(qq{<xml><plot></code><code>
 
<xy>$xy</xy></code><code>
 
<captiontxt>'Compute the volume of the figure shown.'</captiontxt></code><code>
 
<shape shapeType='$shapeType' sides='3' ratio='1.5'/></code><code>
 
<xmax>$xmax</xmax></code><code>
 
        <theColor>0x0000ff</theColor></code><code>
 
<profile></code><code>
 
  <piece func='$func1' cut='8'/></code><code>
 
          <piece func='$func2' cut='10'/></code><code>
 
</profile></code><code>
 
</plot></xml>});</code> configure the applet.  The configuration of the applet is done in xml.  The argument of the function is set to the value held in the variable <code>$xy</code>, the captiontxt that appears initially in the information box in the applet is set to <code>Compute the volume of the figure shown.</code>, the shapeType is set to the variable <code>$shapeType</code>, sides and ratio are ignored when the shapeType is set to circle, the color is set in hexadecimal with the xml code <code><theColor>0x0000ff</theColor></code> (this can be omitted and a default color will be used), the piecewise function is defined with the lines <code><piece func='$func1' cut='8'/></code><code><piece func='$func2' cut='10'/></code><code></code> where <code>$func1</code> and <code>$func2</code> define the function and cut specifies the right endpoint for which the given function definition applies.  The function definition may have a single piece or more pieces in its definition.
 
</p><br>
 
 
<p> The code  
 
<p> The code  
<code>TEXT( MODES(TeX=>'object code', HTML=>$applet->insertAll(
+
<code>TEXT( MODES(TeX=>'object code', </code>
 +
  <code>HTML=>$applet->insertAll(</code>
 +
  <code>
 
   debug=>0,
 
   debug=>0,
   includeAnswerBox=>0,
+
   includeAnswerBox=>0,</code>
 +
  <code>
 
  reinitialize_button=>$permissionLevel>=10,
 
  reinitialize_button=>$permissionLevel>=10,
 
   )));</code> actually embeds the applet in the WeBWorK problem.
 
   )));</code> actually embeds the applet in the WeBWorK problem.
 
</p>
 
</p>
Answer submission and checking is done within WeBWorK.  The applet is intended to aid with visualization and is not used to evaluate the student submission.
+
<p>
 +
Answer submission and checking is done within  
 +
WeBWorK.  The applet is intended to aid with  
 +
visualization and is not used to evaluate the  
 +
student submission.
 
</p>
 
</p>
</td>
+
|- style=" background-color:#ccffff;"
</tr>
+
| <pre>
<tr valign="top">
+
TEXT(MODES(TeX=>"", HTML=><<'END_TEXT'));
 
+
<script>
 +
if (navigator.appVersion.indexOf("MSIE") > 0) {
 +
    document.write("<div width='3in'
 +
    align='center' style='background:yellow'>
 +
    You seem to be using Internet Explorer.
 +
    <br/>It is recommended that another
 +
    browser be used to view this page.</div>");
 +
}
 +
</script>
 +
END_TEXT
 +
</pre>
 +
| <p>
 +
The text between the <code><script></code> tags detects whether the student is using Internet Explorer.  If the student is using this browser, a warning is issued and the student is advised to use another browser.  IE mis-sizes the applets.  Some will work correctly when displayed at the wrong size, but others will fail.  We do not recommend using IE with WeBWorK problems with Flash embedded.</p>
  
<tr valign="top">
+
|- style="background-color:#ffcccc;"
<td style="background-color:#ffcccc;border:black 1px dashed;">
+
| <pre>
<pre>
+
 
BEGIN_TEXT
 
BEGIN_TEXT
  
 
$BR
 
$BR
  
$BR Find the volume of the solid of revolution formed by rotating the  
+
$BR Find the volume of the solid of  
curve \[x=\begin{cases}$a\sin\left(\frac{\pi y}{8}\right)+2&y\le 8\\
+
revolution formed by rotating the  
$b\sin\left(\frac{\pi y}{2}\right)+2&8<y\le 10\end{cases}\] about the \(y\)-axis.
+
curve  
 +
\[x=\begin{cases}
 +
  $a\sin\left(\frac{\pi y}{8}\right)+2
 +
    &y\le 8\\
 +
  $b\sin\left(\frac{\pi y}{2}\right)+2
 +
    &8<y\le 10\end{cases}\]  
 +
about the \(y\)-axis.
  
 
\{ans_rule(35) \}
 
\{ans_rule(35) \}
Line 275: Line 318:
 
Context()->normalStrings;
 
Context()->normalStrings;
 
</pre>
 
</pre>
<td style="background-color:#ffcccc;padding:7px;">
+
| <p>
<p>
+
This is the <strong>text section</strong>  
This is the <strong>text section</strong> of the problem.  The <code>TEXT(beginproblem());</code> line displays a header for the problem, and the <code>Context()->normalStrings;</code> line sets how formulas are displayed in the text, and we reset this after the text section.  Everything between the <code>BEGIN_TEXT</code> and <code>END_TEXT</code> lines (each of which must appear alone on a line) is shown to the student.
+
of the problem.  The <code>TEXT(beginproblem());</code>  
 +
line displays a header for the problem, and the  
 +
<code>Context()->normalStrings;</code> line sets how  
 +
formulas are displayed in the text, and we reset this  
 +
after the text section.  Everything between the  
 +
<code>BEGIN_TEXT</code> and <code>END_TEXT</code>  
 +
lines (each of which must appear alone on a line)  
 +
is shown to the student.
 
</p>
 
</p>
</td>
+
|- style="background-color:#eeddff;"
</tr>
+
| <pre>
<tr valign="top">
+
################################
<td style="background-color:#eeddff;border:black 1px dashed;">
+
<pre>
+
##############################################################
+
 
#
 
#
 
#  Answers
 
#  Answers
Line 290: Line 337:
 
## answer evaluators
 
## answer evaluators
  
ANS( $correctAnswer->cmp() );   #checks AnSwEr00003
+
ANS( $correctAnswer->cmp() );
  
  
 
ENDDOCUMENT();   
 
ENDDOCUMENT();   
 
</pre>
 
</pre>
<td style="background-color:#eeccff;padding:7px;">
+
| <p>
<p>
+
This is the <strong>answer</strong> section of the  
This is the <strong>answer</strong> section of the problem.  The problem answer is set by the <code>ANS( $correctAnswer->cmp() );</code> line.  This is a standard WeBWorK answer checker.
+
problem.  The problem answer is set by the  
 +
<code>ANS( $correctAnswer->cmp() );</code> line.   
 +
This is a standard WeBWorK answer checker.
 
</p>
 
</p>
 
<p>
 
<p>
The <code>ENDDOCUMENT();</code> command is the last command in the file.
+
The <code>ENDDOCUMENT();</code> command is the  
 +
last command in the file.
 
</p>
 
</p>
</td>
+
|}
</tr>
+
 
</table>
+
== License ==
 +
 
 +
The Flash applets developed under DUE-0941388 are protected under the following license: 
 +
[http://creativecommons.org/licenses/by-nc/3.0/ Creative Commons Attribution-NonCommercial 3.0 Unported License].
  
 
[[Category:Sample Problems]]
 
[[Category:Sample Problems]]

Latest revision as of 13:24, 31 July 2013

Flash Applets embedded in WeBWorK questions solidsWW Example

where to find WeBWorK problems like this

Sample Problem with solidsWW.swf embedded

This sample problem shows how to use this versatile applet.

This applet and WeBWorK problem are based upon work supported by the National Science Foundation under Grant Number DUE-0941388.

Click here to see a problem like this in action: testcourses.webwork.maa.org/webwork2/FlashAppletDemos

A standard WeBWorK PG file with an embedded applet has six sections:

  1. A tagging and description section, that describes the problem for future users and authors,
  2. An initialization section, that loads required macros for the problem,
  3. A problem set-up section that sets variables specific to the problem,
  4. An Applet link section that inserts the applet and configures it, (this section is not present in WeBWorK problems without an embedded applet)
  5. A text section, that gives the text that is shown to the student, and
  6. An answer and solution section, that specifies how the answer(s) to the problem is(are) marked for correctness, and gives a solution that may be shown to the student after the problem set is complete.

The sample file attached to this page shows this; below the file is shown to the left, with a second column on its right that explains the different parts of the problem that are indicated above. A screenshot of the applet embedded in this WeBWorK problem is shown below:
SolidsWW1.jpg
There are other example problems using this applet:
solidsWW Flash Applet Sample Problem 2
solidsWW Flash Applet Sample Problem 3
And other problems using applets:
Derivative Graph Matching Flash Applet Sample Problem
USub Applet Sample Problem
trigwidget Applet Sample Problem
solidsWW Flash Applet Sample Problem 1
GraphLimit Flash Applet Sample Problem 2
Other useful links:
Flash Applets Tutorial
Things to consider in developing WeBWorK problems with embedded Flash applets

PG problem file Explanation
##DESCRIPTION
##  Solids of Revolution
##ENDDESCRIPTION

##KEYWORDS('Solids of Revolution')

## DBsubject('Calculus')
## DBchapter('Applications of Integration')
## DBsection('Solids of Revolution')
## Date('7/31/2011')
## Author('Barbara Margolius')
## Institution('Cleveland State University')
## TitleText1('')
## EditionText1('2011')
## AuthorText1('')
## Section1('')
## Problem1('')
##########################################
# This work is supported in part by the 
# National Science Foundation 
# under the grant DUE-0941388.
##########################################

This is the tagging and description section of the problem. Note that any line that begins with a "#" character is a comment for other authors who read the problem, and is not interpreted by WeBWorK.

The description is provided to give a quick summary of the problem so that someone reading it later knows what it does without having to read through all of the problem code.

All of the tagging information exists to allow the problem to be easily indexed. Because this is a sample problem there isn't a textbook per se, and we've used some default tagging values. There is an on-line list of current chapter and section names and a similar list of keywords. The list of keywords should be comma separated and quoted (e.g., KEYWORDS('calculus','derivatives')).

DOCUMENT();        

loadMacros(
  "PGstandard.pl",
  "AppletObjects.pl",
  "MathObjects.pl",
);

This is the initialization section of the problem. The first executed line of the problem must be the DOCUMENT(); command. Note that every command must end with a semicolon.

The loadMacros command loads information that works behind the scenes. For our purposes we can usually just load the macros shown here and not worry about things further.

TEXT(beginproblem());
$showPartialCorrectAnswers = 1;
Context("Numeric"); 

$a = random(2,10,1);
$b = random(2,10,1);

$xy = 'y';
$func1 = "$a*sin(pi*y/8)+2";
$func2 = "$b*sin(pi*y/2)+2";
$xmax = max(Compute("$a+2"),
   Compute("$b+2"),9);
$shapeType = 'circle';

$correctAnswer =
   Compute("64*$a+4*pi*$a^2+32*pi");

This is the problem set-up section of the problem.

The solidsWW.swf applet will accept a piecewise defined function either in terms of x or in terms of y. We set $xy equal to y to define the function in terms of y. The two pieces of the function are defined in the variables $func1 and $func2, though any variable names beginning with the $ character will do. The applet also needs a maximum x-value for the profile graph. Usually you will want the $shapeType to be 'circle' as it is here, but other types are accepted by the applet including: 'ellipse', 'rectangle' and 'poly'. For 'ellipse' and 'rectangle' you will need to set the ratio of the side lengths. For 'poly' you will need to set the number of sides of the regular polygon. They are also set in the code for this problem, but the information is ignored by the applet.

#########################################
#  How to use the solidWW applet.
#    Purpose:  The purpose of this applet 
#       is to help with visualization of
#       solids
#    Use of applet:  The applet state 
#       consists of the following fields:
#     xmax - the maximum x-value.  
#         ymax is 6/5ths of xmax.  the minima
#         are both zero.
#     captiontxt - the initial text in 
#         the info box in the applet
#     shapeType - circle, ellipse, 
#         poly, rectangle
#     piece: consisting of func and cut
#       this is a function defined piecewise. 
#         func is a string for the function 
#         and cut is the right endpoint 
#         of the interval over which it is 
#         defined
#       there can be any number of pieces
#     
#########################################
#  What does the applet do?
#    The applet draws three graphs: 
#       a solid in 3d that the student can 
#          rotate with the mouse
#       the cross-section of the solid 
#          (you'll probably want this to 
#          be a circle
#       the radius of the solid which 
#          varies with the height
#########################################

<p> This is the Applet link section of the problem.


Those portions of the code that begin the line with # are comments and can be omitted or replaced with comments appropriate to your particular problem.

    ###################################
    # Create  link to applet 
    ###################################
    $appletName = "solidsWW";
    $applet =  FlashApplet(
       codebase              
         => findAppletCodebase
            ("$appletName.swf"),
       appletName            
         => $appletName,
       appletId              
         => $appletName,
       setStateAlias         
         => 'setXML',
       getStateAlias         
         => 'getXML',
       setConfigAlias        
         => 'setConfig',
       maxInitializationAttempts 
         => 10,   
       #answerBoxAlias        
         => 'answerBox',
       height     => '550',
       width      => '595',
       bgcolor    => '#e8e8e8',
       debugMode  =>  0,
       submitActionScript  => ''
     );

<p>You must include the section that follows # Create link to applet. If you are embedding a different applet, from the solidsWW applet, put your applet name in place of 'solidsWW' in the line $appletName = "solidsWW";. Enter the height of the applet in the line height => '550', in place of 550 and the width in the line width => '595', in place of 595.


###################################
# Configure applet
###################################
 
    $applet->configuration(qq{<xml><plot>
	<xy>$xy</xy>
	<captiontxt>'Compute the 
          volume of the figure shown.'
        </captiontxt>
	<shape shapeType='$shapeType' 
          sides='3' ratio='1.5'/>
	<xmax>$xmax</xmax>
        <theColor>0x0000ff</theColor>
	<profile>
	   <piece func='$func1' cut='8'/>
           <piece func='$func2' cut='10'/>
	</profile>
</plot></xml>});
    $applet->initialState(qq{<xml><plot>
	<xy>$xy</xy>
	<captiontxt>'Compute the 
          volume of the figure shown.'
        </captiontxt>
	<shape shapeType='$shapeType' 
          sides='3' ratio='1.5'/>
	<xmax>$xmax</xmax>
        <theColor>0x0000ff</theColor>
	<profile>
	   <piece func='$func1' cut='8'/>
           <piece func='$func2' cut='10'/>
	</profile>
</plot></xml>});

TEXT( MODES(TeX=>'object code', 
  HTML=>$applet->insertAll(
  debug=>0,
  includeAnswerBox=>0,
   )));

The lines $applet->configuration(qq{<xml><plot> <xy>$xy</xy> <captiontxt>'Compute the volume of the figure shown.'</captiontxt> <shape shapeType='$shapeType' sides='3' ratio='1.5'/> <xmax>$xmax</xmax> <theColor>0x0000ff</theColor> <profile> <piece func='$func1' cut='8'/> <piece func='$func2' cut='10'/> </profile> </plot></xml>}); and

$applet->initialState(qq{<xml><plot> <xy>$xy</xy> <captiontxt>'Compute the volume of the figure shown.'</captiontxt> <shape shapeType='$shapeType' sides='3' ratio='1.5'/> <xmax>$xmax</xmax> <theColor>0x0000ff</theColor> <profile> <piece func='$func1' cut='8'/> <piece func='$func2' cut='10'/> </profile> </plot></xml>}); configure the applet.

The configuration of the applet is done in xml. The argument of the function is set to the value held in the variable $xy, the captiontxt that appears initially in the information box in the applet is set to Compute the volume of the figure shown., the shapeType is set to the variable $shapeType, sides and ratio are ignored when the shapeType is set to circle, the color is set in hexadecimal with the xml code <theColor>0x0000ff</theColor> (this can be omitted and a default color will be used), the piecewise function is defined with the lines <piece func='$func1' cut='8'/><piece func='$func2' cut='10'/> where $func1 and $func2 define the function and cut specifies the right endpoint for which the given function definition applies. The function definition may have a single piece or more pieces in its definition.

The code TEXT( MODES(TeX=>'object code', HTML=>$applet->insertAll( debug=>0, includeAnswerBox=>0, reinitialize_button=>$permissionLevel>=10, ))); actually embeds the applet in the WeBWorK problem.

Answer submission and checking is done within WeBWorK. The applet is intended to aid with visualization and is not used to evaluate the student submission.

TEXT(MODES(TeX=>"", HTML=><<'END_TEXT'));
<script>
if (navigator.appVersion.indexOf("MSIE") > 0) {
    document.write("<div width='3in' 
    align='center' style='background:yellow'>
    You seem to be using Internet Explorer.
    <br/>It is recommended that another 
    browser be used to view this page.</div>");
}
</script>
END_TEXT

The text between the <script> tags detects whether the student is using Internet Explorer. If the student is using this browser, a warning is issued and the student is advised to use another browser. IE mis-sizes the applets. Some will work correctly when displayed at the wrong size, but others will fail. We do not recommend using IE with WeBWorK problems with Flash embedded.

BEGIN_TEXT

$BR

$BR Find the volume of the solid of 
revolution formed by rotating the 
curve 
\[x=\begin{cases}
  $a\sin\left(\frac{\pi y}{8}\right)+2
    &y\le 8\\
  $b\sin\left(\frac{\pi y}{2}\right)+2
    &8<y\le 10\end{cases}\] 
about the \(y\)-axis.

\{ans_rule(35) \}

$BR

END_TEXT
Context()->normalStrings;

This is the text section of the problem. The TEXT(beginproblem()); line displays a header for the problem, and the Context()->normalStrings; line sets how formulas are displayed in the text, and we reset this after the text section. Everything between the BEGIN_TEXT and END_TEXT lines (each of which must appear alone on a line) is shown to the student.

################################
#
#  Answers
#
## answer evaluators

ANS( $correctAnswer->cmp() );  


ENDDOCUMENT();   

This is the answer section of the problem. The problem answer is set by the ANS( $correctAnswer->cmp() ); line. This is a standard WeBWorK answer checker.

The ENDDOCUMENT(); command is the last command in the file.

License

The Flash applets developed under DUE-0941388 are protected under the following license: Creative Commons Attribution-NonCommercial 3.0 Unported License.

follow us