Panda3D
pnmFileTypePfm.h
Go to the documentation of this file.
1 /**
2  * PANDA 3D SOFTWARE
3  * Copyright (c) Carnegie Mellon University. All rights reserved.
4  *
5  * All use of this software is subject to the terms of the revised BSD
6  * license. You should have received a copy of this license along
7  * with this source code in a file named "LICENSE."
8  *
9  * @file pnmFileTypePfm.h
10  * @author drose
11  * @date 2000-06-17
12  */
13 
14 #ifndef PNMFILETYPEPFM_H
15 #define PNMFILETYPEPFM_H
16 
17 #include "pandabase.h"
18 
19 #include "pnmFileType.h"
20 #include "pnmImage.h"
21 #include "pnmReader.h"
22 #include "pnmWriter.h"
23 
24 /**
25  * For reading and writing PFM files using the basic PNMImage interface, as if
26  * they were basic RGB files.
27  */
28 class EXPCL_PANDA_PNMIMAGETYPES PNMFileTypePfm : public PNMFileType {
29 public:
31 
32  virtual std::string get_name() const;
33 
34  virtual int get_num_extensions() const;
35  virtual std::string get_extension(int n) const;
36  virtual std::string get_suggested_extension() const;
37 
38  virtual bool has_magic_number() const;
39  virtual bool matches_magic_number(const std::string &magic_number) const;
40 
41  virtual PNMReader *make_reader(std::istream *file, bool owns_file = true,
42  const std::string &magic_number = std::string());
43  virtual PNMWriter *make_writer(std::ostream *file, bool owns_file = true);
44 
45 public:
46  class Reader : public PNMReader {
47  public:
48  Reader(PNMFileType *type, std::istream *file, bool owns_file, std::string magic_number);
49 
50  virtual bool is_floating_point();
51  virtual bool read_pfm(PfmFile &pfm);
52 
53  private:
54  PN_float32 _scale;
55  };
56 
57  class Writer : public PNMWriter {
58  public:
59  Writer(PNMFileType *type, std::ostream *file, bool owns_file);
60 
61  virtual bool supports_floating_point();
62  virtual bool supports_integer();
63  virtual bool write_pfm(const PfmFile &pfm);
64  };
65 
66 
67  // The TypedWritable interface follows.
68 public:
69  static void register_with_read_factory();
70 
71 protected:
72  static TypedWritable *make_PNMFileTypePfm(const FactoryParams &params);
73 
74 public:
75  static TypeHandle get_class_type() {
76  return _type_handle;
77  }
78  static void init_type() {
79  PNMFileType::init_type();
80  register_type(_type_handle, "PNMFileTypePfm",
81  PNMFileType::get_class_type());
82  }
83  virtual TypeHandle get_type() const {
84  return get_class_type();
85  }
86  virtual TypeHandle force_init_type() {init_type(); return get_class_type();}
87 
88 private:
89  static TypeHandle _type_handle;
90 };
91 
92 #endif
An instance of this class is passed to the Factory when requesting it to do its business and construc...
Definition: factoryParams.h:36
For reading and writing PFM files using the basic PNMImage interface, as if they were basic RGB files...
This is the base class of a family of classes that represent particular image file types that PNMImag...
Definition: pnmFileType.h:32
virtual bool has_magic_number() const
Returns true if this particular file type uses a magic number to identify it, false otherwise.
Definition: pnmFileType.cxx:76
get_suggested_extension
Returns a suitable filename extension (without a leading dot) to suggest for files of this type,...
Definition: pnmFileType.h:49
virtual PNMReader * make_reader(std::istream *file, bool owns_file=true, const std::string &magic_number=std::string())
Allocates and returns a new PNMReader suitable for reading from this file type, if possible.
Definition: pnmFileType.cxx:96
get_num_extensions
Returns the number of different possible filename extensions associated with this particular file typ...
Definition: pnmFileType.h:44
virtual PNMWriter * make_writer(std::ostream *file, bool owns_file=true)
Allocates and returns a new PNMWriter suitable for reading from this file type, if possible.
get_extension
Returns the nth possible filename extension associated with this particular file type,...
Definition: pnmFileType.h:44
virtual bool matches_magic_number(const std::string &magic_number) const
Returns true if the indicated "magic number" byte stream (the initial few bytes read from the file) m...
Definition: pnmFileType.cxx:86
This is an abstract base class that defines the interface for reading image files of various types.
Definition: pnmReader.h:27
This is an abstract base class that defines the interface for writing image files of various types.
Definition: pnmWriter.h:27
Defines a pfm file, a 2-d table of floating-point numbers, either 3-component or 1-component,...
Definition: pfmFile.h:31
TypeHandle is the identifier used to differentiate C++ class types.
Definition: typeHandle.h:81
Base class for objects that can be written to and read from Bam files.
Definition: typedWritable.h:35
PANDA 3D SOFTWARE Copyright (c) Carnegie Mellon University.
PANDA 3D SOFTWARE Copyright (c) Carnegie Mellon University.
PANDA 3D SOFTWARE Copyright (c) Carnegie Mellon University.
PANDA 3D SOFTWARE Copyright (c) Carnegie Mellon University.
PANDA 3D SOFTWARE Copyright (c) Carnegie Mellon University.
void register_type(TypeHandle &type_handle, const std::string &name)
This inline function is just a convenient way to call TypeRegistry::register_type(),...
Definition: register_type.I:22