Panda3D
Classes | Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
PandaNode Class Reference

A basic node of the scene graph or data graph. More...

Inheritance diagram for PandaNode:
TypedWritableReferenceCount Namable TypedWritable ReferenceCount TypedObject BulletBaseCharacterControllerNode BulletBodyNode BulletDebugNode AnimBundleNode CallbackNode CollisionNode CollisionVisualizer ComputeNode DataNode Fog GeomNode LensNode LightNode LODNode ModelNode OccluderNode ParametricCurve PartBundleNode PGItem PGTop PlaneNode PolylightNode PortalNode RigidBodyCombiner RopeNode SelectiveChildNode ShaderTerrainMesh SheetNode TextNode UvScrollNode ProjectionScreen ForceNode PhysicalNode

Classes

class  Children
 
class  Parents
 
class  Stashed
 

Public Types

enum  FancyBits {
  FB_transform = 1, FB_state = 2, FB_effects = 4, FB_tag = 16,
  FB_draw_mask = 32, FB_cull_callback = 64
}
 
enum  UnexpectedChange {
  UC_parents = 1, UC_children = 2, UC_transform = 4, UC_state = 8,
  UC_draw_mask = 16
}
 

Public Member Functions

PandaNode __copy__ ()
 
object __deepcopy__ (object memo)
 
 __init__ (str name)
 
int __traverse__ (Visitproc visit, void arg)
 
 addChild (PandaNode child_node, int sort, Thread current_thread)
 Adds a new child to the node. More...
 
 addStashed (PandaNode child_node, int sort, Thread current_thread)
 Adds a new child to the node, directly as a stashed child. More...
 
 adjustDrawMask (DrawMask show_mask, DrawMask hide_mask, DrawMask clear_mask)
 Adjusts the hide/show bits of this particular node. More...
 
Light asLight ()
 Cross-casts the node to a Light pointer, if it is one of the four kinds of Light nodes, or returns NULL if it is not. More...
 
 clearAttrib (TypeHandle type)
 Removes the render attribute of the given type from this node. More...
 
 clearAttrib (int slot)
 Removes the render attribute of the given type from this node. More...
 
 clearBounds ()
 Reverses the effect of a previous call to set_bounds(), and allows the node's bounding volume to be automatically computed once more based on the contents of the node. More...
 
 clearEffect (TypeHandle type)
 Removes the render effect of the given type from this node. More...
 
 clearEffects (Thread current_thread)
 Resets this node to have no render effects. More...
 
 clearPythonTag (object key)
 
 clearState (Thread current_thread)
 Resets this node to leave the render state alone. More...
 
 clearTag (str key, Thread current_thread)
 Removes the value defined for this key on this particular node. More...
 
 clearTransform (Thread current_thread)
 Resets the transform on this node to the identity transform. More...
 
 clearUnexpectedChange (unsigned int flags)
 Sets one or more of the PandaNode::UnexpectedChange bits off, indicating that the corresponding property may once again change on this node. More...
 
PandaNode combineWith (PandaNode other)
 Collapses this PandaNode with the other PandaNode, if possible, and returns a pointer to the combined PandaNode, or NULL if the two PandaNodes cannot safely be combined. More...
 
int compareTags (const PandaNode other)
 Returns a number less than 0, 0, or greater than 0, to indicate the similarity of tags between this node and the other one. More...
 
 copyAllProperties (PandaNode other)
 Copies the TransformState, RenderState, RenderEffects, tags, Python tags, and the show/hide state from the other node onto this one. More...
 
 copyChildren (PandaNode other, Thread current_thread)
 Makes another instance of all the children of the other node, copying them to this node. More...
 
PandaNode copySubgraph (Thread current_thread)
 Allocates and returns a complete copy of this PandaNode and the entire scene graph rooted at this PandaNode. More...
 
 copyTags (PandaNode other)
 Copies all of the tags stored on the other node onto this node. More...
 
int countNumDescendants ()
 Returns the number of nodes at and below this level. More...
 
int findChild (PandaNode node, Thread current_thread)
 Returns the index of the indicated child node, if it is a child, or -1 if it is not. More...
 
int findParent (PandaNode node, Thread current_thread)
 Returns the index of the indicated parent node, if it is a parent, or -1 if it is not. More...
 
int findStashed (PandaNode node, Thread current_thread)
 Returns the index of the indicated stashed node, if it is a stashed child, or -1 if it is not. More...
 
const RenderAttrib getAttrib (TypeHandle type)
 Returns the render attribute of the indicated type, if it is defined on the node, or NULL if it is not. More...
 
const RenderAttrib getAttrib (int slot)
 Returns the render attribute of the indicated type, if it is defined on the node, or NULL if it is not. More...
 
const BoundingVolume getBounds (Thread current_thread)
 Returns the external bounding volume of this node: a bounding volume that contains the user bounding volume, the internal bounding volume, and all of the children's bounding volumes. More...
 
const BoundingVolume getBounds (UpdateSeq seq, Thread current_thread)
 This flavor of get_bounds() return the external bounding volume, and also fills in seq with the bounding volume's current sequence number. More...
 
BoundingVolume::BoundsType getBoundsType ()
 Returns the bounding volume type set with set_bounds_type(). More...
 
PandaNode getChild (int n, Thread current_thread)
 Returns the nth child node of this node. More...
 
list getChildren ()
 
int getChildSort (int n, Thread current_thread)
 Returns the sort index of the nth child node of this node (that is, the number that was passed to add_child()). More...
 
DrawMask getDrawControlMask ()
 Returns the set of bits in draw_show_mask that are considered meaningful. More...
 
DrawMask getDrawShowMask ()
 Returns the hide/show bits of this particular node. More...
 
const RenderEffect getEffect (TypeHandle type)
 Returns the render effect of the indicated type, if it is defined on the node, or NULL if it is not. More...
 
const RenderEffects getEffects (Thread current_thread)
 Returns the complete RenderEffects that will be applied to this node. More...
 
int getFancyBits (Thread current_thread)
 Returns the union of all of the enum FancyBits values corresponding to the various "fancy" attributes that are set on the node. More...
 
const BoundingVolume getInternalBounds (Thread current_thread)
 Returns the node's internal bounding volume. More...
 
int getInternalVertices (Thread current_thread)
 Returns the total number of vertices that will be rendered by this particular node alone, not accounting for its children. More...
 
CollideMask getIntoCollideMask ()
 Returns the "into" collide mask for this node. More...
 
CollideMask getLegalCollideMask ()
 Returns the subset of CollideMask bits that may be set for this particular type of PandaNode. More...
 
int getNestedVertices (Thread current_thread)
 Returns the total number of vertices that will be rendered by this node and all of its descendents. More...
 
CollideMask getNetCollideMask (Thread current_thread)
 Returns the union of all into_collide_mask() values set at CollisionNodes at this level and below. More...
 
DrawMask getNetDrawControlMask ()
 Returns the set of bits in get_net_draw_show_mask() that have been explicitly set via adjust_draw_mask(), rather than implicitly inherited. More...
 
DrawMask getNetDrawShowMask ()
 Returns the union of all draw_show_mask values–of renderable nodes only– at this level and below. More...
 
int getNumChildren (Thread current_thread)
 Returns the number of child nodes this node has. More...
 
int getNumParents (Thread current_thread)
 Returns the number of parent nodes this node has. More...
 
int getNumStashed (Thread current_thread)
 Returns the number of stashed nodes this node has. More...
 
const RenderAttrib getOffClipPlanes (Thread current_thread)
 Returns a ClipPlaneAttrib which represents the union of all of the clip planes that have been turned off at this level and below. More...
 
PandaNode getParent (int n, Thread current_thread)
 Returns the nth parent node of this node. More...
 
list getParents ()
 
const TransformState getPrevTransform (Thread current_thread)
 Returns the transform that has been set as this node's "previous" position. More...
 
object getPythonTag (object key)
 
object getPythonTagKeys ()
 
object getPythonTags ()
 
PandaNode::Stashed getStashed (Thread current_thread)
 Returns an object that can be used to walk through the list of children of the node. More...
 
PandaNode getStashed (int n, Thread current_thread)
 Returns the nth stashed child of this node. More...
 
list getStashed ()
 
int getStashedSort (int n, Thread current_thread)
 Returns the sort index of the nth stashed node of this node (that is, the number that was passed to add_child()). More...
 
const RenderState getState (Thread current_thread)
 Returns the complete RenderState that will be applied to all nodes at this level and below, as set on this node. More...
 
str getTag (str key, Thread current_thread)
 Retrieves the user-defined value that was previously set on this node for the particular key, if any. More...
 
object getTagKeys ()
 
const TransformState getTransform (Thread current_thread)
 Returns the transform that has been set on this particular node. More...
 
unsigned int getUnexpectedChange (unsigned int flags)
 Returns nonzero if any of the bits in the input parameter are set on this node, or zero if none of them are set. More...
 
bool hasAttrib (TypeHandle type)
 Returns true if there is a render attribute of the indicated type defined on this node, or false if there is not. More...
 
bool hasAttrib (int slot)
 Returns true if there is a render attribute of the indicated type defined on this node, or false if there is not. More...
 
bool hasDirtyPrevTransform ()
 Returns true if this node has the _dirty_prev_transform flag set, which indicates its _prev_transform is different from its _transform value (in pipeline stage 0). More...
 
bool hasEffect (TypeHandle type)
 Returns true if there is a render effect of the indicated type defined on this node, or false if there is not. More...
 
bool hasPythonTag (object key)
 
bool hasTag (str key, Thread current_thread)
 Returns true if a value has been defined on this node for the particular key (even if that value is the empty string), or false if no value has been set. More...
 
bool hasTags ()
 Returns true if the node has any tags (or any Python tags) at all, false if it has none. More...
 
bool isAmbientLight ()
 Returns true if this is an AmbientLight, false if it is not a light, or it is some other kind of light. More...
 
bool isBoundsStale ()
 Returns true if the bounding volume of this node is stale and will be implicitly recomputed at the next call to get_bounds(), or false if it is fresh and need not be recomputed. More...
 
bool isCollisionNode ()
 A simple downcast check. More...
 
bool isFinal (Thread current_thread)
 Returns the current state of the "final" flag. More...
 
bool isGeomNode ()
 A simple downcast check. More...
 
bool isLodNode ()
 A simple downcast check. More...
 
bool isOverallHidden ()
 Returns true if the node has been hidden to all cameras by clearing its overall bit. More...
 
bool isSceneRoot ()
 Returns true if this particular node is known to be the render root of some active DisplayRegion associated with the global GraphicsEngine, false otherwise. More...
 
bool isUnderSceneRoot ()
 Returns true if this particular node is in a live scene graph: that is, it is a child or descendent of a node that is itself a scene root. More...
 
 listTags (Ostream out, str separator)
 Writes a list of all the tag keys assigned to the node to the indicated stream. More...
 
 ls (Ostream out, int indent_level)
 Lists all the nodes at and below the current path hierarchically. More...
 
PandaNode makeCopy ()
 Returns a newly-allocated PandaNode that is a shallow copy of this one. More...
 
 markBoundsStale (Thread current_thread)
 Indicates that the bounding volume, or something that influences the bounding volume (or any of the other things stored in CData, like net_collide_mask), may have changed for this node, and that it must be recomputed. More...
 
 markInternalBoundsStale (Thread current_thread)
 Should be called by a derived class to mark the internal bounding volume stale, so that compute_internal_bounds() will be called when the bounding volume is next requested. More...
 
 output (Ostream out)
 
 prepareScene (GraphicsStateGuardianBase gsg, const RenderState node_state)
 Walks through the scene graph beginning at this node, and does whatever initialization is required to render the scene properly with the indicated GSG. More...
 
 removeAllChildren (Thread current_thread)
 Removes all the children from the node at once, including stashed children. More...
 
bool removeChild (PandaNode child_node, Thread current_thread)
 Removes the indicated child from the node. More...
 
 removeChild (int child_index, Thread current_thread)
 Removes the nth child from the node. More...
 
 removeStashed (int child_index, Thread current_thread)
 Removes the nth stashed child from the node. More...
 
bool replaceChild (PandaNode orig_child, PandaNode new_child, Thread current_thread)
 Searches for the orig_child node in the node's list of children, and replaces it with the new_child instead. More...
 
 replaceNode (PandaNode other)
 Inserts this node into the scene graph in place of the other one, and removes the other node. More...
 
 resetPrevTransform (Thread current_thread)
 Resets the transform that represents this node's "previous" position to the same as the current transform. More...
 
 setAttrib (const RenderAttrib attrib, int override)
 Adds the indicated render attribute to the scene graph on this node. More...
 
 setBound (const BoundingVolume volume)
 Deprecated. More...
 
 setBounds (const BoundingVolume volume)
 Resets the bounding volume so that it is the indicated volume. More...
 
 setBoundsType (BoundingVolume::BoundsType bounds_type)
 Specifies the desired type of bounding volume that will be created for this node. More...
 
 setEffect (const RenderEffect effect)
 Adds the indicated render effect to the scene graph on this node. More...
 
 setEffects (const RenderEffects effects, Thread current_thread)
 Sets the complete RenderEffects that will be applied this node. More...
 
 setFinal (bool flag)
 Sets the "final" flag on this PandaNode. More...
 
 setIntoCollideMask (CollideMask mask)
 Sets the "into" CollideMask. More...
 
 setOverallHidden (bool overall_hidden)
 Sets or clears the hidden flag. More...
 
 setPrevTransform (const TransformState transform, Thread current_thread)
 Sets the transform that represents this node's "previous" position, one frame ago, for the purposes of detecting motion for accurate collision calculations. More...
 
 setPythonTag (object key, object value)
 
 setState (const RenderState state, Thread current_thread)
 Sets the complete RenderState that will be applied to all nodes at this level and below. More...
 
 setTag (str key, str value, Thread current_thread)
 Associates a user-defined value with a user-defined key which is stored on the node. More...
 
 setTransform (const TransformState transform, Thread current_thread)
 Sets the transform that will be applied to this node and below. More...
 
 setUnexpectedChange (unsigned int flags)
 Sets one or more of the PandaNode::UnexpectedChange bits on, indicating that the corresponding property should not change again on this node. More...
 
bool stashChild (PandaNode child_node, Thread current_thread)
 Stashes the indicated child node. More...
 
 stashChild (int child_index, Thread current_thread)
 Stashes the indicated child node. More...
 
 stealChildren (PandaNode other, Thread current_thread)
 Moves all the children from the other node onto this node. More...
 
bool unstashChild (PandaNode child_node, Thread current_thread)
 Returns the indicated stashed node to normal child status. More...
 
 unstashChild (int stashed_index, Thread current_thread)
 Returns the indicated stashed node to normal child status. More...
 
 write (Ostream out, int indent_level)
 
- Public Member Functions inherited from TypedWritable
object __reduce__ ()
 
object __reduce_persist__ (object pickler)
 
VectorUchar encodeToBamStream ()
 Converts the TypedWritable object into a single stream of data using a BamWriter, and returns that data as a bytes object. More...
 
bool encodeToBamStream (VectorUchar data, BamWriter writer)
 Converts the TypedWritable object into a single stream of data using a BamWriter, and stores that data in the indicated string. More...
 
 fillin (DatagramIterator scan, BamReader manager)
 This internal function is intended to be called by each class's make_from_bam() method to read in all of the relevant data from the BamFile for the new object. More...
 
UpdateSeq getBamModified ()
 Returns the current bam_modified counter. More...
 
 markBamModified ()
 Increments the bam_modified counter, so that this object will be invalidated and retransmitted on any open bam streams. 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...
 
- Public Member Functions inherited from Namable
 __init__ (const Namable)
 
 __init__ (str initial_name)
 
 clearName ()
 Resets the Namable's name to empty. More...
 
str getName ()
 
bool hasName ()
 Returns true if the Namable has a nonempty name set, false if the name is empty. More...
 
 output (Ostream out)
 Outputs the Namable. More...
 
 setName (str name)
 

Static Public Member Functions

static PandaNode decodeFromBamStream (VectorUchar data, BamReader reader)
 Reads the bytes created by a previous call to encode_to_bam_stream(), and extracts and returns the single object on those bytes. More...
 
static DrawMask getAllCameraMask ()
 Returns a DrawMask that is appropriate for rendering to all cameras. More...
 
static TypeHandle getClassType ()
 
static DrawMask getOverallBit ()
 Returns the special bit that, when specifically cleared in the node's DrawMask, indicates that the node is hidden to all cameras, regardless of the remaining DrawMask bits. More...
 
static resetAllPrevTransform (Thread current_thread)
 Visits all nodes in the world with the _dirty_prev_transform flag–that is, all nodes whose _prev_transform is different from the _transform in pipeline stage 0–and resets the _prev_transform to be the same as _transform. More...
 
- Static Public Member Functions inherited from TypedWritableReferenceCount
static TypedWritableReferenceCount decodeFromBamStream (VectorUchar data, BamReader reader)
 Reads the bytes created by a previous call to encode_to_bam_stream(), and extracts and returns the single object on those bytes. More...
 
static TypeHandle getClassType ()
 
- Static Public Member Functions inherited from TypedWritable
static TypeHandle getClassType ()
 
- Static Public Member Functions inherited from TypedObject
static TypeHandle getClassType ()
 
- Static Public Member Functions inherited from ReferenceCount
static TypeHandle getClassType ()
 
- Static Public Member Functions inherited from Namable
static TypeHandle getClassType ()
 

Public Attributes

DrawMask all_camera_mask
 Returns a DrawMask that is appropriate for rendering to all cameras. More...
 
bool bounds_stale
 Returns true if the bounding volume of this node is stale and will be implicitly recomputed at the next call to get_bounds(), or false if it is fresh and need not be recomputed. More...
 
BoundingVolume::BoundsType bounds_type
 Returns the bounding volume type set with set_bounds_type(). More...
 
PandaNode::Children children
 Returns an object that can be used to walk through the list of children of the node. More...
 
DrawMask draw_control_mask
 Returns the set of bits in draw_show_mask that are considered meaningful. More...
 
DrawMask draw_show_mask
 Returns the hide/show bits of this particular node. More...
 
ConstPointerToRenderEffects effects
 Returns the complete RenderEffects that will be applied to this node. More...
 
bool final
 Returns the current state of the "final" flag. More...
 
ConstPointerToBoundingVolume internal_bounds
 Returns the node's internal bounding volume. More...
 
int internal_vertices
 Returns the total number of vertices that will be rendered by this particular node alone, not accounting for its children. More...
 
CollideMask into_collide_mask
 Returns the "into" collide mask for this node. More...
 
CollideMask legal_collide_mask
 Returns the subset of CollideMask bits that may be set for this particular type of PandaNode. More...
 
int nested_vertices
 Returns the total number of vertices that will be rendered by this node and all of its descendents. More...
 
DrawMask overall_bit
 Returns the special bit that, when specifically cleared in the node's DrawMask, indicates that the node is hidden to all cameras, regardless of the remaining DrawMask bits. More...
 
bool overall_hidden
 Returns true if the node has been hidden to all cameras by clearing its overall bit. More...
 
PandaNode::Parents parents
 Returns an object that can be used to walk through the list of parents of the node, similar to get_children() and get_stashed(). More...
 
ConstPointerToTransformState prev_transform
 Returns the transform that has been set as this node's "previous" position. More...
 
object python_tags
 
PandaNode::Stashed stashed
 Returns the nth stashed child of this node. More...
 
ConstPointerToRenderState state
 Returns the complete RenderState that will be applied to all nodes at this level and below, as set on this node. More...
 
String tags []
 
ConstPointerToTransformState transform
 Returns the transform that has been set on this particular node. More...
 
- 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...
 
- Public Attributes inherited from Namable
const String name
 

Detailed Description

A basic node of the scene graph or data graph.

This is the base class of all specialized nodes, and also serves as a generic node with no special properties.

Member Enumeration Documentation

◆ FancyBits

enum FancyBits
Enumerator
FB_transform 
FB_state 
FB_effects 
FB_tag 
FB_draw_mask 
FB_cull_callback 

◆ UnexpectedChange

