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