class EggBinMaker

Bases: EggObject

This is a handy class for collecting related nodes together. It is an abstract class; to use it you must subclass off of it. See the somewhat lengthy comment above.

Inheritance diagram

Inheritance diagram of EggBinMaker

collapseGroup(group: EggGroup, bin_number: int) → bool

May be overridden in derived classes to specify whether a particular group node, apparently redundant, may be safely collapsed out.

getBinName(bin_number: int, child: EggNode) → str

May be overridden in derived classes to define a name for each new bin, based on its bin number, and a sample child.

getBinNumber(node: EggNode) → int
static getClassType() → TypeHandle
Return type


makeBin(bin_number: int, child: EggNode, collapse_from: EggGroup) → EggBin

May be overridden in derived classes to construct a new EggBin object (or some derived class, if needed), and preload some initial data into as required.

child is an arbitrary child of the bin, and collapse_from is the group the bin is being collapsed with, if any (implying collapseGroup() returned true), or NULL if not.

Return type


makeBins(root_group: EggGroupNode) → int

The main entry point to EggBinMaker. Walks the egg scene graph beginning at the indicated root node, and moves all binnable nodes into EggBin objects. Returns the number of EggBins created.

prepareNode(node: EggNode) → None

May be overridden in derived classes to perform some setup work as each node is encountered. This will be called once for each node in the egg hierarchy.

sortsLess(bin_number: int, a: EggNode, b: EggNode) → bool

May be overridden in derived classes to create additional bins within a particular bin number, based on some arbitrary property of nodes. This function establishes an arbitrary but fixed ordering between nodes; if two nodes do not sort to the same position, different bins are created for each one (with the same bin number on each bin).