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

This global object records NodePaths that are referenced by scene graph attribs, such as ClipPlaneAttribs and LightAttribs. More...

Public Member Functions

 addNode (const NodePath attrib_node)
 Adds the indicated NodePath to the registry. More...
 
 clear ()
 Removes all nodes from the registry. More...
 
int findNode (const NodePath attrib_node)
 Returns the index number of the indicated NodePath in the registry (assuming its name hasn't changed since it was recorded in the registry), or -1 if the NodePath cannot be found (for instance, because its name has changed). More...
 
int findNode (TypeHandle type, str name)
 Returns the index number of the node with the indicated type and name in the registry, or -1 if there is no such node in the registry. More...
 
NodePath getNode (int n)
 Returns the nth NodePath recorded in the registry. More...
 
str getNodeName (int n)
 Returns the name of the nth node, as recorded in the registry. More...
 
list getNodes ()
 
TypeHandle getNodeType (int n)
 Returns the type of the nth node, as recorded in the registry. More...
 
int getNumNodes ()
 Returns the total number of nodes in the registry. More...
 
NodePath lookupNode (const NodePath orig_node)
 Looks up the indicated NodePath in the registry. More...
 
 output (Ostream out)
 
bool removeNode (const NodePath attrib_node)
 Removes the indicated NodePath from the registry. More...
 
 removeNode (int n)
 Removes the nth node from the registry. More...
 
 write (Ostream out)
 

Static Public Member Functions

static AttribNodeRegistry getGlobalPtr ()
 

Detailed Description

This global object records NodePaths that are referenced by scene graph attribs, such as ClipPlaneAttribs and LightAttribs.

Its primary purpose is to unify attribs that are loaded in from bam files. Attrib nodes are identified by name and type; when a bam file that contains references to some attrib nodes is loaded, those nodes are first looked up here in the AttribNodeRegistry. If there is a match (by name and node type), the identified node is used instead of the node referenced within the bam file itself.

Member Function Documentation

◆ addNode()

addNode ( const NodePath  attrib_node)

Adds the indicated NodePath to the registry.

The name and type of the node are noted at the time of this call; if the name changes later, it will not update the registry index.

The NodePath must reference some kind of an attribute node, such as a LightNode or a PlaneNode. When bam files that reference an attribute node of the same type and the same name are loaded, they will quietly be redirected to reference this NodePath.

If there is already a node matching the indicated name and type, it will be replaced.

◆ clear()

clear ( )

Removes all nodes from the registry.

◆ findNode() [1/2]

int findNode ( const NodePath  attrib_node)

Returns the index number of the indicated NodePath in the registry (assuming its name hasn't changed since it was recorded in the registry), or -1 if the NodePath cannot be found (for instance, because its name has changed).

◆ findNode() [2/2]

int findNode ( TypeHandle  type,
str  name 
)

Returns the index number of the node with the indicated type and name in the registry, or -1 if there is no such node in the registry.

◆ getGlobalPtr()

static AttribNodeRegistry getGlobalPtr ( )
static

◆ getNode()

NodePath getNode ( int  n)

Returns the nth NodePath recorded in the registry.

◆ getNodeName()

str getNodeName ( int  n)

Returns the name of the nth node, as recorded in the registry.

This will be the node name as it was at the time the node was recorded; if the node has changed names since then, this will still return the original name.

◆ getNodes()

list getNodes ( )

◆ getNodeType()

TypeHandle getNodeType ( int  n)

Returns the type of the nth node, as recorded in the registry.

◆ getNumNodes()

int getNumNodes ( )

Returns the total number of nodes in the registry.

◆ lookupNode()

NodePath lookupNode ( const NodePath  orig_node)

Looks up the indicated NodePath in the registry.

If there is a node already in the registry with the matching name and type, returns that NodePath instead; otherwise, returns the original NodePath.

◆ output()

output ( Ostream  out)

◆ removeNode() [1/2]

bool removeNode ( const NodePath  attrib_node)

Removes the indicated NodePath from the registry.

The name of the node must not have changed since the matching call to add_node(), or it will not be successfully removed.

Returns true if the NodePath is found and removed, false if it is not found (for instance, because the name has changed).

◆ removeNode() [2/2]

removeNode ( int  n)

Removes the nth node from the registry.

◆ write()

write ( Ostream  out)