panda3d.core.PandaNode

class PandaNode

Bases: TypedWritableReferenceCount, Namable, LinkedListNode

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.

Inheritance diagram

__init__(name: str) → None

combineWith(other: PandaNode) → PandaNode

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.

Return type

PandaNode

makeCopy() → PandaNode

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.

Return type

PandaNode

copySubgraph(current_thread: Thread) → PandaNode

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.

Return type

PandaNode

getNumParents(current_thread: Thread) → int

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.

getParent(n: int, current_thread: Thread) → PandaNode

Returns the nth parent node of this node. See getNumParents(). Also see getParents(), if your intention is to iterate through the complete list of parents; getParents() is preferable in this case.

Return type

PandaNode

findParent(node: PandaNode, current_thread: Thread) → int

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

getNumChildren(current_thread: Thread) → int

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 addChild(), and also on the order in which the nodes were added.

getChild(n: int, current_thread: Thread) → PandaNode

Returns the nth child node of this node. See getNumChildren(). Also see getChildren(), if your intention is to iterate through the complete list of children; getChildren() is preferable in this case.

Return type

PandaNode

getChildSort(n: int, current_thread: Thread) → int

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

findChild(node: PandaNode, current_thread: Thread) → int

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

countNumDescendants() → int

Returns the number of nodes at and below this level.

addChild(child_node: PandaNode, sort: int, current_thread: Thread) → None

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.

removeChild(child_node: PandaNode, current_thread: Thread) → bool

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(child_index: int, current_thread: Thread) → None

Removes the nth child from the node.

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

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.

stashChild(child_node: PandaNode, current_thread: Thread) → bool

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

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(child_index: int, current_thread: Thread) → None

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

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

unstashChild(child_node: PandaNode, current_thread: Thread) → bool

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(stashed_index: int, current_thread: Thread) → None

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

getNumStashed(current_thread: Thread) → int

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

getStashed(current_thread: Thread) → Stashed

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

Return type

Stashed

getStashed(n: int, current_thread: Thread) → PandaNode

Returns the nth stashed child of this node. See getNumStashed(). Also see getStashed(), if your intention is to iterate through the complete list of stashed children; getStashed() is preferable in this case.

Return type

PandaNode

getStashedSort(n: int, current_thread: Thread) → int

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

findStashed(node: PandaNode, current_thread: Thread) → int

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

addStashed(child_node: PandaNode, sort: int, current_thread: Thread) → None

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

removeStashed(child_index: int, current_thread: Thread) → None

Removes the nth stashed child from the node.

removeAllChildren(current_thread: Thread) → None

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

stealChildren(other: PandaNode, current_thread: Thread) → None

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.

copyChildren(other: PandaNode, current_thread: Thread) → None

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

setAttrib(attrib: RenderAttrib, override: int) → None

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.

getAttrib(type: TypeHandle) → RenderAttrib

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.

Return type

RenderAttrib

getAttrib(slot: int) → RenderAttrib

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.

Return type

RenderAttrib

hasAttrib(type: TypeHandle) → bool

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

hasAttrib(slot: int) → bool

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

clearAttrib(type: TypeHandle) → None

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(slot: int) → None

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.

setEffect(effect: RenderEffect) → None

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.

getEffect(type: TypeHandle) → RenderEffect

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

Return type

RenderEffect

hasEffect(type: TypeHandle) → bool

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

clearEffect(type: TypeHandle) → None

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

setState(state: RenderState, current_thread: Thread) → None

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

getState(current_thread: Thread) → RenderState

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.

Return type

RenderState

clearState(current_thread: Thread) → None

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.

setEffects(effects: RenderEffects, current_thread: Thread) → None

Sets the complete RenderEffects that will be applied this node. This completely replaces whatever has been set on this node via repeated calls to setAttrib().

getEffects(current_thread: Thread) → RenderEffects

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

Return type

RenderEffects

clearEffects(current_thread: Thread) → None

Resets this node to have no render effects.

setTransform(transform: TransformState, current_thread: Thread) → None

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.

getTransform(current_thread: Thread) → TransformState

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.

Return type

TransformState

clearTransform(current_thread: Thread) → None

Resets the transform on this node to the identity transform.

setPrevTransform(transform: TransformState, current_thread: Thread) → None

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

getPrevTransform(current_thread: Thread) → TransformState

Returns the transform that has been set as this node’s “previous” position. See setPrevTransform().

Return type

TransformState

resetPrevTransform(current_thread: Thread) → None

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.

hasDirtyPrevTransform() → bool

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

static resetAllPrevTransform(current_thread: Thread) → None

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.

setTag(key: str, value: str, current_thread: Thread) → None

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.

getTag(key: str, current_thread: Thread) → str

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.

hasTag(key: str, current_thread: Thread) → bool

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.

clearTag(key: str, current_thread: Thread) → None

Removes the value defined for this key on this particular node. After a call to clearTag(), hasTag() will return false for the indicated key.

getTagKeys() → object

getPythonTags() → object

setPythonTag(key: object, value: object) → None

getPythonTag(key: object) → object

hasPythonTag(key: object) → bool

clearPythonTag(key: object) → None

getPythonTagKeys() → object

hasTags() → bool

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

copyTags(other: PandaNode) → None

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.

listTags(out: ostream, separator: str) → None

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.

compareTags(other: PandaNode) → int

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(other: PandaNode) → None

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

replaceNode(other: PandaNode) → None

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.

setUnexpectedChange(flags: int) → None

Sets one or more of the PandaNodeUnexpectedChange 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 clearUnexpectedChange().

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

getUnexpectedChange(flags: int) → int

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

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

clearUnexpectedChange(flags: int) → None

Sets one or more of the PandaNodeUnexpectedChange bits off, indicating that the corresponding property may once again change on this node. See setUnexpectedChange().

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.

static getOverallBit() → DrawMask

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.

Return type

DrawMask

static getAllCameraMask() → DrawMask

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

Return type

DrawMask

isOverallHidden() → bool

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

setOverallHidden(overall_hidden: bool) → None

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.

adjustDrawMask(show_mask: DrawMask, hide_mask: DrawMask, clear_mask: DrawMask) → None

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

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.

getDrawControlMask() → DrawMask

Returns the set of bits in draw_show_mask that are considered meaningful. See adjustDrawMask().

Return type

DrawMask

getDrawShowMask() → DrawMask

Returns the hide/show bits of this particular node. See adjustDrawMask().

Return type

DrawMask

getNetDrawControlMask() → DrawMask

Returns the set of bits in getNetDrawShowMask() that have been explicitly set via adjustDrawMask(), 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.

Return type

DrawMask

getNetDrawShowMask() → DrawMask

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.

Return type

DrawMask

setIntoCollideMask(mask: CollideMask) → None

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

getIntoCollideMask() → CollideMask

Returns the “into” collide mask for this node.

Return type

CollideMask

getLegalCollideMask() → CollideMask

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.

Return type

CollideMask

getNetCollideMask(current_thread: Thread) → CollideMask

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

Return type

CollideMask

getOffClipPlanes(current_thread: Thread) → RenderAttrib

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

Return type

RenderAttrib

prepareScene(gsg: GraphicsStateGuardianBase, node_state: RenderState) → None

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.

isSceneRoot() → bool

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

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.

output(out: ostream) → None

write(out: ostream, indent_level: int) → None

ls(out: ostream, indent_level: int) → None

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

setBoundsType(bounds_type: BoundsType) → None

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 getBounds(), which is not exactly the same bounding volume modified by setBounds(), because a new bounding volume has to be created that includes this node and all of its children.

getBoundsType() → BoundsType

Returns the bounding volume type set with setBoundsType().

Return type

BoundsType

setBounds(volume: BoundingVolume) → None

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 clearBounds() if you would like to return the bounding volume to its default behavior later.

setBound(volume: BoundingVolume) → None

Deprecated. Use setBounds() instead.

clearBounds() → None

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

getBounds(current_thread: Thread) → BoundingVolume

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.

Return type

