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

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

#include "pandaNode.h"

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

Classes

class  Children
 
class  DownConnection
 
class  Parents
 
class  Stashed
 

Public Types

enum  FancyBits {
  FB_transform = 0x0001, FB_state = 0x0002, FB_effects = 0x0004, FB_tag = 0x0010,
  FB_draw_mask = 0x0020, FB_cull_callback = 0x0040
}
 
typedef bool SceneRootFunc(const PandaNode *)
 
enum  UnexpectedChange {
  UC_parents = 0x001, UC_children = 0x002, UC_transform = 0x004, UC_state = 0x008,
  UC_draw_mask = 0x010
}
 

Public Member Functions

 PandaNode (const string &name)
 
void add_child (PandaNode *child_node, int sort=0, Thread *current_thread=Thread::get_current_thread())
 
virtual void add_for_draw (CullTraverser *trav, CullTraverserData &data)
 Adds the node's contents to the CullResult we are building up during the cull traversal, so that it will be drawn at render time. More...
 
void add_stashed (PandaNode *child_node, int sort=0, Thread *current_thread=Thread::get_current_thread())
 Adds a new child to the node, directly as a stashed child. More...
 
void adjust_draw_mask (DrawMask show_mask, DrawMask hide_mask, DrawMask clear_mask)
 Adjusts the hide/show bits of this particular node. More...
 
virtual void apply_attribs_to_vertices (const AccumulatedAttribs &attribs, int attrib_types, GeomTransformer &transformer)
 Applies whatever attributes are specified in the AccumulatedAttribs object (and by the attrib_types bitmask) to the vertices on this node, if appropriate. More...
 
virtual Lightas_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. More...
 
void clear_attrib (TypeHandle type)
 
void clear_attrib (int slot)
 Removes the render attribute of the given type from this node. More...
 
void clear_bounds ()
 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...
 
void clear_effect (TypeHandle type)
 Removes the render effect of the given type from this node. More...
 
void clear_effects (Thread *current_thread=Thread::get_current_thread())
 
void clear_state (Thread *current_thread=Thread::get_current_thread())
 
void clear_tag (const string &key, Thread *current_thread=Thread::get_current_thread())
 Removes the value defined for this key on this particular node. More...
 
void clear_transform (Thread *current_thread=Thread::get_current_thread())
 
void clear_unexpected_change (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...
 
virtual PandaNodecombine_with (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 compare_tags (const PandaNode *other) const
 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...
 
void copy_all_properties (PandaNode *other)
 Copies the TransformState, RenderState, RenderEffects, tags, Python tags, and the show/hide state from the other node onto this one. More...
 
void copy_children (PandaNode *other, Thread *current_thread=Thread::get_current_thread())
 Makes another instance of all the children of the other node, copying them to this node. More...
 
void copy_tags (PandaNode *other)
 Copies all of the tags stored on the other node onto this node. More...
 
int count_num_descendants () const
 
virtual CPT (TransformState) calc_tight_bounds(LPoint3 &min_point
 
 CPT (RenderAttrib) get_attrib(TypeHandle type) const
 
 CPT (RenderAttrib) get_attrib(int slot) const
 
 CPT (RenderEffect) get_effect(TypeHandle type) const
 
 CPT (RenderState) get_state(Thread *current_thread
 
 CPT (RenderEffects) get_effects(Thread *current_thread
 
 CPT (TransformState) get_transform(Thread *current_thread
 
 CPT (TransformState) get_prev_transform(Thread *current_thread
 
 CPT (RenderAttrib) get_off_clip_planes(Thread *current_thread
 
 CPT (BoundingVolume) get_bounds(Thread *current_thread
 
 CPT (BoundingVolume) get_bounds(UpdateSeq &seq
 
 CPT (BoundingVolume) get_internal_bounds(Thread *current_thread
 
virtual bool cull_callback (CullTraverser *trav, CullTraverserData &data)
 
virtual PandaNodedupe_for_flatten () const
 This is similar to make_copy(), but it makes a copy for the specific purpose of flatten. More...
 
int find_child (PandaNode *node, Thread *current_thread=Thread::get_current_thread()) const
 Returns the index of the indicated child node, if it is a child, or -1 if it is not. More...
 
int find_parent (PandaNode *node, Thread *current_thread=Thread::get_current_thread()) const
 Returns the index of the indicated parent node, if it is a parent, or -1 if it is not. More...
 
int find_stashed (PandaNode *node, Thread *current_thread=Thread::get_current_thread()) const
 Returns the index of the indicated stashed node, if it is a stashed child, or -1 if it is not. More...
 
virtual TypeHandle force_init_type ()
 
BoundingVolume::BoundsType get_bounds_type () const
 Returns the bounding volume type set with set_bounds_type(). More...
 
PandaNodeget_child (int n, Thread *current_thread=Thread::get_current_thread()) const
 Returns the nth child node of this node. More...
 
int get_child_sort (int n, Thread *current_thread=Thread::get_current_thread()) const
 Returns the sort index of the nth child node of this node (that is, the number that was passed to add_child()). More...
 
Children get_children (Thread *current_thread=Thread::get_current_thread()) const
 Returns an object that can be used to walk through the list of children of the node. More...
 
DrawMask get_draw_control_mask () const
 Returns the set of bits in draw_show_mask that are considered meaningful. More...
 
DrawMask get_draw_show_mask () const
 Returns the hide/show bits of this particular node. More...
 
int get_fancy_bits (Thread *current_thread=Thread::get_current_thread()) const
 Returns the union of all of the enum FancyBits values corresponding to the various "fancy" attributes that are set on the node. More...
 
virtual int get_first_visible_child () const
 Returns the index number of the first visible child of this node, or a number >= get_num_children() if there are no visible children of this node. More...
 
int get_internal_vertices (Thread *current_thread=Thread::get_current_thread()) const
 
CollideMask get_into_collide_mask () const
 Returns the "into" collide mask for this node. More...
 
virtual CollideMask get_legal_collide_mask () const
 Returns the subset of CollideMask bits that may be set for this particular type of PandaNode. More...
 
int get_nested_vertices (Thread *current_thread=Thread::get_current_thread()) const
 
CollideMask get_net_collide_mask (Thread *current_thread=Thread::get_current_thread()) const
 Returns the union of all into_collide_mask() values set at CollisionNodes at this level and below. More...
 
DrawMask get_net_draw_control_mask () const
 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 get_net_draw_show_mask () const
 Returns the union of all draw_show_mask values–of renderable nodes only–at this level and below. More...
 
virtual int get_next_visible_child (int n) const
 Returns the index number of the next visible child of this node following the indicated child, or a number >= get_num_children() if there are no more visible children of this node. More...
 
int get_num_children (Thread *current_thread=Thread::get_current_thread()) const
 Returns the number of child nodes this node has. More...
 
int get_num_parents (Thread *current_thread=Thread::get_current_thread()) const
 Returns the number of parent nodes this node has. More...
 
int get_num_stashed (Thread *current_thread=Thread::get_current_thread()) const
 Returns the number of stashed nodes this node has. More...
 
PandaNodeget_parent (int n, Thread *current_thread=Thread::get_current_thread()) const
 Returns the nth parent node of this node. More...
 
Parents get_parents (Thread *current_thread=Thread::get_current_thread()) const
 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...
 
PandaNodeget_stashed (int n, Thread *current_thread=Thread::get_current_thread()) const
 Returns the nth stashed child of this node. More...
 
Stashed get_stashed (Thread *current_thread=Thread::get_current_thread()) const
 Returns an object that can be used to walk through the list of children of the node. More...
 
int get_stashed_sort (int n, Thread *current_thread=Thread::get_current_thread()) const
 Returns the sort index of the nth stashed node of this node (that is, the number that was passed to add_child()). More...
 
string get_tag (const string &key, Thread *current_thread=Thread::get_current_thread()) const
 
void get_tag_keys (vector_string &keys) const
 Fills the given vector up with the list of tags on this PandaNode. More...
 
virtual TypeHandle get_type () const
 
unsigned int get_unexpected_change (unsigned int flags) const
 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...
 
virtual int get_unsafe_to_apply_attribs () const
 Returns the union of all attributes from SceneGraphReducer::AttribTypes that may not safely be applied to the vertices of this node. More...
 
virtual int get_visible_child () const
 Returns the index number of the currently visible child of this node. More...
 
bool has_attrib (TypeHandle type) const
 
bool has_attrib (int slot) const
 
bool has_dirty_prev_transform () const
 
bool has_effect (TypeHandle type) const
 
virtual bool has_selective_visibility () const
 Should be overridden by derived classes to return true if this kind of node has some restrictions on the set of children that should be rendered. More...
 
virtual bool has_single_child_visibility () const
 Should be overridden by derived classes to return true if this kind of node has the special property that just one of its children is visible at any given time, and furthermore that the particular visible child can be determined without reference to any external information (such as a camera). More...
 
bool has_tag (const string &key, Thread *current_thread=Thread::get_current_thread()) const
 
bool has_tags () const
 
virtual bool is_ambient_light () const
 Returns true if this is an AmbientLight, false if it is not a light, or it is some other kind of light. More...
 
bool is_bounds_stale () const
 
virtual bool is_collision_node () const
 A simple downcast check. More...
 
bool is_final (Thread *current_thread=Thread::get_current_thread()) const
 Returns the current state of the "final" flag. More...
 
virtual bool is_geom_node () const
 A simple downcast check. More...
 
virtual bool is_lod_node () const
 A simple downcast check. More...
 
bool is_overall_hidden () const
 Returns true if the node has been hidden to all cameras by clearing its overall bit. More...
 
virtual bool is_renderable () const
 Returns true if there is some value to visiting this particular node during the cull traversal for any camera, false otherwise. More...
 
bool is_scene_root () const
 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 is_under_scene_root () const
 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...
 
void list_tags (ostream &out, const string &separator="\) const
 Writes a list of all the tag keys assigned to the node to the indicated stream. More...
 
void ls (ostream &out, int indent_level) const
 
virtual PandaNodemake_copy () const
 Returns a newly-allocated PandaNode that is a shallow copy of this one. More...
 
 MAKE_SEQ (get_parents, get_num_parents, get_parent)
 
 MAKE_SEQ (get_children, get_num_children, get_child)
 
 MAKE_SEQ (get_stashed, get_num_stashed, get_stashed)
 
void mark_bounds_stale (Thread *current_thread=Thread::get_current_thread()) const
 
void mark_internal_bounds_stale (Thread *current_thread=Thread::get_current_thread())
 
virtual void output (ostream &out) const
 
void prepare_scene (GraphicsStateGuardianBase *gsg, const RenderState *node_state)
 
virtual bool preserve_name () const
 Returns true if the node's name has extrinsic meaning and must be preserved across a flatten operation, false otherwise. More...
 
 PT (PandaNode) copy_subgraph(Thread *current_thread
 
virtual void r_prepare_scene (GraphicsStateGuardianBase *gsg, const RenderState *node_state, GeomTransformer &transformer, Thread *current_thread)
 The recursive implementation of prepare_scene(). More...
 
void remove_all_children (Thread *current_thread=Thread::get_current_thread())
 Removes all the children from the node at once, including stashed children. More...
 
void remove_child (int child_index, Thread *current_thread=Thread::get_current_thread())
 Removes the nth child from the node. More...
 
bool remove_child (PandaNode *child_node, Thread *current_thread=Thread::get_current_thread())
 Removes the indicated child from the node. More...
 
void remove_stashed (int child_index, Thread *current_thread=Thread::get_current_thread())
 Removes the nth stashed child from the node. More...
 
bool replace_child (PandaNode *orig_child, PandaNode *new_child, Thread *current_thread=Thread::get_current_thread())
 Searches for the orig_child node in the node's list of children, and replaces it with the new_child instead. More...
 
void replace_node (PandaNode *other)
 Inserts this node into the scene graph in place of the other one, and removes the other node. More...
 
void reset_prev_transform (Thread *current_thread=Thread::get_current_thread())
 Resets the transform that represents this node's "previous" position to the same as the current transform. More...
 
virtual bool safe_to_combine () const
 Returns true if it is generally safe to combine this particular kind of PandaNode with other kinds of PandaNodes of compatible type, adding children or whatever. More...
 
virtual bool safe_to_combine_children () const
 Returns true if it is generally safe to combine the children of this PandaNode with each other. More...
 
virtual bool safe_to_flatten () const
 Returns true if it is generally safe to flatten out this particular kind of PandaNode by duplicating instances (by calling dupe_for_flatten()), false otherwise (for instance, a Camera cannot be safely flattened, because the Camera pointer itself is meaningful). More...
 
virtual bool safe_to_flatten_below () const
 Returns true if a flatten operation may safely continue past this node, or false if nodes below this node may not be molested. More...
 
virtual bool safe_to_modify_transform () const
 Returns true if it is safe to automatically adjust the transform on this kind of node. More...
 
virtual bool safe_to_transform () const
 Returns true if it is generally safe to transform this particular kind of PandaNode by calling the xform() method, false otherwise. More...
 
void set_attrib (const RenderAttrib *attrib, int override=0)
 Adds the indicated render attribute to the scene graph on this node. More...
 
void set_bound (const BoundingVolume *volume)
 Deprecated. More...
 
void set_bounds (const BoundingVolume *volume)
 Resets the bounding volume so that it is the indicated volume. More...
 
void set_bounds_type (BoundingVolume::BoundsType bounds_type)
 Specifies the desired type of bounding volume that will be created for this node. More...
 
void set_effect (const RenderEffect *effect)
 Adds the indicated render effect to the scene graph on this node. More...
 
void set_effects (const RenderEffects *effects, Thread *current_thread=Thread::get_current_thread())
 Sets the complete RenderEffects that will be applied this node. More...
 
void set_final (bool flag)
 
void set_into_collide_mask (CollideMask mask)
 Sets the "into" CollideMask. More...
 
void set_overall_hidden (bool overall_hidden)
 Sets or clears the hidden flag. More...
 
void set_prev_transform (const TransformState *transform, Thread *current_thread=Thread::get_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...
 
void set_state (const RenderState *state, Thread *current_thread=Thread::get_current_thread())
 Sets the complete RenderState that will be applied to all nodes at this level and below. More...
 
void set_tag (const string &key, const string &value, Thread *current_thread=Thread::get_current_thread())
 Associates a user-defined value with a user-defined key which is stored on the node. More...
 
void set_transform (const TransformState *transform, Thread *current_thread=Thread::get_current_thread())
 Sets the transform that will be applied to this node and below. More...
 
void set_unexpected_change (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 stash_child (PandaNode *child_node, Thread *current_thread=Thread::get_current_thread())
 Stashes the indicated child node. More...
 
void stash_child (int child_index, Thread *current_thread=Thread::get_current_thread())
 Stashes the indicated child node. More...
 
void steal_children (PandaNode *other, Thread *current_thread=Thread::get_current_thread())
 Moves all the children from the other node onto this node. More...
 
bool unstash_child (PandaNode *child_node, Thread *current_thread=Thread::get_current_thread())
 Returns the indicated stashed node to normal child status. More...
 
void unstash_child (int stashed_index, Thread *current_thread=Thread::get_current_thread())
 Returns the indicated stashed node to normal child status. More...
 
virtual void update_bam_nested (BamWriter *manager)
 Called by the BamWriter when this object has not itself been modified recently, but it should check its nested objects for updates. More...
 
virtual void write (ostream &out, int indent_level) const
 
virtual void write_datagram (BamWriter *manager, Datagram &dg)
 Writes the contents of this object to the datagram for shipping out to a Bam file. More...
 
void write_recorder (BamWriter *manager, Datagram &dg)
 This method is provided for the benefit of classes (like MouseRecorder) that inherit from PandaMode and also RecorderBase. More...
 
virtual void xform (const LMatrix4 &mat)
 Transforms the contents of this PandaNode by the indicated matrix, if it means anything to do so. More...
 
- Public Member Functions inherited from TypedWritableReferenceCount
 TypedWritableReferenceCount (const TypedWritableReferenceCount &copy)
 
virtual ReferenceCountas_reference_count ()
 Returns the pointer cast to a ReferenceCount pointer, if it is in fact of that type. More...
 
void operator= (const TypedWritableReferenceCount &copy)
 
- Public Member Functions inherited from TypedWritable
 TypedWritable (const TypedWritable &copy)
 
virtual int complete_pointers (TypedWritable **p_list, BamReader *manager)
 Receives an array of pointers, one for each time manager->read_pointer() was called in fillin(). More...
 
string encode_to_bam_stream () const
 Converts the TypedWritable object into a single stream of data using a BamWriter, and returns that data as a string string. More...
 
bool encode_to_bam_stream (string &data, BamWriter *writer=NULL) const
 Converts the TypedWritable object into a single stream of data using a BamWriter, and stores that data in the indicated string. More...
 
virtual void finalize (BamReader *manager)
 Called by the BamReader to perform any final actions needed for setting up the object after all objects have been read and all pointers have been completed. More...
 
UpdateSeq get_bam_modified () const
 Returns the current bam_modified counter. More...
 
void mark_bam_modified ()
 Increments the bam_modified counter, so that this object will be invalidated and retransmitted on any open bam streams. More...
 
void operator= (const TypedWritable &copy)
 
virtual bool require_fully_complete () const
 Some objects require all of their nested pointers to have been completed before the objects themselves can be completed. More...
 
- Public Member Functions inherited from TypedObject
 TypedObject (const TypedObject &copy)
 
TypedObjectas_typed_object ()
 Returns the object, upcast (if necessary) to a TypedObject pointer. More...
 
const TypedObjectas_typed_object () const
 Returns the object, upcast (if necessary) to a TypedObject pointer. More...
 
int get_best_parent_from_Set (const std::set< int > &) const
 
int get_type_index () const
 Returns the internal index number associated with this object's TypeHandle, a unique number for each different type. More...
 
bool is_exact_type (TypeHandle handle) const
 Returns true if the current object is the indicated type exactly. More...
 
bool is_of_type (TypeHandle handle) const
 Returns true if the current object is or derives from the indicated type. More...
 
void operator= (const TypedObject &copy)
 
- Public Member Functions inherited from ReferenceCount
int get_ref_count () const
 Returns the current reference count. More...
 
WeakReferenceListget_weak_list () const
 Returns the WeakReferenceList associated with this ReferenceCount object. More...
 
bool has_weak_list () const
 Returns true if this particular ReferenceCount object has a WeakReferenceList created, false otherwise. More...
 
void local_object ()
 This function should be called, once, immediately after creating a new instance of some ReferenceCount-derived object on the stack. More...
 
void ref () const
 Explicitly increments the reference count. More...
 
bool test_ref_count_integrity () const
 Does some easy checks to make sure that the reference count isn't completely bogus. More...
 
bool test_ref_count_nonzero () const
 Does some easy checks to make sure that the reference count isn't zero, or completely bogus. More...
 
virtual bool unref () const
 Explicitly decrements the reference count. More...
 
void weak_ref (WeakPointerToVoid *ptv)
 Adds the indicated PointerToVoid as a weak reference to this object. More...
 
void weak_unref (WeakPointerToVoid *ptv)
 Removes the indicated PointerToVoid as a weak reference to this object. More...
 
- Public Member Functions inherited from Namable
 Namable (const string &initial_name="")
 
 Namable (const Namable &copy)
 
void clear_name ()
 Resets the Namable's name to empty. More...
 
const string & get_name () const
 
bool has_name () const
 Returns true if the Namable has a nonempty name set, false if the name is empty. More...
 
Namableoperator= (const Namable &other)
 
void output (ostream &out) const
 Outputs the Namable. More...
 
void set_name (const string &name)
 

Static Public Member Functions

static DrawMask get_all_camera_mask ()
 Returns a DrawMask that is appropriate for rendering to all cameras. More...
 
static TypeHandle get_class_type ()
 
static DrawMask get_overall_bit ()
 
static void init_type ()
 
static PT (PandaNode) decode_from_bam_stream(const string &data
 
static void register_with_read_factory ()
 Tells the BamReader how to create objects of type PandaNode. More...
 
static void reset_all_prev_transform (Thread *current_thread=Thread::get_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 void set_scene_root_func (SceneRootFunc *func)
 This is used by the GraphicsEngine to hook in a pointer to the scene_root_func(), the function to determine whether the node is an active scene root. More...
 
- Static Public Member Functions inherited from TypedWritableReferenceCount
static TypeHandle get_class_type ()
 
static void init_type ()
 
static PT (TypedWritableReferenceCount) decode_from_bam_stream(const string &data
 
- Static Public Member Functions inherited from TypedWritable
static bool decode_raw_from_bam_stream (TypedWritable *&ptr, ReferenceCount *&ref_ptr, const string &data, BamReader *reader=NULL)
 Reads the string created by a previous call to encode_to_bam_stream(), and extracts the single object on that string. More...
 
static TypeHandle get_class_type ()
 
static void init_type ()
 
- Static Public Member Functions inherited from TypedObject
static TypeHandle get_class_type ()
 
static void init_type ()
 This function is declared non-inline to work around a compiler bug in g++ 2.96. More...
 
- Static Public Member Functions inherited from ReferenceCount
static TypeHandle get_class_type ()
 
static void init_type ()
 
- Static Public Member Functions inherited from Namable
static TypeHandle get_class_type ()
 
static void init_type ()
 

Public Attributes

virtual LPoint3 bool const TransformState Threadcurrent_thread = Thread::get_current_thread()) const
 
Threadcurrent_thread = Thread::get_current_thread()) const
 
virtual LPoint3 bool & found_any
 
virtual LPoint3max_point
 
static BamReaderreader = NULL)
 
virtual LPoint3 bool const TransformState * transform
 
- Public Attributes inherited from TypedWritableReferenceCount
static BamReaderreader = NULL)
 

Friends

class EggLoader
 
class Extension< PandaNode >
 
class NodePath
 
class NodePathComponent
 
class PandaNode::Children
 
class PandaNode::Stashed
 
class PandaNodePipelineReader
 
class WorkingNodePath
 

Additional Inherited Members

- Static Public Attributes inherited from TypedWritable
static TypedWritable *const Null = (TypedWritable*)0L
 

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.

Definition at line 72 of file pandaNode.h.

Member Function Documentation

◆ add_for_draw()

void PandaNode::add_for_draw ( CullTraverser trav,
CullTraverserData data 
)
virtual

Adds the node's contents to the CullResult we are building up during the cull traversal, so that it will be drawn at render time.

For most nodes other than GeomNodes, this is a do-nothing operation.

Reimplemented in SpeedTreeNode, GeomNode, ComputeNode, and CallbackNode.

Definition at line 591 of file pandaNode.cxx.

References make_copy().

Referenced by is_renderable(), and CullTraverser::traverse_below().

◆ add_stashed()

void PandaNode::add_stashed ( PandaNode child_node,
int  sort = 0,
Thread current_thread = Thread::get_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).

Definition at line 919 of file pandaNode.cxx.

References Thread::get_pipeline_stage(), TypedWritable::mark_bam_modified(), remove_child(), and remove_stashed().

Referenced by copy_children(), EggLoader::make_polyset(), steal_children(), and unstash_child().

◆ adjust_draw_mask()

void PandaNode::adjust_draw_mask ( 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.

Definition at line 1932 of file pandaNode.cxx.

References Thread::get_current_thread(), get_net_draw_control_mask(), BitMask< WType, nbits >::is_zero(), and TypedWritable::mark_bam_modified().

Referenced by clear_unexpected_change(), NodePath::hide(), set_overall_hidden(), NodePath::show(), and NodePath::show_through().

◆ apply_attribs_to_vertices()

void PandaNode::apply_attribs_to_vertices ( const AccumulatedAttribs attribs,
int  attrib_types,
GeomTransformer transformer 
)
virtual

Applies whatever attributes are specified in the AccumulatedAttribs object (and by the attrib_types bitmask) to the vertices on this node, if appropriate.

If this node uses geom arrays like a GeomNode, the supplied GeomTransformer may be used to unify shared arrays across multiple different nodes.

This is a generalization of xform().

Reimplemented in TextNode, SpeedTreeNode, PartBundleNode, and GeomNode.

Definition at line 352 of file pandaNode.cxx.

References Thread::get_current_thread(), TypedWritable::mark_bam_modified(), OccluderNode::xform(), and xform().

Referenced by SceneGraphReducer::check_live_flatten(), and get_unsafe_to_apply_attribs().

◆ as_light()

Light * PandaNode::as_light ( )
virtual

◆ clear_attrib()

void PandaNode::clear_attrib ( 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.

Definition at line 1141 of file pandaNode.cxx.

References Thread::get_current_thread(), TypedWritable::mark_bam_modified(), and set_effect().

◆ clear_bounds()

void PandaNode::clear_bounds ( )
inline

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.

Definition at line 596 of file pandaNode.I.

References Thread::get_pipeline_stage(), is_final(), TypedWritable::mark_bam_modified(), and set_bounds().

Referenced by get_into_collide_mask().

◆ clear_effect()

void PandaNode::clear_effect ( TypeHandle  type)

◆ clear_tag()

void PandaNode::clear_tag ( const string &  key,
Thread current_thread = Thread::get_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.

Definition at line 1423 of file pandaNode.cxx.

References copy_tags(), and TypedWritable::mark_bam_modified().

Referenced by NodePath::clear_tag(), and set_tag().

◆ clear_unexpected_change()

void PandaNode::clear_unexpected_change ( 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.

Definition at line 1887 of file pandaNode.cxx.

References adjust_draw_mask().

Referenced by get_unexpected_change().

◆ combine_with()

PandaNode * PandaNode::combine_with ( PandaNode other)
virtual

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.

Reimplemented in SpeedTreeNode, Character, GeomNode, PortalNode, CollisionNode, and ModelNode.

Definition at line 397 of file pandaNode.cxx.

References PandaNode::Children::get_child(), get_children(), PandaNode::Children::get_num_children(), has_selective_visibility(), and TypedObject::is_exact_type().

Referenced by ModelNode::combine_with(), PortalNode::combine_with(), GeomNode::combine_with(), Character::combine_with(), SpeedTreeNode::combine_with(), and xform().

◆ compare_tags()

int PandaNode::compare_tags ( const PandaNode other) const

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.

Definition at line 1567 of file pandaNode.cxx.

References copy_all_properties().

Referenced by get_tag_keys().

◆ copy_all_properties()

void PandaNode::copy_all_properties ( 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()).

Definition at line 1655 of file pandaNode.cxx.

References Thread::get_current_thread(), TypedWritable::mark_bam_modified(), and replace_node().

Referenced by compare_tags(), and replace_node().

◆ copy_children()

void PandaNode::copy_children ( PandaNode other,
Thread current_thread = Thread::get_current_thread() 
)

◆ copy_tags()

void PandaNode::copy_tags ( 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.

Definition at line 1442 of file pandaNode.cxx.

References Thread::get_current_thread(), list_tags(), and TypedWritable::mark_bam_modified().

Referenced by clear_tag().

◆ dupe_for_flatten()

PandaNode * PandaNode::dupe_for_flatten ( ) const
virtual

This is similar to make_copy(), but it makes a copy for the specific purpose of flatten.

Typically, this will be a new PandaNode with a new pointer, but all of the internal data will always be shared with the original; whereas the new node returned by make_copy() might not share the internal data.

Reimplemented in Character.

Definition at line 222 of file pandaNode.cxx.

References OccluderNode::make_copy(), and safe_to_flatten().

Referenced by SceneGraphReducer::check_live_flatten().

◆ find_child()

int PandaNode::find_child ( PandaNode node,
Thread current_thread = Thread::get_current_thread() 
) const
inline

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

Definition at line 111 of file pandaNode.I.

References stash_child().

Referenced by PandaFramework::event_arrow_left(), PandaFramework::event_arrow_right(), get_child_sort(), NodePath::get_sort(), and stash_child().

◆ find_parent()

int PandaNode::find_parent ( PandaNode node,
Thread current_thread = Thread::get_current_thread() 
) const
inline

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

Definition at line 54 of file pandaNode.I.

References get_num_children().

Referenced by get_parent(), NodePathComponent::output(), replace_node(), DataGraphTraverser::traverse_below(), and NodePath::verify_complete().

◆ find_stashed()

int PandaNode::find_stashed ( PandaNode node,
Thread current_thread = Thread::get_current_thread() 
) const
inline

◆ get_all_camera_mask()

DrawMask PandaNode::get_all_camera_mask ( )
inlinestatic

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

Definition at line 513 of file pandaNode.I.

References is_overall_hidden().

Referenced by find_stashed().

◆ get_bounds_type()

BoundingVolume::BoundsType PandaNode::get_bounds_type ( ) const

Returns the bounding volume type set with set_bounds_type().

Definition at line 2284 of file pandaNode.cxx.

References set_bounds().

Referenced by set_bounds_type().

◆ get_child()

PandaNode * PandaNode::get_child ( int  n,
Thread current_thread = Thread::get_current_thread() 
) const
inline

◆ get_child_sort()

int PandaNode::get_child_sort ( int  n,
Thread current_thread = Thread::get_current_thread() 
) const
inline

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

Definition at line 97 of file pandaNode.I.

References find_child().

Referenced by SceneGraphReducer::check_live_flatten(), Character::force_update(), get_child(), NodePath::get_sort(), stash_child(), and steal_children().

◆ get_children()

PandaNode::Children PandaNode::get_children ( Thread current_thread = Thread::get_current_thread()) const
inline

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.

Definition at line 773 of file pandaNode.I.

References get_stashed().

Referenced by SceneGraphReducer::check_live_flatten(), CollisionTraverser::clear_colliders(), combine_with(), FindApproxLevelEntry::consider_node(), copy_children(), RigidBodyCombiner::cull_callback(), AnimBundleNode::find_anim_bundle(), SceneGraphReducer::flatten(), NodePath::get_children(), get_fancy_bits(), is_ambient_light(), make_copy(), TextNode::r_prepare_scene(), r_prepare_scene(), MultitexReducer::scan(), StaticTextFont::StaticTextFont(), DataGraphTraverser::traverse_below(), and SpeedTreeNode::write_error().

◆ get_draw_control_mask()

DrawMask PandaNode::get_draw_control_mask ( ) const
inline

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

See adjust_draw_mask().

Definition at line 559 of file pandaNode.I.

References get_draw_show_mask().

Referenced by NodePath::get_hidden_ancestor(), is_under_scene_root(), and set_overall_hidden().

◆ get_draw_show_mask()

DrawMask PandaNode::get_draw_show_mask ( ) const
inline

Returns the hide/show bits of this particular node.

See adjust_draw_mask().

Definition at line 571 of file pandaNode.I.

References get_into_collide_mask().

Referenced by get_draw_control_mask(), NodePath::get_hidden_ancestor(), and is_under_scene_root().

◆ get_fancy_bits()

int PandaNode::get_fancy_bits ( Thread current_thread = Thread::get_current_thread()) const
inline

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.

Definition at line 694 of file pandaNode.I.

References get_children().

Referenced by is_final().

◆ get_first_visible_child()

int PandaNode::get_first_visible_child ( ) const
virtual

Returns the index number of the first visible child of this node, or a number >= get_num_children() if there are no visible children of this node.

This is called during the cull traversal, but only if has_selective_visibility() has already returned true. See has_selective_visibility().

Reimplemented in SequenceNode, SwitchNode, and SelectiveChildNode.

Definition at line 515 of file pandaNode.cxx.

References get_next_visible_child().

Referenced by has_selective_visibility(), and CullTraverser::traverse_below().

◆ get_into_collide_mask()

CollideMask PandaNode::get_into_collide_mask ( ) const
inline

Returns the "into" collide mask for this node.

Definition at line 582 of file pandaNode.I.

References clear_bounds().

Referenced by CollisionTraverser::clear_colliders(), BulletWorld::contact_test_pair(), get_draw_show_mask(), and CollisionNode::get_into_collide_mask().

◆ get_legal_collide_mask()

CollideMask PandaNode::get_legal_collide_mask ( ) const
virtual

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.

Reimplemented in BulletBodyNode, GeomNode, CollisionNode, and BulletBaseCharacterControllerNode.

Definition at line 2069 of file pandaNode.cxx.

References BitMask< PN_uint32, 32 >::all_off(), and get_net_collide_mask().

Referenced by set_into_collide_mask().

◆ get_net_collide_mask()

CollideMask PandaNode::get_net_collide_mask ( Thread current_thread = Thread::get_current_thread()) const

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

Definition at line 2080 of file pandaNode.cxx.

References Thread::get_current_thread(), Thread::get_pipeline_stage(), is_scene_root(), and r_prepare_scene().

Referenced by NodePath::get_collide_mask(), and get_legal_collide_mask().

◆ get_net_draw_control_mask()

DrawMask PandaNode::get_net_draw_control_mask ( ) const

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.

Definition at line 1974 of file pandaNode.cxx.

References Thread::get_current_thread(), get_net_draw_show_mask(), and Thread::get_pipeline_stage().

Referenced by adjust_draw_mask().

◆ get_net_draw_show_mask()

DrawMask PandaNode::get_net_draw_show_mask ( ) const

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.

Definition at line 2005 of file pandaNode.cxx.

References Thread::get_current_thread(), Thread::get_pipeline_stage(), and set_into_collide_mask().

Referenced by get_net_draw_control_mask().

◆ get_next_visible_child()

int PandaNode::get_next_visible_child ( int  n) const
virtual

Returns the index number of the next visible child of this node following the indicated child, or a number >= get_num_children() if there are no more visible children of this node.

See has_selective_visibility() and get_first_visible_child().

Reimplemented in SelectiveChildNode.

Definition at line 530 of file pandaNode.cxx.

References has_single_child_visibility().

Referenced by get_first_visible_child(), and CullTraverser::traverse_below().

◆ get_num_children()

int PandaNode::get_num_children ( Thread current_thread = Thread::get_current_thread()) const
inline

◆ get_num_parents()

int PandaNode::get_num_parents ( Thread current_thread = Thread::get_current_thread()) const
inline

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.

Definition at line 26 of file pandaNode.I.

References get_parent().

Referenced by SceneGraphReducer::check_live_flatten(), DataGraphTraverser::traverse(), DataGraphTraverser::traverse_below(), DataNode::write_connections(), and ParticleSystem::~ParticleSystem().

◆ get_num_stashed()

int PandaNode::get_num_stashed ( Thread current_thread = Thread::get_current_thread()) const
inline

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

Definition at line 176 of file pandaNode.I.

References get_stashed().

Referenced by FindApproxLevelEntry::consider_node(), NodePath::get_stashed_children(), r_prepare_scene(), steal_children(), and unstash_child().

◆ get_parent()

PandaNode * PandaNode::get_parent ( int  n,
Thread current_thread = Thread::get_current_thread() 
) const
inline

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.

Definition at line 40 of file pandaNode.I.

References find_parent().

Referenced by get_num_parents(), r_prepare_scene(), DataNode::write_connections(), and write_recorder().

◆ get_parents()

PandaNode::Parents PandaNode::get_parents ( Thread current_thread = Thread::get_current_thread()) const
inline

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

Definition at line 809 of file pandaNode.I.

References LightMutexDirect::debug_is_locked(), and PandaNode::DownConnection::operator<().

Referenced by get_stashed(), is_under_scene_root(), r_prepare_scene(), and replace_node().

◆ get_stashed() [1/2]

PandaNode * PandaNode::get_stashed ( int  n,
Thread current_thread = Thread::get_current_thread() 
) const
inline

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.

Definition at line 191 of file pandaNode.I.

References get_stashed_sort().

Referenced by FindApproxLevelEntry::consider_node(), copy_children(), PandaNodePipelineReader::find_stashed(), get_children(), get_num_stashed(), NodePath::get_stashed_children(), is_ambient_light(), r_prepare_scene(), steal_children(), unstash_child(), and write_recorder().

◆ get_stashed() [2/2]

PandaNode::Stashed PandaNode::get_stashed ( Thread current_thread = Thread::get_current_thread()) const
inline

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.

Definition at line 796 of file pandaNode.I.

References get_parents().

◆ get_stashed_sort()

int PandaNode::get_stashed_sort ( int  n,
Thread current_thread = Thread::get_current_thread() 
) const
inline

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

Definition at line 206 of file pandaNode.I.

References find_stashed().

Referenced by NodePath::get_sort(), get_stashed(), steal_children(), and unstash_child().

◆ get_tag_keys()

void PandaNode::get_tag_keys ( vector_string &  keys) const

Fills the given vector up with the list of tags on this PandaNode.

It is the user's responsibility to ensure that the keys vector is empty before making this call; otherwise, the new keys will be appended to it.

Definition at line 1544 of file pandaNode.cxx.

References compare_tags().

Referenced by NodePath::get_tag_keys(), and list_tags().

◆ get_unexpected_change()

unsigned int PandaNode::get_unexpected_change ( unsigned int  flags) const

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.

Definition at line 1864 of file pandaNode.cxx.

References clear_unexpected_change().

Referenced by set_unexpected_change().

◆ get_unsafe_to_apply_attribs()

int PandaNode::get_unsafe_to_apply_attribs ( ) const
virtual

Returns the union of all attributes from SceneGraphReducer::AttribTypes that may not safely be applied to the vertices of this node.

If this is nonzero, these attributes must be dropped at this node as a state change.

This is a generalization of safe_to_transform().

Reimplemented in TextNode, and ModelNode.

Definition at line 335 of file pandaNode.cxx.

References apply_attribs_to_vertices().

Referenced by SceneGraphReducer::check_live_flatten(), and preserve_name().

◆ get_visible_child()

int PandaNode::get_visible_child ( ) const
virtual

Returns the index number of the currently visible child of this node.

This is only meaningful if has_single_child_visibility() has returned true.

Reimplemented in SequenceNode, and SwitchNode.

Definition at line 563 of file pandaNode.cxx.

References is_renderable().

Referenced by CollisionTraverser::clear_colliders(), and has_single_child_visibility().

◆ has_selective_visibility()

bool PandaNode::has_selective_visibility ( ) const
virtual

Should be overridden by derived classes to return true if this kind of node has some restrictions on the set of children that should be rendered.

Node with this property include LODNodes, SwitchNodes, and SequenceNodes.

If this function returns true, get_first_visible_child() and get_next_visible_child() will be called to walk through the list of children during cull, instead of iterating through the entire list. This method is called after cull_callback(), so cull_callback() may be responsible for the decisions as to which children are visible at the moment.

Reimplemented in SelectiveChildNode.

Definition at line 500 of file pandaNode.cxx.

References get_first_visible_child().

Referenced by combine_with(), and CullTraverser::traverse_below().

◆ has_single_child_visibility()

bool PandaNode::has_single_child_visibility ( ) const
virtual

Should be overridden by derived classes to return true if this kind of node has the special property that just one of its children is visible at any given time, and furthermore that the particular visible child can be determined without reference to any external information (such as a camera).

At present, only SequenceNodes and SwitchNodes fall into this category.

If this function returns true, get_visible_child() can be called to return the index of the currently-visible child.

Reimplemented in SequenceNode, and SwitchNode.

Definition at line 551 of file pandaNode.cxx.

References get_visible_child().

Referenced by CollisionTraverser::clear_colliders(), and get_next_visible_child().

◆ is_ambient_light()

bool PandaNode::is_ambient_light ( ) const
virtual

◆ is_collision_node()

bool PandaNode::is_collision_node ( ) const
virtual

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

Reimplemented in CollisionNode.

Definition at line 2516 of file pandaNode.cxx.

References as_light().

Referenced by CollisionHandlerPhysical::add_collider(), CollisionTraverser::add_collider(), CollisionTraverser::clear_colliders(), and is_lod_node().

◆ is_final()

bool PandaNode::is_final ( Thread current_thread = Thread::get_current_thread()) const
inline

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

Definition at line 678 of file pandaNode.I.

References get_fancy_bits().

Referenced by clear_bounds().

◆ is_geom_node()

bool PandaNode::is_geom_node ( ) const
virtual

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.

Reimplemented in GeomNode.

Definition at line 2486 of file pandaNode.cxx.

References is_lod_node().

Referenced by EggSaver::add_node(), CollisionTraverser::clear_colliders(), RigidBodyCombiner::cull_callback(), CullTraverser::draw_bounding_volume(), Character::force_update(), PipeOcclusionCullTraverser::get_texture(), EggLoader::make_polyset(), CharacterMaker::part_to_node(), TextNode::r_prepare_scene(), ProjectionScreen::recompute_if_stale(), MultitexReducer::scan(), set_bound(), StaticTextFont::StaticTextFont(), CullTraverser::traverse_below(), and SceneGraphAnalyzer::write().

◆ is_lod_node()

bool PandaNode::is_lod_node ( ) const
virtual

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

Reimplemented in LODNode.

Definition at line 2501 of file pandaNode.cxx.

References is_collision_node().

Referenced by CollisionTraverser::clear_colliders(), is_geom_node(), and SceneGraphAnalyzer::write().

◆ is_overall_hidden()

bool PandaNode::is_overall_hidden ( ) const
inline

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

Definition at line 524 of file pandaNode.I.

References set_overall_hidden().

Referenced by EggSaver::add_node(), FindApproxLevelEntry::consider_next_step(), get_all_camera_mask(), NodePath::get_hidden_ancestor(), and PGItem::get_text_node().

◆ is_renderable()

bool PandaNode::is_renderable ( ) const
virtual

Returns true if there is some value to visiting this particular node during the cull traversal for any camera, false otherwise.

This will be used to optimize the result of get_net_draw_show_mask(), so that any subtrees that contain only nodes for which is_renderable() is false need not be visited.

Reimplemented in TextNode, SpeedTreeNode, GeomNode, PGTop, RopeNode, PlaneNode, PortalNode, SheetNode, CollisionNode, OccluderNode, ComputeNode, and CallbackNode.

Definition at line 578 of file pandaNode.cxx.

References add_for_draw().

Referenced by get_visible_child().

◆ is_scene_root()

bool PandaNode::is_scene_root ( ) const

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

Definition at line 2145 of file pandaNode.cxx.

References is_under_scene_root().

Referenced by get_net_collide_mask(), and is_under_scene_root().

◆ is_under_scene_root()

bool PandaNode::is_under_scene_root ( ) const

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.

Definition at line 2166 of file pandaNode.cxx.

References find_stashed(), get_draw_control_mask(), get_draw_show_mask(), PandaNode::Parents::get_num_parents(), PandaNode::Parents::get_parent(), get_parents(), is_scene_root(), is_under_scene_root(), BitMask< WType, nbits >::is_zero(), list_tags(), and set_bounds_type().

Referenced by SceneGraphReducer::check_live_flatten(), is_scene_root(), and is_under_scene_root().

◆ list_tags()

void PandaNode::list_tags ( ostream &  out,
const string &  separator = "\n" 
) const

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.

Definition at line 1505 of file pandaNode.cxx.

References get_tag_keys().

Referenced by EggSaver::add_node(), copy_tags(), is_under_scene_root(), and NodePath::list_tags().

◆ make_copy()

PandaNode * PandaNode::make_copy ( ) const
virtual

◆ preserve_name()

bool PandaNode::preserve_name ( ) const
virtual

Returns true if the node's name has extrinsic meaning and must be preserved across a flatten operation, false otherwise.

Reimplemented in ModelNode, OccluderNode, PortalNode, and CollisionNode.

Definition at line 319 of file pandaNode.cxx.

References get_unsafe_to_apply_attribs().

Referenced by safe_to_flatten_below().

◆ r_prepare_scene()

void PandaNode::r_prepare_scene ( GraphicsStateGuardianBase gsg,
const RenderState node_state,
GeomTransformer transformer,
Thread current_thread 
)
virtual

◆ register_with_read_factory()

void PandaNode::register_with_read_factory ( )
static

Tells the BamReader how to create objects of type PandaNode.

Definition at line 4153 of file pandaNode.cxx.

References BamReader::get_factory(), Factory< Type >::register_factory(), and write_datagram().

Referenced by set_scene_root_func().

◆ remove_all_children()

void PandaNode::remove_all_children ( Thread current_thread = Thread::get_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).

Definition at line 990 of file pandaNode.cxx.

References get_child(), TypedWritable::mark_bam_modified(), and steal_children().

Referenced by GeoMipTerrain::generate(), remove_stashed(), steal_children(), and GeoMipTerrain::update().

◆ remove_child() [1/2]

void PandaNode::remove_child ( int  child_index,
Thread current_thread = Thread::get_current_thread() 
)

◆ remove_child() [2/2]

bool PandaNode::remove_child ( PandaNode child_node,
Thread current_thread = Thread::get_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.

Definition at line 732 of file pandaNode.cxx.

References replace_child().

◆ remove_stashed()

void PandaNode::remove_stashed ( int  child_index,
Thread current_thread = Thread::get_current_thread() 
)

Removes the nth stashed child from the node.

Definition at line 956 of file pandaNode.cxx.

References Thread::get_pipeline_stage(), TypedWritable::mark_bam_modified(), and remove_all_children().

Referenced by add_stashed(), and unstash_child().

◆ replace_child()

bool PandaNode::replace_child ( PandaNode orig_child,
PandaNode new_child,
Thread current_thread = Thread::get_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.

Definition at line 771 of file pandaNode.cxx.

References stash_child().

Referenced by SceneGraphReducer::check_live_flatten(), remove_child(), and replace_node().

◆ replace_node()

void PandaNode::replace_node ( 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.

Definition at line 1777 of file pandaNode.cxx.

References copy_all_properties(), find_parent(), Thread::get_current_thread(), PandaNode::Parents::get_num_parents(), PandaNode::Parents::get_parent(), get_parents(), remove_child(), replace_child(), set_unexpected_change(), and steal_children().

Referenced by copy_all_properties().

◆ reset_all_prev_transform()

void PandaNode::reset_all_prev_transform ( Thread current_thread = Thread::get_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.

Definition at line 1362 of file pandaNode.cxx.

References Thread::get_pipeline_stage(), TypedWritable::mark_bam_modified(), and set_tag().

Referenced by reset_prev_transform().

◆ reset_prev_transform()

void PandaNode::reset_prev_transform ( Thread current_thread = Thread::get_current_thread())

◆ safe_to_combine()

bool PandaNode::safe_to_combine ( ) const
virtual

Returns true if it is generally safe to combine this particular kind of PandaNode with other kinds of PandaNodes of compatible type, adding children or whatever.

For instance, an LODNode should not be combined with any other PandaNode, because its set of children is meaningful.

Reimplemented in BulletBodyNode, GeomNode, ModelNode, ComputeNode, BulletDebugNode, CallbackNode, BulletBaseCharacterControllerNode, SequenceNode, LODNode, UvScrollNode, and SwitchNode.

Definition at line 281 of file pandaNode.cxx.

References safe_to_combine_children().

Referenced by safe_to_modify_transform().

◆ safe_to_combine_children()

bool PandaNode::safe_to_combine_children ( ) const
virtual

Returns true if it is generally safe to combine the children of this PandaNode with each other.

For instance, an LODNode's children should not be combined with each other, because the set of children is meaningful.

Reimplemented in BulletBodyNode, BulletDebugNode, BulletBaseCharacterControllerNode, SequenceNode, LODNode, and SwitchNode.

Definition at line 295 of file pandaNode.cxx.

References safe_to_flatten_below().

Referenced by SceneGraphReducer::check_live_flatten(), SceneGraphReducer::flatten(), and safe_to_combine().

◆ safe_to_flatten()

bool PandaNode::safe_to_flatten ( ) const
virtual

Returns true if it is generally safe to flatten out this particular kind of PandaNode by duplicating instances (by calling dupe_for_flatten()), false otherwise (for instance, a Camera cannot be safely flattened, because the Camera pointer itself is meaningful).

Reimplemented in BulletBodyNode, ParametricCurve, GeomNode, ForceNode, PhysicalNode, Camera, ModelNode, BulletDebugNode, AnimBundleNode, BulletBaseCharacterControllerNode, and UvScrollNode.

Definition at line 237 of file pandaNode.cxx.

References safe_to_transform().

Referenced by SceneGraphReducer::check_live_flatten(), dupe_for_flatten(), and ProjectionScreen::recompute_if_stale().

◆ safe_to_flatten_below()

bool PandaNode::safe_to_flatten_below ( ) const
virtual

Returns true if a flatten operation may safely continue past this node, or false if nodes below this node may not be molested.

Reimplemented in BulletBodyNode, BulletDebugNode, ModelNode, and BulletBaseCharacterControllerNode.

Definition at line 307 of file pandaNode.cxx.

References preserve_name().

Referenced by SceneGraphReducer::check_live_flatten(), and safe_to_combine_children().

◆ safe_to_modify_transform()

bool PandaNode::safe_to_modify_transform ( ) const
virtual

Returns true if it is safe to automatically adjust the transform on this kind of node.

Usually, this is only a bad idea if the user expects to find a particular transform on the node.

ModelNodes with the preserve_transform flag set are presently the only kinds of nodes that should not have their transform even adjusted.

Reimplemented in BulletBodyNode, ModelNode, BulletDebugNode, and BulletBaseCharacterControllerNode.

Definition at line 266 of file pandaNode.cxx.

References safe_to_combine().

Referenced by SceneGraphReducer::check_live_flatten(), and safe_to_transform().

◆ safe_to_transform()

bool PandaNode::safe_to_transform ( ) const
virtual

Returns true if it is generally safe to transform this particular kind of PandaNode by calling the xform() method, false otherwise.

Reimplemented in BulletBodyNode, ParametricCurve, RopeNode, SheetNode, Camera, ModelNode, BulletDebugNode, and BulletBaseCharacterControllerNode.

Definition at line 249 of file pandaNode.cxx.

References safe_to_modify_transform().

Referenced by SceneGraphReducer::check_live_flatten(), and safe_to_flatten().

◆ set_attrib()

void PandaNode::set_attrib ( const RenderAttrib attrib,
int  override = 0 
)

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.

Definition at line 1107 of file pandaNode.cxx.

References Thread::get_current_thread(), and TypedWritable::mark_bam_modified().

Referenced by AccumulatedAttribs::apply_to_node(), NodePath::clear_clip_plane(), NodePath::clear_light(), NodePath::clear_tex_gen(), NodePath::clear_tex_transform(), NodePath::clear_texture(), NodePath::compose_color_scale(), copy_children(), MultitexReducer::flatten(), NodePath::get_instance_count(), NodePath::get_texture_sampler(), NodePath::has_material(), NodePath::has_tex_transform(), GeomParticleRenderer::make_copy(), EggLoader::make_polyset(), NodePath::set_all_color_scale(), NodePath::set_alpha_scale(), NodePath::set_antialias(), NodePath::set_audio_volume(), NodePath::set_audio_volume_off(), NodePath::set_bin(), NodePath::set_clip_plane(), NodePath::set_clip_plane_off(), NodePath::set_color(), NodePath::set_color_off(), NodePath::set_color_scale(), NodePath::set_color_scale_off(), NodePath::set_depth_offset(), NodePath::set_depth_test(), NodePath::set_depth_write(), NodePath::set_fog_off(), NodePath::set_instance_count(), NodePath::set_light(), NodePath::set_light_off(), NodePath::set_material(), NodePath::set_material_off(), WindowFramework::set_one_sided_reverse(), NodePath::set_render_mode(), NodePath::set_render_mode_filled(), NodePath::set_render_mode_filled_wireframe(), NodePath::set_render_mode_perspective(), NodePath::set_render_mode_thickness(), NodePath::set_render_mode_wireframe(), NodePath::set_shader_auto(), NodePath::set_state(), NodePath::set_tex_gen(), NodePath::set_tex_transform(), NodePath::set_texture(), NodePath::set_texture_off(), NodePath::set_transparency(), NodePath::set_two_sided(), and WindowFramework::set_wireframe().

◆ set_bound()

void PandaNode::set_bound ( const BoundingVolume volume)

Deprecated.

Use set_bounds() instead.

Definition at line 2325 of file pandaNode.cxx.

References Thread::get_pipeline_stage(), is_geom_node(), and set_bounds().

Referenced by set_bounds().

◆ set_bounds()

void PandaNode::set_bounds ( 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.

Definition at line 2304 of file pandaNode.cxx.

References Thread::get_current_thread(), TypedWritable::mark_bam_modified(), and set_bound().

Referenced by clear_bounds(), get_bounds_type(), and set_bound().

◆ set_bounds_type()

void PandaNode::set_bounds_type ( 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.

Definition at line 2261 of file pandaNode.cxx.

References get_bounds_type(), Thread::get_current_thread(), and TypedWritable::mark_bam_modified().

Referenced by is_under_scene_root().

◆ set_effect()

void PandaNode::set_effect ( const RenderEffect effect)

◆ set_effects()

void PandaNode::set_effects ( const RenderEffects effects,
Thread current_thread = Thread::get_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().

Definition at line 1247 of file pandaNode.cxx.

References RenderEffects::is_empty(), TypedWritable::mark_bam_modified(), and set_transform().

Referenced by find_stashed(), NodePath::set_effects(), and set_state().

◆ set_into_collide_mask()

void PandaNode::set_into_collide_mask ( 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.

Definition at line 2037 of file pandaNode.cxx.

References Thread::get_current_thread(), get_legal_collide_mask(), and TypedWritable::mark_bam_modified().

Referenced by get_net_draw_show_mask(), and CollisionNode::set_into_collide_mask().

◆ set_overall_hidden()

void PandaNode::set_overall_hidden ( bool  hidden)
inline

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.

Definition at line 544 of file pandaNode.I.

References adjust_draw_mask(), BitMask< PN_uint32, 32 >::all_off(), and get_draw_control_mask().

Referenced by is_overall_hidden().

◆ set_prev_transform()

void PandaNode::set_prev_transform ( const TransformState *  transform,
Thread current_thread = Thread::get_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.

Definition at line 1306 of file pandaNode.cxx.

References TypedWritable::mark_bam_modified(), and reset_prev_transform().

Referenced by NodePath::clear_transform(), AccumulatedAttribs::collect(), EggLoader::make_polyset(), and set_transform().

◆ set_scene_root_func()

void PandaNode::set_scene_root_func ( SceneRootFunc *  func)
static

This is used by the GraphicsEngine to hook in a pointer to the scene_root_func(), the function to determine whether the node is an active scene root.

This back-pointer is necessary because we can't make calls directly into GraphicsEngine, which is in the display module.

Definition at line 4142 of file pandaNode.cxx.

References register_with_read_factory().

Referenced by GraphicsEngine::dispatch_compute(), and r_prepare_scene().

◆ set_state()

void PandaNode::set_state ( const RenderState state,
Thread current_thread = Thread::get_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().

Definition at line 1216 of file pandaNode.cxx.

References RenderState::is_empty(), TypedWritable::mark_bam_modified(), and set_effects().

Referenced by AccumulatedAttribs::apply_to_node(), clear_effect(), AccumulatedAttribs::collect(), PGButton::enter_region(), PGButton::exit_region(), find_stashed(), GeomParticleRenderer::make_copy(), PGButton::press(), ProjectionScreen::recompute_if_stale(), PGButton::release(), MultitexReducer::scan(), PGButton::set_active(), NodePath::set_state(), and PGVirtualFrame::setup().

◆ set_tag()

void PandaNode::set_tag ( const string &  key,
const string &  value,
Thread current_thread = Thread::get_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.

Definition at line 1403 of file pandaNode.cxx.

References clear_tag(), and TypedWritable::mark_bam_modified().

Referenced by ColladaLoader::build_graph(), EggLoader::make_polyset(), reset_all_prev_transform(), and NodePath::set_tag().

◆ set_transform()

void PandaNode::set_transform ( const TransformState *  transform,
Thread current_thread = Thread::get_current_thread() 
)

◆ set_unexpected_change()

void PandaNode::set_unexpected_change ( 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.

Definition at line 1843 of file pandaNode.cxx.

References get_unexpected_change().

Referenced by replace_node().

◆ stash_child() [1/2]

bool PandaNode::stash_child ( PandaNode child_node,
Thread current_thread = Thread::get_current_thread() 
)
inline

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

Definition at line 133 of file pandaNode.I.

References find_child(), and unstash_child().

Referenced by find_child(), and replace_child().

◆ stash_child() [2/2]

void PandaNode::stash_child ( int  child_index,
Thread current_thread = Thread::get_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).

Definition at line 826 of file pandaNode.cxx.

References get_child(), get_child_sort(), get_num_children(), Thread::get_pipeline_stage(), TypedWritable::mark_bam_modified(), remove_child(), and unstash_child().

◆ steal_children()

void PandaNode::steal_children ( PandaNode other,
Thread current_thread = Thread::get_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.

Definition at line 1038 of file pandaNode.cxx.

References add_stashed(), copy_children(), get_child(), get_child_sort(), get_num_children(), get_num_stashed(), get_stashed(), get_stashed_sort(), and remove_all_children().

Referenced by remove_all_children(), and replace_node().

◆ unstash_child() [1/2]

bool PandaNode::unstash_child ( PandaNode child_node,
Thread current_thread = Thread::get_current_thread() 
)
inline

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

Definition at line 159 of file pandaNode.I.

References find_stashed(), and get_num_stashed().

Referenced by stash_child().

◆ unstash_child() [2/2]

void PandaNode::unstash_child ( int  stashed_index,
Thread current_thread = Thread::get_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).

Definition at line 871 of file pandaNode.cxx.

References add_stashed(), get_num_stashed(), Thread::get_pipeline_stage(), get_stashed(), get_stashed_sort(), TypedWritable::mark_bam_modified(), and remove_stashed().

◆ update_bam_nested()

void PandaNode::update_bam_nested ( BamWriter manager)
virtual

Called by the BamWriter when this object has not itself been modified recently, but it should check its nested objects for updates.

Reimplemented from TypedWritable.

Definition at line 4179 of file pandaNode.cxx.

References write_recorder().

Referenced by write_datagram().

◆ write_datagram()

void PandaNode::write_datagram ( BamWriter manager,
Datagram dg 
)
virtual

◆ write_recorder()

void PandaNode::write_recorder ( BamWriter manager,
Datagram dg 
)

◆ xform()

void PandaNode::xform ( const LMatrix4 mat)
virtual

Transforms the contents of this PandaNode by the indicated matrix, if it means anything to do so.

For most kinds of PandaNodes, this does nothing.

Reimplemented in PolylightNode, PGItem, Fog, PGEntry, PartBundleNode, PGScrollFrame, GeomNode, PlaneNode, OccluderNode, PortalNode, Spotlight, PGSliderBar, CollisionNode, LODNode, LensNode, DirectionalLight, and PointLight.

Definition at line 377 of file pandaNode.cxx.

References combine_with().

Referenced by apply_attribs_to_vertices(), LensNode::xform(), and PlaneNode::xform().


The documentation for this class was generated from the following files: