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

XFileToEggConverter Class Reference

#include <xFileToEggConverter.h>

Inheritance diagram for XFileToEggConverter:

SomethingToEggConverter List of all members.

Public Member Functions

 XFileToEggConverter ()
 XFileToEggConverter (const XFileToEggConverter &copy)
 ~XFileToEggConverter ()
virtual SomethingToEggConverter * make_copy ()
 Allocates and returns a new copy of the converter.

virtual string get_name () const
 Returns the English name of the file type this converter supports.

virtual string get_extension () const
 Returns the common extension of the file type this converter supports.

virtual bool convert_file (const Filename &filename)
 Handles the reading of the input file and converting it to egg.

void close ()
 Finalizes and closes the file previously opened via convert_file().

EggTexture * create_unique_texture (const EggTexture &copy)
 Returns an EggTexture pointer whose properties match that of the the given EggTexture, except for the tref name.

EggMaterial * create_unique_material (const EggMaterial &copy)
 Returns an EggMaterial pointer whose properties match that of the the given EggMaterial, except for the mref name.

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.

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.

void set_animation_convert (AnimationConvert animation_convert)
 Specifies how source animation will be converted into egg structures.

AnimationConvert get_animation_convert () const
 Returns how source animation will be converted into egg structures.

void set_character_name (const string &character_name)
 Specifies the name of the character generated.

const string & get_character_name () const
 Returns the name of the character generated.

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().

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.

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

void clear_start_frame ()
 Removes the value previously set by set_start_frame().

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().

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.

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

void clear_end_frame ()
 Removes the value previously set by set_end_frame().

void set_frame_inc (double frame_inc)
 Specifies the increment between frames to extract.

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.

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

void clear_frame_inc ()
 Removes the value previously set by set_frame_inc().

void set_neutral_frame (double neutral_frame)
 Specifies the frame of animation to represent the neutral pose of the model.

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

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

void clear_neutral_frame ()
 Removes the value previously set by set_neutral_frame().

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.

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

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

void clear_input_frame_rate ()
 Removes the value previously set by set_input_frame_rate().

void set_output_frame_rate (double output_frame_rate)
 Specifies the number of frames per second that the resulting animation should be played at.

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

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

void clear_output_frame_rate ()
 Removes the value previously set by set_output_frame_rate().

void set_merge_externals (bool merge_externals)
 Sets the merge_externals flag.

bool get_merge_externals () const
 Returns the current state of the merge_externals flag.

void set_egg_data (EggData *egg_data, bool owns_egg_data)
 Sets the egg data that will be filled in when convert_file() is called.

void clear_egg_data ()
 Sets the EggData to NULL and makes the converter invalid.

EggData & get_egg_data ()
 Returns the EggData structure.

bool handle_external_reference (EggGroupNode *egg_parent, const Filename &ref_filename)
 Handles an external reference in the source file.

Filename convert_texture_path (const Filename &orig_filename)
 Converts the indicated texture filename to a relative or absolute or whatever filename, according to _path_replace.

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.


Static Public Member Functions

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 Attributes

PointerTo< PathReplace > _path_replace
AnimationConvert _animation_convert
string _character_name
double _start_frame
double _end_frame
double _frame_inc
double _neutral_frame
double _input_frame_rate
double _output_frame_rate
int _control_flags
bool _merge_externals
EggData * _egg_data
bool _owns_egg_data
bool _error

Private Member Functions

bool get_toplevel ()
 Pulls off all of the top-level objects in the .x file and converts them, and their descendents, to the appropriate egg structures.

bool convert_object (LPDIRECTXFILEOBJECT obj, EggGroupNode *egg_parent)
 Converts the indicated object to the appropriate egg structures.

bool convert_data_object (LPDIRECTXFILEDATA obj, EggGroupNode *egg_parent)
 Converts the indicated object to the appropriate egg structures.

bool convert_frame (LPDIRECTXFILEDATA obj, EggGroupNode *egg_parent)
 Converts the indicated frame to the appropriate egg structures.

bool convert_transform (LPDIRECTXFILEDATA obj, EggGroupNode *egg_parent)
 Reads a transform matrix, a child of a given frame, and applies it to the node.

bool convert_mesh (LPDIRECTXFILEDATA obj, EggGroupNode *egg_parent)
 Converts the indicated mesh to the appropriate egg structures.

bool convert_mesh_object (LPDIRECTXFILEOBJECT obj, XFileMesh &mesh)
 Converts the indicated object, a child of a Mesh, to the appropriate egg structures.

bool convert_mesh_data_object (LPDIRECTXFILEDATA obj, XFileMesh &mesh)
 Converts the indicated data object, a child of a Mesh, to the appropriate egg structures.

bool convert_mesh_normals (LPDIRECTXFILEDATA obj, XFileMesh &mesh)
 Converts the indicated MeshNormals template object.

bool convert_mesh_colors (LPDIRECTXFILEDATA obj, XFileMesh &mesh)
 Converts the indicated MeshVertexColors template object.

bool convert_mesh_uvs (LPDIRECTXFILEDATA obj, XFileMesh &mesh)
 Converts the indicated MeshTextureCoords template object.

bool convert_mesh_material_list (LPDIRECTXFILEDATA obj, XFileMesh &mesh)
 Converts the indicated MeshMaterialList template object.

bool convert_material_list_object (LPDIRECTXFILEOBJECT obj, XFileMesh &mesh)
 Converts the indicated object, a child of a MeshMaterialList.

bool convert_material_list_data_object (LPDIRECTXFILEDATA obj, XFileMesh &mesh)
 Converts the indicated data object, a child of a MeshMaterialList.

bool convert_material (LPDIRECTXFILEDATA obj, XFileMesh &mesh)
 Converts the indicated Material template object.

bool convert_material_object (LPDIRECTXFILEOBJECT obj, XFileMaterial &material)
 Converts the indicated object, a child of a Material.

bool convert_material_data_object (LPDIRECTXFILEDATA obj, XFileMaterial &material)
 Converts the indicated data object, a child of a Material.

bool convert_texture (LPDIRECTXFILEDATA obj, XFileMaterial &material)
 Converts the indicated TextureFilename template object.

string get_object_name (LPDIRECTXFILEOBJECT obj)
 Returns the name of the indicated object.

bool get_data (LPDIRECTXFILEDATA obj, Datagram &raw_data)
 Extracts out the raw data for the indicated object.


Private Attributes

LPDIRECTXFILE _dx_file
LPDIRECTXFILEENUMOBJECT _dx_file_enum
EggTextureCollection _textures
EggMaterialCollection _materials

Member Enumeration Documentation

enum SomethingToEggConverter::ControlFlags [protected, inherited]
 

Enumeration values:
CF_start_frame 
CF_end_frame 
CF_frame_inc 
CF_neutral_frame 
CF_input_frame_rate 
CF_output_frame_rate 

Definition at line 140 of file somethingToEggConverter.h.

Constructor & Destructor Documentation

XFileToEggConverter::XFileToEggConverter (   ) 
 

Definition at line 43 of file xFileToEggConverter.cxx.

References _dx_file, _dx_file_enum, and NULL.

Referenced by ~XFileToEggConverter().

XFileToEggConverter::XFileToEggConverter (  const XFileToEggConverter &  copy  ) 
 

Definition at line 56 of file xFileToEggConverter.cxx.

References close().

XFileToEggConverter::~XFileToEggConverter (   ) 
 

Definition at line 71 of file xFileToEggConverter.cxx.

References XFileToEggConverter().

Member Function Documentation

void SomethingToEggConverter::clear_egg_data (   )  [inline, inherited]
 

Sets the EggData to NULL and makes the converter invalid.

Definition at line 654 of file somethingToEggConverter.I.

void SomethingToEggConverter::clear_end_frame (   )  [inline, inherited]
 

Removes the value previously set by set_end_frame().

Definition at line 291 of file somethingToEggConverter.I.

References SomethingToEggConverter::_neutral_frame, SomethingToEggConverter::has_neutral_frame(), INLINE, and nassertr.

void SomethingToEggConverter::clear_frame_inc (   )  [inline, inherited]
 

Removes the value previously set by set_frame_inc().

Definition at line 370 of file somethingToEggConverter.I.

References SomethingToEggConverter::_control_flags, SomethingToEggConverter::_output_frame_rate, SomethingToEggConverter::CF_output_frame_rate, and INLINE.

void SomethingToEggConverter::clear_input_frame_rate (   )  [inline, inherited]
 

Removes the value previously set by set_input_frame_rate().

Definition at line 514 of file somethingToEggConverter.I.

void SomethingToEggConverter::clear_neutral_frame (   )  [inline, inherited]
 

Removes the value previously set by set_neutral_frame().

Definition at line 437 of file somethingToEggConverter.I.

References SomethingToEggConverter::_merge_externals, and INLINE.

void SomethingToEggConverter::clear_output_frame_rate (   )  [inline, inherited]
 

Removes the value previously set by set_output_frame_rate().

Definition at line 585 of file somethingToEggConverter.I.

void SomethingToEggConverter::clear_start_frame (   )  [inline, inherited]
 

Removes the value previously set by set_start_frame().

Definition at line 216 of file somethingToEggConverter.I.

References SomethingToEggConverter::_control_flags, SomethingToEggConverter::_frame_inc, SomethingToEggConverter::CF_frame_inc, and INLINE.

void XFileToEggConverter::close (   ) 
 

Finalizes and closes the file previously opened via convert_file().

Definition at line 185 of file xFileToEggConverter.cxx.

References _dx_file_enum, SomethingToEggConverter::_egg_data, and convert_data_object().

Referenced by XFileToEggConverter().

bool XFileToEggConverter::convert_data_object (  LPDIRECTXFILEDATA  obj,
EggGroupNode *  egg_parent
)  [private]
 

Converts the indicated object to the appropriate egg structures.

Definition at line 305 of file xFileToEggConverter.cxx.

References convert_object().

Referenced by close().

bool XFileToEggConverter::convert_file (  const Filename &  filename  )  [virtual]
 

Handles the reading of the input file and converting it to egg.

Returns true if successful, false otherwise.

This is designed to be as generic as possible, generally in support of run-time loading. Command-line converters may choose to use convert_flt() instead, as it provides more control.

Implements SomethingToEggConverter.

Definition at line 142 of file xFileToEggConverter.cxx.

bool XFileToEggConverter::convert_frame (  LPDIRECTXFILEDATA  obj,
EggGroupNode *  egg_parent
)  [private]
 

Converts the indicated frame to the appropriate egg structures.

Definition at line 355 of file xFileToEggConverter.cxx.

References convert_mesh_object(), XFileMesh::create_polygons(), get_data(), get_object_name(), XFileMesh::read_mesh_data(), and Namable::set_name().

Referenced by get_toplevel().

bool XFileToEggConverter::convert_material (  LPDIRECTXFILEDATA  obj,
XFileMesh &  mesh
)  [private]
 

Converts the indicated Material template object.

Definition at line 744 of file xFileToEggConverter.cxx.

bool XFileToEggConverter::convert_material_data_object (  LPDIRECTXFILEDATA  obj,
XFileMaterial &  material
)  [private]
 

Converts the indicated data object, a child of a Material.

Definition at line 823 of file xFileToEggConverter.cxx.

Referenced by convert_material_list_object().

bool XFileToEggConverter::convert_material_list_data_object (  LPDIRECTXFILEDATA  obj,
XFileMesh &  mesh
)  [private]
 

Converts the indicated data object, a child of a MeshMaterialList.

Definition at line 710 of file xFileToEggConverter.cxx.

bool XFileToEggConverter::convert_material_list_object (  LPDIRECTXFILEOBJECT  obj,
XFileMesh &  mesh
)  [private]
 

Converts the indicated object, a child of a MeshMaterialList.

Definition at line 681 of file xFileToEggConverter.cxx.

References convert_material_data_object(), and get_object_name().

bool XFileToEggConverter::convert_material_object (  LPDIRECTXFILEOBJECT  obj,
XFileMaterial &  material
)  [private]
 

Converts the indicated object, a child of a Material.

Definition at line 794 of file xFileToEggConverter.cxx.

References get_object_name().

Referenced by convert_mesh_material_list().

bool XFileToEggConverter::convert_mesh (  LPDIRECTXFILEDATA  obj,
EggGroupNode *  egg_parent
)  [private]
 

Converts the indicated mesh to the appropriate egg structures.

Definition at line 433 of file xFileToEggConverter.cxx.

Referenced by get_toplevel().

bool XFileToEggConverter::convert_mesh_colors (  LPDIRECTXFILEDATA  obj,
XFileMesh &  mesh
)  [private]
 

Converts the indicated MeshVertexColors template object.

Definition at line 588 of file xFileToEggConverter.cxx.

bool XFileToEggConverter::convert_mesh_data_object (  LPDIRECTXFILEDATA  obj,
XFileMesh &  mesh
)  [private]
 

Converts the indicated data object, a child of a Mesh, to the appropriate egg structures.

Definition at line 512 of file xFileToEggConverter.cxx.

References get_data(), and XFileMesh::read_uv_data().

Referenced by convert_transform().

bool XFileToEggConverter::convert_mesh_material_list (  LPDIRECTXFILEDATA  obj,
XFileMesh &  mesh
)  [private]
 

Converts the indicated MeshMaterialList template object.

Definition at line 636 of file xFileToEggConverter.cxx.

References XFileMesh::add_material(), convert_material_object(), get_data(), get_object_name(), and XFileMaterial::read_material_data().

bool XFileToEggConverter::convert_mesh_normals (  LPDIRECTXFILEDATA  obj,
XFileMesh &  mesh
)  [private]
 

Converts the indicated MeshNormals template object.

Definition at line 564 of file xFileToEggConverter.cxx.

References get_object_name().

bool XFileToEggConverter::convert_mesh_object (  LPDIRECTXFILEOBJECT  obj,
XFileMesh &  mesh
)  [private]
 

Converts the indicated object, a child of a Mesh, to the appropriate egg structures.

Definition at line 483 of file xFileToEggConverter.cxx.

Referenced by convert_frame().

bool XFileToEggConverter::convert_mesh_uvs (  LPDIRECTXFILEDATA  obj,
XFileMesh &  mesh
)  [private]
 

Converts the indicated MeshTextureCoords template object.

Definition at line 612 of file xFileToEggConverter.cxx.

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

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

Definition at line 701 of file somethingToEggConverter.I.

bool XFileToEggConverter::convert_object (  LPDIRECTXFILEOBJECT  obj,
EggGroupNode *  egg_parent
)  [private]
 

Converts the indicated object to the appropriate egg structures.

Definition at line 275 of file xFileToEggConverter.cxx.

Referenced by convert_data_object().

bool XFileToEggConverter::convert_texture (  LPDIRECTXFILEDATA  obj,
XFileMaterial &  material
)  [private]
 

Converts the indicated TextureFilename template object.

Definition at line 857 of file xFileToEggConverter.cxx.

Filename SomethingToEggConverter::convert_texture_path (  const Filename &  orig_filename  )  [inline, inherited]
 

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

Definition at line 684 of file somethingToEggConverter.I.

bool XFileToEggConverter::convert_transform (  LPDIRECTXFILEDATA  obj,
EggGroupNode *  egg_parent
)  [private]
 

Reads a transform matrix, a child of a given frame, and applies it to the node.

Normally this can only be done if the node in question is an EggGroup, which should be the case if the transform was a child of a frame.

Definition at line 399 of file xFileToEggConverter.cxx.

References convert_mesh_data_object(), and get_object_name().

Referenced by get_toplevel().

EggMaterial * XFileToEggConverter::create_unique_material (  const EggMaterial &  copy  ) 
 

Returns an EggMaterial pointer whose properties match that of the the given EggMaterial, except for the mref name.

Definition at line 226 of file xFileToEggConverter.cxx.

EggTexture * XFileToEggConverter::create_unique_texture (  const EggTexture &  copy  ) 
 

Returns an EggTexture pointer whose properties match that of the the given EggTexture, except for the tref name.

Definition at line 209 of file xFileToEggConverter.cxx.

AnimationConvert SomethingToEggConverter::get_animation_convert (   )  const [inline, inherited]
 

Returns how source animation will be converted into egg structures.

Definition at line 108 of file somethingToEggConverter.I.

References SomethingToEggConverter::_control_flags, SomethingToEggConverter::_start_frame, SomethingToEggConverter::CF_start_frame, and INLINE.

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

Returns the name of the character generated.

See set_character_name().

Definition at line 142 of file somethingToEggConverter.I.

References SomethingToEggConverter::_start_frame, SomethingToEggConverter::has_start_frame(), and nassertr.

bool XFileToEggConverter::get_data (  LPDIRECTXFILEDATA  obj,
Datagram &  raw_data
)  [private]
 

Extracts out the raw data for the indicated object.

Definition at line 913 of file xFileToEggConverter.cxx.

Referenced by convert_frame(), convert_mesh_data_object(), and convert_mesh_material_list().

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

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 605 of file somethingToEggConverter.I.

EggData & SomethingToEggConverter::get_egg_data (   )  [inline, inherited]
 

Returns the EggData structure.

Definition at line 667 of file somethingToEggConverter.I.

Referenced by MayaToEggConverter::close_api(), MayaToEggConverter::convert_flip(), and SomethingToEggConverter::set_egg_data().

double SomethingToEggConverter::get_end_frame (   )  const [inline, inherited]
 

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 275 of file somethingToEggConverter.I.

References SomethingToEggConverter::_control_flags, SomethingToEggConverter::_neutral_frame, and SomethingToEggConverter::CF_neutral_frame.

string XFileToEggConverter::get_extension (   )  const [virtual]
 

Returns the common extension of the file type this converter supports.

Implements SomethingToEggConverter.

Definition at line 115 of file xFileToEggConverter.cxx.

References nout.

double SomethingToEggConverter::get_frame_inc (   )  const [inline, inherited]
 

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 354 of file somethingToEggConverter.I.

References SomethingToEggConverter::_input_frame_rate.

double SomethingToEggConverter::get_input_frame_rate (   )  const [inline, inherited]
 

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 498 of file somethingToEggConverter.I.

References SomethingToEggConverter::_path_replace, and INLINE.

bool SomethingToEggConverter::get_merge_externals (   )  const [inline, inherited]
 

Returns the current state of the merge_externals flag.

See set_merge_externals().

Definition at line 639 of file somethingToEggConverter.I.

string XFileToEggConverter::get_name (   )  const [virtual]
 

Returns the English name of the file type this converter supports.

Implements SomethingToEggConverter.

Definition at line 100 of file xFileToEggConverter.cxx.

double SomethingToEggConverter::get_neutral_frame (   )  const [inline, inherited]
 

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 421 of file somethingToEggConverter.I.

References INLINE.

Referenced by MayaToEggConverter::close_api().

string XFileToEggConverter::get_object_name (  LPDIRECTXFILEOBJECT  obj  )  [private]
 

Returns the name of the indicated object.

Definition at line 879 of file xFileToEggConverter.cxx.

Referenced by convert_frame(), convert_material_list_object(), convert_material_object(), convert_mesh_material_list(), convert_mesh_normals(), and convert_transform().

double SomethingToEggConverter::get_output_frame_rate (   )  const [inline, inherited]
 

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 569 of file somethingToEggConverter.I.

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

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.

References SomethingToEggConverter::_animation_convert, AnimationConvert, and INLINE.

PathReplace * SomethingToEggConverter::get_path_replace (   )  [inline, inherited]
 

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 55 of file somethingToEggConverter.I.

References SomethingToEggConverter::_path_replace.

Referenced by MayaPview::creator().

double SomethingToEggConverter::get_start_frame (   )  const [inline, inherited]
 

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 200 of file somethingToEggConverter.I.

References SomethingToEggConverter::_control_flags, SomethingToEggConverter::_end_frame, SomethingToEggConverter::CF_end_frame, and INLINE.

bool XFileToEggConverter::get_toplevel (   )  [private]
 

Pulls off all of the top-level objects in the .x file and converts them, and their descendents, to the appropriate egg structures.

Definition at line 243 of file xFileToEggConverter.cxx.

References convert_frame(), convert_mesh(), and convert_transform().

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

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 141 of file somethingToEggConverter.cxx.

Referenced by FltToEggConverter::convert_bead().

bool SomethingToEggConverter::has_end_frame (   )  const [inline, inherited]
 

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 258 of file somethingToEggConverter.I.

References SomethingToEggConverter::_control_flags, SomethingToEggConverter::_frame_inc, SomethingToEggConverter::CF_frame_inc, and INLINE.

bool SomethingToEggConverter::has_frame_inc (   )  const [inline, inherited]
 

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 337 of file somethingToEggConverter.I.

References SomethingToEggConverter::_control_flags, SomethingToEggConverter::CF_input_frame_rate, and INLINE.

bool SomethingToEggConverter::has_input_frame_rate (   )  const [inline, inherited]
 

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

Definition at line 481 of file somethingToEggConverter.I.

References SomethingToEggConverter::_path_replace, get_texture_path(), and INLINE.

bool SomethingToEggConverter::has_neutral_frame (   )  const [inline, inherited]
 

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

Definition at line 404 of file somethingToEggConverter.I.

References SomethingToEggConverter::_output_frame_rate, SomethingToEggConverter::has_output_frame_rate(), and nassertr.

Referenced by SomethingToEggConverter::clear_end_frame(), and MayaToEggConverter::close_api().

bool SomethingToEggConverter::has_output_frame_rate (   )  const [inline, inherited]
 

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

Definition at line 552 of file somethingToEggConverter.I.

Referenced by SomethingToEggConverter::has_neutral_frame().

bool SomethingToEggConverter::has_start_frame (   )  const [inline, inherited]
 

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 183 of file somethingToEggConverter.I.

References SomethingToEggConverter::_control_flags, and SomethingToEggConverter::CF_end_frame.

Referenced by SomethingToEggConverter::get_character_name().

SomethingToEggConverter * XFileToEggConverter::make_copy (  void   )  [virtual]
 

Allocates and returns a new copy of the converter.

Implements SomethingToEggConverter.

Definition at line 84 of file xFileToEggConverter.cxx.

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

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 93 of file somethingToEggConverter.I.

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

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 127 of file somethingToEggConverter.I.

References SomethingToEggConverter::_control_flags, SomethingToEggConverter::CF_start_frame, and INLINE.

void SomethingToEggConverter::set_egg_data (  EggData *  egg_data,
bool  owns_egg_data
)  [inherited]
 

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

This must be called before convert_file(). If owns_egg_data is true, the egg_data will be deleted when the converter destructs. (We don't use the reference counting on EggData, to allow static EggDatas to be passed in.)

Definition at line 102 of file somethingToEggConverter.cxx.

References SomethingToEggConverter::_allow_errors, SomethingToEggConverter::_error, EggGroupNode::add_child(), SomethingToEggConverter::convert_file(), SomethingToEggConverter::get_egg_data(), SomethingToEggConverter::make_copy(), nout, EggData::set_coordinate_system(), Filename::set_extension(), and EggGroupNode::steal_children().

Referenced by SomethingToEggConverter::set_input_frame_rate().

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

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 238 of file somethingToEggConverter.I.

References SomethingToEggConverter::_control_flags, and SomethingToEggConverter::CF_frame_inc.

Referenced by SomethingToEgg::apply_units_scale().

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

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 317 of file somethingToEggConverter.I.

References SomethingToEggConverter::_control_flags, SomethingToEggConverter::_input_frame_rate, SomethingToEggConverter::CF_input_frame_rate, and INLINE.

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

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 463 of file somethingToEggConverter.I.

References INLINE, NULL, and SomethingToEggConverter::set_egg_data().

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

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 624 of file somethingToEggConverter.I.

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

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

Definition at line 386 of file somethingToEggConverter.I.

References SomethingToEggConverter::_control_flags, SomethingToEggConverter::CF_output_frame_rate, and INLINE.

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

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 534 of file somethingToEggConverter.I.

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

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 36 of file somethingToEggConverter.I.

References SomethingToEggConverter::_path_replace, and INLINE.

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

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 163 of file somethingToEggConverter.I.

References SomethingToEggConverter::_control_flags, SomethingToEggConverter::_end_frame, SomethingToEggConverter::CF_end_frame, and INLINE.

Member Data Documentation

bool SomethingToEggConverter::_allow_errors [inherited]
 

Definition at line 127 of file somethingToEggConverter.h.

Referenced by SomethingToEggConverter::set_egg_data().

AnimationConvert SomethingToEggConverter::_animation_convert [protected, inherited]
 

Definition at line 132 of file somethingToEggConverter.h.

Referenced by SomethingToEggConverter::get_path_replace().

string SomethingToEggConverter::_character_name [protected, inherited]
 

Definition at line 133 of file somethingToEggConverter.h.

Referenced by MayaToEggConverter::close_api(), and MayaToEggConverter::convert_flip().

int SomethingToEggConverter::_control_flags [protected, inherited]
 

Definition at line 148 of file somethingToEggConverter.h.

Referenced by SomethingToEggConverter::clear_frame_inc(), SomethingToEggConverter::clear_start_frame(), SomethingToEggConverter::get_animation_convert(), SomethingToEggConverter::get_end_frame(), SomethingToEggConverter::get_start_frame(), SomethingToEggConverter::has_end_frame(), SomethingToEggConverter::has_frame_inc(), SomethingToEggConverter::has_start_frame(), SomethingToEggConverter::set_character_name(), SomethingToEggConverter::set_end_frame(), SomethingToEggConverter::set_frame_inc(), SomethingToEggConverter::set_neutral_frame(), and SomethingToEggConverter::set_start_frame().

LPDIRECTXFILE XFileToEggConverter::_dx_file [private]
 

Definition at line 92 of file xFileToEggConverter.h.

Referenced by XFileToEggConverter().

LPDIRECTXFILEENUMOBJECT XFileToEggConverter::_dx_file_enum [private]
 

Definition at line 93 of file xFileToEggConverter.h.

Referenced by close(), and XFileToEggConverter().

EggData* SomethingToEggConverter::_egg_data [protected, inherited]
 

Definition at line 152 of file somethingToEggConverter.h.

Referenced by close(), LwoToEggConverter::convert_file(), FltToEggConverter::convert_file(), and SomethingToEggConverter::~SomethingToEggConverter().

double SomethingToEggConverter::_end_frame [protected, inherited]
 

Definition at line 135 of file somethingToEggConverter.h.

Referenced by SomethingToEggConverter::get_start_frame(), and SomethingToEggConverter::set_start_frame().

bool SomethingToEggConverter::_error [protected, inherited]
 

Definition at line 155 of file somethingToEggConverter.h.

Referenced by LwoToEggConverter::convert_file(), SomethingToEggConverter::set_egg_data(), and SomethingToEggConverter::SomethingToEggConverter().

double SomethingToEggConverter::_frame_inc [protected, inherited]
 

Definition at line 136 of file somethingToEggConverter.h.

Referenced by SomethingToEggConverter::clear_start_frame(), and SomethingToEggConverter::has_end_frame().

double SomethingToEggConverter::_input_frame_rate [protected, inherited]
 

Definition at line 138 of file somethingToEggConverter.h.

Referenced by SomethingToEggConverter::get_frame_inc(), and SomethingToEggConverter::set_frame_inc().

EggMaterialCollection XFileToEggConverter::_materials [private]
 

Definition at line 96 of file xFileToEggConverter.h.

bool SomethingToEggConverter::_merge_externals [protected, inherited]
 

Definition at line 150 of file somethingToEggConverter.h.

Referenced by SomethingToEggConverter::clear_neutral_frame().

double SomethingToEggConverter::_neutral_frame [protected, inherited]
 

Definition at line 137 of file somethingToEggConverter.h.

Referenced by SomethingToEggConverter::clear_end_frame(), and SomethingToEggConverter::get_end_frame().

double SomethingToEggConverter::_output_frame_rate [protected, inherited]
 

Definition at line 139 of file somethingToEggConverter.h.

Referenced by SomethingToEggConverter::clear_frame_inc(), and SomethingToEggConverter::has_neutral_frame().

bool SomethingToEggConverter::_owns_egg_data [protected, inherited]
 

Definition at line 153 of file somethingToEggConverter.h.

Referenced by SomethingToEggConverter::~SomethingToEggConverter().

PointerTo< PathReplace > SomethingToEggConverter::_path_replace [protected, inherited]
 

Definition at line 130 of file somethingToEggConverter.h.

Referenced by MayaToEggConverter::get_egg_table(), SomethingToEggConverter::get_input_frame_rate(), FltToEggConverter::get_name(), SomethingToEggConverter::get_path_replace(), SomethingToEggConverter::has_input_frame_rate(), and SomethingToEggConverter::set_path_replace().

double SomethingToEggConverter::_start_frame [protected, inherited]
 

Definition at line 134 of file somethingToEggConverter.h.

Referenced by SomethingToEggConverter::get_animation_convert(), and SomethingToEggConverter::get_character_name().

EggTextureCollection XFileToEggConverter::_textures [private]
 

Definition at line 95 of file xFileToEggConverter.h.

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