Panda3D
Public Member Functions | Static Public Member Functions | List of all members
EggBinMaker Class Reference

This is a handy class for collecting related nodes together. More...

Inheritance diagram for EggBinMaker:
EggObject TypedReferenceCount TypedObject ReferenceCount EggPolysetMaker

Public Member Functions

bool collapseGroup (const EggGroup group, int bin_number)
 May be overridden in derived classes to specify whether a particular group node, apparently redundant, may be safely collapsed out. More...
 
str getBinName (int bin_number, const EggNode child)
 May be overridden in derived classes to define a name for each new bin, based on its bin number, and a sample child. More...
 
int getBinNumber (const EggNode node)
 
EggBin makeBin (int bin_number, const EggNode child, EggGroup collapse_from)
 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. More...
 
int makeBins (EggGroupNode root_group)
 The main entry point to EggBinMaker. More...
 
 prepareNode (EggNode node)
 May be overridden in derived classes to perform some setup work as each node is encountered. More...
 
bool sortsLess (int bin_number, const EggNode a, const EggNode b)
 May be overridden in derived classes to create additional bins within a particular bin number, based on some arbitrary property of nodes. More...
 
- Public Member Functions inherited from EggObject
 __init__ ()
 
 __init__ (const EggObject copy)
 
 clearUserData ()
 Removes all user data pointers from the node. More...
 
 clearUserData (TypeHandle type)
 Removes the user data pointer of the indicated type. More...
 
EggUserData getUserData ()
 Returns the user data pointer most recently stored on this object, or NULL if nothing was previously stored. More...
 
EggUserData getUserData (TypeHandle type)
 Returns the user data pointer of the indicated type, if it exists, or NULL if it does not. More...
 
bool hasUserData ()
 Returns true if a generic user data pointer has recently been set and not yet cleared, false otherwise. More...
 
bool hasUserData (TypeHandle type)
 Returns true if the user data pointer of the indicated type has been set, false otherwise. More...
 
EggObject operator= (const EggObject copy)
 
 setUserData (EggUserData user_data)
 Sets the user data associated with this object. More...
 
- Public Member Functions inherited from TypedObject
TypeHandle getType ()
 
int getTypeIndex ()
 Returns the internal index number associated with this object's TypeHandle, a unique number for each different type. More...
 
bool isExactType (TypeHandle handle)
 Returns true if the current object is the indicated type exactly. More...
 
bool isOfType (TypeHandle handle)
 Returns true if the current object is or derives from the indicated type. More...
 
- Public Member Functions inherited from ReferenceCount
int getRefCount ()
 Returns the current reference count. More...
 
 ref ()
 Explicitly increments the reference count. More...
 
bool testRefCountIntegrity ()
 Does some easy checks to make sure that the reference count isn't completely bogus. More...
 
bool testRefCountNonzero ()
 Does some easy checks to make sure that the reference count isn't zero, or completely bogus. More...
 
bool unref ()
 Explicitly decrements the reference count. More...
 

Static Public Member Functions

static TypeHandle getClassType ()
 
- Static Public Member Functions inherited from EggObject
static TypeHandle getClassType ()
 
- Static Public Member Functions inherited from TypedReferenceCount
static TypeHandle getClassType ()
 
- Static Public Member Functions inherited from TypedObject
static TypeHandle getClassType ()
 
- Static Public Member Functions inherited from ReferenceCount
static TypeHandle getClassType ()
 

Additional Inherited Members

- Public Attributes inherited from TypedObject
TypeHandle type
 Returns the TypeHandle representing this object's type. More...
 
- Public Attributes inherited from ReferenceCount
int ref_count
 The current reference count. More...
 

Detailed Description

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.

Member Function Documentation

◆ collapseGroup()

bool collapseGroup ( const EggGroup  group,
int  bin_number 
)

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

◆ getBinName()

str getBinName ( int  bin_number,
const EggNode  child 
)

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

◆ getBinNumber()

int getBinNumber ( const EggNode  node)

◆ getClassType()

static TypeHandle getClassType ( )
static

◆ makeBin()

EggBin makeBin ( int  bin_number,
const EggNode  child,
EggGroup  collapse_from 
)

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 collapse_group() returned true), or NULL if not.

◆ makeBins()

int makeBins ( EggGroupNode  root_group)

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

prepareNode ( EggNode  node)

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

bool sortsLess ( int  bin_number,
const EggNode  a,
const EggNode  b 
)

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