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

FltExternalReference Class Reference

An external reference to another flt file (possibly to a specific bead within the flt file). More...

#include <fltExternalReference.h>

Inheritance diagram for FltExternalReference:


Public Types
enum	Flags { F_color_palette_override = 0x80000000, F_material_palette_override = 0x40000000, F_texture_palette_override = 0x20000000, F_line_style_palette_override = 0x10000000, F_sound_palette_override = 0x08000000, F_light_palette_override = 0x04000000 }
Public Member Functions
	FltExternalReference (FltHeader *header)
virtual void	apply_converted_filenames ()
	Walks the hierarchy at this record and below and copies the _converted_filename record into the _orig_filename record, so the flt file will be written out with the converted filename instead of what was originally read in.
virtual void	output (ostream &out) const
	Writes a quick one-line description of the record, but not its children.
Filename	get_ref_filename () const
	Returns the name of the referenced file.
void	set_ref_filename (const Filename &filename)
	Changes the name of the referenced file.
virtual TypeHandle	get_type () const
virtual TypeHandle	force_init_type ()
bool	has_transform () const
	Returns true if the bead has been transformed, false otherwise.
const LMatrix4d &	get_transform () const
	Returns the single-precision 4x4 matrix that represents the transform applied to this bead, or the identity matrix if the bead has not been transformed.
void	set_transform (const LMatrix4d &mat)
	Replaces the transform matrix on this bead.
void	clear_transform ()
	Removes any transform matrix and all transform steps on this bead.
int	get_num_transform_steps () const
	Returns the number of individual steps that define the net transform on this bead as returned by set_transform().
FltTransformRecord *	get_transform_step (int n)
	Returns the nth individual step that defines the net transform on this bead.
const FltTransformRecord *	get_transform_step (int n) const
	Returns the nth individual step that defines the net transform on this bead.
void	add_transform_step (FltTransformRecord *record)
	Applies the indicated transform step to the net transformation applied to the bead.
int	get_replicate_count () const
	Returns the replicate count of this bead.
void	set_replicate_count (int count)
	Changes the replicate count of this bead.
int	get_num_children () const
	Returns the number of child records of this record.
FltRecord *	get_child (int n) const
	Returns the nth child of this record.
void	clear_children ()
	Removes all children from this record.
void	add_child (FltRecord *child)
	Adds a new child to the end of the list of children for this record.
int	get_num_subfaces () const
	Returns the number of subface records of this record.
FltRecord *	get_subface (int n) const
	Returns the nth subface of this record.
void	clear_subfaces ()
	Removes all subfaces from this record.
void	add_subface (FltRecord *subface)
	Adds a new subface to the end of the list of subfaces for this record.
int	get_num_extensions () const
	Returns the number of extension attribute records for this object.
FltRecord *	get_extension (int n) const
	Returns the nth extension of this record.
void	clear_extensions ()
	Removes all extensions from this record.
void	add_extension (FltRecord *extension)
	Adds a new extension to the end of the list of extensions for this record.
int	get_num_ancillary () const
	Returns the number of unsupported ancillary records of this record.
FltRecord *	get_ancillary (int n) const
	Returns the nth unsupported ancillary record of this record.
void	clear_ancillary ()
	Removes all unsupported ancillary records from this record.
void	add_ancillary (FltRecord *ancillary)
	Adds a new unsupported ancillary record to the end of the list of ancillary records for this record.
bool	has_comment () const
	Returns true if this record has a nonempty comment, false otherwise.
const string &	get_comment () const
	Retrieves the comment for this record, or empty string if the record has no comment.
void	clear_comment ()
	Removes the comment for this record.
void	set_comment (const string &comment)
	Changes the comment for this record.
void	check_remaining_size (const DatagramIterator &di, const string &name=string()) const
	Checks that the iterator has no bytes left, as it should at the end of a successfully read record.
virtual void	write (ostream &out, int indent_level=0) const
	Writes a multiple-line description of the record and all of its children.
int	get_type_index () const
bool	is_of_type (TypeHandle handle) const
bool	is_exact_type (TypeHandle handle) const
int	get_ref_count () const
int	ref () const
int	unref () const
void	test_ref_count_integrity () const
Static Public Member Functions
TypeHandle	get_class_type ()
void	init_type ()
Public Attributes
string	_orig_filename
Filename	_converted_filename
string	_bead_id
int	_flags
Protected Member Functions
virtual bool	extract_record (FltRecordReader &reader)
	Fills in the information in this bead based on the information given in the indicated datagram, whose opcode has already been read.
virtual bool	build_record (FltRecordWriter &writer) const
	Fills up the current record on the FltRecordWriter with data for this record, but does not advance the writer.
virtual bool	extract_ancillary (FltRecordReader &reader)
	Checks whether the given bead, which follows this bead sequentially in the file, is an ancillary record of this bead.
virtual FltError	write_ancillary (FltRecordWriter &writer) const
	Writes whatever ancillary records are required for this record.
void	write_children (ostream &out, int indent_level) const
	Assuming the current write position has been left at the end of the last line of the record description, writes out the list of children.
FltRecord *	create_new_record (FltOpcode opcode) const
	Creates a new FltRecord corresponding to the opcode.
FltError	read_record_and_children (FltRecordReader &reader)
	Extracts this record information from the current record presented in the reader, then advances the reader and continues to read any children, if present.
virtual FltError	write_record_and_children (FltRecordWriter &writer) const
	Writes this record out to the flt file, along with all of its ancillary records and children records.
Static Protected Member Functions
bool	is_ancillary (FltOpcode opcode)
	Returns true if the indicated opcode corresponds to an ancillary record type, false otherwise.
Protected Attributes
FltHeader *	_header
int	_ref_count
Static Private Attributes
TypeHandle	_type_handle

Detailed Description

An external reference to another flt file (possibly to a specific bead within the flt file).

Definition at line 40 of file fltExternalReference.h.

Member Enumeration Documentation

enum FltExternalReference::Flags

Enumeration values:

F_color_palette_override

F_material_palette_override

F_texture_palette_override

F_line_style_palette_override

F_sound_palette_override

F_light_palette_override

Definition at line 47 of file fltExternalReference.h.

Constructor & Destructor Documentation

FltExternalReference::FltExternalReference ( FltHeader * header )

Definition at line 38 of file fltExternalReference.cxx.
References _converted_filename, _orig_filename, FltRecord::apply_converted_filenames(), and Filename::to_os_generic().

Member Function Documentation

void FltRecord::add_ancillary ( FltRecord * ancillary ) [inherited]

Adds a new unsupported ancillary record to the end of the list of ancillary records for this record.
This record will be written to the flt file following this record, without attempting to understand what is in it.
Normally, there is no reason to use this function; if the data stored in the FltRecord requires one or more ancillary record, the appropriate records will automatically be generated when the record is written. This function is only required to output a record whose type is not supported by the flt loader. But it would be better to extend the flt loader to know about this new kind of data record.
Definition at line 341 of file fltRecord.cxx.

void FltRecord::add_child ( FltRecord * child ) [inherited]

Adds a new child to the end of the list of children for this record.

Definition at line 126 of file fltRecord.cxx.
References nassertr, and NULL.
Referenced by FltRecord::is_ancillary().

void FltRecord::add_extension ( FltRecord * extension ) [inherited]

Adds a new extension to the end of the list of extensions for this record.
This should be a record of type FO_extension.
Definition at line 250 of file fltRecord.cxx.
Referenced by FltRecord::is_ancillary().

void FltRecord::add_subface ( FltRecord * subface ) [inherited]

Adds a new subface to the end of the list of subfaces for this record.

Definition at line 187 of file fltRecord.cxx.
Referenced by FltRecord::is_ancillary().

void FltBead::add_transform_step ( FltTransformRecord * record ) [inherited]

Applies the indicated transform step to the net transformation applied to the bead.

Definition at line 201 of file fltBead.cxx.

void FltExternalReference::apply_converted_filenames ( ) [virtual]

Walks the hierarchy at this record and below and copies the _converted_filename record into the _orig_filename record, so the flt file will be written out with the converted filename instead of what was originally read in.

Reimplemented from FltRecord.
Definition at line 59 of file fltExternalReference.cxx.
References _bead_id, and get_ref_filename().

bool FltExternalReference::build_record ( FltRecordWriter & writer ) const [protected, virtual]

Fills up the current record on the FltRecordWriter with data for this record, but does not advance the writer.
Returns true on success, false if there is some error.
Reimplemented from FltBead.
Definition at line 174 of file fltExternalReference.cxx.

void FltRecord::check_remaining_size ( const DatagramIterator & di,

const string & name = string()

) const [inherited]

Checks that the iterator has no bytes left, as it should at the end of a successfully read record.
If there *are* remaining bytes, print a warning message but otherwise don't worry about it.
If we are attempting to read a flt file whose version is newer than the newest this program understands, don't even print a warning message, since this is exactly the sort of thing we expect.
Definition at line 426 of file fltRecord.cxx.
References FO_14_material_palette, FO_bounding_box, FO_bounding_cylinder, FO_bounding_sphere, FO_bv_center, FO_bv_orientation, FO_cat_data, FO_comment, FO_general_matrix, FO_local_vertex_pool, FO_long_id, FO_multitexture, FO_put, FO_replicate, FO_road_zone, FO_rotate_about_edge, FO_rotate_about_point, FO_rotate_and_scale, FO_scale, FO_transform_matrix, FO_translate, FO_uv_list, FO_vector, FO_vertex_c, and FO_vertex_palette.
Referenced by FltLocalVertexPool::FltLocalVertexPool(), FltVectorRecord::get_vector(), FltTransformScale::recompute_matrix(), FltTransformRotateAboutPoint::recompute_matrix(), FltTransformRotateAboutEdge::recompute_matrix(), FltTransformGeneralMatrix::set_matrix(), and FltInstanceRef::write().

void FltRecord::clear_ancillary ( ) [inherited]

Removes all unsupported ancillary records from this record.
See get_num_ancillary().
Definition at line 304 of file fltRecord.cxx.
References FltRecord::_header, FltHeader::get_flt_version(), DatagramIterator::get_remaining_size(), TypedReferenceCount::get_type(), FltHeader::max_flt_version(), and nout.

void FltRecord::clear_children ( ) [inherited]

Removes all children from this record.

Definition at line 111 of file fltRecord.cxx.

void FltRecord::clear_comment ( ) [inherited]

Removes the comment for this record.

Definition at line 384 of file fltRecord.cxx.

void FltRecord::clear_extensions ( ) [inherited]

Removes all extensions from this record.

Definition at line 233 of file fltRecord.cxx.

void FltRecord::clear_subfaces ( ) [inherited]

Removes all subfaces from this record.

Definition at line 172 of file fltRecord.cxx.
References nassertr, and NULL.

void FltBead::clear_transform ( ) [inherited]

Removes any transform matrix and all transform steps on this bead.

Definition at line 123 of file fltBead.cxx.
References nassertr, and NULL.

FltRecord * FltRecord::create_new_record ( FltOpcode opcode ) const [protected, inherited]

Creates a new FltRecord corresponding to the opcode.
If the opcode is unknown, creates a FltUnsupportedRecord.
Definition at line 672 of file fltRecord.cxx.
References reader().
Referenced by FltRecord::is_ancillary().

bool FltBead::extract_ancillary ( FltRecordReader & reader ) [protected, virtual, inherited]

Checks whether the given bead, which follows this bead sequentially in the file, is an ancillary record of this bead.
If it is, extracts the relevant information and returns true; otherwise, leaves it alone and returns false.
Reimplemented from FltRecord.
Reimplemented in FltBeadID, and FltMesh.
Definition at line 292 of file fltBead.cxx.
References FE_ok, FltError, FltRecord::write_ancillary(), FltBead::write_replicate_count(), FltBead::write_transform(), and writer().

bool FltExternalReference::extract_record ( FltRecordReader & reader ) [protected, virtual]

Fills in the information in this bead based on the information given in the indicated datagram, whose opcode has already been read.
Returns true on success, false if the datagram is invalid.
Reimplemented from FltBead.
Definition at line 128 of file fltExternalReference.cxx.
References _bead_id, _flags, _orig_filename, Datagram::add_be_uint32(), Datagram::add_fixed_string(), FltBead::build_record(), FO_external_ref, Datagram::pad_bytes(), and writer().

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

Reimplemented from TypedReferenceCount.
Definition at line 72 of file fltExternalReference.h.

FltRecord * FltRecord::get_ancillary ( int n ) const [inherited]

Returns the nth unsupported ancillary record of this record.
See get_num_ancillary().
Definition at line 288 of file fltRecord.cxx.

FltRecord * FltRecord::get_child ( int n ) const [inherited]

Returns the nth child of this record.

Definition at line 97 of file fltRecord.cxx.
Referenced by FltCopy::scan_flt().

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

Reimplemented from TypedReferenceCount.
Definition at line 73 of file fltExternalReference.h.

const string & FltRecord::get_comment ( ) const [inherited]

Retrieves the comment for this record, or empty string if the record has no comment.

Definition at line 371 of file fltRecord.cxx.
References indent(), and FltRecord::write_children().

FltRecord * FltRecord::get_extension ( int n ) const [inherited]

Returns the nth extension of this record.

Definition at line 219 of file fltRecord.cxx.
References nassertr, and NULL.

int FltRecord::get_num_ancillary ( ) const [inherited]

Returns the number of unsupported ancillary records of this record.
These are ancillary records that appeared following this record in the flt file but that aren't directly understood by the flt loader--normally, an ancillary record is examined and decoded on the spot, and no pointer to it is kept.
Definition at line 273 of file fltRecord.cxx.

int FltRecord::get_num_children ( ) const [inherited]

Returns the number of child records of this record.
This reflects the normal scene graph hierarchy.
Definition at line 84 of file fltRecord.cxx.
References NULL.

int FltRecord::get_num_extensions ( ) const [inherited]

Returns the number of extension attribute records for this object.
These are auxiliary nodes, presumably of type FO_extension, that have some local meaning to the object.
Definition at line 206 of file fltRecord.cxx.

int FltRecord::get_num_subfaces ( ) const [inherited]

Returns the number of subface records of this record.
Normally, subfaces will only be present on object records, although it is logically possible for them to appear anywhere.
Definition at line 145 of file fltRecord.cxx.

int FltBead::get_num_transform_steps ( ) const [inherited]

Returns the number of individual steps that define the net transform on this bead as returned by set_transform().
Each step is a single transformation; the concatenation of all transformations will produce the matrix represented by set_transform().
Definition at line 148 of file fltBead.cxx.
References FltBead::_has_transform, FltBead::_transform, and FltTransformRecord::get_matrix().

Filename FltExternalReference::get_ref_filename ( ) const

Returns the name of the referenced file.

Definition at line 95 of file fltExternalReference.cxx.
References FltBead::extract_record(), FO_external_ref, DatagramIterator::get_fixed_string(), nassertr, reader(), and DatagramIterator::skip_bytes().
Referenced by apply_converted_filenames(), and FltToEggConverter::convert_bead().

int FltBead::get_replicate_count ( ) const [inherited]

Returns the replicate count of this bead.
If this is nonzero, it means that the bead is implicitly copied this number of additional times (for replicate_count + 1 total copies), applying the transform on this bead for each copy. In this case, the transform does not* apply to the initial copy of the bead.
Definition at line 230 of file fltBead.cxx.
References FO_rotate_about_edge, FO_rotate_about_point, FO_rotate_and_scale, FO_scale, and FO_translate.

FltRecord * FltRecord::get_subface ( int n ) const [inherited]

Returns the nth subface of this record.

Definition at line 158 of file fltRecord.cxx.

const LMatrix4d & FltBead::get_transform ( ) const [inherited]

Returns the single-precision 4x4 matrix that represents the transform applied to this bead, or the identity matrix if the bead has not been transformed.

Definition at line 86 of file fltBead.cxx.
Referenced by FltToEggLevelState::ParentNodes::ParentNodes().

const FltTransformRecord * FltBead::get_transform_step ( int n ) const [inherited]

Returns the nth individual step that defines the net transform on this bead.
See get_num_transform_steps().
Definition at line 184 of file fltBead.cxx.

FltTransformRecord * FltBead::get_transform_step ( int n ) [inherited]

Returns the nth individual step that defines the net transform on this bead.
See get_num_transform_steps().
Definition at line 165 of file fltBead.cxx.

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

Reimplemented from TypedReferenceCount.
Definition at line 69 of file fltExternalReference.h.
References _type_handle, TypedReferenceCount::init_type(), and register_type().

bool FltRecord::has_comment ( ) const [inherited]

Returns true if this record has a nonempty comment, false otherwise.

Definition at line 356 of file fltRecord.cxx.
References TypedReferenceCount::get_type().

bool FltBead::has_transform ( ) const [inherited]

Returns true if the bead has been transformed, false otherwise.
If this returns true, get_transform() will return the single-precision net transformation, and get_num_transform_steps() will return nonzero.
Definition at line 69 of file fltBead.cxx.
References FltBead::_has_transform, and FltBead::_transform.

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

Reimplemented from TypedReferenceCount.
Definition at line 76 of file fltExternalReference.h.
References _type_handle.

bool FltRecord::is_ancillary ( FltOpcode opcode ) [static, protected, inherited]

Returns true if the indicated opcode corresponds to an ancillary record type, false otherwise.
In general, this function is used to identify ancillary records that are not presently supported by the FltReader; these will be ignored. Normally, ancillary records will be detected and processed by extract_ancillary().
Definition at line 575 of file fltRecord.cxx.
References FltRecord::_header, FltRecord::add_child(), FltRecord::add_extension(), FltHeader::add_instance(), FltRecord::add_subface(), FltRecord::create_new_record(), DCAST, FltRecord::extract_ancillary(), FltRecord::extract_record(), FE_end_of_file, FE_invalid_record, FE_ok, flt_error_abort, FltError, FO_pop, FO_pop_extension, FO_pop_face, FO_push, FO_push_extension, FO_push_face, FltInstanceDefinition::get_class_type(), nout, PT, and reader().

void FltExternalReference::output ( ostream & out ) const [virtual]

Writes a quick one-line description of the record, but not its children.
This is a human-readable description, primarily for debugging; to write a flt file, use FltHeader::write_flt().
Reimplemented from FltRecord.
Definition at line 79 of file fltExternalReference.cxx.
References _converted_filename, _orig_filename, and Filename::to_os_generic().

FltError FltRecord::read_record_and_children ( FltRecordReader & reader ) [protected, inherited]

Extracts this record information from the current record presented in the reader, then advances the reader and continues to read any children, if present.
On return, the reader is position on the next sibling record to this record.
Returns FE_ok if successful, otherwise on error.
Definition at line 740 of file fltRecord.cxx.
References FE_ok.

void FltRecord::set_comment ( const string & comment ) [inherited]

Changes the comment for this record.

Definition at line 397 of file fltRecord.cxx.

void FltExternalReference::set_ref_filename ( const Filename & filename )

Changes the name of the referenced file.

Definition at line 108 of file fltExternalReference.cxx.
References _bead_id, _flags, _orig_filename, and size_t.

void FltBead::set_replicate_count ( int count ) [inherited]

Changes the replicate count of this bead.
If you are setting the replicate count to some nonzero number, you must also set a transform on the bead. See set_replicate_count().
Definition at line 249 of file fltBead.cxx.
References FO_replicate.

void FltBead::set_transform ( const LMatrix4d & mat ) [inherited]

Replaces the transform matrix on this bead.
This implicitly removes all of the transform steps added previously, and replaces them with a single 4x4 general matrix transform step.
Definition at line 105 of file fltBead.cxx.

void FltRecord::write ( ostream & out,

int indent_level = 0

) const [virtual, inherited]

Writes a multiple-line description of the record and all of its children.
This is a human-readable description, primarily for debugging; to write a flt file, use FltHeader::write_flt().
Reimplemented in FltInstanceRef.
Definition at line 504 of file fltRecord.cxx.
References FO_instance, FO_instance_ref, FO_pop_extension, FO_push_extension, and nout.

FltError FltBead::write_ancillary ( FltRecordWriter & writer ) const [protected, virtual, inherited]

Writes whatever ancillary records are required for this record.
Returns FE_ok on success, or something else if there is some error.
Reimplemented from FltRecord.
Reimplemented in FltBeadID, and FltMesh.
Definition at line 379 of file fltBead.cxx.
References FE_invalid_record.
Referenced by FltBeadID::extract_ancillary().

void FltRecord::write_children ( ostream & out,

int indent_level

) const [protected, inherited]

Assuming the current write position has been left at the end of the last line of the record description, writes out the list of children.

Definition at line 522 of file fltRecord.cxx.
References FltRecord::_header, FO_curve, FO_external_ref, FO_face, FO_group, FO_instance, FO_instance_ref, FO_local_vertex_pool, FO_lod, FO_mesh, FO_mesh_primitive, FO_object, FO_vector, FO_vertex_list, and nout.
Referenced by FltRecord::get_comment(), and FltInstanceRef::get_instance().

FltError FltRecord::write_record_and_children ( FltRecordWriter & writer ) const [protected, virtual, inherited]

Writes this record out to the flt file, along with all of its ancillary records and children records.
Returns FE_ok on success, or something else on error.
Reimplemented in FltInstanceRef.
Definition at line 904 of file fltRecord.cxx.
Referenced by FltInstanceRef::extract_record().

Member Data Documentation

string FltExternalReference::_bead_id

Definition at line 58 of file fltExternalReference.h.
Referenced by apply_converted_filenames(), extract_record(), and set_ref_filename().

Filename FltExternalReference::_converted_filename

Definition at line 57 of file fltExternalReference.h.
Referenced by FltExternalReference(), and output().

int FltExternalReference::_flags

Definition at line 59 of file fltExternalReference.h.
Referenced by extract_record(), and set_ref_filename().

FltHeader* FltRecord::_header [protected, inherited]

Definition at line 107 of file fltRecord.h.
Referenced by FltVertexList::add_vertex(), FltRecord::clear_ancillary(), FltVertexList::extract_record(), FltInstanceRef::extract_record(), FltGroup::extract_record(), FltInstanceRef::FltInstanceRef(), FltLocalVertexPool::FltLocalVertexPool(), FltGeometry::get_alt_rgb(), FltInstanceRef::get_instance(), FltGeometry::get_texture(), FltGeometry::has_alt_color(), FltGeometry::has_texture(), FltRecord::is_ancillary(), and FltRecord::write_children().

string FltExternalReference::_orig_filename

Definition at line 56 of file fltExternalReference.h.
Referenced by extract_record(), FltExternalReference(), output(), and set_ref_filename().

TypeHandle FltExternalReference::_type_handle [static, private]

Reimplemented from TypedReferenceCount.
Definition at line 28 of file fltExternalReference.cxx.
Referenced by get_type(), and init_type().

The documentation for this class was generated from the following files:

pandatool/src/flt/fltExternalReference.h
pandatool/src/flt/fltExternalReference.cxx

Generated on Fri May 2 03:26:39 2003 for Panda-Tool by

1.3

FltExternalReference Class Reference

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Static Private Attributes

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation