Panda3D
Public Member Functions | Static Public Member Functions

EggBinMaker Class Reference

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

Inheritance diagram for EggBinMaker:
EggObject EggPolysetMaker

List of all members.

Public Member Functions

 clearUserData ()
 Removes *all* user data pointers from the node.
 clearUserData (TypeHandle type)
 Removes the user data pointer of the indicated type.
bool collapseGroup (EggGroup const group, int bin_number)
 May be overridden in derived classes to specify whether a particular group node, apparently redundant, may be safely collapsed out.
string getBinName (int bin_number, EggNode const child)
 May be overridden in derived classes to define a name for each new bin, based on its bin number, and a sample child.
int getBinNumber (EggNode const node)
EggUserData getUserData ()
 Returns the user data pointer most recently stored on this object, or NULL if nothing was previously stored.
EggUserData getUserData (TypeHandle type)
 Returns the user data pointer of the indicated type, if it exists, or NULL if it does not.
bool hasUserData ()
 Returns true if a generic user data pointer has recently been set and not yet cleared, false otherwise.
bool hasUserData (TypeHandle type)
 Returns true if the user data pointer of the indicated type has been set, false otherwise.
EggBin makeBin (int bin_number, EggNode const 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.
int makeBins (EggGroupNode root_group)
 The main entry point to EggBinMaker.
 prepareNode (EggNode node)
 May be overridden in derived classes to perform some setup work as each node is encountered.
 setUserData (EggUserData user_data)
 Sets the user data associated with this object.
bool sortsLess (int bin_number, EggNode const a, EggNode const b)
 May be overridden in derived classes to create additional bins within a particular bin number, based on some arbitrary property of nodes.

Static Public Member Functions

static TypeHandle getClassType ()

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

clearUserData ( ) [inherited]

Removes *all* user data pointers from the node.

clearUserData ( TypeHandle  type) [inherited]

Removes the user data pointer of the indicated type.

bool collapseGroup ( EggGroup const  group,
int  bin_number 
)

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

string getBinName ( int  bin_number,
EggNode const  child 
)

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

int getBinNumber ( EggNode const  node)
static TypeHandle getClassType ( ) [static]

Reimplemented from EggObject.

Reimplemented in EggPolysetMaker.

EggUserData getUserData ( TypeHandle  type) [inherited]

Returns the user data pointer of the indicated type, if it exists, or NULL if it does not.

EggUserData getUserData ( ) [inherited]

Returns the user data pointer most recently stored on this object, or NULL if nothing was previously stored.

bool hasUserData ( TypeHandle  type) [inherited]

Returns true if the user data pointer of the indicated type has been set, false otherwise.

bool hasUserData ( ) [inherited]

Returns true if a generic user data pointer has recently been set and not yet cleared, false otherwise.

EggBin makeBin ( int  bin_number,
EggNode const  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.

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

setUserData ( EggUserData  user_data) [inherited]

Sets the user data associated with this object.

This may be any EggUserData-derived object. The egg library will do nothing with this pointer, except to hold its reference count and return the pointer on request.

The EggObject maintains multiple different EggUserData pointers, one for each unique type (as reported by get_type()). If you know that only one type of EggUserData object will be added in your application, you may use the query functions that accept no parameters, but it is recommended that in general you pass in the type of your particular user data, to allow multiple applications to coexist in the same egg data.

This pointer is also copied by the copy assignment operator and copy constructor.

bool sortsLess ( int  bin_number,
EggNode const  a,
EggNode const  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).

 All Classes Namespaces Functions Variables Enumerations Enumerator Properties