panda3d.egg.EggData

class EggData

Bases: EggGroupNode

This is the primary interface into all the egg data, and the root of the egg file structure. An EggData structure corresponds exactly with an egg file on the disk.

The EggData class inherits from EggGroupNode its collection of children, which are accessed by using the EggData itself as an STL container with begin() and end() calls. The children of the EggData class are the toplevel nodes in the egg file.

Inheritance diagram

Inheritance diagram of EggData

__init__() → None
__init__(copy: EggData) → None
assign(copy: EggData) → EggData
Return type

EggData

property auto_resolve_externals
Getter

Indicates whether the EggData object will automatically resolve any external references when read() is called. The default is false.

Setter

Indicates whether the EggData object will automatically resolve any external references when read() is called. The default is false.

Return type

bool

collapseEquivalentMaterials() → int

Removes duplicate references to the same material with the same properties. Considers two material references with identical properties, but different mref names, to be equivalent, and collapses them, choosing one mref name to keep arbitrarily. Returns the number of materials removed.

collapseEquivalentTextures() → int

Removes duplicate references to the same texture image with the same properties. Considers two texture references with identical properties, but different tref names, to be equivalent, and collapses them, choosing one tref name to keep arbitrarily. Returns the number of textures removed.

property coordinate_system
Getter

Returns the coordinate system in which the egg file is defined.

Setter

Changes the coordinate system of the EggData. If the coordinate system was previously different, this may result in a conversion of the data.

Return type

CoordinateSystem

property egg_filename
Getter

Returns the directory in which the egg file is considered to reside.

Setter

Sets the filename–especially the directory part–in which the egg file is considered to reside. This is also implicitly set by read().

Return type

Filename

property egg_timestamp
Getter

Returns the timestamp of the egg file on disk, at the time it was opened for reading, or 0 if this information is not available.

Setter

Sets the timestamp of the egg file on disk, at the time it was opened for reading. This is also implicitly set by read().

Return type

time_t

getAutoResolveExternals() → bool

Indicates whether the EggData object will automatically resolve any external references when read() is called. The default is false.

static getClassType() → TypeHandle
Return type

TypeHandle

getCoordinateSystem() → CoordinateSystem

Returns the coordinate system in which the egg file is defined.

Return type

CoordinateSystem

getEggFilename() → Filename

Returns the directory in which the egg file is considered to reside.

Return type

Filename

getEggTimestamp() → time_t

Returns the timestamp of the egg file on disk, at the time it was opened for reading, or 0 if this information is not available.

Return type

time_t

loadExternals(searchpath: DSearchPath) → bool

Loads up all the egg files referenced by <File> entries within the egg structure, and inserts their contents in place of the <File> entries. Searches for files in the searchpath, if not found directly, and writes error messages to the indicated output stream. Returns true if all externals were loaded successfully, false otherwise.

loadExternals(searchpath: DSearchPath, record: BamCacheRecord) → bool

Loads up all the egg files referenced by <File> entries within the egg structure, and inserts their contents in place of the <File> entries. Searches for files in the searchpath, if not found directly, and writes error messages to the indicated output stream. Returns true if all externals were loaded successfully, false otherwise.

merge(other: EggData) → None

Appends the other egg structure to the end of this one. The other egg structure is invalidated.

originalHadAbsolutePathnames() → bool

Returns true if the data processed in the last call to read() contained absolute pathnames, or false if those pathnames were all relative.

This method is necessary because if auto_resolve_externals() is in effect, it may modify the pathnames to be absolute whether or not they were as loaded from disk. This method can be used to query the state of the original egg file from disk.

read(filename: Filename, display_name: str) → bool

Opens the indicated filename and reads the egg data contents from it. Returns true if the file was successfully opened and read, false if there were some errors, in which case the data may be partially read.

error is the output stream to which to write error messages.

read(in: istream) → bool

Parses the egg syntax contained in the indicated input stream. Returns true if the stream was a completely valid egg file, false if there were some errors, in which case the data may be partially read.

Before you call this routine, you should probably call setEggFilename() to set the name of the egg file we’re processing, if at all possible. If there is no such filename, you may set it to the empty string.

recomputePolygonNormals() → None

Recomputes all the polygon normals for polygon geometry at this group node and below so that they accurately reflect the vertex positions. Normals are removed from the vertices and defined only on polygons, giving the geometry a faceted appearance.

This function also removes degenerate polygons that do not have enough vertices to define a normal. It does not affect normals for other kinds of primitives like Nurbs or Points.

This function does not remove or adjust vertices in the vertex pool; it only adds new vertices with the normals removed. Thus, it is a good idea to call remove_unused_vertices() after calling this.

recomputeVertexNormals(threshold: float) → None

Recomputes all the vertex normals for polygon geometry at this group node and below so that they accurately reflect the vertex positions. A shared edge between two polygons (even in different groups) is considered smooth if the angle between the two edges is less than threshold degrees.

This function also removes degenerate polygons that do not have enough vertices to define a normal. It does not affect normals for other kinds of primitives like Nurbs or Points.

This function does not remove or adjust vertices in the vertex pool; it only adds new vertices with the correct normals. Thus, it is a good idea to call remove_unused_vertices() after calling this.

static resolveEggFilename(egg_filename: Filename, searchpath: DSearchPath) → bool

Looks for the indicated filename, first along the indicated searchpath, and then along the model_path. If found, updates the filename to the full path and returns true; otherwise, returns false.

setAutoResolveExternals(resolve: bool) → None

Indicates whether the EggData object will automatically resolve any external references when read() is called. The default is false.

setCoordinateSystem(coordsys: CoordinateSystem) → None

Changes the coordinate system of the EggData. If the coordinate system was previously different, this may result in a conversion of the data.

setEggFilename(egg_filename: Filename) → None

Sets the filename–especially the directory part–in which the egg file is considered to reside. This is also implicitly set by read().

setEggTimestamp(egg_timestamp: time_t) → None

Sets the timestamp of the egg file on disk, at the time it was opened for reading. This is also implicitly set by read().

stripNormals() → None

Removes all normals from primitives, and the vertices they reference, at this node and below.

This function does not remove or adjust vertices in the vertex pool; it only adds new vertices with the normal removed. Thus, it is a good idea to call remove_unused_vertices() after calling this.

writeEgg(filename: Filename) → bool

The main interface for writing complete egg files.

writeEgg(out: ostream) → bool

The main interface for writing complete egg files.