Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  

PNMFileTypeTIFF Class Reference

For reading and writing TIFF files. More...

#include <pnmFileTypeTIFF.h>

Inheritance diagram for PNMFileTypeTIFF:

PNMFileType TypedWritable TypedObject List of all members.

Public Member Functions

 PNMFileTypeTIFF ()
virtual string get_name () const
 Returns a few words describing the file type.

virtual int get_num_extensions () const
 Returns the number of different possible filename extensions associated with this particular file type.

virtual string get_extension (int n) const
 Returns the nth possible filename extension associated with this particular file type, without a leading dot.

virtual string get_suggested_extension () const
 Returns a suitable filename extension (without a leading dot) to suggest for files of this type, or empty string if no suggestions are available.

virtual bool has_magic_number () const
 Returns true if this particular file type uses a magic number to identify it, false otherwise.

virtual bool matches_magic_number (const string &magic_number) const
 Returns true if the indicated "magic number" byte stream (the initial few bytes read from the file) matches this particular file type, false otherwise.

virtual PNMReader * make_reader (istream *file, bool owns_file=true, const string &magic_number=string())
 Allocates and returns a new PNMReader suitable for reading from this file type, if possible.

virtual PNMWriter * make_writer (ostream *file, bool owns_file=true)
 Allocates and returns a new PNMWriter suitable for reading from this file type, if possible.

virtual TypeHandle get_type () const
virtual TypeHandle force_init_type ()
virtual void write_datagram (BamWriter *writer, Datagram &datagram)
 Fills the indicated datagram up with a binary representation of the current object, in preparation for writing to a Bam file.

virtual int complete_pointers (TypedWritable **p_list, BamReader *manager)
 Receives an array of pointers, one for each time manager->read_pointer() was called in fillin().

virtual void finalize ()
 Called by the BamReader to perform any final actions needed for setting up the object after all objects have been read and all pointers have been completed.

int get_type_index () const
 Returns the internal index number associated with this object's TypeHandle, a unique number for each different type.

bool is_of_type (TypeHandle handle) const
 Returns true if the current object is or derives from the indicated type.

bool is_exact_type (TypeHandle handle) const
 Returns true if the current object is the indicated type exactly.


Static Public Member Functions

void register_with_read_factory ()
 Registers the current object as something that can be read from a Bam file.

TypeHandle get_class_type ()
void init_type ()
 This function is declared non-inline to work around a compiler bug in g++ 2.96.


Static Public Attributes

TypedWritable *const Null = (TypedWritable*)0L

Protected Member Functions

void fillin (DatagramIterator &scan, BamReader *manager)
 This internal function is intended to be called by each class's make_from_bam() method to read in all of the relevant data from the BamFile for the new object.


Static Protected Member Functions

TypedWritable * make_PNMFileTypeTIFF (const FactoryParams &params)
 This method is called by the BamReader when an object of this type is encountered in a Bam file; it should allocate and return a new object with all the data read.

void init_pnm ()
 Initializes the underlying PNM library, if it has not already been initialized.

TypedWritable * make_PNMFileType (const FactoryParams &params)

Static Private Member Functions

void install_error_handlers ()
 Installs our personal error and warning message handlers if they have not already been installed.

void tiff_warning (const char *module, const char *format, va_list ap)
 This is our own warning handler.

void tiff_error (const char *module, const char *format, va_list ap)
 This is our own error handler.


Static Private Attributes

bool _installed_error_handlers = false
TypeHandle _type_handle

Detailed Description

For reading and writing TIFF files.

Definition at line 43 of file pnmFileTypeTIFF.h.

Constructor & Destructor Documentation

PNMFileTypeTIFF::PNMFileTypeTIFF (   ) 
 

Definition at line 215 of file pnmFileTypeTIFF.cxx.

Member Function Documentation

int TypedWritable::complete_pointers (  TypedWritable **  p_list,
BamReader *  manager
)  [virtual, inherited]
 

Receives an array of pointers, one for each time manager->read_pointer() was called in fillin().

Returns the number of pointers processed.

