Panda3D
pnmFileTypeSoftImage.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 pnmFileTypeSoftImage.h
10  * @author drose
11  * @date 2000-06-17
12  */
13 
14 #ifndef PNMFILETYPESOFTIMAGE_H
15 #define PNMFILETYPESOFTIMAGE_H
16 
17 #include "pandabase.h"
18 
19 #ifdef HAVE_SOFTIMAGE_PIC
20 
21 #include "pnmFileType.h"
22 #include "pnmReader.h"
23 #include "pnmWriter.h"
24 
25 /**
26  * For reading and SoftImage native image files.
27  */
28 class EXPCL_PANDA_PNMIMAGETYPES PNMFileTypeSoftImage : public PNMFileType {
29 public:
30  PNMFileTypeSoftImage();
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 supports_read_row() const;
51  virtual bool read_row(xel *array, xelval *alpha, int x_size, int y_size);
52 
53  private:
54  enum { unknown, rgb, rgba, rgb_a } soft_color;
55  int rgb_ctype, alpha_ctype;
56  };
57 
58  class Writer : public PNMWriter {
59  public:
60  Writer(PNMFileType *type, std::ostream *file, bool owns_file);
61 
62  virtual bool supports_write_row() const;
63  virtual bool write_header();
64  virtual bool write_row(xel *array, xelval *alpha);
65  };
66 
67 
68  // The TypedWritable interface follows.
69 public:
70  static void register_with_read_factory();
71 
72 protected:
73  static TypedWritable *make_PNMFileTypeSoftImage(const FactoryParams &params);
74 
75 public:
76  static TypeHandle get_class_type() {
77  return _type_handle;
78  }
79  static void init_type() {
80  PNMFileType::init_type();
81  register_type(_type_handle, "PNMFileTypeSoftImage",
82  PNMFileType::get_class_type());
83  }
84  virtual TypeHandle get_type() const {
85  return get_class_type();
86  }
87  virtual TypeHandle force_init_type() {init_type(); return get_class_type();}
88 
89 private:
90  static TypeHandle _type_handle;
91 };
92 
93 #endif // HAVE_SOFTIMAGE_PIC
94 
95 #endif
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
Base class for objects that can be written to and read from Bam files.
Definition: typedWritable.h:35
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
PANDA 3D SOFTWARE Copyright (c) Carnegie Mellon University.
This is the base class of a family of classes that represent particular image file types that PNMImag...
Definition: pnmFileType.h:32
An instance of this class is passed to the Factory when requesting it to do its business and construc...
Definition: factoryParams.h:36
This is an abstract base class that defines the interface for reading image files of various types.
Definition: pnmReader.h:27
get_extension
Returns the nth possible filename extension associated with this particular file type,...
Definition: pnmFileType.h:44
This is an abstract base class that defines the interface for writing image files of various types.
Definition: pnmWriter.h:27
PANDA 3D SOFTWARE Copyright (c) Carnegie Mellon University.
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
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
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.
TypeHandle is the identifier used to differentiate C++ class types.
Definition: typeHandle.h:81
PANDA 3D SOFTWARE Copyright (c) Carnegie Mellon University.
PANDA 3D SOFTWARE Copyright (c) Carnegie Mellon University.