updated the documentation for IO Options

git-svn-id: http://www.openmesh.org/svnrepo/OpenMesh/trunk@819 fdac6126-5c0c-442c-9429-916003d36597
This commit is contained in:
Isaak Lim
2013-03-04 17:09:45 +00:00
parent 837c866abb
commit 7aab2ad475
2 changed files with 9 additions and 5 deletions

View File

@@ -12,7 +12,7 @@ for enabling, disabling and verifying the bits in the set. We
distinguish between distinguish between
-# mode bits - control binary reading/writing -# mode bits - control binary reading/writing
- Options::Binary - Options::Binary
- Options::MSB - Options::MSB
- Options::LSB - Options::LSB
- Options::Swap (MSB|LSB) - Options::Swap (MSB|LSB)
@@ -22,6 +22,8 @@ distinguish between
- Options::VertexColor - Options::VertexColor
- Options::FaceNormal - Options::FaceNormal
- Options::FaceColor - Options::FaceColor
- Options::ColorAlpha
- Options::ColorFloat
These bits have different effects when reading or writing. The file These bits have different effects when reading or writing. The file
format itself is selected by the extension of the filename. The IO 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> <td>STL</td><td>.stla, .stl</td><td>.stlb, .stl</td>
</tr><tr> </tr><tr>
<td>OM</td><td></td><td>.om</td> <td>OM</td><td></td><td>.om</td>
</tr> </tr>
</table> </table>
The program does not more than providing a command line based 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 mesh properties. Hence illegal combinations are possible and will
result in a failure of the program. (The input file won't be damaged 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!) 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> <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 -# the option is not supported by the choosen format
-# a selected standard property is not available -# a selected standard property is not available
-# a 'system' error like -# a 'system' error like
- could not open the file due to access rights - could not open the file due to access rights
- disk space exhausted during write - disk space exhausted during write
- ... - ...
@@ -118,4 +122,4 @@ The complete source looks like this:
\include 08-io_options/io_options.cc \include 08-io_options/io_options.cc
*/ */

View File

@@ -107,7 +107,7 @@ public:
FaceColor = 0x0200, ///< Has (r) / store (w) face colors FaceColor = 0x0200, ///< Has (r) / store (w) face colors
FaceTexCoord = 0x0400, ///< Has (r) / store (w) face texture coordinates FaceTexCoord = 0x0400, ///< Has (r) / store (w) face texture coordinates
ColorAlpha = 0x0800, ///< Has (r) / store (w) alpha values for colors 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)
}; };
public: public: