Panda3D
Public Types | Public Member Functions | Static Public Member Functions

EggPolysetMaker Class Reference

A specialization on EggBinMaker for making polysets that share the same basic rendering characteristic. More...

Inheritance diagram for EggPolysetMaker:
EggBinMaker EggObject

List of all members.

Public Types

enum  BinNumber { BNNone = 0, BNPolyset = 1 }
enum  Properties {
  PHasTexture = 1, PTexture = 2, PHasMaterial = 4, PMaterial = 8,
  PHasPolyColor = 16, PPolyColor = 32, PHasPolyNormal = 64, PHasVertexNormal = 128,
  PHasVertexColor = 256, PBface = 512
}

Public Member Functions

 EggPolysetMaker ()
 clearUserData (TypeHandle type)
 Removes the user data pointer of the indicated type.
 clearUserData ()
 Removes *all* user data pointers from the node.
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.
 setProperties (int properties)
 Sets the set of properties that determines which polygons are allowed to be grouped together into a single polyset.
 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

A specialization on EggBinMaker for making polysets that share the same basic rendering characteristic.

This really just defines the example functions described in the leading comment to EggBinMaker.

It makes some common assumptions about how polysets should be grouped; if these are not sufficient, you can always rederive your own further specialization of this class.


Member Enumeration Documentation

enum BinNumber
Enumerator:
BNNone 
BNPolyset 
enum Properties
Enumerator:
PHasTexture 
PTexture 
PHasMaterial 
PMaterial 
PHasPolyColor 
PPolyColor 
PHasPolyNormal 
PHasVertexNormal 
PHasVertexColor 
PBface 

Constructor & Destructor Documentation


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 
) [inherited]

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 
) [inherited]

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) [inherited]
static TypeHandle getClassType ( ) [static]

Reimplemented from EggBinMaker.

EggUserData getUserData ( ) [inherited]

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

EggUserData getUserData ( TypeHandle  type) [inherited]

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

bool hasUserData ( ) [inherited]

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

bool hasUserData ( TypeHandle  type) [inherited]

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 
) [inherited]

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) [inherited]

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) [inherited]

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.

setProperties ( int  properties)

Sets the set of properties that determines which polygons are allowed to be grouped together into a single polyset.

This is the bitwise 'or' of all the properties that matter. If this is 0, all polygons (within a given group) will be lumped into a common polyset regardless of their properties.

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 
) [inherited]

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