Commit 7aab2ad4 authored by Isaak Lim's avatar Isaak Lim
Browse files

updated the documentation for IO Options

git-svn-id: fdac6126-5c0c-442c-9429-916003d36597
parent 837c866a
......@@ -12,7 +12,7 @@ for enabling, disabling and verifying the bits in the set. We
distinguish between
-# mode bits - control binary reading/writing
- Options::Binary
- Options::Binary
- Options::MSB
- Options::LSB
- Options::Swap (MSB|LSB)
......@@ -22,6 +22,8 @@ distinguish between
- Options::VertexColor
- Options::FaceNormal
- Options::FaceColor
- Options::ColorAlpha
- Options::ColorFloat
These bits have different effects when reading or writing. The file
format itself is selected by the extension of the filename. The IO
......@@ -40,7 +42,7 @@ the format supports ASCII/binary storage with the apropiate extension.
<td>STL</td><td>.stla, .stl</td><td>.stlb, .stl</td>
The program does not more than providing a command line based
......@@ -48,6 +50,8 @@ interface to select the option bits for reading/writing and to request
mesh properties. Hence illegal combinations are possible and will
result in a failure of the program. (The input file won't be damaged
in this case, but be careful where you put the ouput file!)
Please note that the Options::ColorFloat is currently only implemented for PLY
and OFF files.
<h5>Reading meshes</h5>
......@@ -108,7 +112,7 @@ The method returns false on error, which might have three different reasons:
-# the option is not supported by the choosen format
-# a selected standard property is not available
-# a 'system' error like
-# a 'system' error like
- could not open the file due to access rights
- disk space exhausted during write
- ...
......@@ -118,4 +122,4 @@ The complete source looks like this:
\include 08-io_options/
\ No newline at end of file
......@@ -107,7 +107,7 @@ public:
FaceColor = 0x0200, ///< Has (r) / store (w) face colors
FaceTexCoord = 0x0400, ///< Has (r) / store (w) face texture coordinates
ColorAlpha = 0x0800, ///< Has (r) / store (w) alpha values for colors
ColorFloat = 0x1000 ///< Has (r) / store (w) float values for colors
ColorFloat = 0x1000 ///< Has (r) / store (w) float values for colors (currently only implemented for PLY and OFF files)
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment