The base class for all kinds of records in a MultiGen OpenFlight file. More...

#include "fltRecord.h"

Inheritance diagram for FltRecord:

Public Member Functions
	FltRecord (FltHeader *header)

void	add_ancillary (FltRecord *ancillary)
	Adds a new unsupported ancillary record to the end of the list of ancillary records for this record. More...

void	add_child (FltRecord *child)
	Adds a new child to the end of the list of children for this record. More...

void	add_extension (FltRecord *extension)
	Adds a new extension to the end of the list of extensions for this record. More...

void	add_subface (FltRecord *subface)
	Adds a new subface to the end of the list of subfaces for this record. More...

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. More...

void	check_remaining_size (const DatagramIterator &di, const std::string &name=std::string()) const
	Checks that the iterator has no bytes left, as it should at the end of a successfully read record. More...

void	clear_ancillary ()
	Removes all unsupported ancillary records from this record. More...

void	clear_children ()
	Removes all children from this record. More...

void	clear_comment ()
	Removes the comment for this record. More...

void	clear_extensions ()
	Removes all extensions from this record. More...

void	clear_subfaces ()
	Removes all subfaces from this record. More...

virtual TypeHandle	force_init_type ()

FltRecord *	get_ancillary (int n) const
	Returns the nth unsupported ancillary record of this record. More...

FltRecord *	get_child (int n) const
	Returns the nth child of this record. More...

const std::string &	get_comment () const
	Retrieves the comment for this record, or empty string if the record has no comment. More...

FltRecord *	get_extension (int n) const
	Returns the nth extension of this record. More...

int	get_num_ancillary () const
	Returns the number of unsupported ancillary records of this record. More...

int	get_num_children () const
	Returns the number of child records of this record. More...

int	get_num_extensions () const
	Returns the number of extension attribute records for this object. More...

int	get_num_subfaces () const
	Returns the number of subface records of this record. More...

FltRecord *	get_subface (int n) const
	Returns the nth subface of this record. More...

virtual TypeHandle	get_type () const

bool	has_comment () const
	Returns true if this record has a nonempty comment, false otherwise. More...

virtual void	output (std::ostream &out) const
	Writes a quick one-line description of the record, but not its children. More...

void	set_comment (const std::string &comment)
	Changes the comment for this record. More...

virtual void	write (std::ostream &out, int indent_level=0) const
	Writes a multiple-line description of the record and all of its children. More...

Public Member Functions inherited from TypedReferenceCount
	TypedReferenceCount (const TypedReferenceCount &copy)

void	operator= (const TypedReferenceCount &copy)

Public Member Functions inherited from TypedObject
	TypedObject (const TypedObject &copy)=default

TypedObject *	as_typed_object ()
	Returns the object, upcast (if necessary) to a TypedObject pointer. More...

const TypedObject *	as_typed_object () const
	Returns the object, upcast (if necessary) to a TypedObject pointer. More...

int	get_best_parent_from_Set (const std::set< int > &) const

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

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

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

TypedObject &	operator= (const TypedObject &copy)=default

Public Member Functions inherited from ReferenceCount
int	get_ref_count () const

WeakReferenceList *	get_weak_list () const
	Returns the WeakReferenceList associated with this ReferenceCount object. More...

bool	has_weak_list () const
	Returns true if this particular ReferenceCount object has a WeakReferenceList created, false otherwise. More...

void	local_object ()
	This function should be called, once, immediately after creating a new instance of some ReferenceCount-derived object on the stack. More...

void	ref () const
	Explicitly increments the reference count. More...

bool	ref_if_nonzero () const
	Atomically increases the reference count of this object if it is not zero. More...

bool	test_ref_count_integrity () const
	Does some easy checks to make sure that the reference count isn't completely bogus. More...

bool	test_ref_count_nonzero () const
	Does some easy checks to make sure that the reference count isn't zero, or completely bogus. More...

virtual bool	unref () const
	Explicitly decrements the reference count. More...

WeakReferenceList *	weak_ref ()
	Adds the indicated PointerToVoid as a weak reference to this object. More...

void	weak_unref ()
	Removes the indicated PointerToVoid as a weak reference to this object. More...

Static Public Member Functions
static TypeHandle	get_class_type ()

static void	init_type ()

Static Public Member Functions inherited from TypedReferenceCount
static TypeHandle	get_class_type ()

static void	init_type ()

Static Public Member Functions inherited from TypedObject
static TypeHandle	get_class_type ()

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

Static Public Member Functions inherited from ReferenceCount
static TypeHandle	get_class_type ()

static void	init_type ()

Additional Inherited Members
Public Attributes inherited from TypedObject
	get_type

Public Attributes inherited from ReferenceCount
	get_ref_count
	Returns the current reference count. More...

Detailed Description

The base class for all kinds of records in a MultiGen OpenFlight file.

A flt file consists of a hierarchy of "beads" of various kinds, each of which may be followed by n ancillary records, written sequentially to the file.

Definition at line 36 of file fltRecord.h.

Member Function Documentation

◆ add_ancillary()

void FltRecord::add_ancillary ( FltRecord * ancillary )

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 207 of file fltRecord.cxx.

◆ add_child()

void FltRecord::add_child ( FltRecord * child )

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

Definition at line 88 of file fltRecord.cxx.

◆ add_extension()

void FltRecord::add_extension ( FltRecord * extension )

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 159 of file fltRecord.cxx.

◆ add_subface()

void FltRecord::add_subface ( FltRecord * subface )

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

Definition at line 123 of file fltRecord.cxx.

◆ apply_converted_filenames()

void FltRecord::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 in FltHeader, FltExternalReference, and FltTexture.

Definition at line 278 of file fltRecord.cxx.

Referenced by FltExternalReference::apply_converted_filenames(), FltTexture::apply_converted_filenames(), and FltHeader::apply_converted_filenames().

◆ check_remaining_size()

void FltRecord::check_remaining_size	(	const DatagramIterator &	di,
		const std::string &	name = `std::string()`
	)		const

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 254 of file fltRecord.cxx.

References FltHeader::get_flt_version(), DatagramIterator::get_remaining_size(), and FltHeader::max_flt_version().

◆ clear_ancillary()

void FltRecord::clear_ancillary ( )

Removes all unsupported ancillary records from this record.

See get_num_ancillary().

Definition at line 190 of file fltRecord.cxx.

◆ clear_children()

void FltRecord::clear_children ( )

Removes all children from this record.

Definition at line 80 of file fltRecord.cxx.

◆ clear_comment()

void FltRecord::clear_comment ( )

Removes the comment for this record.

Definition at line 232 of file fltRecord.cxx.

◆ clear_extensions()

void FltRecord::clear_extensions ( )

Removes all extensions from this record.

Definition at line 150 of file fltRecord.cxx.

◆ clear_subfaces()

void FltRecord::clear_subfaces ( )

Removes all subfaces from this record.

Definition at line 115 of file fltRecord.cxx.

◆ get_ancillary()

FltRecord * FltRecord::get_ancillary ( int n ) const

Returns the nth unsupported ancillary record of this record.

See get_num_ancillary().

Definition at line 180 of file fltRecord.cxx.

◆ get_child()

FltRecord * FltRecord::get_child ( int n ) const

Returns the nth child of this record.

Definition at line 71 of file fltRecord.cxx.

◆ get_comment()

const std::string & FltRecord::get_comment ( ) const

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

Definition at line 224 of file fltRecord.cxx.

◆ get_extension()

FltRecord * FltRecord::get_extension ( int n ) const

Returns the nth extension of this record.

Definition at line 141 of file fltRecord.cxx.

◆ get_num_ancillary()

int FltRecord::get_num_ancillary ( ) const

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 171 of file fltRecord.cxx.

◆ get_num_children()

int FltRecord::get_num_children ( ) const

Returns the number of child records of this record.

This reflects the normal scene graph hierarchy.

Definition at line 63 of file fltRecord.cxx.

◆ get_num_extensions()

int FltRecord::get_num_extensions ( ) const

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 133 of file fltRecord.cxx.

◆ get_num_subfaces()

int FltRecord::get_num_subfaces ( ) const

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 98 of file fltRecord.cxx.

◆ get_subface()

FltRecord * FltRecord::get_subface ( int n ) const

Returns the nth subface of this record.

Definition at line 106 of file fltRecord.cxx.

◆ has_comment()

bool FltRecord::has_comment ( ) const

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

Definition at line 215 of file fltRecord.cxx.

◆ output()

void FltRecord::output ( std::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 in FltVertexList, FltExternalReference, FltBeadID, and FltUnsupportedRecord.

Definition at line 294 of file fltRecord.cxx.

◆ set_comment()

void FltRecord::set_comment ( const std::string & comment )

Changes the comment for this record.

Definition at line 240 of file fltRecord.cxx.

◆ write()

void FltRecord::write	(	std::ostream &	out,
		int	indent_level = `0`
	)		const

virtual

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 304 of file fltRecord.cxx.

References indent().

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

pandatool/src/flt/fltRecord.h
pandatool/src/flt/fltRecord.cxx

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ add_ancillary()

◆ add_child()

◆ add_extension()

◆ add_subface()

◆ apply_converted_filenames()

◆ check_remaining_size()

◆ clear_ancillary()

◆ clear_children()

◆ clear_comment()

◆ clear_extensions()

◆ clear_subfaces()

◆ get_ancillary()

◆ get_child()

◆ get_comment()

◆ get_extension()

◆ get_num_ancillary()

◆ get_num_children()

◆ get_num_extensions()

◆ get_num_subfaces()

◆ get_subface()

◆ has_comment()

◆ output()

◆ set_comment()

◆ write()