BoundingVolume

getBounds(seq: UpdateSeq, current_thread: Thread) → BoundingVolume

This flavor of getBounds() 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.

Return type

BoundingVolume

getNestedVertices(current_thread: Thread) → int

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.

getInternalBounds(current_thread: Thread) → BoundingVolume

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

Return type

BoundingVolume

getInternalVertices(current_thread: Thread) → int

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.

markBoundsStale(current_thread: Thread) → None

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(current_thread: Thread) → None

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.

isBoundsStale() → bool

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

setFinal(flag: bool) → None

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.

isFinal(current_thread: Thread) → bool

Returns the current state of the “final” flag. Initially, this flag is off (false), but it may be changed by an explicit call to setFinal(). See setFinal().

isGeomNode() → bool

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.getClassType()), since this test is so important to rendering.

isLodNode() → bool

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

isCollisionNode() → bool

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

asLight() → Light

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.

Return type

Light

isAmbientLight() → bool

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

getFancyBits(current_thread: Thread) → int

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.

static decodeFromBamStream(data: bytes, reader: BamReader) → PandaNode

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.

Return type

PandaNode

static getClassType() → TypeHandle

Return type

TypeHandle

getParents() → list

getChildren() → list

getStashed() → list

property state

Getter

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.

Setter

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

Return type

ConstPointerTo_RenderState

property effects

Getter

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

Setter

Sets the complete RenderEffects that will be applied this node. This completely replaces whatever has been set on this node via repeated calls to setAttrib().

Return type

ConstPointerTo_RenderEffects

property transform

Getter

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.

Setter

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.

Return type

ConstPointerTo_TransformState

property prev_transform

Returns the transform that has been set as this node’s “previous” position. See setPrevTransform().

Return type

ConstPointerTo_TransformState

property tags

Getter

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.

Setter

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.

Return type

Mapping[string]

property python_tags

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

Return type

DrawMask

property all_camera_mask

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

Return type

DrawMask

property overall_hidden

Getter

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

Setter

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.

Return type

bool

property draw_control_mask

Returns the set of bits in draw_show_mask that are considered meaningful. See adjustDrawMask().

Return type

DrawMask

property draw_show_mask

Returns the hide/show bits of this particular node. See adjustDrawMask().

Return type

DrawMask

property into_collide_mask

Getter

Returns the “into” collide mask for this node.

Setter

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

Return type

CollideMask

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

Return type

CollideMask

property bounds_type

Returns the bounding volume type set with setBoundsType().

Return type

BoundsType

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

Return type

int

property 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 setBounds(), 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.

Return type

ConstPointerTo_BoundingVolume

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

Return type

int

property bounds_stale

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

Return type

bool

property final

Getter

Returns the current state of the “final” flag. Initially, this flag is off (false), but it may be changed by an explicit call to setFinal(). See setFinal().

Setter

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.

Return type

bool

property 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 getChild() 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.

Return type

Children

property stashed

Returns the nth stashed child of this node. See getNumStashed(). Also see getStashed(), if your intention is to iterate through the complete list of stashed children; getStashed() 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 getStashed() 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.

Return type

Stashed

property parents

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

Return type

Parents

enum UnexpectedChange

enumerator UC_parents = 1

enumerator UC_children = 2

enumerator UC_transform = 4

enumerator UC_state = 8

enumerator UC_draw_mask = 16

enum FancyBits

enumerator FB_transform = 1

enumerator FB_state = 2

enumerator FB_effects = 4

enumerator FB_tag = 16

enumerator FB_draw_mask = 32

enumerator FB_cull_callback = 64

class Children

This class is returned from getChildren(). Use it to walk through the list of children. This is faster, and safer, than walking through the children one at a time via getNumChildren()/getChild(), since the list of children is saved out ahead of time, rather than having to reacquire the lock with each iteration, or to keep the lock held for the entire pass.

size() → size_t

Return type

size_t

class Stashed

Similarly for stashed children.

size() → size_t

Return type

size_t

class Parents

This class is returned from getParents().

size() → size_t

Return type

size_t