This is the callback function that is made by the BamReader at some later point, after all of the required pointers have been filled in. It is necessary because there might be forward references in a bam file; when we call read_pointer() in fillin(), the object may not have been read from the file yet, so we do not have a pointer available at that time. Thus, instead of returning a pointer, read_pointer() simply reserves a later callback. This function provides that callback. The calling object is responsible for keeping track of the number of times it called read_pointer() and extracting the same number of pointers out of the supplied vector, and storing them appropriately within the object.

Reimplemented in AnimBundleNode, AnimGroup, PartBundleNode, PartGroup, Character, CharacterJoint, CollisionNode, GeomSprite, PiecewiseCurve, ClipPlaneAttrib, FogAttrib, LensNode, LightAttrib, MaterialAttrib, RenderEffects, RenderState, TextureAttrib, Person, and Child.

Definition at line 94 of file typedWritable.cxx.

Referenced by RenderState::do_invert_compose().

void TypedWritable::fillin (  DatagramIterator &  scan,
BamReader *  manager
)  [protected, inherited]
 

This internal function is intended to be called by each class's make_from_bam() method to read in all of the relevant data from the BamFile for the new object.

It is defined at the TypedWritable level so that derived classes may call up the inheritance chain from their own fillin() method.

Reimplemented in AnimBundle, AnimBundleNode, AnimChannelBase, AnimChannelMatrixXfmTable, AnimChannelScalarTable, AnimGroup, MovingPart< SwitchType >, PartBundleNode, PartGroup, Character, CharacterJoint, ComputedVertices, DynamicVertices, CollisionNode, CollisionPlane, CollisionPolygon, CollisionRay, CollisionSegment, CollisionSolid, CollisionSphere, dDrawable, Geom, GeomLine, GeomLinestrip, GeomPoint, GeomSprite, ImageBuffer, Material, Texture, ClassicNurbsCurve, CubicCurveseg, HermiteCurve, ParametricCurve, PiecewiseCurve, RopeNode, AlphaTestAttrib, AmbientLight, BillboardEffect, Camera, ClipPlaneAttrib, ColorAttrib, ColorBlendAttrib, ColorScaleAttrib, ColorWriteAttrib, CompassEffect, CullBinAttrib, CullFaceAttrib, DecalEffect, DepthOffsetAttrib, DepthTestAttrib, DepthWriteAttrib, DirectionalLight, Fog, FogAttrib, GeomNode, LensNode, LightAttrib, LightLensNode, LightNode, LODNode, MaterialAttrib, ModelNode, ModelRoot, PandaNode, PlaneNode, PointLight, RenderAttrib, RenderEffect, RenderEffects, RenderModeAttrib, RenderState, SequenceNode, ShowBoundsEffect, Spotlight, SwitchNode, TexMatrixAttrib, TextureApplyAttrib, TextureAttrib, TransformState, TransparencyAttrib, MovingPart< ACScalarSwitchType >, and MovingPart< ACMatrixSwitchType >.

Definition at line 139 of file typedWritable.cxx.

Referenced by PandaNode::reparent().

void TypedWritable::finalize (  void   )  [virtual, inherited]
 

Called by the BamReader to perform any final actions needed for setting up the object after all objects have been read and all pointers have been completed.

Reimplemented in PartBundle, RenderAttrib, RenderEffect, RenderEffects, RenderState, and TransformState.

Definition at line 112 of file typedWritable.cxx.

Referenced by BamReader::skip_pointer().

virtual TypeHandle PNMFileTypeTIFF::force_init_type (  void   )  [inline, virtual]
 

Reimplemented from PNMFileType.

Definition at line 111 of file pnmFileTypeTIFF.h.

TypeHandle PNMFileTypeTIFF::get_class_type (  void   )  [inline, static]
 

Reimplemented from PNMFileType.

Definition at line 100 of file pnmFileTypeTIFF.h.

string PNMFileTypeTIFF::get_extension (  int  n  )  const [virtual]
 

Returns the nth possible filename extension associated with this particular file type, without a leading dot.

Reimplemented from PNMFileType.

Definition at line 259 of file pnmFileTypeTIFF.cxx.

string PNMFileTypeTIFF::get_name (   )  const [virtual]
 

Returns a few words describing the file type.

Implements PNMFileType.

Definition at line 227 of file pnmFileTypeTIFF.cxx.

References num_extensions_tiff.

int PNMFileTypeTIFF::get_num_extensions (   )  const [virtual]
 

Returns the number of different possible filename extensions associated with this particular file type.

Reimplemented from PNMFileType.

Definition at line 242 of file pnmFileTypeTIFF.cxx.

References extensions_tiff, nassertr, and num_extensions_tiff.

string PNMFileTypeTIFF::get_suggested_extension (   )  const [virtual]
 

Returns a suitable filename extension (without a leading dot) to suggest for files of this type, or empty string if no suggestions are available.

Reimplemented from PNMFileType.

Definition at line 277 of file pnmFileTypeTIFF.cxx.

References nassertr.

virtual TypeHandle PNMFileTypeTIFF::get_type (  void   )  const [inline, virtual]
 

Reimplemented from PNMFileType.

Definition at line 108 of file pnmFileTypeTIFF.h.

int TypedObject::get_type_index (   )  const [inline, inherited]
 

Returns the internal index number associated with this object's TypeHandle, a unique number for each different type.

This is equivalent to get_type().get_index().

Definition at line 71 of file typedObject.I.

References TypeHandle::get_name(), TypedObject::get_type(), and INLINE.

bool PNMFileTypeTIFF::has_magic_number (   )  const [virtual]
 

Returns true if this particular file type uses a magic number to identify it, false otherwise.

Reimplemented from PNMFileType.

Definition at line 292 of file pnmFileTypeTIFF.cxx.

References PNMFileType::init_pnm(), and install_error_handlers().

void PNMFileType::init_pnm (   )  [static, protected, inherited]
 

Initializes the underlying PNM library, if it has not already been initialized.

This should be called by every implementation of make_reader() and make_writer(), to ensure that the library is properly initialized before any I/O is attempted.

Definition at line 190 of file pnmFileType.cxx.

Referenced by PNMFileTypeTGA::get_extension(), PNMFileTypeIMG::get_extension(), PNMFileTypeAlias::get_extension(), PNMFileTypeTGA::get_suggested_extension(), PNMFileTypeIMG::get_suggested_extension(), PNMFileTypeAlias::get_suggested_extension(), has_magic_number(), PNMFileTypeSoftImage::has_magic_number(), PNMFileTypeSGI::has_magic_number(), PNMFileTypeJPG2000::has_magic_number(), and PNMFileTypeJPG::has_magic_number().

void PNMFileTypeTIFF::init_type (  void   )  [inline, static]
 

This function is declared non-inline to work around a compiler bug in g++ 2.96.

Making it inline seems to cause problems in the optimizer.

Reimplemented from PNMFileType.

Definition at line 103 of file pnmFileTypeTIFF.h.

void PNMFileTypeTIFF::install_error_handlers (   )  [static, private]
 

Installs our personal error and warning message handlers if they have not already been installed.

These methods are used to route the Tiff error messages through notify, so we can turn some of them off.

Definition at line 982 of file pnmFileTypeTIFF.cxx.

Referenced by has_magic_number().

bool TypedObject::is_exact_type (  TypeHandle  handle  )  const [inline, inherited]
 

Returns true if the current object is the indicated type exactly.

Definition at line 101 of file typedObject.I.

Referenced by PT(), and CollisionNode::xform().

bool TypedObject::is_of_type (  TypeHandle  handle  )  const [inline, inherited]
 

Returns true if the current object is or derives from the indicated type.

Definition at line 86 of file typedObject.I.

Referenced by EggMaterialCollection::collapse_equivalent_materials(), EggTextureCollection::collapse_equivalent_textures(), DeferredNodeProperty::compose(), AnimBundleMaker::create_s_channel(), CharacterMaker::create_slider(), ProjectionScreen::cull_callback(), DataNode::define_output(), EggNode::determine_draw_order(), CharacterMaker::egg_to_index(), EggGroupUniquifier::EggGroupUniquifier(), EggPoolUniquifier::EggPoolUniquifier(), EggGroupNode::find_textures(), StaticTextFont::get_glyph(), EggMaterialCollection::insert_materials(), EggTextureCollection::insert_textures(), CharacterJoint::make_copy(), PT(), EggGroupNode::r_flatten_transforms(), EggGroupNode::r_transform_vertices(), EggGroupNode::recompute_polygon_normals(), CollisionLevelState::reserve(), PandaFramework::reset_frame_rate(), PandaFramework::set_texture(), EggGroupNode::steal_children(), and DataGraphTraverser::traverse().

TypedWritable* PNMFileType::make_PNMFileType (  const FactoryParams &  params  )  [static, protected, inherited]
 

TypedWritable * PNMFileTypeTIFF::make_PNMFileTypeTIFF (  const FactoryParams &  params  )  [static, protected]
 

This method is called by the BamReader when an object of this type is encountered in a Bam file; it should allocate and return a new object with all the data read.

In the case of the PNMFileType objects, since these objects are all shared, we just pull the object from the registry.

Definition at line 1080 of file pnmFileTypeTIFF.cxx.

PNMReader * PNMFileTypeTIFF::make_reader (  istream *  file,
bool  owns_file = true,
const string &  magic_number = string()
)  [virtual]
 

Allocates and returns a new PNMReader suitable for reading from this file type, if possible.

If reading from this file type is not supported, returns NULL.

Reimplemented from PNMFileType.

Definition at line 330 of file pnmFileTypeTIFF.cxx.

PNMWriter * PNMFileTypeTIFF::make_writer (  ostream *  file,
bool  owns_file = true
)  [virtual]
 

Allocates and returns a new PNMWriter suitable for reading from this file type, if possible.

If writing files of this type is not supported, returns NULL.

Reimplemented from PNMFileType.

Definition at line 349 of file pnmFileTypeTIFF.cxx.

References NULL.

bool PNMFileTypeTIFF::matches_magic_number (  const string &  magic_number  )  const [virtual]
 

Returns true if the indicated "magic number" byte stream (the initial few bytes read from the file) matches this particular file type, false otherwise.

Reimplemented from PNMFileType.

Definition at line 309 of file pnmFileTypeTIFF.cxx.

void PNMFileTypeTIFF::register_with_read_factory (  void   )  [static]
 

Registers the current object as something that can be read from a Bam file.

Reimplemented from PNMFileType.

Definition at line 1052 of file pnmFileTypeTIFF.cxx.

void PNMFileTypeTIFF::tiff_error (  const char *  module,
const char *  format,
va_list  ap
)  [static, private]
 

This is our own error handler.

It is called by the tiff library to issue a error message.

Definition at line 1026 of file pnmFileTypeTIFF.cxx.

void PNMFileTypeTIFF::tiff_warning (  const char *  module,
const char *  format,
va_list  ap
)  [static, private]
 

This is our own warning handler.

It is called by the tiff library to issue a warning message.

Definition at line 1001 of file pnmFileTypeTIFF.cxx.

void PNMFileType::write_datagram (  BamWriter *  writer,
Datagram &  datagram
)  [virtual, inherited]
 

Fills the indicated datagram up with a binary representation of the current object, in preparation for writing to a Bam file.

None of the particular PNMFileType objects store any extra data--at least, not yet--so we just define this up here to do nothing.

Reimplemented from TypedWritable.

Definition at line 243 of file pnmFileType.cxx.

Member Data Documentation

bool PNMFileTypeTIFF::_installed_error_handlers = false [static, private]
 

Definition at line 204 of file pnmFileTypeTIFF.cxx.

Referenced by iostream_unmap().

TypeHandle PNMFileTypeTIFF::_type_handle [static, private]
 

Reimplemented from PNMFileType.

Definition at line 205 of file pnmFileTypeTIFF.cxx.

Referenced by iostream_unmap().

TypedWritable *const TypedWritable::Null = (TypedWritable*)0L [static, inherited]
 

Definition at line 25 of file typedWritable.cxx.

Referenced by Child::complete_pointers(), Parent::complete_pointers(), Person::complete_pointers(), LoaderFileTypeBam::get_extension(), PartGroup::pick_channel_index(), BamReader::read_pointer(), and AnimGroup::write_datagram().

The documentation for this class was generated from the following files:
Generated on Fri May 2 00:54:03 2003 for Panda by doxygen1.3