Panda3D
 All Classes Functions Variables Enumerations
load_egg_file.h
1 // Filename: load_egg_file.h
2 // Created by: drose (26Feb02)
3 //
4 ////////////////////////////////////////////////////////////////////
5 //
6 // PANDA 3D SOFTWARE
7 // Copyright (c) Carnegie Mellon University. All rights reserved.
8 //
9 // All use of this software is subject to the terms of the revised BSD
10 // license. You should have received a copy of this license along
11 // with this source code in a file named "LICENSE."
12 //
13 ////////////////////////////////////////////////////////////////////
14 
15 #ifndef LOAD_EGG_FILE_H
16 #define LOAD_EGG_FILE_H
17 
18 #include "pandabase.h"
19 
20 #include "pandaNode.h"
21 #include "coordinateSystem.h"
22 #include "eggData.h"
23 
24 class BamCacheRecord;
25 
26 BEGIN_PUBLISH
27 ////////////////////////////////////////////////////////////////////
28 // Function: load_egg_file
29 // Description: A convenience function; the primary interface to this
30 // package. Loads up the indicated egg file, and
31 // returns the root of a scene graph. Returns NULL if
32 // the file cannot be read for some reason.
33 //
34 // Also see the EggLoader class, which can exercise a
35 // bit more manual control over the loading process.
36 ////////////////////////////////////////////////////////////////////
37 EXPCL_PANDAEGG PT(PandaNode)
38 load_egg_file(const Filename &filename, CoordinateSystem cs = CS_default,
39  BamCacheRecord *record = NULL);
40 
41 ////////////////////////////////////////////////////////////////////
42 // Function: load_egg_data
43 // Description: Another convenience function; works like
44 // load_egg_file() but starts from an already-filled
45 // EggData structure. The structure is destroyed in the
46 // loading.
47 ////////////////////////////////////////////////////////////////////
48 EXPCL_PANDAEGG PT(PandaNode)
49 load_egg_data(EggData *data, CoordinateSystem cs = CS_default);
50 END_PUBLISH
51 
52 #endif
A basic node of the scene graph or data graph.
Definition: pandaNode.h:72
This is the primary interface into all the egg data, and the root of the egg file structure...
Definition: eggData.h:41
The name of a file, such as a texture file or an Egg file.
Definition: filename.h:44
An instance of this class is written to the front of a Bam or Txo file to make the file a cached inst...