updated advanced docs

hiz1 · Aug 11, 2013 · acdd0db · acdd0db
1 parent 28d2d06
commit acdd0db
Show file tree

Hide file tree

Showing 747 changed files with 75,399 additions and 18,032 deletions.
diff --git a/doxygen/annotated.html.mako b/doxygen/annotated.html.mako
diff --git a/doxygen/category_q_t_movie_07_q_t_from763_08-members.html.mako b/doxygen/category_q_t_movie_07_q_t_from763_08-members.html.mako
@@ -35,6 +35,7 @@
   <div id="navrow1" class="tabs">
     <ul class="tablist">
       <li><a href="index.html"><span>Main&#160;Page</span></a></li>
+      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
       <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
       <li><a href="files.html"><span>Files</span></a></li>
     </ul>

diff --git a/doxygen/category_q_t_movie_07_q_t_from763_08.html.mako b/doxygen/category_q_t_movie_07_q_t_from763_08.html.mako
@@ -35,6 +35,7 @@
   <div id="navrow1" class="tabs">
     <ul class="tablist">
       <li><a href="index.html"><span>Main&#160;Page</span></a></li>
+      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
       <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
       <li><a href="files.html"><span>Files</span></a></li>
     </ul>
@@ -116,7 +117,7 @@ Instance Methods</h2></td></tr>
 </div>
 </div>
 <hr/>The documentation for this category was generated from the following file:<ul>
-<li>video/<a class="el" href="of_q_t_kit_movie_renderer_8m.html">ofQTKitMovieRenderer.m</a></li>
+<li>/home/arturo/Desktop/openFrameworks/libs/openFrameworks/video/<a class="el" href="of_q_t_kit_movie_renderer_8m.html">ofQTKitMovieRenderer.m</a></li>
 </ul>
 </div><!-- contents -->
 

diff --git a/doxygen/class_extension_comparator-members.html.mako b/doxygen/class_extension_comparator-members.html.mako
@@ -35,6 +35,7 @@
   <div id="navrow1" class="tabs">
     <ul class="tablist">
       <li><a href="index.html"><span>Main&#160;Page</span></a></li>
+      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
       <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
       <li><a href="files.html"><span>Files</span></a></li>
     </ul>

diff --git a/doxygen/class_extension_comparator.html.mako b/doxygen/class_extension_comparator.html.mako
@@ -35,6 +35,7 @@
   <div id="navrow1" class="tabs">
     <ul class="tablist">
       <li><a href="index.html"><span>Main&#160;Page</span></a></li>
+      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
       <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
       <li><a href="files.html"><span>Files</span></a></li>
     </ul>
@@ -115,7 +116,7 @@ Public Attributes</h2></td></tr>
 </div>
 </div>
 <hr/>The documentation for this class was generated from the following file:<ul>
-<li>utils/<a class="el" href="of_file_utils_8cpp.html">ofFileUtils.cpp</a></li>
+<li>/home/arturo/Desktop/openFrameworks/libs/openFrameworks/utils/<a class="el" href="of_file_utils_8cpp.html">ofFileUtils.cpp</a></li>
 </ul>
 </div><!-- contents -->
 

diff --git a/doxygen/class_q_t_kit_movie_renderer-members.html.mako b/doxygen/class_q_t_kit_movie_renderer-members.html.mako
@@ -35,6 +35,7 @@
   <div id="navrow1" class="tabs">
     <ul class="tablist">
       <li><a href="index.html"><span>Main&#160;Page</span></a></li>
+      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
       <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
       <li><a href="files.html"><span>Files</span></a></li>
     </ul>

diff --git a/doxygen/class_q_t_kit_video_grabber-members.html.mako b/doxygen/class_q_t_kit_video_grabber-members.html.mako
@@ -35,6 +35,7 @@
   <div id="navrow1" class="tabs">
     <ul class="tablist">
       <li><a href="index.html"><span>Main&#160;Page</span></a></li>
+      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
       <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
       <li><a href="files.html"><span>Files</span></a></li>
     </ul>