Enumerator
UC_parents 
UC_children 
UC_transform 
UC_state 
UC_draw_mask 

Member Function Documentation

◆ __copy__()

PandaNode __copy__ ( )

◆ __deepcopy__()

object __deepcopy__ ( object  memo)

◆ __init__()

__init__ ( str  name)

◆ __traverse__()

int __traverse__ ( Visitproc  visit,
void  arg 
)

◆ addChild()

addChild ( PandaNode  child_node,
int  sort,
Thread  current_thread 
)

Adds a new child to the node.

The child is added in the relative position indicated by sort; if all children have the same sort index, the child is added at the end.

If the same child is added to a node more than once, the previous instance is first removed.

◆ addStashed()

addStashed ( PandaNode  child_node,
int  sort,
Thread  current_thread 
)

Adds a new child to the node, directly as a stashed child.

The child is not added in the normal sense, but will be revealed if unstash_child() is called on it later.

If the same child is added to a node more than once, the previous instance is first removed.

This can only be called from the top pipeline stage (i.e. from App).

◆ adjustDrawMask()

adjustDrawMask ( DrawMask  show_mask,
DrawMask  hide_mask,
DrawMask  clear_mask 
)

Adjusts the hide/show bits of this particular node.

These three parameters can be used to adjust the _draw_control_mask and _draw_show_mask independently, which work together to provide per-camera visibility for the node and its descendents.

_draw_control_mask indicates the bits in _draw_show_mask that are significant. Each different bit corresponds to a different camera (and these bits are assigned via Camera::set_camera_mask()).

Where _draw_control_mask has a 1 bit, a 1 bit in _draw_show_mask indicates the node is visible to that camera, and a 0 bit indicates the node is hidden to that camera. Where _draw_control_mask is 0, the node is hidden only if a parent node is hidden.

The meaning of the three parameters is as follows:

  • Wherever show_mask is 1, _draw_show_mask and _draw_control_mask will be set 1. Thus, show_mask indicates the set of cameras to which the node should be shown.
  • Wherever hide_mask is 1, _draw_show_mask will be set 0 and _draw_control_mask will be set 1. Thus, hide_mask indicates the set of cameras from which the node should be hidden.
  • Wherever clear_mask is 1, _draw_control_mask will be set 0. Thus, clear_mask indicates the set of cameras from which the hidden state should be inherited from a parent.

◆ asLight()

Light asLight ( )

Cross-casts the node to a Light pointer, if it is one of the four kinds of Light nodes, or returns NULL if it is not.

◆ clearAttrib() [1/2]

clearAttrib ( TypeHandle  type)

Removes the render attribute of the given type from this node.

This node, and the subgraph below, will now inherit the indicated render attribute from the nodes above this one.

◆ clearAttrib() [2/2]

clearAttrib ( int  slot)

Removes the render attribute of the given type from this node.

This node, and the subgraph below, will now inherit the indicated render attribute from the nodes above this one.

◆ clearBounds()

clearBounds ( )

Reverses the effect of a previous call to set_bounds(), and allows the node's bounding volume to be automatically computed once more based on the contents of the node.

◆ clearEffect()

clearEffect ( TypeHandle  type)

Removes the render effect of the given type from this node.

◆ clearEffects()

clearEffects ( Thread  current_thread)

Resets this node to have no render effects.

◆ clearPythonTag()

clearPythonTag ( object  key)

◆ clearState()

clearState ( Thread  current_thread)

Resets this node to leave the render state alone.

Nodes at this level and below will once again inherit their render state unchanged from the nodes above this level.

◆ clearTag()

clearTag ( str  key,
Thread  current_thread 
)

Removes the value defined for this key on this particular node.

After a call to clear_tag(), has_tag() will return false for the indicated key.

◆ clearTransform()

clearTransform ( Thread  current_thread)

Resets the transform on this node to the identity transform.

◆ clearUnexpectedChange()

clearUnexpectedChange ( unsigned int  flags)

Sets one or more of the PandaNode::UnexpectedChange bits off, indicating that the corresponding property may once again change on this node.

See set_unexpected_change().

The input parameter is the union of bits that are to be cleared.

Since this is a developer debugging tool only, this function does nothing in a production (NDEBUG) build.

◆ combineWith()

PandaNode combineWith ( PandaNode  other)

Collapses this PandaNode with the other PandaNode, if possible, and returns a pointer to the combined PandaNode, or NULL if the two PandaNodes cannot safely be combined.

The return value may be this, other, or a new PandaNode altogether.

This function is called from GraphReducer::flatten(), and need not deal with children; its job is just to decide whether to collapse the two PandaNodes and what the collapsed PandaNode should look like.

◆ compareTags()

int compareTags ( const PandaNode  other)

Returns a number less than 0, 0, or greater than 0, to indicate the similarity of tags between this node and the other one.

If this returns 0, the tags are identical. If it returns other than 0, then the tags are different; and the nodes may be sorted into a consistent (but arbitrary) ordering based on this number.

◆ copyAllProperties()

copyAllProperties ( PandaNode  other)

Copies the TransformState, RenderState, RenderEffects, tags, Python tags, and the show/hide state from the other node onto this one.

Typically this is used to prepare a node to replace another node in the scene graph (also see replace_node()).

◆ copyChildren()

copyChildren ( PandaNode  other,
Thread  current_thread 
)

Makes another instance of all the children of the other node, copying them to this node.

◆ copySubgraph()

PandaNode copySubgraph ( Thread  current_thread)

Allocates and returns a complete copy of this PandaNode and the entire scene graph rooted at this PandaNode.

Some data may still be shared from the original (e.g. vertex index tables), but nothing that will impede normal use of the PandaNode.

◆ copyTags()

copyTags ( PandaNode  other)

Copies all of the tags stored on the other node onto this node.

If a particular tag exists on both nodes, the contents of this node's value is replaced by that of the other.

◆ countNumDescendants()

int countNumDescendants ( )

Returns the number of nodes at and below this level.

◆ decodeFromBamStream()

static PandaNode decodeFromBamStream ( VectorUchar  data,
BamReader  reader 
)
static

Reads the bytes created by a previous call to encode_to_bam_stream(), and extracts and returns the single object on those bytes.

Returns NULL on error.

This method is intended to replace decode_raw_from_bam_stream() when you know the stream in question returns an object of type PandaNode, allowing for easier reference count management. Note that the caller is still responsible for maintaining the reference count on the return value.

◆ findChild()

int findChild ( PandaNode  node,
Thread  current_thread 
)

Returns the index of the indicated child node, if it is a child, or -1 if it is not.

◆ findParent()

int findParent ( PandaNode  node,
Thread  current_thread 
)

Returns the index of the indicated parent node, if it is a parent, or -1 if it is not.

◆ findStashed()

int findStashed ( PandaNode  node,
Thread  current_thread 
)

Returns the index of the indicated stashed node, if it is a stashed child, or -1 if it is not.

◆ getAllCameraMask()

static DrawMask getAllCameraMask ( )
static

Returns a DrawMask that is appropriate for rendering to all cameras.

◆ getAttrib() [1/2]

const RenderAttrib getAttrib ( TypeHandle  type)

Returns the render attribute of the indicated type, if it is defined on the node, or NULL if it is not.

This checks only what is set on this particular node level, and has nothing to do with what render attributes may be inherited from parent nodes.

◆ getAttrib() [2/2]

const RenderAttrib getAttrib ( int  slot)

Returns the render attribute of the indicated type, if it is defined on the node, or NULL if it is not.

This checks only what is set on this particular node level, and has nothing to do with what render attributes may be inherited from parent nodes.

◆ getBounds() [1/2]

const BoundingVolume getBounds ( Thread  current_thread)

Returns the external bounding volume of this node: a bounding volume that contains the user bounding volume, the internal bounding volume, and all of the children's bounding volumes.

◆ getBounds() [2/2]

const BoundingVolume getBounds ( UpdateSeq  seq,
Thread  current_thread 
)

This flavor of get_bounds() return the external bounding volume, and also fills in seq with the bounding volume's current sequence number.

When this sequence number changes, it indicates that the bounding volume might have changed, e.g. because some nested child's bounding volume has changed.

Although this might occasionally increment without changing the bounding volume, the bounding volume will never change without incrementing this counter, so as long as this counter remains unchanged you can be confident the bounding volume is also unchanged.

◆ getBoundsType()

BoundingVolume::BoundsType getBoundsType ( )

Returns the bounding volume type set with set_bounds_type().

◆ getChild()

PandaNode getChild ( int  n,
Thread  current_thread 
)

Returns the nth child node of this node.

See get_num_children(). Also see get_children(), if your intention is to iterate through the complete list of children; get_children() is preferable in this case.

◆ getChildren()

list getChildren ( )

◆ getChildSort()

int getChildSort ( int  n,
Thread  current_thread 
)

Returns the sort index of the nth child node of this node (that is, the number that was passed to add_child()).

See get_num_children().

◆ getClassType()

static TypeHandle getClassType ( )
static

◆ getDrawControlMask()

DrawMask getDrawControlMask ( )

Returns the set of bits in draw_show_mask that are considered meaningful.

See adjust_draw_mask().

◆ getDrawShowMask()

DrawMask getDrawShowMask ( )

Returns the hide/show bits of this particular node.

See adjust_draw_mask().

◆ getEffect()

const RenderEffect getEffect ( TypeHandle  type)

Returns the render effect of the indicated type, if it is defined on the node, or NULL if it is not.

◆ getEffects()

const RenderEffects getEffects ( Thread  current_thread)

Returns the complete RenderEffects that will be applied to this node.

◆ getFancyBits()

int getFancyBits ( Thread  current_thread)

Returns the union of all of the enum FancyBits values corresponding to the various "fancy" attributes that are set on the node.

If this returns 0, the node has nothing interesting about it. This is intended to speed traversal by quickly skipping past nodes that don't particularly affect the render state.

◆ getInternalBounds()

const BoundingVolume getInternalBounds ( Thread  current_thread)

Returns the node's internal bounding volume.

This is the bounding volume around the node alone, without including children. If the user has called set_bounds(), it will be the specified bounding volume.

◆ getInternalVertices()

int getInternalVertices ( Thread  current_thread)

Returns the total number of vertices that will be rendered by this particular node alone, not accounting for its children.

This may not include all vertices for certain dynamic effects.

◆ getIntoCollideMask()

CollideMask getIntoCollideMask ( )

Returns the "into" collide mask for this node.

◆ getLegalCollideMask()

CollideMask getLegalCollideMask ( )

Returns the subset of CollideMask bits that may be set for this particular type of PandaNode.

For most nodes, this is 0; it doesn't make sense to set a CollideMask for most kinds of nodes.

For nodes that can be collided with, such as GeomNode and CollisionNode, this returns all bits on.

◆ getNestedVertices()

int getNestedVertices ( Thread  current_thread)

Returns the total number of vertices that will be rendered by this node and all of its descendents.

This is not necessarily an accurate count of vertices that will actually be rendered, since this will include all vertices of all LOD's, and it will also include hidden nodes. It may also omit or only approximate certain kinds of dynamic geometry. However, it will not include stashed nodes.

◆ getNetCollideMask()

CollideMask getNetCollideMask ( Thread  current_thread)

Returns the union of all into_collide_mask() values set at CollisionNodes at this level and below.

◆ getNetDrawControlMask()

DrawMask getNetDrawControlMask ( )

Returns the set of bits in get_net_draw_show_mask() that have been explicitly set via adjust_draw_mask(), rather than implicitly inherited.

A 1 bit in any position of this mask indicates that (a) this node has renderable children, and (b) some child of this node has made an explicit hide() or show_through() call for the corresponding bit.

◆ getNetDrawShowMask()

DrawMask getNetDrawShowMask ( )

Returns the union of all draw_show_mask values–of renderable nodes only– at this level and below.

If any bit in this mask is 0, there is no reason to traverse below this node for a camera with the corresponding camera_mask.

The bits in this mask that do not correspond to a 1 bit in the net_draw_control_mask are meaningless (and will be set to 1). For bits that do correspond to a 1 bit in the net_draw_control_mask, a 1 bit indicates that at least one child should be visible, while a 0 bit indicates that all children are hidden.

◆ getNumChildren()

int getNumChildren ( Thread  current_thread)

Returns the number of child nodes this node has.

The order of the child nodes is meaningful and is based on the sort number that was passed to add_child(), and also on the order in which the nodes were added.

◆ getNumParents()

int getNumParents ( Thread  current_thread)

Returns the number of parent nodes this node has.

If this number is greater than 1, the node has been multiply instanced. The order of the parent nodes is not meaningful and is not related to the order in which the node was instanced to them.

◆ getNumStashed()

int getNumStashed ( Thread  current_thread)

Returns the number of stashed nodes this node has.

These are former children of the node that have been moved to the special stashed list via stash_child().

◆ getOffClipPlanes()

const RenderAttrib getOffClipPlanes ( Thread  current_thread)

Returns a ClipPlaneAttrib which represents the union of all of the clip planes that have been turned off at this level and below.

◆ getOverallBit()

static DrawMask getOverallBit ( )
static

Returns the special bit that, when specifically cleared in the node's DrawMask, indicates that the node is hidden to all cameras, regardless of the remaining DrawMask bits.

◆ getParent()

PandaNode getParent ( int  n,
Thread  current_thread 
)

Returns the nth parent node of this node.

See get_num_parents(). Also see get_parents(), if your intention is to iterate through the complete list of parents; get_parents() is preferable in this case.

◆ getParents()

list getParents ( )

◆ getPrevTransform()

