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

#include "pandaNode.h"

Inheritance diagram for PandaNode:

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 std::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 Light *	as_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 std::string &key, Thread *current_thread=Thread::get_current_thread())

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 PandaNode *	combine_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 PandaNode *	dupe_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

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

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

DrawMask	get_draw_control_mask () const

DrawMask	get_draw_show_mask () const

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

virtual CollideMask	get_legal_collide_mask () const

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

int	get_num_parents (Thread *current_thread=Thread::get_current_thread()) const

int	get_num_stashed (Thread *current_thread=Thread::get_current_thread()) const

size_t	get_num_tags () const

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

Parents	get_parents (Thread *current_thread=Thread::get_current_thread()) const

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

Stashed	get_stashed (Thread *current_thread=Thread::get_current_thread()) const

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

std::string	get_tag (const std::string &key, Thread *current_thread=Thread::get_current_thread()) const

std::string	get_tag_key (size_t i) 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 std::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

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

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 (std::ostream &out, const std::string &separator="\n") const
	Writes a list of all the tag keys assigned to the node to the indicated stream. More...

void	ls (std::ostream &out, int indent_level) const

virtual PandaNode *	make_copy () const
	Returns a newly-allocated PandaNode that is a shallow copy of this one. More...

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 (std::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())

void	set_final (bool flag)

void	set_into_collide_mask (CollideMask mask)

void	set_overall_hidden (bool overall_hidden)

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

void	set_tag (const std::string &key, const std::string &value, Thread *current_thread=Thread::get_current_thread())

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

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 (std::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 ReferenceCount *	as_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...

vector_uchar	encode_to_bam_stream () const
	Converts the TypedWritable object into a single stream of data using a BamWriter, and returns that data as a bytes object. More...

bool	encode_to_bam_stream (vector_uchar &data, BamWriter *writer=nullptr) 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)=default

TypedObject *	as_typed_object ()
	Returns the object, upcast (if necessary) to a TypedObject pointer. More...

const TypedObject *	as_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...

TypedObject &	operator= (const TypedObject &copy)=default

Public Member Functions inherited from ReferenceCount
int	get_ref_count () const

WeakReferenceList *	get_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	ref_if_nonzero () const
	Atomically increases the reference count of this object if it is not zero. 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...

WeakReferenceList *	weak_ref ()
	Adds the indicated PointerToVoid as a weak reference to this object. More...

void	weak_unref ()
	Removes the indicated PointerToVoid as a weak reference to this object. More...

Public Member Functions inherited from Namable
	Namable (const std::string &initial_name="")

void	clear_name ()
	Resets the Namable's name to empty. More...

const std::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...

void	output (std::ostream &out) const
	Outputs the Namable. More...

void	set_name (const std::string &name)

Static Public Member Functions
static DrawMask	get_all_camera_mask ()

static TypeHandle	get_class_type ()

static DrawMask	get_overall_bit ()

static void	init_type ()

static	PT (PandaNode) decode_from_bam_stream(vector_uchar 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(vector_uchar data

Static Public Member Functions inherited from TypedWritable
static bool	decode_raw_from_bam_stream (TypedWritable &ptr, ReferenceCount &ref_ptr, vector_uchar data, BamReader *reader=nullptr)
	Reads the bytes created by a previous call to encode_to_bam_stream(), and extracts the single object on those bytes. 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
	clear_tag
	Removes the value defined for this key on this particular node. More...

virtual LPoint3 bool const TransformState Thread *	current_thread = Thread::get_current_thread()) const

Thread *	current_thread = Thread::get_current_thread()) const

virtual LPoint3 bool &	found_any

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

	get_bounds_type
	Returns the bounding volume type set with set_bounds_type(). More...

	get_child
	Returns the nth child node of this node. More...

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

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

	get_draw_show_mask
	Returns the hide/show bits of this particular node. More...

	get_effects

	get_internal_bounds

	get_internal_vertices

	get_into_collide_mask
	Returns the "into" collide mask for this node. More...

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

	get_nested_vertices

	get_num_children
	Returns the number of child nodes this node has. More...

	get_num_parents
	Returns the number of parent nodes this node has. More...

	get_num_stashed
	Returns the number of stashed nodes this node has. More...

	get_num_tags

	get_overall_bit

	get_parent
	Returns the nth parent node of this node. More...

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

	get_prev_transform

	get_python_tags

	get_stashed
	Returns the nth stashed child of this node. More...

	get_state

	get_tag

	get_tag_key

	get_transform

	has_tag

	is_bounds_stale

	is_final
	Returns the current state of the "final" flag. More...

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

virtual LPoint3 &	max_point

static BamReader *	reader = nullptr)

	set_effects
	Sets the complete RenderEffects that will be applied this node. More...

	set_final

	set_into_collide_mask
	Sets the "into" CollideMask. More...

	set_overall_hidden
	Sets or clears the hidden flag. More...

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

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

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

virtual LPoint3 bool const TransformState *	transform

Public Attributes inherited from TypedWritableReferenceCount
static BamReader *	reader = nullptr)

Public Attributes inherited from TypedObject
	get_type

Public Attributes inherited from ReferenceCount
	get_ref_count
	Returns the current reference count. More...

Public Attributes inherited from Namable
	get_name

	set_name

Friends
class	CullTraverserData

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 = nullptr

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 64 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, ShaderTerrainMesh, BulletDebugNode, GeomNode, ComputeNode, and CallbackNode.

Definition at line 478 of file pandaNode.cxx.

◆ 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 771 of file pandaNode.cxx.

References Thread::get_pipeline_stage.

◆ 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 1591 of file pandaNode.cxx.

◆ 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 288 of file pandaNode.cxx.

◆ as_light()

Light * PandaNode::as_light ( )

virtual

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.

Reimplemented in LightLensNode, and LightNode.

Definition at line 2101 of file pandaNode.cxx.

Referenced by GraphicsStateGuardian::fetch_specified_member(), and LightAttrib::~LightAttrib().

◆ 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 975 of file pandaNode.cxx.

◆ 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 498 of file pandaNode.I.

References set_bounds().

◆ clear_effect()

void PandaNode::clear_effect ( TypeHandle type )

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

Definition at line 1022 of file pandaNode.cxx.

◆ 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 1554 of file pandaNode.cxx.

◆ 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 325 of file pandaNode.cxx.

References TypedObject::is_exact_type().

Referenced by ModelNode::combine_with(), and PT().

◆ 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 1319 of file pandaNode.cxx.

References SimpleHashMap< Key, Value, Compare >::get_key(), and SimpleHashMap< Key, Value, Compare >::size().

◆ 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 1367 of file pandaNode.cxx.

Referenced by replace_node().

◆ copy_children()

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

Definition at line 916 of file pandaNode.cxx.

References get_children, PandaNode::Children::get_num_children(), and get_stashed.

◆ 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 1246 of file pandaNode.cxx.

◆ 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 190 of file pandaNode.cxx.

References make_copy().

◆ 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 90 of file pandaNode.I.

Referenced by 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 44 of file pandaNode.I.

Referenced by NodePathComponent::output().

◆ find_stashed()

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

inline

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

Definition at line 178 of file pandaNode.I.

Referenced by NodePath::get_stashed_ancestor(), NodePathComponent::output(), and unstash_child().

◆ 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 78 of file pandaNode.I.

◆ 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 574 of file pandaNode.I.

◆ 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 421 of file pandaNode.cxx.

◆ 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 1721 of file pandaNode.cxx.

References Thread::get_pipeline_stage.

◆ 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 1629 of file pandaNode.cxx.

References Thread::get_pipeline_stage.

◆ 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 1656 of file pandaNode.cxx.

References Thread::get_pipeline_stage.

◆ 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 432 of file pandaNode.cxx.

◆ 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 166 of file pandaNode.I.

◆ 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 1304 of file pandaNode.cxx.

◆ 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 1535 of file pandaNode.cxx.

◆ 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 274 of file pandaNode.cxx.

◆ 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 457 of file pandaNode.cxx.

◆ 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 409 of file pandaNode.cxx.

◆ 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 448 of file pandaNode.cxx.

◆ is_ambient_light()

bool PandaNode::is_ambient_light ( ) const

virtual

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

Reimplemented in AmbientLight.

Definition at line 2110 of file pandaNode.cxx.

◆ 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 2092 of file pandaNode.cxx.

◆ 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 2068 of file pandaNode.cxx.

◆ 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 2080 of file pandaNode.cxx.

◆ 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, ShaderTerrainMesh, BulletDebugNode, GeomNode, ComputeNode, PlaneNode, PGTop, RopeNode, PortalNode, CallbackNode, CollisionNode, SheetNode, and OccluderNode.

Definition at line 468 of file pandaNode.cxx.

◆ 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 1775 of file pandaNode.cxx.

Referenced by 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 1792 of file pandaNode.cxx.

References get_parents, and is_scene_root().

◆ list_tags()

void PandaNode::list_tags	(	std::ostream &	out,
		const std::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 1283 of file pandaNode.cxx.

◆ make_copy()

PandaNode * PandaNode::make_copy ( ) const

virtual

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.

Reimplemented in BulletRigidBodyNode, SpeedTreeNode, PolylightNode, DataNode, ProjectionScreen, ModelRoot, NurbsCurve, Fog, ForceNode, PhysicalNode, PGScrollFrame, Character, ComputeNode, PGTop, PGEntry, PlaneNode, RopeNode, Camera, CallbackNode, SheetNode, GeomNode, LensNode, OccluderNode, PortalNode, Spotlight, PGSliderBar, CollisionNode, ModelNode, SequenceNode, AnimBundleNode, PGButton, LODNode, RectangleLight, SphereLight, UvScrollNode, PGWaitBar, AmbientLight, DirectionalLight, PointLight, SwitchNode, and FadeLODNode.

Definition at line 487 of file pandaNode.cxx.

Referenced by dupe_for_flatten().

◆ 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 262 of file pandaNode.cxx.

◆ r_prepare_scene()

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

virtual

The recursive implementation of prepare_scene().

Don't call this directly; call PandaNode::prepare_scene() or NodePath::prepare_scene() instead.

Reimplemented in TextNode, and GeomNode.

Definition at line 2442 of file pandaNode.cxx.

References get_children.

Referenced by TextNode::r_prepare_scene().

◆ register_with_read_factory()

void PandaNode::register_with_read_factory ( )

static

Tells the BamReader how to create objects of type PandaNode.

Definition at line 3580 of file pandaNode.cxx.

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

Referenced by init_libpgraph(), and init_libpgraphnodes().

◆ 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 836 of file pandaNode.cxx.

Referenced by MouseWatcherBase::clear_regions(), GeoMipTerrain::generate(), ProjectionScreen::regenerate_screen(), and GeoMipTerrain::update().

◆ remove_child() [1/2]

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

Removes the nth child from the node.

Definition at line 570 of file pandaNode.cxx.

References Thread::get_pipeline_stage.

Referenced by LensNode::hide_frustum(), PGScrollFrame::setup(), PGSliderBar::setup_scroll_bar(), and PGSliderBar::setup_slider().

◆ 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 602 of file pandaNode.cxx.

◆ 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 806 of file pandaNode.cxx.

References Thread::get_pipeline_stage.

◆ 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 638 of file pandaNode.cxx.

◆ 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 1460 of file pandaNode.cxx.

References 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 1176 of file pandaNode.cxx.

◆ reset_prev_transform()

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

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

Definition at line 1153 of file pandaNode.cxx.

Referenced by AccumulatedAttribs::apply_to_node().

◆ 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, ShaderTerrainMesh, GeomNode, BulletDebugNode, ComputeNode, ModelNode, CallbackNode, SequenceNode, BulletBaseCharacterControllerNode, LODNode, UvScrollNode, and SwitchNode.

Definition at line 234 of file pandaNode.cxx.

◆ 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, SequenceNode, BulletBaseCharacterControllerNode, LODNode, and SwitchNode.

Definition at line 244 of file pandaNode.cxx.

◆ 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, ShaderTerrainMesh, ParametricCurve, GeomNode, BulletDebugNode, ForceNode, PhysicalNode, Camera, ModelNode, AnimBundleNode, BulletBaseCharacterControllerNode, and UvScrollNode.

Definition at line 201 of file pandaNode.cxx.

◆ 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 253 of file pandaNode.cxx.

◆ 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, BulletDebugNode, ModelNode, and BulletBaseCharacterControllerNode.

Definition at line 223 of file pandaNode.cxx.

◆ 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, BulletDebugNode, RopeNode, Camera, SheetNode, ModelNode, and BulletBaseCharacterControllerNode.

Definition at line 210 of file pandaNode.cxx.

◆ 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 944 of file pandaNode.cxx.

Referenced by AccumulatedAttribs::apply_to_node(), WindowFramework::get_render(), FrameRateMeter::setup_window(), and SceneGraphAnalyzerMeter::setup_window().

◆ set_bound()

void PandaNode::set_bound ( const BoundingVolume * volume )

Deprecated.

Use set_bounds() instead.

Definition at line 1932 of file pandaNode.cxx.

References 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 1913 of file pandaNode.cxx.

Referenced by clear_bounds(), set_bound(), and ShaderTerrainMesh::ShaderTerrainMesh().

◆ 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 1878 of file pandaNode.cxx.

◆ set_effect()

void PandaNode::set_effect ( const RenderEffect * effect )

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

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

Definition at line 1005 of file pandaNode.cxx.

Referenced by CharacterJoint::add_local_transform(), CharacterJoint::add_net_transform(), and GraphicsOutput::make_cube_map().

◆ 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 1124 of file pandaNode.cxx.

◆ 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 3572 of file pandaNode.cxx.

◆ 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 1519 of file pandaNode.cxx.

◆ 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 107 of file pandaNode.I.

References find_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 688 of file pandaNode.cxx.

References Thread::get_pipeline_stage.

◆ 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 881 of file pandaNode.cxx.

References get_num_children.

◆ 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 128 of file pandaNode.I.

References find_stashed().

◆ 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 728 of file pandaNode.cxx.

References Thread::get_pipeline_stage.

◆ 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 3601 of file pandaNode.cxx.

◆ write_datagram()

void PandaNode::write_datagram	(	BamWriter *	manager,
		Datagram &	dg
	)

virtual

Writes the contents of this object to the datagram for shipping out to a Bam file.

Reimplemented from TypedWritable.

Reimplemented in SpeedTreeNode, RopeNode, LODNode, GeomNode, BulletBodyNode, Character, BulletRigidBodyNode, PortalNode, Camera, BulletDebugNode, PolylightNode, PlaneNode, DataNode, Spotlight, CollisionNode, SheetNode, Fog, ComputeNode, LightLensNode, PointLight, OccluderNode, DirectionalLight, MouseRecorder, LensNode, CallbackNode, RectangleLight, ModelNode, PartBundleNode, FadeLODNode, SphereLight, SwitchNode, ModelRoot, UvScrollNode, AnimBundleNode, SequenceNode, AmbientLight, and LightNode.

Definition at line 3589 of file pandaNode.cxx.

References Datagram::add_string(), BamWriter::write_cdata(), and TypedWritable::write_datagram().

◆ write_recorder()

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

This method is provided for the benefit of classes (like MouseRecorder) that inherit from PandaMode and also RecorderBase.

It's not virtual at this level since it doesn't need to be (it's called up from the derived class).

This method acts very like write_datagram, but it writes the node as appropriate for writing a RecorderBase object as described in the beginning of a session file, meaning it doesn't need to write things such as children. It balances with fillin_recorder().

Definition at line 3618 of file pandaNode.cxx.

References Datagram::add_string().

Referenced by MouseRecorder::write_recorder().

◆ 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, Fog, PGScrollFrame, PartBundleNode, PGEntry, GeomNode, PlaneNode, OccluderNode, PortalNode, PGSliderBar, CollisionNode, Spotlight, LODNode, LensNode, SphereLight, DirectionalLight, and PointLight.

Definition at line 310 of file pandaNode.cxx.

Referenced by SpeedTreeNode::apply_attribs_to_vertices().

Member Data Documentation

◆ clear_tag

void PandaNode::clear_tag

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 207 of file pandaNode.h.

◆ get_all_camera_mask

DrawMask PandaNode::get_all_camera_mask

inline

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

Definition at line 247 of file pandaNode.h.

◆ get_bounds_type

BoundingVolume::BoundsType PandaNode::get_bounds_type

Returns the bounding volume type set with set_bounds_type().

Definition at line 293 of file pandaNode.h.

◆ get_child

PandaNode * PandaNode::get_child

inline

Returns the nth child node of this node.

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

Definition at line 124 of file pandaNode.h.

◆ get_children

PandaNode::Children PandaNode::get_children

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 784 of file pandaNode.h.

Referenced by RigidBodyCombiner::collect(), copy_children(), CPT(), r_prepare_scene(), and DataGraphTraverser::traverse_below().

◆ get_draw_control_mask

DrawMask PandaNode::get_draw_control_mask

inline

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

See adjust_draw_mask().

Definition at line 255 of file pandaNode.h.

Referenced by NodePath::get_hidden_ancestor().

◆ get_draw_show_mask

DrawMask PandaNode::get_draw_show_mask

inline

Returns the hide/show bits of this particular node.

See adjust_draw_mask().

Definition at line 256 of file pandaNode.h.

Referenced by NodePath::get_hidden_ancestor().

◆ get_into_collide_mask

CollideMask PandaNode::get_into_collide_mask

inline

Returns the "into" collide mask for this node.

Definition at line 264 of file pandaNode.h.

◆ get_legal_collide_mask

CollideMask PandaNode::get_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.

Definition at line 265 of file pandaNode.h.

◆ get_num_children

int PandaNode::get_num_children

inline

Returns the number of child nodes this node has.

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

Definition at line 124 of file pandaNode.h.

Referenced by SelectiveChildNode::get_next_visible_child(), SequenceNode::get_num_frames(), and steal_children().

◆ get_num_parents

int PandaNode::get_num_parents

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 118 of file pandaNode.h.

Referenced by Fog::adjust_to_camera().

◆ get_num_stashed

int PandaNode::get_num_stashed

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 148 of file pandaNode.h.

◆ get_parent

PandaNode * PandaNode::get_parent

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 118 of file pandaNode.h.

◆ get_parents

PandaNode::Parents PandaNode::get_parents

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 786 of file pandaNode.h.

Referenced by CPT(), and is_under_scene_root().

◆ get_stashed

PandaNode::Stashed PandaNode::get_stashed

inline

Returns the nth stashed child of this node.

Returns an object that can be used to walk through the list of children of the 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.

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 148 of file pandaNode.h.

Referenced by copy_children(), and PandaNodePipelineReader::find_stashed().

◆ is_final

bool PandaNode::is_final

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 314 of file pandaNode.h.

◆ is_overall_hidden

bool PandaNode::is_overall_hidden

inline

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

Definition at line 248 of file pandaNode.h.

Referenced by BulletDebugNode::draw_mask_changed(), and NodePath::get_hidden_ancestor().

◆ set_effects

void PandaNode::set_effects

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 178 of file pandaNode.h.

◆ set_into_collide_mask

void PandaNode::set_into_collide_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 264 of file pandaNode.h.

◆ set_overall_hidden

void PandaNode::set_overall_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 248 of file pandaNode.h.

◆ set_state

void PandaNode::set_state

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 173 of file pandaNode.h.

Referenced by AccumulatedAttribs::apply_to_node().

◆ set_tag

void PandaNode::set_tag

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 207 of file pandaNode.h.

◆ set_transform

void PandaNode::set_transform

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.

Definition at line 183 of file pandaNode.h.

Referenced by CharacterJoint::add_local_transform(), CharacterJoint::add_net_transform(), AccumulatedAttribs::apply_to_node(), and ActorNode::update_transform().

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

panda/src/pgraph/pandaNode.h
panda/src/pgraph/pandaNode.cxx
panda/src/pgraph/pandaNode.I

Classes

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Friends

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ add_for_draw()

◆ add_stashed()

◆ adjust_draw_mask()

◆ apply_attribs_to_vertices()

◆ as_light()

◆ clear_attrib()

◆ clear_bounds()

◆ clear_effect()

◆ clear_unexpected_change()

◆ combine_with()

◆ compare_tags()

◆ copy_all_properties()

◆ copy_children()

◆ copy_tags()

◆ dupe_for_flatten()

◆ find_child()

◆ find_parent()

◆ find_stashed()

◆ get_child_sort()

◆ get_fancy_bits()

◆ get_first_visible_child()

◆ get_net_collide_mask()

◆ get_net_draw_control_mask()

◆ get_net_draw_show_mask()

◆ get_next_visible_child()

◆ get_stashed_sort()

◆ get_tag_keys()

◆ get_unexpected_change()

◆ get_unsafe_to_apply_attribs()

◆ get_visible_child()

◆ has_selective_visibility()

◆ has_single_child_visibility()

◆ is_ambient_light()

◆ is_collision_node()

◆ is_geom_node()

◆ is_lod_node()

◆ is_renderable()

◆ is_scene_root()

◆ is_under_scene_root()

◆ list_tags()

◆ make_copy()

◆ preserve_name()

◆ r_prepare_scene()

◆ register_with_read_factory()

◆ remove_all_children()

◆ remove_child() [1/2]

◆ remove_child() [2/2]

◆ remove_stashed()

◆ replace_child()

◆ replace_node()

◆ reset_all_prev_transform()

◆ reset_prev_transform()

◆ safe_to_combine()

◆ safe_to_combine_children()

◆ safe_to_flatten()

◆ safe_to_flatten_below()

◆ safe_to_modify_transform()

◆ safe_to_transform()

◆ set_attrib()

◆ set_bound()

◆ set_bounds()

◆ set_bounds_type()

◆ set_effect()

◆ set_prev_transform()

◆ set_scene_root_func()

◆ set_unexpected_change()

◆ stash_child() [1/2]

◆ stash_child() [2/2]

◆ steal_children()

◆ unstash_child() [1/2]

◆ unstash_child() [2/2]