solarframework.github.io/use_it.html at master · SolarFramework/solarframework.github.io · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
<!doctype html>
<html class="no-js">
    <head>
    <meta charset="utf-8">
    <meta http-equiv="X-UA-Compatible" content="IE=edge">
    <title>SolAR</title>
    <meta name="description" content="">
    <meta name="viewport" content="width=device-width">

    <!-- IE 10 Metro tile icon (Metro equivalent of apple-touch-icon) -->
    <meta name="msapplication-TileColor" content="#FFFFFF">
    <meta name="msapplication-TileImage" content="https://solarframework.github.io//assets/static/favicon-144.png">

    <!-- Touch icon for iOS 2.0+ and Android 2.1+ -->
    <link rel="apple-touch-icon-precomposed" href="https://solarframework.github.io//assets/static/favicon-152.png">

    <link rel="icon" type="image/x-icon" href="https://solarframework.github.io//assets/static/favicon.ico">

    <!-- Place favicon.ico and apple-touch-icon.png in the root directory -->
    <!-- build:css assets/styles/vendor.css -->
    <!-- bower:css -->
    <link rel="stylesheet" href="https://solarframework.github.io//assets/styles/bootstrap.css" />
    <!-- endbower -->
    <!-- endbuild -->
    <!-- build:css assets/styles/main.css -->
    <link rel="stylesheet" href="https://solarframework.github.io//assets/styles/coderay.css">
    <link rel="stylesheet" href="https://solarframework.github.io//assets/styles/asciidoctor.css">
    <link rel="stylesheet" href="https://solarframework.github.io//assets/styles/solar-asciidoctor-theme.css">
    <link rel="stylesheet" href="https://solarframework.github.io//assets/styles/font-awesome.min.css">
    <link rel="stylesheet" href="https://solarframework.github.io//assets/styles/solar-bootstrap-theme.css">
    <link rel="stylesheet" href="https://solarframework.github.io//assets/styles/main.css">
    <link rel="stylesheet" href="https://solarframework.github.io//assets/styles/media.css">
    <!-- endbuild -->
    <script src="https://solarframework.github.io//js/vendor/jquery.js"></script><!--needed with bootstrap-->
    <script src="https://solarframework.github.io//js/vendor/bootstrap.js"></script>
    <script src="https://solarframework.github.io//js/toc.js"></script>
    <script src="https://solarframework.github.io//js/block-folding.js"></script>
    <script type="text/javascript">
        $(document).ready(function() {
        /* Set up style for active page in submenu and matching navbar entry This code cannot be put in navbar.html because each default.html template imports a brand new navbar so the activate class will be overwriten by brand new navbar DOM*/
          var pageHasSubmenu = false;
          $("#submenuconfig + .sectionbody ul li a").each(function(){
              if ($(this).prop("href") == window.location.href) {
                  /* Set up style for active page in submenu */
                  pageHasSubmenu = true;
                  $(this).addClass("active");
                  $(this).parents("p").addClass("active");
                  return false; /* same as break, specific for jquery each() function */
              }
          });
          var matchingNavbarURL = window.location.href;
          if (pageHasSubmenu) {
              var urlParts = window.location.href.split("/");
              var matchingNavbarItem = urlParts[urlParts.length-3];
              matchingNavbarURL = window.location.href.substring(0, window.location.href.indexOf(matchingNavbarItem))+matchingNavbarItem+".html";
          }
          /* Set up style for active item in navbar (no click on submenu yet) This code cannot be put in navbar.html because each default.html template imports a brand new navbar so the activate class will be overwriten by brand new navbar DOM*/
          $("#navbar-collapse ul.navbar-nav a").each(function(){
              if ($(this).prop("href") == matchingNavbarURL) {
                  $(this).addClass('active');
                  $(this).parents('li').addClass('active');
                  return false; /* same as break, specific for jquery each() function */
              }
          });

          /* Configure TOC to take into account all titles */
          $("#toc").toc(  { headers: "h2, h3, h4, h5, h6",
                              listType: "ul",
                              title: "<div id='toctitle'>Table of Contents</div>",
                              noBackToTopLinks: true /*usefull to avoid tag <i class="icon-arrow-up back-to-top"> </i> to be placed between #submenuconfig and sectionbody and screw the submenu css style*/
           });
        });
      </script>
  <!-- Google Analytics -->
  <script>
          (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
          (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
          m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
          })(window,document,'script','//www.google-analytics.com/analytics.js','ga');

          ga('create', 'UA-107058603-1', 'auto');
          ga('send', 'pageview');
  </script>  <!-- End Google Analytics -->
<link rel="stylesheet" type="text/css" href="https://solarframework.github.io//js/cookieconsent/cookieconsent.min.css" />
<script src="https://solarframework.github.io//js/cookieconsent/cookieconsent.min.js"></script>
<script>
var userLang = navigator.language || navigator.userLanguage;
if (userLang == "fr") {
  message="En poursuivant votre navigation sur ce site, vous acceptez que des cookies soient utilisés afin d’améliorer votre expérience d’utilisateur.";
  link="En savoir plus";
  href="https://b-com.com/fr/mentions-l%C3%A9gales";
}
else {
  message="By proceeding beyond this page, you consent to the cookies usage, in order to improve your experience on this website.";
  link="More information";
  href="https://b-com.com/en/legal-notice";
}
window.addEventListener("load", function(){
window.cookieconsent.initialise({
  "palette": {
    "popup": {
      "background": "#252e39"
    },
    "button": {
      "background": "#14a7d0"
    }
  },
  "position": "bottom-left",
  "theme": "edgeless",
  "content": {
    "message": message,
    "dismiss": "OK",
    "link": link,
    "href": href
  }
})});
</script>
</head>

    <body>
        <!--[if lt IE 9]>
            <p class="browserupgrade">You are using an <strong>outdated</strong> browser. Please <a href="http://browsehappy.com/">upgrade your browser</a> to improve your experience.</p>
        <![endif]-->
        <div><div class="navbar navbar-default">
    <div class="container-fluid">
        <div class="navbar-header">
            <button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar" aria-expanded="false" aria-controls="navbar">
                <span class="sr-only">Toggle navigation</span>
                <span class="icon-bar"></span>
                <span class="icon-bar"></span>
                <span class="icon-bar"></span>
            </button>
            <a class="navbar-brand link" href="https://solarframework.github.io//">&lsaquo;SolAR&rsaquo;</a>
        </div>

        <div id="navbar" class="navbar-collapse collapse" aria-expanded="false" style="height: 1px;">
            <ul class="nav navbar-nav">


                    <li>
                        <a href="https://solarframework.github.io//discover.html">
                            <span>Discover</span>
                        </a>
                    </li>


                    <li>
                        <a href="https://solarframework.github.io//API.html">
                            <span>API</span>
                        </a>
                    </li>


                    <li>
                        <a class="active" href="https://solarframework.github.io//use_it.html">
                            <span>Use it</span>
                        </a>
                    </li>


                <!--li>
                    <form action="https://solarframework.github.io//search.html" method="get" class="navbar-form" role="search">
                        <div class="input-group">
                            <input type="text" id="search" class="form-control" placeholder="Search"
                                    name="q" class="span1" type="text" size="15">
                            <div class="input-group-btn">
                                <button class="btn btn-default" type="submit">
                                    <i class="fa fa-search"></i>
                                </button>
                            </div>
                        </div>
                    </form>
                </li-->
            </ul>
        </div><!--/.nav-collapse -->

    </div>

</div>
</div>

        <div class="container">
            <div class="well">
              <h1>Use it !</h1>
<div id="toc" class="toc">
<div id="toctitle">Table of Contents</div>
<ul class="sectlevel1">
<li><a href="#submenuconfig">submenuconfig</a></li>
<li><a href="#please_contribute">Please contribute</a></li>
<li><a href="#how_to_use">How to use</a></li>
<li><a href="#who">who</a></li>
</ul>
</div>
<div class="sect1">
<h2 id="submenuconfig"><a class="anchor" href="#submenuconfig"></a><a class="link" href="#submenuconfig">submenuconfig</a></h2>
<div class="sectionbody">
<div class="ulist none">
<ul class="none">
<li>
<p><a href="https://solarframework.github.io//use_it/downloads/">setup</a></p>
</li>
<li>
<p><a href="https://solarframework.github.io//use_it/samples/">samples</a></p>
</li>
<li>
<p><a href="https://solarframework.github.io//use_it/tutorials/">tutorials</a></p>
</li>
<li>
<p><a href="https://solarframework.github.io//use_it/tools/">tools</a></p>
</li>
<li>
<p><a href="https://solarframework.github.io//use_it/programmer_guide/">programmer&#8217;s guide</a></p>
</li>
</ul>
</div>
</div>
</div>
<div class="sect1">
<h2 id="please_contribute"><a class="anchor" href="#please_contribute"></a><a class="link" href="#please_contribute">Please contribute</a></h2>
<div class="sectionbody">
<div class="paragraph">
<p>SolAR framework is <strong>looking for contributors</strong> .</p>
</div>
</div>
</div>
<div class="sect1">
<h2 id="how_to_use"><a class="anchor" href="#how_to_use"></a><a class="link" href="#how_to_use">How to use</a></h2>
<div class="sectionbody">
<div class="paragraph">
<p>You can start using SolAR Framework very quickly:</p>
</div>
<div class="ulist">
<ul>
<li>
<p>download and execute the SolAR installer. It will install all you need to user SolAR Framework. <a href="use_it/downloads"><strong>binaries</strong></a>.  It will only take 15 minutes .</p>
</li>
<li>
<p>download and test solAR sample code : <a href="_use_it/samples"><strong>sample codes</strong></a>, compile it and run it. You will learn about SolARFramework use (code organization, API call) . It will take about 30 minutes.</p>
</li>
<li>
<p>implement your own program based on SolAR: to help you some tutorials will soon be available.
<a href="use_it/tutorials"><strong>tutorials</strong></a> and do some exercises. You will learn more about SolARFramework, so that you will be able to program a code based on SolAR framework by your own.
//It will take more time, depending on which level of expertise you want.</p>
</li>
</ul>
</div>
</div>
</div>
<div class="sect1">
<h2 id="who"><a class="anchor" href="#who"></a><a class="link" href="#who">who</a></h2>
<div class="sectionbody">
<div class="paragraph">
<p>SOlAR framework can be used by :</p>
</div>
<div class="ulist">
<ul>
<li>
<p>pose estimation developers (using a C++ API) and</p>
</li>
<li>
<p>designers (using an editor),</p>
</li>
</ul>
</div>
<div class="paragraph">
<p>to create a good pose estimation solution.</p>
</div>
</div>
</div>
            </div>
        </div>

        <!-- build:js scripts/vendor.js -->
        <!-- bower:js -->

        <!-- endbower -->
        <!-- endbuild -->

    <!-- build:js({.tmp,src/main/webapp}) scripts/app.js -->
    <script src="https://solarframework.github.io//js/vendor/modernizr.js"></script>
    <!-- endbuild -->
    <script type="text/javascript">
      /* Fix padding-top on anchor with TOC */
      window.addEventListener("hashchange", function() { scrollBy(0, -95) })
    </script>
    </body>
</html>