Changeset 262

Timestamp:

09/08/09 19:25:01 (3 years ago)

Author:

bwoeldecke

Message:

avango-doc: updated avango-connect documentation

• updated list of supported field types
• added description of the used network protocol

Location:

trunk/avango-doc/guide

Files:

• avango-connect.html (modified) (2 diffs)
• screen.css (modified) (2 diffs)

trunk/avango-doc/guide/avango-connect.html

@@ -39 +39 @@
 
 <p>
-Supported field types:
+The following list shows the supported field types. At this time, there is only a small subset of the existing types,
+which grows on demand.
 <ul>
         <li>SFBool</li>
         <li>SFInt</li>
+        <li>SFFloat</li>
         <li>SFDouble</li>
         <li>SFString</li>
-        <li>MFBool</li>
+        <li>SFVec4</li>
+        <li>SFMatrix</li>
         <li>MFInt</li>
-        <li>MFDouble</li>
         <li>MFString</li>
+        <li>MFVec2</li>
+        <li>MFVec3</li>
+        <li>MFMatrix</li>
 </ul>
 </p>
@@ -126 +131 @@
 </ul>
 
+<h3>Network protocol</h3>
+<p>
+The values of the fields are sent over a TCP connection with a simple stream based text protocol.
+Every line of text carries the information of one single field and ends in a line feed (ASCII code 0x0a).
+The different parts of a line are separated by NUL characters (ASCII code 0x00).
+
+<pre class="example">
+Text<b>&lt;NUL&gt;</b>SFString<b>&lt;NUL&gt;</b>This is a test<b>&lt;LF&gt;</b>
+Translation<b>&lt;NUL&gt;</b>SFVec4<b>&lt;NUL&gt;</b>1<b>&lt;NUL&gt;</b>2<b>&lt;NUL&gt;</b>3<b>&lt;NUL&gt;</b>4<b>&lt;LF&gt;</b>
+</pre>
+
+In this example, the information about two fields is sent:
+<ul>
+        <li>A field called "Text" of type "SFString" containing the text "This is a text"</li>
+        <li>A field called "Translation" of type "SFVec4" containing the value "(1, 2, 3, 4)".</li>
+</ul>
+
+</p>
+
 <!-- End page contents -->
 

trunk/avango-doc/guide/screen.css

@@ -70 +70 @@
 .sidenote:before {
         font-family:Fixedsys,Courier,monospace;
-        width:7.5em;
+        width:6.0em;
         display:block;
         margin-top:-10px;
@@ -114 +114 @@
 }
 
+/* Examples should be formatted with <div class="example"> */
+
+.example {
+        background-color:#ddf;
+        font-family:Fixedsys,Courier,monospace;
+        padding:10px;
+        border:dotted 1px black;
+}
+
+/* insert "example" badge */
+
+.example:before {
+        width:4.5em;
+        display:block;
+        margin-top:-10px;
+        margin-left:-10px;
+        margin-right:-10px;
+        margin-bottom:10px;
+        padding:1px;
+        border-color:#999;
+        border-right-style:dotted;
+        border-right-width:1px;
+        border-bottom-style:dotted;
+        border-bottom-width:1px;
+        font-style:italic;
+        content: "example";
+}
+
 /* Class lists - displayed in a separate block. TODO: Make consistent with other lists */