diff --git a/doxygen/classes.html.mako b/doxygen/classes.html.mako
diff --git a/doxygen/classof3d_primitive-members.html.mako b/doxygen/classof3d_primitive-members.html.mako
diff --git a/doxygen/classof3d_primitive.html.mako b/doxygen/classof3d_primitive.html.mako
diff --git a/doxygen/classof3d_primitive.png b/doxygen/classof3d_primitive.png
diff --git a/doxygen/classof_abstract_has_pixels-members.html.mako b/doxygen/classof_abstract_has_pixels-members.html.mako
@@ -35,6 +35,7 @@
   <div id="navrow1" class="tabs">
     <ul class="tablist">
       <li><a href="index.html"><span>Main&#160;Page</span></a></li>
+      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
       <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
       <li><a href="files.html"><span>Files</span></a></li>
     </ul>

diff --git a/doxygen/classof_abstract_has_pixels.html.mako b/doxygen/classof_abstract_has_pixels.html.mako
@@ -35,6 +35,7 @@
   <div id="navrow1" class="tabs">
     <ul class="tablist">
       <li><a href="index.html"><span>Main&#160;Page</span></a></li>
+      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
       <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
       <li><a href="files.html"><span>Files</span></a></li>
     </ul>
@@ -64,12 +65,13 @@ Inheritance diagram for ofAbstractHasPixels:</div>
  <div class="center">
   <img src="classof_abstract_has_pixels.png" usemap="#ofAbstractHasPixels_map" alt=""/>
   <map id="ofAbstractHasPixels_map" name="ofAbstractHasPixels_map">
-<area href="classof_base_has_pixels__.html" alt="ofBaseHasPixels_&lt; T &gt;" shape="rect" coords="505,56,697,80"/>
+<area href="classof_base_has_pixels__.html" alt="ofBaseHasPixels_&lt; T &gt;" shape="rect" coords="555,56,747,80"/>
 <area href="classof_base_has_pixels__.html" alt="ofBaseHasPixels_&lt; PixelType &gt;" shape="rect" coords="1616,56,1808,80"/>
-<area href="classof_base_image__.html" alt="ofBaseImage_&lt; T &gt;" shape="rect" coords="0,112,192,136"/>
+<area href="classof_base_image__.html" alt="ofBaseImage_&lt; T &gt;" shape="rect" coords="101,112,293,136"/>
 <area href="classof_base_video.html" alt="ofBaseVideo" shape="rect" coords="1010,112,1202,136"/>
 <area href="classof_base_image__.html" alt="ofBaseImage_&lt; PixelType &gt;" shape="rect" coords="1616,112,1808,136"/>
 <area href="classof_base_video_draws.html" alt="ofBaseVideoDraws" shape="rect" coords="0,168,192,192"/>
+<area href="classof_image__.html" alt="ofImage_&lt; unsigned char &gt;" shape="rect" coords="202,168,394,192"/>
 <area href="classof_base_video_draws.html" alt="ofBaseVideoDraws" shape="rect" coords="404,168,596,192"/>
 <area href="classof_base_video_grabber.html" alt="ofBaseVideoGrabber" shape="rect" coords="808,168,1000,192"/>
 <area href="classof_base_video_player.html" alt="ofBaseVideoPlayer" shape="rect" coords="1212,168,1404,192"/>
@@ -120,7 +122,7 @@ Public Member Functions</h2></td></tr>
 </div>
 </div>
 <hr/>The documentation for this class was generated from the following file:<ul>
-<li>types/<a class="el" href="of_base_types_8h_source.html">ofBaseTypes.h</a></li>
+<li>/home/arturo/Desktop/openFrameworks/libs/openFrameworks/types/<a class="el" href="of_base_types_8h_source.html">ofBaseTypes.h</a></li>
 </ul>
 </div><!-- contents -->
 

diff --git a/doxygen/classof_abstract_has_pixels.png b/doxygen/classof_abstract_has_pixels.png
diff --git a/doxygen/classof_abstract_image-members.html.mako b/doxygen/classof_abstract_image-members.html.mako
@@ -35,6 +35,7 @@
   <div id="navrow1" class="tabs">
     <ul class="tablist">
       <li><a href="index.html"><span>Main&#160;Page</span></a></li>
+      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
       <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
       <li><a href="files.html"><span>Files</span></a></li>
     </ul>

diff --git a/doxygen/classof_abstract_image.html.mako b/doxygen/classof_abstract_image.html.mako
@@ -35,6 +35,7 @@
   <div id="navrow1" class="tabs">
     <ul class="tablist">
       <li><a href="index.html"><span>Main&#160;Page</span></a></li>
+      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
       <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
       <li><a href="files.html"><span>Files</span></a></li>
     </ul>
@@ -64,12 +65,13 @@ Inheritance diagram for ofAbstractImage:</div>
  <div class="center">
   <img src="classof_abstract_image.png" usemap="#ofAbstractImage_map" alt=""/>
   <map id="ofAbstractImage_map" name="ofAbstractImage_map">
-<area href="classof_base_draws.html" alt="ofBaseDraws" shape="rect" coords="90,0,260,24"/>
-<area href="classof_base_has_texture.html" alt="ofBaseHasTexture" shape="rect" coords="270,0,440,24"/>
-<area href="classof_base_image__.html" alt="ofBaseImage_&lt; T &gt;" shape="rect" coords="90,112,260,136"/>
-<area href="classof_base_image__.html" alt="ofBaseImage_&lt; PixelType &gt;" shape="rect" coords="270,112,440,136"/>
+<area href="classof_base_draws.html" alt="ofBaseDraws" shape="rect" coords="225,0,395,24"/>
+<area href="classof_base_has_texture.html" alt="ofBaseHasTexture" shape="rect" coords="405,0,575,24"/>
+<area href="classof_base_image__.html" alt="ofBaseImage_&lt; T &gt;" shape="rect" coords="180,112,350,136"/>
+<area href="classof_base_image__.html" alt="ofBaseImage_&lt; PixelType &gt;" shape="rect" coords="450,112,620,136"/>
 <area href="classof_base_video_draws.html" alt="ofBaseVideoDraws" shape="rect" coords="90,168,260,192"/>
-<area href="classof_image__.html" alt="ofImage_&lt; PixelType &gt;" shape="rect" coords="270,168,440,192"/>
+<area href="classof_image__.html" alt="ofImage_&lt; unsigned char &gt;" shape="rect" coords="270,168,440,192"/>
+<area href="classof_image__.html" alt="ofImage_&lt; PixelType &gt;" shape="rect" coords="450,168,620,192"/>
 <area href="classof_video_grabber.html" alt="ofVideoGrabber" shape="rect" coords="0,224,170,248"/>
 <area href="classof_video_player.html" alt="ofVideoPlayer" shape="rect" coords="180,224,350,248"/>
 </map>
@@ -135,7 +137,7 @@ Public Member Functions</h2></td></tr>
 </div>
 </div>
 <hr/>The documentation for this class was generated from the following file:<ul>
-<li>types/<a class="el" href="of_base_types_8h_source.html">ofBaseTypes.h</a></li>
+<li>/home/arturo/Desktop/openFrameworks/libs/openFrameworks/types/<a class="el" href="of_base_types_8h_source.html">ofBaseTypes.h</a></li>
 </ul>
 </div><!-- contents -->
 

diff --git a/doxygen/classof_abstract_image.png b/doxygen/classof_abstract_image.png
diff --git a/doxygen/classof_abstract_parameter-members.html.mako b/doxygen/classof_abstract_parameter-members.html.mako
@@ -0,0 +1,92 @@
+<%inherit file="base.mako" />
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" 
+    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
+    ${self.head()}
+    <meta http-equiv="X-UA-Compatible" content="IE=9"/>
+    <meta name="generator" content="Doxygen 1.8.3.1"/>
+    <title>openFrameworks: Class Index</title>
+    <link href="tabs.css" rel="stylesheet" type="text/css"/>
+    <script type="text/javascript" src="dynsections.js"></script>
+    <link href="search/search.css" rel="stylesheet" type="text/css"/>
+    <script type="text/javascript" src="search/search.js"></script>
+    <script type="text/javascript">
+      $(document).ready(function() { searchBox.OnSelectItem(0); });
+    </script>
+    <link href="doxygen.css" rel="stylesheet" type="text/css" />
+  </head>
+  <body>
+    <div id="content">
+      ${self.header()}
+      <div id="body-wrap">
+      		<div class="page-wide">
+	            <div class="page-left-split">
+           		    <h1 class="documentation">reference</h1> <ul class="docsadvanced"><li><a href="/documentation">basic</a></li> <li><a  class="active" href="/doxygen/annotated.html">advanced</a></li> </ul>
+           		</div>
+		        <div class="page-right-narrow">
+			        <p>This documentation is automatically generated from the openFrameworks source code using doxygen and refers to the most recent release, version <strong>${bf.config.currentVersion}</strong>.</p>
+		        </div>
+       		</div>
+      		<div class="page-wide">
+      		    <div class="doxy-mainmenu">
+<!-- Generated by Doxygen 1.8.3.1 -->
+  <div id="navrow1" class="tabs">
+    <ul class="tablist">
+      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
+      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
+      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
+      <li><a href="files.html"><span>Files</span></a></li>
+    </ul>
+  </div>
+  <div id="navrow2" class="tabs2">
+    <ul class="tablist">
+      <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
+      <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
+      <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
+      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
+    </ul>
+  </div>
+</div><!-- top -->
+<div class="header">
+  <div class="headertitle">
+<div class="title">ofAbstractParameter Member List</div>  </div>
+</div><!--header-->
+<div class="contents">
+
+<p>This is the complete list of members for <a class="el" href="classof_abstract_parameter.html">ofAbstractParameter</a>, including all inherited members.</p>
+<table class="directory">
+  <tr class="even"><td class="entry"><a class="el" href="classof_abstract_parameter.html#af499be15e00175479941a3b6b2ca03c5">cast</a>()</td><td class="entry"><a class="el" href="classof_abstract_parameter.html">ofAbstractParameter</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
+  <tr><td class="entry"><a class="el" href="classof_abstract_parameter.html#a3d30a35fef8cf2104a7204f5e8b7c9ae">cast</a>() const </td><td class="entry"><a class="el" href="classof_abstract_parameter.html">ofAbstractParameter</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
+  <tr class="even"><td class="entry"><a class="el" href="classof_abstract_parameter.html#ac5c07a878a756f4622f3a63325bffdee">escape</a>(string str) const </td><td class="entry"><a class="el" href="classof_abstract_parameter.html">ofAbstractParameter</a></td><td class="entry"><span class="mlabel">protected</span><span class="mlabel">virtual</span></td></tr>
+  <tr><td class="entry"><a class="el" href="classof_abstract_parameter.html#acf734f1df8f342558103907081996506">fromString</a>(string str)</td><td class="entry"><a class="el" href="classof_abstract_parameter.html">ofAbstractParameter</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
+  <tr class="even"><td class="entry"><a class="el" href="classof_abstract_parameter.html#a6f551b616064a7dec0f00111b7bdc1f0">getEscapedName</a>() const </td><td class="entry"><a class="el" href="classof_abstract_parameter.html">ofAbstractParameter</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
+  <tr><td class="entry"><a class="el" href="classof_abstract_parameter.html#ae1163059d5965b71bb1102e8e39e3b43">getGroupHierarchyNames</a>() const </td><td class="entry"><a class="el" href="classof_abstract_parameter.html">ofAbstractParameter</a></td><td class="entry"></td></tr>
+  <tr class="even"><td class="entry"><a class="el" href="classof_abstract_parameter.html#ad48af3aa34c920787cd96e8435b2bd2d">getName</a>() const </td><td class="entry"><a class="el" href="classof_abstract_parameter.html">ofAbstractParameter</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
+  <tr><td class="entry"><a class="el" href="classof_abstract_parameter.html#a17714d848ae7f712c122855b8002f216">getParent</a>() const </td><td class="entry"><a class="el" href="classof_abstract_parameter.html">ofAbstractParameter</a></td><td class="entry"></td></tr>
+  <tr class="even"><td class="entry"><a class="el" href="classof_abstract_parameter.html#af87f5682257c3c00d7156f20f44597ee">getParent</a>()</td><td class="entry"><a class="el" href="classof_abstract_parameter.html">ofAbstractParameter</a></td><td class="entry"></td></tr>
+  <tr><td class="entry"><a class="el" href="classof_abstract_parameter.html#ad0ce001d9523f0a0669980478066c487">isSerializable</a>() const </td><td class="entry"><a class="el" href="classof_abstract_parameter.html">ofAbstractParameter</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
+  <tr class="even"><td class="entry"><a class="el" href="classof_abstract_parameter.html#a7f73e294af3bb01969fa7d8f21afb269">notifyParent</a>()</td><td class="entry"><a class="el" href="classof_abstract_parameter.html">ofAbstractParameter</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
+  <tr><td class="entry"><a class="el" href="classof_abstract_parameter.html#a999650a36fee7b7af6a0e666400cb67b">ofAbstractParameter</a>()</td><td class="entry"><a class="el" href="classof_abstract_parameter.html">ofAbstractParameter</a></td><td class="entry"></td></tr>
+  <tr class="even"><td class="entry"><a class="el" href="classof_abstract_parameter.html#a207f0b2cbad99a6e213f7c7c6667f65f">operator&lt;&lt;</a>(ostream &amp;os, const ofAbstractParameter &amp;p)</td><td class="entry"><a class="el" href="classof_abstract_parameter.html">ofAbstractParameter</a></td><td class="entry"><span class="mlabel">friend</span></td></tr>
+  <tr><td class="entry"><a class="el" href="classof_abstract_parameter.html#a80b71a9031de018c02c0e4a34e53422a">operator&gt;&gt;</a>(istream &amp;is, ofAbstractParameter &amp;p)</td><td class="entry"><a class="el" href="classof_abstract_parameter.html">ofAbstractParameter</a></td><td class="entry"><span class="mlabel">friend</span></td></tr>
+  <tr class="even"><td class="entry"><a class="el" href="classof_abstract_parameter.html#ab174eca700e465dfcd3d882e1ad5e022">setName</a>(string name)</td><td class="entry"><a class="el" href="classof_abstract_parameter.html">ofAbstractParameter</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
+  <tr><td class="entry"><a class="el" href="classof_abstract_parameter.html#a3c09bea13abf9524548ae48b6dbf8809">setParent</a>(ofParameterGroup *_parent)</td><td class="entry"><a class="el" href="classof_abstract_parameter.html">ofAbstractParameter</a></td><td class="entry"></td></tr>
+  <tr class="even"><td class="entry"><a class="el" href="classof_abstract_parameter.html#adae33a5337dc08dd9e924f0523eec828">setSerializable</a>(bool serializable)</td><td class="entry"><a class="el" href="classof_abstract_parameter.html">ofAbstractParameter</a></td><td class="entry"><span class="mlabel">protected</span><span class="mlabel">virtual</span></td></tr>
+  <tr><td class="entry"><a class="el" href="classof_abstract_parameter.html#afe7e90b4f9aa8dd1b908308da328d275">toString</a>() const </td><td class="entry"><a class="el" href="classof_abstract_parameter.html">ofAbstractParameter</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
+  <tr class="even"><td class="entry"><a class="el" href="classof_abstract_parameter.html#a48c11f6a5d54eafb5d1739e4a334f4e0">type</a>() const </td><td class="entry"><a class="el" href="classof_abstract_parameter.html">ofAbstractParameter</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
+  <tr><td class="entry"><a class="el" href="classof_abstract_parameter.html#a1e2a7909988fbda340a2d3ad6caccaec">~ofAbstractParameter</a>()</td><td class="entry"><a class="el" href="classof_abstract_parameter.html">ofAbstractParameter</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
+</table></div><!-- contents -->
+
+            </div>
+      </div>
+      <div id="footer">
+        ${self.footer()}
+      </div> <!-- End Footer -->
+    </div> <!-- End Content -->
+  </body>
+</html>
+<%def name="header()">
+  <%include file="header.mako" args="active='documentation'" />
+</%def>