const TransformState getPrevTransform ( Thread  current_thread)

Returns the transform that has been set as this node's "previous" position.

See set_prev_transform().

◆ getPythonTag()

object getPythonTag ( object  key)

◆ getPythonTagKeys()

object getPythonTagKeys ( )

◆ getPythonTags()

object getPythonTags ( )

◆ getStashed() [1/3]

PandaNode::Stashed getStashed ( Thread  current_thread)

Returns an object that can be used to walk through the list of children of the node.

When you intend to visit multiple children, using this is slightly faster than calling get_stashed() directly on the PandaNode, since this object avoids reopening the PipelineCycler each time.

This object also protects you from self-modifying loops (e.g. adding or removing children during traversal), since a virtual copy of the children is made ahead of time. The virtual copy is fast–it is a form of copy-on- write, so the list is not actually copied unless it is modified during the traversal.

◆ getStashed() [2/3]

PandaNode getStashed ( int  n,
Thread  current_thread 
)

Returns the nth stashed child of this node.

See get_num_stashed(). Also see get_stashed(), if your intention is to iterate through the complete list of stashed children; get_stashed() is preferable in this case.

◆ getStashed() [3/3]

list getStashed ( )

◆ getStashedSort()

int getStashedSort ( int  n,
Thread  current_thread 
)

Returns the sort index of the nth stashed node of this node (that is, the number that was passed to add_child()).

See get_num_stashed().

◆ getState()

const RenderState getState ( Thread  current_thread)

Returns the complete RenderState that will be applied to all nodes at this level and below, as set on this node.

This returns only the RenderState set on this particular node, and has nothing to do with state that might be inherited from above.

◆ getTag()

str getTag ( str  key,
Thread  current_thread 
)

Retrieves the user-defined value that was previously set on this node for the particular key, if any.

If no value has been previously set, returns the empty string.

◆ getTagKeys()

object getTagKeys ( )

◆ getTransform()

const TransformState getTransform ( Thread  current_thread)

Returns the transform that has been set on this particular node.

This is not the net transform from the root, but simply the transform on this particular node.

◆ getUnexpectedChange()

unsigned int getUnexpectedChange ( unsigned int  flags)

Returns nonzero if any of the bits in the input parameter are set on this node, or zero if none of them are set.

More specifically, this returns the particular set of bits (masked by the input parameter) that have been set on this node. See set_unexpected_change().

Since this is a developer debugging tool only, this function always returns zero in a production (NDEBUG) build.

◆ hasAttrib() [1/2]

bool hasAttrib ( TypeHandle  type)

Returns true if there is a render attribute of the indicated type defined on this node, or false if there is not.

◆ hasAttrib() [2/2]

bool hasAttrib ( int  slot)

Returns true if there is a render attribute of the indicated type defined on this node, or false if there is not.

◆ hasDirtyPrevTransform()

bool hasDirtyPrevTransform ( )

Returns true if this node has the _dirty_prev_transform flag set, which indicates its _prev_transform is different from its _transform value (in pipeline stage 0).

In this case, the node will be visited by reset_prev_transform().

◆ hasEffect()

bool hasEffect ( TypeHandle  type)

Returns true if there is a render effect of the indicated type defined on this node, or false if there is not.

◆ hasPythonTag()

bool hasPythonTag ( object  key)

◆ hasTag()

bool hasTag ( str  key,
Thread  current_thread 
)

Returns true if a value has been defined on this node for the particular key (even if that value is the empty string), or false if no value has been set.

◆ hasTags()

bool hasTags ( )

Returns true if the node has any tags (or any Python tags) at all, false if it has none.

◆ isAmbientLight()

bool isAmbientLight ( )

Returns true if this is an AmbientLight, false if it is not a light, or it is some other kind of light.

◆ isBoundsStale()

bool isBoundsStale ( )

Returns true if the bounding volume of this node is stale and will be implicitly recomputed at the next call to get_bounds(), or false if it is fresh and need not be recomputed.

◆ isCollisionNode()

bool isCollisionNode ( )

A simple downcast check.

Returns true if this kind of node happens to inherit from CollisionNode, false otherwise.

This is provided as a a faster alternative to calling is_of_type(CollisionNode::get_class_type()).

◆ isFinal()

bool isFinal ( Thread  current_thread)

Returns the current state of the "final" flag.

Initially, this flag is off (false), but it may be changed by an explicit call to set_final(). See set_final().

◆ isGeomNode()

bool isGeomNode ( )

A simple downcast check.

Returns true if this kind of node happens to inherit from GeomNode, false otherwise.

This is provided as a a faster alternative to calling is_of_type(GeomNode::get_class_type()), since this test is so important to rendering.

◆ isLodNode()

bool isLodNode ( )

A simple downcast check.

Returns true if this kind of node happens to inherit from LODNode, false otherwise.

This is provided as a a faster alternative to calling is_of_type(LODNode::get_class_type()).

◆ isOverallHidden()

bool isOverallHidden ( )

Returns true if the node has been hidden to all cameras by clearing its overall bit.

◆ isSceneRoot()

bool isSceneRoot ( )

Returns true if this particular node is known to be the render root of some active DisplayRegion associated with the global GraphicsEngine, false otherwise.

◆ isUnderSceneRoot()

bool isUnderSceneRoot ( )

Returns true if this particular node is in a live scene graph: that is, it is a child or descendent of a node that is itself a scene root.

If this is true, this node may potentially be traversed by the render traverser. Stashed nodes don't count for this purpose, but hidden nodes do.

◆ listTags()

listTags ( Ostream  out,
str  separator 
)

Writes a list of all the tag keys assigned to the node to the indicated stream.

Writes one instance of the separator following each key (but does not write a terminal separator). The value associated with each key is not written.

This is mainly for the benefit of the realtime user, to see the list of all of the associated tag keys.

◆ ls()

ls ( Ostream  out,
int  indent_level 
)

Lists all the nodes at and below the current path hierarchically.

◆ makeCopy()

PandaNode makeCopy ( )

Returns a newly-allocated PandaNode that is a shallow copy of this one.

It will be a different pointer, but its internal data may or may not be shared with that of the original PandaNode. No children will be copied.

◆ markBoundsStale()

markBoundsStale ( Thread  current_thread)

Indicates that the bounding volume, or something that influences the bounding volume (or any of the other things stored in CData, like net_collide_mask), may have changed for this node, and that it must be recomputed.

With no parameters, this means to iterate through all stages including and upstream of the current pipeline stage.

This method is intended for internal use; usually it is not necessary for a user to call this directly. It will be called automatically by derived classes when appropriate.

◆ markInternalBoundsStale()

markInternalBoundsStale ( Thread  current_thread)

Should be called by a derived class to mark the internal bounding volume stale, so that compute_internal_bounds() will be called when the bounding volume is next requested.

With no parameters, this means to iterate through all stages including and upstream of the current pipeline stage.

It is normally not necessary to call this method directly; each node should be responsible for calling it when its internals have changed.

◆ output()

output ( Ostream  out)

◆ prepareScene()

prepareScene ( GraphicsStateGuardianBase  gsg,
const RenderState  node_state 
)

Walks through the scene graph beginning at this node, and does whatever initialization is required to render the scene properly with the indicated GSG.

It is not strictly necessary to call this, since the GSG will initialize itself when the scene is rendered, but this may take some of the overhead away from that process.

In particular, this will ensure that textures and vertex buffers within the scene are loaded into graphics memory.

◆ removeAllChildren()

removeAllChildren ( Thread  current_thread)

Removes all the children from the node at once, including stashed children.

This can only be called from the top pipeline stage (i.e. from App).

◆ removeChild() [1/2]

bool removeChild ( PandaNode  child_node,
Thread  current_thread 
)

Removes the indicated child from the node.

Returns true if the child was removed, false if it was not already a child of the node. This will also successfully remove the child if it had been stashed.

◆ removeChild() [2/2]

removeChild ( int  child_index,
Thread  current_thread 
)

Removes the nth child from the node.

◆ removeStashed()

removeStashed ( int  child_index,
Thread  current_thread 
)

Removes the nth stashed child from the node.

◆ replaceChild()

bool replaceChild ( PandaNode  orig_child,
PandaNode  new_child,
Thread  current_thread 
)

Searches for the orig_child node in the node's list of children, and replaces it with the new_child instead.

Returns true if the replacement is made, or false if the node is not a child or if there is some other problem.

◆ replaceNode()

replaceNode ( PandaNode  other)

Inserts this node into the scene graph in place of the other one, and removes the other node.

All scene graph attributes (TransformState, RenderState, etc.) are copied to this node.

All children are moved to this node, and removed from the old node. The new node is left in the same place in the old node's parent's list of children.

Even NodePaths that reference the old node are updated in-place to reference the new node instead.

This method is intended to be used to replace a node of a given type in the scene graph with a node of a different type.

◆ resetAllPrevTransform()

static resetAllPrevTransform ( Thread  current_thread)
static

Visits all nodes in the world with the _dirty_prev_transform flag–that is, all nodes whose _prev_transform is different from the _transform in pipeline stage 0–and resets the _prev_transform to be the same as _transform.

◆ resetPrevTransform()

resetPrevTransform ( Thread  current_thread)

Resets the transform that represents this node's "previous" position to the same as the current transform.

This is not the same thing as clearing it to identity.

◆ setAttrib()

setAttrib ( const RenderAttrib  attrib,
int  override 
)

Adds the indicated render attribute to the scene graph on this node.

This attribute will now apply to this node and everything below. If there was already an attribute of the same type, it is replaced.

◆ setBound()

setBound ( const BoundingVolume  volume)

Deprecated.

Use set_bounds() instead.

◆ setBounds()

setBounds ( const BoundingVolume  volume)

Resets the bounding volume so that it is the indicated volume.

When it is explicitly set, the bounding volume will no longer be automatically computed according to the contents of the node itself, for nodes like GeomNodes and TextNodes that contain substance (but the bounding volume will still be automatically expanded to include its children).

Call clear_bounds() if you would like to return the bounding volume to its default behavior later.

◆ setBoundsType()

setBoundsType ( BoundingVolume::BoundsType  bounds_type)

Specifies the desired type of bounding volume that will be created for this node.

This is normally BoundingVolume::BT_default, which means to set the type according to the config variable "bounds-type".

If this is BT_sphere or BT_box, a BoundingSphere or BoundingBox is explicitly created. If it is BT_best, the appropriate type to best enclose the node's children is created.

This affects the bounding volume returned by get_bounds(), which is not exactly the same bounding volume modified by set_bounds(), because a new bounding volume has to be created that includes this node and all of its children.

◆ setEffect()

setEffect ( const RenderEffect  effect)

Adds the indicated render effect to the scene graph on this node.

If there was already an effect of the same type, it is replaced.

◆ setEffects()

setEffects ( const RenderEffects  effects,
Thread  current_thread 
)

Sets the complete RenderEffects that will be applied this node.

This completely replaces whatever has been set on this node via repeated calls to set_attrib().

◆ setFinal()

setFinal ( bool  flag)

Sets the "final" flag on this PandaNode.

If this is true, than no bounding volume need be tested below it; a positive intersection with this node's bounding volume is deemed to be a positive intersection with all geometry inside.

This is useful to quickly force a larger bounding volume around a node when the GeomNodes themselves are inaccurate for some reason, without forcing a recompute of every nested bounding volume. It's also helpful when the bounding volume is tricked by some special properties, like billboards, that may move geometry out of its bounding volume otherwise.

◆ setIntoCollideMask()

setIntoCollideMask ( CollideMask  mask)

Sets the "into" CollideMask.

This specifies the set of bits that must be shared with a CollisionNode's "from" CollideMask in order for the CollisionNode to detect a collision with this particular node.

The actual CollideMask that will be set is masked by the return value from get_legal_collide_mask(). Thus, the into_collide_mask cannot be set to anything other than nonzero except for those types of nodes that can be collided into, such as CollisionNodes and GeomNodes.

◆ setOverallHidden()

setOverallHidden ( bool  overall_hidden)

Sets or clears the hidden flag.

When the hidden flag is true, the node and all of its children are invisible to all cameras, regardless of the setting of any draw masks. Setting the hidden flag to false restores the previous visibility as established by the draw masks.

This actually works by twiddling the reserved _overall_bit in the node's draw mask, which has special meaning.

◆ setPrevTransform()

setPrevTransform ( const TransformState  transform,
Thread  current_thread 
)

Sets the transform that represents this node's "previous" position, one frame ago, for the purposes of detecting motion for accurate collision calculations.

◆ setPythonTag()

setPythonTag ( object  key,
object  value 
)

◆ setState()

setState ( const RenderState  state,
Thread  current_thread 
)

Sets the complete RenderState that will be applied to all nodes at this level and below.

(The actual state that will be applied to lower nodes is based on the composition of RenderStates from above this node as well). This completely replaces whatever has been set on this node via repeated calls to set_attrib().

◆ setTag()

setTag ( str  key,
str  value,
Thread  current_thread 
)

Associates a user-defined value with a user-defined key which is stored on the node.

This value has no meaning to Panda; but it is stored indefinitely on the node until it is requested again.

Each unique key stores a different string value. There is no effective limit on the number of different keys that may be stored or on the length of any one key's value.

◆ setTransform()

setTransform ( const TransformState  transform,
Thread  current_thread 
)

Sets the transform that will be applied to this node and below.

This defines a new coordinate space at this point in the scene graph and below.

◆ setUnexpectedChange()

setUnexpectedChange ( unsigned int  flags)

Sets one or more of the PandaNode::UnexpectedChange bits on, indicating that the corresponding property should not change again on this node.

Once one of these bits has been set, if the property changes, an assertion failure will be raised, which is designed to assist the developer in identifying the troublesome code that modified the property unexpectedly.

The input parameter is the union of bits that are to be set. To clear these bits later, use clear_unexpected_change().

Since this is a developer debugging tool only, this function does nothing in a production (NDEBUG) build.

◆ stashChild() [1/2]

bool stashChild ( PandaNode  child_node,
Thread  current_thread 
)

Stashes the indicated child node.

This removes the child from the list of active children and puts it on a special list of stashed children. This child node no longer contributes to the bounding volume of the PandaNode, and is not visited in normal traversals. It is invisible and uncollidable. The child may later be restored by calling unstash_child().

This function returns true if the child node was successfully stashed, or false if it was not a child of the node in the first place (e.g. it was previously stashed).

◆ stashChild() [2/2]

stashChild ( int  child_index,
Thread  current_thread 
)

Stashes the indicated child node.

This removes the child from the list of active children and puts it on a special list of stashed children. This child node no longer contributes to the bounding volume of the PandaNode, and is not visited in normal traversals. It is invisible and uncollidable. The child may later be restored by calling unstash_child().

This can only be called from the top pipeline stage (i.e. from App).

◆ stealChildren()

stealChildren ( PandaNode  other,
Thread  current_thread 
)

Moves all the children from the other node onto this node.

Any NodePaths to child nodes of the other node are truncated, rather than moved to the new parent.

◆ unstashChild() [1/2]

bool unstashChild ( PandaNode  child_node,
Thread  current_thread 
)

Returns the indicated stashed node to normal child status.

This removes the child from the list of stashed children and puts it on the normal list of active children. This child node once again contributes to the bounding volume of the PandaNode, and will be visited in normal traversals. It is visible and collidable.

This function returns true if the child node was successfully stashed, or false if it was not a child of the node in the first place (e.g. it was previously stashed).

◆ unstashChild() [2/2]

unstashChild ( int  stashed_index,
Thread  current_thread 
)

Returns the indicated stashed node to normal child status.

This removes the child from the list of stashed children and puts it on the normal list of active children. This child node once again contributes to the bounding volume of the PandaNode, and will be visited in normal traversals. It is visible and collidable.

This can only be called from the top pipeline stage (i.e. from App).

◆ write()

write ( Ostream  out,
int  indent_level 
)

Member Data Documentation

◆ all_camera_mask

DrawMask all_camera_mask

Returns a DrawMask that is appropriate for rendering to all cameras.

◆ bounds_stale

bool bounds_stale

Returns true if the bounding volume of this node is stale and will be implicitly recomputed at the next call to get_bounds(), or false if it is fresh and need not be recomputed.

◆ bounds_type

Returns the bounding volume type set with set_bounds_type().

◆ children

Returns an object that can be used to walk through the list of children of the node.

When you intend to visit multiple children, using this is slightly faster than calling get_child() directly on the PandaNode, since this object avoids reopening the PipelineCycler each time.

This object also protects you from self-modifying loops (e.g. adding or removing children during traversal), since a virtual copy of the children is made ahead of time. The virtual copy is fast–it is a form of copy-on- write, so the list is not actually copied unless it is modified during the traversal.

◆ draw_control_mask

DrawMask draw_control_mask

Returns the set of bits in draw_show_mask that are considered meaningful.

See adjust_draw_mask().

◆ draw_show_mask

DrawMask draw_show_mask

Returns the hide/show bits of this particular node.

See adjust_draw_mask().

◆ effects

ConstPointerToRenderEffects effects

Returns the complete RenderEffects that will be applied to this node.

◆ final

bool final

Returns the current state of the "final" flag.

Initially, this flag is off (false), but it may be changed by an explicit call to set_final(). See set_final().

◆ internal_bounds

ConstPointerToBoundingVolume internal_bounds

Returns the node's internal bounding volume.

This is the bounding volume around the node alone, without including children. If the user has called set_bounds(), it will be the specified bounding volume.Returns the node's internal bounding volume. This is the bounding volume around the node alone, without including children.

◆ internal_vertices

int internal_vertices

Returns the total number of vertices that will be rendered by this particular node alone, not accounting for its children.

This may not include all vertices for certain dynamic effects.Returns the total number of vertices that will be rendered by this particular node alone, not accounting for its children.

This may not include all vertices for certain dynamic effects.

◆ into_collide_mask

CollideMask into_collide_mask

Returns the "into" collide mask for this node.

◆ legal_collide_mask

CollideMask legal_collide_mask

Returns the subset of CollideMask bits that may be set for this particular type of PandaNode.

For most nodes, this is 0; it doesn't make sense to set a CollideMask for most kinds of nodes.

For nodes that can be collided with, such as GeomNode and CollisionNode, this returns all bits on.

◆ nested_vertices

int nested_vertices

Returns the total number of vertices that will be rendered by this node and all of its descendents.

This is not necessarily an accurate count of vertices that will actually be rendered, since this will include all vertices of all LOD's, and it will also include hidden nodes. It may also omit or only approximate certain kinds of dynamic geometry. However, it will not include stashed nodes.

◆ overall_bit

DrawMask overall_bit

Returns the special bit that, when specifically cleared in the node's DrawMask, indicates that the node is hidden to all cameras, regardless of the remaining DrawMask bits.

◆ overall_hidden

bool overall_hidden

Returns true if the node has been hidden to all cameras by clearing its overall bit.

◆ parents

Returns an object that can be used to walk through the list of parents of the node, similar to get_children() and get_stashed().

◆ prev_transform

ConstPointerToTransformState prev_transform

Returns the transform that has been set as this node's "previous" position.

See set_prev_transform().

◆ python_tags

object python_tags

◆ stashed

Returns the nth stashed child of this node.

See get_num_stashed(). Also see get_stashed(), if your intention is to iterate through the complete list of stashed children; get_stashed() is preferable in this case.Returns an object that can be used to walk through the list of children of the node. When you intend to visit multiple children, using this is slightly faster than calling get_stashed() directly on the PandaNode, since this object avoids reopening the PipelineCycler each time.

This object also protects you from self-modifying loops (e.g. adding or removing children during traversal), since a virtual copy of the children is made ahead of time. The virtual copy is fast–it is a form of copy-on- write, so the list is not actually copied unless it is modified during the traversal.

◆ state

ConstPointerToRenderState state

Returns the complete RenderState that will be applied to all nodes at this level and below, as set on this node.

This returns only the RenderState set on this particular node, and has nothing to do with state that might be inherited from above.

◆ tags

String tags[]

◆ transform

ConstPointerToTransformState transform

Returns the transform that has been set on this particular node.

This is not the net transform from the root, but simply the transform on this particular node.