This is a base class for a family of converter classes that manage a conversion from some file type to egg format. More...

#include "somethingToEggConverter.h"

Inheritance diagram for SomethingToEggConverter:

List of all members.

Public Member Functions
	SomethingToEggConverter (const SomethingToEggConverter &copy)
void	clear_egg_data ()
	Sets the EggData to NULL and makes the converter invalid.
void	clear_end_frame ()
	Removes the value previously set by set_end_frame().
void	clear_error ()
	Resets the error flag to the no-error state.
void	clear_frame_inc ()
	Removes the value previously set by set_frame_inc().
void	clear_input_frame_rate ()
	Removes the value previously set by set_input_frame_rate().
void	clear_neutral_frame ()
	Removes the value previously set by set_neutral_frame().
void	clear_output_frame_rate ()
	Removes the value previously set by set_output_frame_rate().
void	clear_start_frame ()
	Removes the value previously set by set_start_frame().
virtual bool	convert_file (const Filename &filename)=0
Filename	convert_model_path (const Filename &orig_filename)
	Converts the indicated model filename to a relative or absolute or whatever filename, according to _path_replace.
virtual string	get_additional_extensions () const
	Returns a space-separated list of extension, in addition to the one returned by get_extension(), that are recognized by this converter.
AnimationConvert	get_animation_convert () const
	Returns how source animation will be converted into egg structures.
const string &	get_character_name () const
	Returns the name of the character generated.
EggData *	get_egg_data ()
	Returns the EggData structure.
double	get_end_frame () const
	Returns the value set by a previous call to set_end_frame().
virtual string	get_extension () const =0
double	get_frame_inc () const
	Returns the value set by a previous call to set_frame_inc().
double	get_input_frame_rate () const
	Returns the value set by a previous call to set_input_frame_rate().
virtual DistanceUnit	get_input_units ()
	This may be called after convert_file() has been called and returned true, indicating a successful conversion.
bool	get_merge_externals () const
	Returns the current state of the merge_externals flag.
virtual string	get_name () const =0
double	get_neutral_frame () const
	Returns the value set by a previous call to set_neutral_frame().
double	get_output_frame_rate () const
	Returns the value set by a previous call to set_output_frame_rate().
PathReplace *	get_path_replace ()
	Returns a pointer to the PathReplace object associated with this converter.
const PathReplace *	get_path_replace () const
	Returns a pointer to the PathReplace object associated with this converter.
double	get_start_frame () const
	Returns the value set by a previous call to set_start_frame().
bool	had_error () const
	Returns true if an error was detected during the conversion process (unless _allow_errors is true), false otherwise.
bool	handle_external_reference (EggGroupNode *egg_parent, const Filename &ref_filename)
	Handles an external reference in the source file.
bool	has_end_frame () const
	Returns true if the ending frame has been explicitly specified via set_end_frame(), or false if the ending frame should be implicit based on the source.
bool	has_frame_inc () const
	Returns true if the frame increment has been explicitly specified via set_frame_inc(), or false if the ending frame should be implicit based on the source.
bool	has_input_frame_rate () const
	Returns true if the frame rate has been explicitly specified via set_input_frame_rate(), or false otherwise.
bool	has_neutral_frame () const
	Returns true if the neutral frame has been explicitly specified via set_neutral_frame(), or false otherwise.
bool	has_output_frame_rate () const
	Returns true if the frame rate has been explicitly specified via set_output_frame_rate(), or false otherwise.
bool	has_start_frame () const
	Returns true if the starting frame has been explicitly specified via set_start_frame(), or false if the starting frame should be implicit based on the source.
virtual SomethingToEggConverter *	make_copy ()=0
void	set_animation_convert (AnimationConvert animation_convert)
	Specifies how source animation will be converted into egg structures.
void	set_character_name (const string &character_name)
	Specifies the name of the character generated.
void	set_egg_data (EggData *egg_data)
	Sets the egg data that will be filled in when convert_file() is called.
void	set_end_frame (double end_frame)
	Specifies the ending frame of the animation to convert, in the units specified by set_input_frame_rate().
void	set_frame_inc (double frame_inc)
	Specifies the increment between frames to extract.
void	set_input_frame_rate (double input_frame_rate)
	Specifies the number of frames per second that is represented by the "frame" unit in the animation package.
void	set_merge_externals (bool merge_externals)
	Sets the merge_externals flag.
void	set_neutral_frame (double neutral_frame)
	Specifies the frame of animation to represent the neutral pose of the model.
void	set_output_frame_rate (double output_frame_rate)
	Specifies the number of frames per second that the resulting animation should be played at.
void	set_path_replace (PathReplace *path_replace)
	Replaces the PathReplace object (which specifies how to mangle paths from the source to the destination egg file) with a new one.
void	set_start_frame (double start_frame)
	Specifies the starting frame of the animation to convert, in the units specified by set_input_frame_rate().
virtual bool	supports_compressed () const
	Returns true if this file type can transparently load compressed files (with a .pz extension), false otherwise.
Static Public Member Functions
static double	get_default_frame_rate ()
	Returns the default frame rate if nothing is specified for input_frame_rate or output_frame_rate, and the animation package does not have an implicit frame rate.
Public Attributes
bool	_allow_errors
Protected Types
enum	ControlFlags { CF_start_frame = 0x0001, CF_end_frame = 0x0002, CF_frame_inc = 0x0004, CF_neutral_frame = 0x0008, CF_input_frame_rate = 0x0010, CF_output_frame_rate = 0x0020 }
Protected Member Functions
	PT (PathReplace) _path_replace
	PT (EggData) _egg_data
Protected Attributes
AnimationConvert	_animation_convert
string	_character_name
int	_control_flags
double	_end_frame
bool	_error
double	_frame_inc
double	_input_frame_rate
bool	_merge_externals
double	_neutral_frame
double	_output_frame_rate
double	_start_frame

Detailed Description

This is a base class for a family of converter classes that manage a conversion from some file type to egg format.

Classes of this type can be used to implement xxx2egg converter programs, as well as LoaderFileTypeXXX run-time loaders.

Definition at line 40 of file somethingToEggConverter.h.

Member Function Documentation

void SomethingToEggConverter::clear_egg_data ( ) [inline]

Sets the EggData to NULL and makes the converter invalid.

Definition at line 485 of file somethingToEggConverter.I.

References set_egg_data().

void SomethingToEggConverter::clear_end_frame ( ) [inline]

Removes the value previously set by set_end_frame().

Definition at line 227 of file somethingToEggConverter.I.

void SomethingToEggConverter::clear_error ( ) [inline]

Resets the error flag to the no-error state.

had_error() will return false until a new error is generated.

Definition at line 24 of file somethingToEggConverter.I.

Referenced by XFileToEggConverter::convert_file(), VRMLToEggConverter::convert_file(), DXFToEggConverter::convert_file(), DAEToEggConverter::convert_file(), FltToEggConverter::convert_flt(), and MayaToEggConverter::convert_maya().

void SomethingToEggConverter::clear_frame_inc ( ) [inline]

Removes the value previously set by set_frame_inc().

Definition at line 282 of file somethingToEggConverter.I.

void SomethingToEggConverter::clear_input_frame_rate ( ) [inline]

Removes the value previously set by set_input_frame_rate().

Definition at line 385 of file somethingToEggConverter.I.

void SomethingToEggConverter::clear_neutral_frame ( ) [inline]

Removes the value previously set by set_neutral_frame().

Definition at line 331 of file somethingToEggConverter.I.

void SomethingToEggConverter::clear_output_frame_rate ( ) [inline]

Removes the value previously set by set_output_frame_rate().

Definition at line 436 of file somethingToEggConverter.I.

void SomethingToEggConverter::clear_start_frame ( ) [inline]

Removes the value previously set by set_start_frame().

Definition at line 174 of file somethingToEggConverter.I.

Filename SomethingToEggConverter::convert_model_path ( const Filename & orig_filename ) [inline]

Converts the indicated model filename to a relative or absolute or whatever filename, according to _path_replace.

Definition at line 507 of file somethingToEggConverter.I.

Referenced by XFileMaterial::apply_to_egg(), and CLwoSurface::check_texture().

string SomethingToEggConverter::get_additional_extensions ( ) const [virtual]

Returns a space-separated list of extension, in addition to the one returned by get_extension(), that are recognized by this converter.

Reimplemented in MayaToEggConverter.

Definition at line 88 of file somethingToEggConverter.cxx.

Referenced by LoaderFileTypePandatool::get_additional_extensions().

AnimationConvert SomethingToEggConverter::get_animation_convert ( ) const [inline]

Returns how source animation will be converted into egg structures.

Definition at line 98 of file somethingToEggConverter.I.

Referenced by MayaToEggConverter::convert_maya(), and MayaNodeTree::get_egg_group().

const string & SomethingToEggConverter::get_character_name ( ) const [inline]

Returns the name of the character generated.

See set_character_name().

Definition at line 122 of file somethingToEggConverter.I.

double SomethingToEggConverter::get_default_frame_rate ( ) [inline, static]

Returns the default frame rate if nothing is specified for input_frame_rate or output_frame_rate, and the animation package does not have an implicit frame rate.

Definition at line 450 of file somethingToEggConverter.I.

EggData * SomethingToEggConverter::get_egg_data ( ) [inline]

Returns the EggData structure.

Definition at line 495 of file somethingToEggConverter.I.

Referenced by CLwoLayer::connect_egg(), VRMLToEggConverter::convert_file(), MayaToEggConverter::convert_maya(), SoftToEggConverter::convert_soft(), XFileAnimationSet::create_hierarchy(), and handle_external_reference().

double SomethingToEggConverter::get_end_frame ( ) const [inline]

Returns the value set by a previous call to set_end_frame().

It is an error to call this if has_end_frame() returns false.

Definition at line 215 of file somethingToEggConverter.I.

References has_end_frame().

Referenced by MayaToEggConverter::convert_maya().

double SomethingToEggConverter::get_frame_inc ( ) const [inline]

Returns the value set by a previous call to set_frame_inc().

It is an error to call this if has_frame_inc() returns false.

Definition at line 270 of file somethingToEggConverter.I.

References has_frame_inc().

Referenced by MayaToEggConverter::convert_maya().

double SomethingToEggConverter::get_input_frame_rate ( ) const [inline]

Returns the value set by a previous call to set_input_frame_rate().

It is an error to call this if has_input_frame_rate() returns false.

Definition at line 373 of file somethingToEggConverter.I.

References has_input_frame_rate().

Referenced by MayaToEggConverter::convert_maya().

DistanceUnit SomethingToEggConverter::get_input_units ( ) [virtual]

This may be called after convert_file() has been called and returned true, indicating a successful conversion.

It will return the distance units represented by the converted egg file, if known, or DU_invalid if not known.

Reimplemented in FltToEggConverter, and MayaToEggConverter.

Definition at line 114 of file somethingToEggConverter.cxx.

bool SomethingToEggConverter::get_merge_externals ( ) const [inline]

Returns the current state of the merge_externals flag.

See set_merge_externals().

Definition at line 474 of file somethingToEggConverter.I.

double SomethingToEggConverter::get_neutral_frame ( ) const [inline]

Returns the value set by a previous call to set_neutral_frame().

It is an error to call this if has_neutral_frame() returns false.

Definition at line 319 of file somethingToEggConverter.I.

References has_neutral_frame().

double SomethingToEggConverter::get_output_frame_rate ( ) const [inline]

Returns the value set by a previous call to set_output_frame_rate().

It is an error to call this if has_output_frame_rate() returns false.

Definition at line 424 of file somethingToEggConverter.I.

References has_output_frame_rate().

Referenced by MayaToEggConverter::convert_maya().

PathReplace * SomethingToEggConverter::get_path_replace ( ) [inline]

Returns a pointer to the PathReplace object associated with this converter.

If the converter is non-const, this returns a non-const pointer, which can be adjusted.

Definition at line 61 of file somethingToEggConverter.I.

const PathReplace * SomethingToEggConverter::get_path_replace ( ) const [inline]

Returns a pointer to the PathReplace object associated with this converter.

If the converter is non-const, this returns a non-const pointer, which can be adjusted.

Definition at line 74 of file somethingToEggConverter.I.

double SomethingToEggConverter::get_start_frame ( ) const [inline]

Returns the value set by a previous call to set_start_frame().

It is an error to call this if has_start_frame() returns false.

Definition at line 162 of file somethingToEggConverter.I.

References has_start_frame().

Referenced by MayaToEggConverter::convert_maya().

bool SomethingToEggConverter::had_error ( ) const [inline]

Returns true if an error was detected during the conversion process (unless _allow_errors is true), false otherwise.

Definition at line 36 of file somethingToEggConverter.I.

Referenced by XFileToEggConverter::convert_file(), VRMLToEggConverter::convert_file(), DXFToEggConverter::convert_file(), FltToEggConverter::convert_flt(), LwoToEggConverter::convert_lwo(), and MayaToEggConverter::convert_maya().

bool SomethingToEggConverter::handle_external_reference	(	EggGroupNode *	egg_parent,
		const Filename &	ref_filename
	)

Handles an external reference in the source file.

If the merge_externals flag is true (see set_merge_externals()), this causes the named file to be read in and converted, and the converted egg geometry is parented to egg_parent. Otherwise, only a reference to a similarly named egg file is parented to egg_parent.

The parameters orig_filename and searchpath are as those passed to convert_model_path().

Returns true on success, false on failure.

Definition at line 135 of file somethingToEggConverter.cxx.

References EggGroupNode::add_child(), get_egg_data(), EggData::set_coordinate_system(), set_egg_data(), and EggGroupNode::steal_children().

bool SomethingToEggConverter::has_end_frame ( ) const [inline]

Returns true if the ending frame has been explicitly specified via set_end_frame(), or false if the ending frame should be implicit based on the source.

Definition at line 203 of file somethingToEggConverter.I.

Referenced by MayaToEggConverter::convert_maya(), and get_end_frame().

bool SomethingToEggConverter::has_frame_inc ( ) const [inline]

Returns true if the frame increment has been explicitly specified via set_frame_inc(), or false if the ending frame should be implicit based on the source.

Definition at line 258 of file somethingToEggConverter.I.

Referenced by MayaToEggConverter::convert_maya(), and get_frame_inc().

bool SomethingToEggConverter::has_input_frame_rate ( ) const [inline]

Returns true if the frame rate has been explicitly specified via set_input_frame_rate(), or false otherwise.

Definition at line 361 of file somethingToEggConverter.I.

Referenced by MayaToEggConverter::convert_maya(), and get_input_frame_rate().

bool SomethingToEggConverter::has_neutral_frame ( ) const [inline]

Returns true if the neutral frame has been explicitly specified via set_neutral_frame(), or false otherwise.

Definition at line 307 of file somethingToEggConverter.I.

Referenced by get_neutral_frame().

bool SomethingToEggConverter::has_output_frame_rate ( ) const [inline]

Returns true if the frame rate has been explicitly specified via set_output_frame_rate(), or false otherwise.

Definition at line 412 of file somethingToEggConverter.I.

Referenced by MayaToEggConverter::convert_maya(), and get_output_frame_rate().

bool SomethingToEggConverter::has_start_frame ( ) const [inline]

Returns true if the starting frame has been explicitly specified via set_start_frame(), or false if the starting frame should be implicit based on the source.

Definition at line 150 of file somethingToEggConverter.I.

Referenced by MayaToEggConverter::convert_maya(), and get_start_frame().

void SomethingToEggConverter::set_animation_convert ( AnimationConvert animation_convert ) [inline]

Specifies how source animation will be converted into egg structures.

The default is AC_none, which means animation tables will be ignored. This is only meaningful for converters that understand animation.

Definition at line 87 of file somethingToEggConverter.I.

Referenced by SomethingToEgg::apply_parameters().

void SomethingToEggConverter::set_character_name ( const string & character_name ) [inline]

Specifies the name of the character generated.

This name should match between all the model and channel egg files for a particular character and its associated animations.

Definition at line 111 of file somethingToEggConverter.I.

Referenced by SomethingToEgg::apply_parameters().

void SomethingToEggConverter::set_egg_data ( EggData * egg_data )

Sets the egg data that will be filled in when convert_file() is called.

This must be called before convert_file().

Definition at line 76 of file somethingToEggConverter.cxx.

Referenced by clear_egg_data(), SoftToEggConverter::convert_soft(), and handle_external_reference().

void SomethingToEggConverter::set_end_frame ( double end_frame ) [inline]

Specifies the ending frame of the animation to convert, in the units specified by set_input_frame_rate().

If this is unspecified, the ending frame is taken from the source, for instance from the last frame of the animation slider.

Definition at line 189 of file somethingToEggConverter.I.

Referenced by SomethingToEgg::apply_parameters().

void SomethingToEggConverter::set_frame_inc ( double frame_inc ) [inline]

Specifies the increment between frames to extract.

This is the amount to increment the time slider (in units of internal_frame_rate) between extracting each frame. If this is not specified, the default is taken from the animation package, or 1.0 if the animation package does not specified a frame increment.

Definition at line 244 of file somethingToEggConverter.I.

Referenced by SomethingToEgg::apply_parameters().

void SomethingToEggConverter::set_input_frame_rate ( double input_frame_rate ) [inline]

Specifies the number of frames per second that is represented by the "frame" unit in the animation package.

If this is omitted, it is taken from whatever the file header indicates. Some animation packages do not encode a frame rate, in which case the default if this is omitted is the same as the output frame rate.

Definition at line 348 of file somethingToEggConverter.I.

Referenced by SomethingToEgg::apply_parameters().

void SomethingToEggConverter::set_merge_externals ( bool merge_externals ) [inline]

Sets the merge_externals flag.

When this is true, external references within the source file are read in and merged directly; otherwise, only a reference to a similarly-named egg file is inserted.

Definition at line 463 of file somethingToEggConverter.I.

void SomethingToEggConverter::set_neutral_frame ( double neutral_frame ) [inline]

Specifies the frame of animation to represent the neutral pose of the model.

Definition at line 294 of file somethingToEggConverter.I.

Referenced by SomethingToEgg::apply_parameters().

void SomethingToEggConverter::set_output_frame_rate ( double output_frame_rate ) [inline]

Specifies the number of frames per second that the resulting animation should be played at.

If this is omitted, it is taken to be the same as the input frame rate.

Definition at line 399 of file somethingToEggConverter.I.

Referenced by SomethingToEgg::apply_parameters().

void SomethingToEggConverter::set_path_replace ( PathReplace * path_replace ) [inline]

Replaces the PathReplace object (which specifies how to mangle paths from the source to the destination egg file) with a new one.

Definition at line 48 of file somethingToEggConverter.I.

Referenced by SomethingToEgg::apply_parameters().

void SomethingToEggConverter::set_start_frame ( double start_frame ) [inline]

Specifies the starting frame of the animation to convert, in the units specified by set_input_frame_rate().

If this is unspecified, the starting frame is taken from the source, for instance from the first frame of the animation slider.

Definition at line 136 of file somethingToEggConverter.I.

Referenced by SomethingToEgg::apply_parameters().

bool SomethingToEggConverter::supports_compressed ( ) const [virtual]

Returns true if this file type can transparently load compressed files (with a .pz extension), false otherwise.

Reimplemented in DXFToEggConverter, FltToEggConverter, LwoToEggConverter, VRMLToEggConverter, and XFileToEggConverter.

Definition at line 100 of file somethingToEggConverter.cxx.

Referenced by LoaderFileTypePandatool::supports_compressed().

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

pandatool/src/converter/somethingToEggConverter.h
pandatool/src/converter/somethingToEggConverter.cxx
pandatool/src/converter/somethingToEggConverter.I

SomethingToEggConverter Class Reference

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Types

Protected Member Functions

Protected Attributes

Detailed Description

Member Function Documentation