This is a set of zero or more NodePaths. More...

#include "nodePathCollection.h"

Public Member Functions
void	add_path (const NodePath &node_path)
	Adds a new NodePath to the collection. More...

void	add_paths_from (const NodePathCollection &other)
	Adds all the NodePaths indicated in the other collection to this path. More...

void	append (const NodePath &node_path)
	Adds a new NodePath to the collection. More...

bool	calc_tight_bounds (LPoint3 &min_point, LPoint3 &max_point) const
	Calculates the minimum and maximum vertices of all Geoms at these NodePath's bottom nodes and below This is a tight bounding box; it will generally be tighter than the bounding volume returned by get_bounds() (but it is more expensive to compute). More...

void	clear ()
	Removes all NodePaths from the collection. More...

void	compose_color_scale (PN_stdfloat r, PN_stdfloat g, PN_stdfloat b, PN_stdfloat a=1.0, int priority=0)
	Applies color scales to all NodePaths in the collection. More...

void	compose_color_scale (const LVecBase4 &scale, int priority=0)
	Applies color scales to all NodePaths in the collection. More...

void	detach ()
	Detaches all NodePaths in the collection. More...

void	extend (const NodePathCollection &other)
	Appends the other list onto the end of this one. More...

NodePathCollection	find_all_matches (const std::string &path) const
	Returns the complete set of all NodePaths that begin with any NodePath in this collection and can be extended by path. More...

CollideMask	get_collide_mask () const
	Returns the union of all of the into_collide_masks for nodes at this level and below. More...

int	get_num_paths () const

NodePath	get_path (int index) const

bool	has_path (const NodePath &path) const
	Returns true if the indicated NodePath appears in this collection, false otherwise. More...

void	hide ()
	Hides all NodePaths in the collection. More...

bool	is_empty () const
	Returns true if there are no NodePaths in the collection, false otherwise. More...

void	ls () const
	Lists all the nodes at and below each node in the collection hierarchically. More...

void	ls (std::ostream &out, int indent_level=0) const
	Lists all the nodes at and below each node in the collection hierarchically. More...

NodePath	operator [] (size_t index) const
	Returns the nth NodePath in the collection. More...

NodePathCollection	operator+ (const NodePathCollection &other) const
	Returns a NodePathCollection representing the concatenation of the two lists. More...

void	operator+= (const NodePathCollection &other)
	Appends the other list onto the end of this one. More...

void	output (std::ostream &out) const
	Writes a brief one-line description of the NodePathCollection to the indicated output stream. More...

void	remove_duplicate_paths ()
	Removes any duplicate entries of the same NodePaths on this collection. More...

bool	remove_path (const NodePath &node_path)
	Removes the indicated NodePath from the collection. More...

void	remove_paths_from (const NodePathCollection &other)
	Removes from this collection all of the NodePaths listed in the other collection. More...

void	reparent_to (const NodePath &other)
	Reparents all the NodePaths in the collection to the indicated node. More...

void	reserve (size_t num)
	This is a hint to Panda to allocate enough memory to hold the given number of NodePaths, if you know ahead of time how many you will be adding. More...

void	set_attrib (const RenderAttrib *attrib, int priority=0)
	Applies the indicated RenderAttrib to all NodePaths in the collection. More...

void	set_collide_mask (CollideMask new_mask, CollideMask bits_to_change=CollideMask::all_on(), TypeHandle node_type=TypeHandle::none())
	Recursively applies the indicated CollideMask to the into_collide_masks for all nodes at this level and below. More...

void	set_color (PN_stdfloat r, PN_stdfloat g, PN_stdfloat b, PN_stdfloat a=1.0, int priority=0)
	Colors all NodePaths in the collection. More...

void	set_color (const LColor &color, int priority=0)
	Colors all NodePaths in the collection. More...

void	set_color_scale (PN_stdfloat r, PN_stdfloat g, PN_stdfloat b, PN_stdfloat a=1.0, int priority=0)
	Applies color scales to all NodePaths in the collection. More...

void	set_color_scale (const LVecBase4 &scale, int priority=0)
	Applies color scales to all NodePaths in the collection. More...

void	set_texture (Texture *tex, int priority=0)
	Adds the indicated texture to the list of textures that will be rendered on the default texture stage. More...

void	set_texture (TextureStage stage, Texture tex, int priority=0)
	Adds the indicated texture to the list of textures that will be rendered on the indicated multitexture stage. More...

void	set_texture_off (int priority=0)
	Sets the geometry at this level and below to render using no texture, on any stage. More...

void	set_texture_off (TextureStage *stage, int priority=0)
	Sets the geometry at this level and below to render using no texture, on the indicated stage. More...

void	show ()
	Shows all NodePaths in the collection. More...

size_t	size () const
	Returns the number of paths in the collection. More...

void	stash ()
	Stashes all NodePaths in the collection. More...

void	unstash ()
	Unstashes all NodePaths in the collection. More...

void	write (std::ostream &out, int indent_level=0) const
	Writes a complete multi-line description of the NodePathCollection to the indicated output stream. More...

void	wrt_reparent_to (const NodePath &other)
	Reparents all the NodePaths in the collection to the indicated node, adjusting each transform so as not to move in world coordinates. More...

Public Attributes
	get_num_paths
	Returns the number of NodePaths in the collection. More...

	get_path
	Returns the nth NodePath in the collection. More...

Detailed Description

This is a set of zero or more NodePaths.

It's handy for returning from functions that need to return multiple NodePaths (for instance, NodePaths::get_children).

Definition at line 26 of file nodePathCollection.h.

Member Function Documentation

◆ add_path()

void NodePathCollection::add_path ( const NodePath & node_path )

Adds a new NodePath to the collection.

Definition at line 29 of file nodePathCollection.cxx.

Referenced by append(), FindApproxLevelEntry::consider_node(), CharacterJoint::get_local_transforms(), and CharacterJoint::get_net_transforms().

◆ add_paths_from()

void NodePathCollection::add_paths_from ( const NodePathCollection & other )

Adds all the NodePaths indicated in the other collection to this path.

The other paths are simply appended to the end of the paths in this list; duplicates are not automatically removed.

Definition at line 81 of file nodePathCollection.cxx.

References get_num_paths.

Referenced by operator+=().

◆ append()

void NodePathCollection::append ( const NodePath & node_path )

inline

Adds a new NodePath to the collection.

This method duplicates the add_path() method; it is provided to satisfy Python's naming convention.

Definition at line 38 of file nodePathCollection.I.

References add_path().

◆ calc_tight_bounds()

bool NodePathCollection::calc_tight_bounds	(	LPoint3 &	min_point,
		LPoint3 &	max_point
	)		const

Calculates the minimum and maximum vertices of all Geoms at these NodePath's bottom nodes and below This is a tight bounding box; it will generally be tighter than the bounding volume returned by get_bounds() (but it is more expensive to compute).

The return value is true if any points are within the bounding volume, or false if none are.

Definition at line 362 of file nodePathCollection.cxx.

◆ clear()

void NodePathCollection::clear ( )

Removes all NodePaths from the collection.

Definition at line 150 of file nodePathCollection.cxx.

◆ compose_color_scale() [1/2]

void NodePathCollection::compose_color_scale	(	PN_stdfloat	r,
		PN_stdfloat	g,
		PN_stdfloat	b,
		PN_stdfloat	a = `1.0`,
		int	priority = `0`
	)

inline

Applies color scales to all NodePaths in the collection.

The existing color scale, if any, is multiplied by the specified color scale.

Definition at line 82 of file nodePathCollection.I.

◆ compose_color_scale() [2/2]

void NodePathCollection::compose_color_scale	(	const LVecBase4 &	scale,
		int	priority = `0`
	)

Applies color scales to all NodePaths in the collection.

The existing color scale, if any, is multiplied by the specified color scale.

Definition at line 512 of file nodePathCollection.cxx.

◆ detach()

void NodePathCollection::detach ( )

Detaches all NodePaths in the collection.

Definition at line 314 of file nodePathCollection.cxx.

◆ extend()

void NodePathCollection::extend ( const NodePathCollection & other )

inline

Appends the other list onto the end of this one.

This method duplicates the += operator; it is provided to satisfy Python's naming convention.

Definition at line 47 of file nodePathCollection.I.

References operator+=().

◆ find_all_matches()

NodePathCollection NodePathCollection::find_all_matches ( const std::string & path ) const

Returns the complete set of all NodePaths that begin with any NodePath in this collection and can be extended by path.

The shortest paths will be listed first.

Definition at line 229 of file nodePathCollection.cxx.

References FindApproxPath::add_string(), and is_empty().

◆ get_collide_mask()

CollideMask NodePathCollection::get_collide_mask ( ) const

Returns the union of all of the into_collide_masks for nodes at this level and below.

This is the same thing as node()->get_net_collide_mask().

If you want to return what the into_collide_mask of this node itself is, without regard to its children, use node()->get_into_collide_mask().

Definition at line 328 of file nodePathCollection.cxx.

◆ has_path()

bool NodePathCollection::has_path ( const NodePath & path ) const

Returns true if the indicated NodePath appears in this collection, false otherwise.

Definition at line 137 of file nodePathCollection.cxx.

◆ hide()

void NodePathCollection::hide ( )

Hides all NodePaths in the collection.

Definition at line 284 of file nodePathCollection.cxx.

◆ is_empty()

bool NodePathCollection::is_empty ( ) const

Returns true if there are no NodePaths in the collection, false otherwise.

Definition at line 167 of file nodePathCollection.cxx.

Referenced by find_all_matches().

◆ ls() [1/2]

void NodePathCollection::ls ( ) const

inline

Lists all the nodes at and below each node in the collection hierarchically.

Definition at line 56 of file nodePathCollection.I.

◆ ls() [2/2]

void NodePathCollection::ls	(	std::ostream &	out,
		int	indent_level = `0`
	)		const

Lists all the nodes at and below each node in the collection hierarchically.

Definition at line 214 of file nodePathCollection.cxx.

◆ operator []()

NodePath NodePathCollection::operator [] ( size_t index ) const

Returns the nth NodePath in the collection.

This is the same as get_path(), but it may be a more convenient way to access it.

Definition at line 194 of file nodePathCollection.cxx.

◆ operator+()

NodePathCollection NodePathCollection::operator+ ( const NodePathCollection & other ) const

inline

Returns a NodePathCollection representing the concatenation of the two lists.

Definition at line 27 of file nodePathCollection.I.

◆ operator+=()

void NodePathCollection::operator+= ( const NodePathCollection & other )

inline

Appends the other list onto the end of this one.

Definition at line 18 of file nodePathCollection.I.

References add_paths_from().

Referenced by extend().

◆ output()

void NodePathCollection::output ( std::ostream & out ) const

Writes a brief one-line description of the NodePathCollection to the indicated output stream.

Definition at line 563 of file nodePathCollection.cxx.

References get_num_paths.

◆ remove_duplicate_paths()

void NodePathCollection::remove_duplicate_paths ( )

Removes any duplicate entries of the same NodePaths on this collection.

If a NodePath appears multiple times, the first appearance is retained; subsequent appearances are removed.

Definition at line 112 of file nodePathCollection.cxx.

References get_num_paths.

◆ remove_path()

bool NodePathCollection::remove_path ( const NodePath & node_path )

Removes the indicated NodePath from the collection.

Returns true if the path was removed, false if it was not a member of the collection.

Definition at line 48 of file nodePathCollection.cxx.

◆ remove_paths_from()

void NodePathCollection::remove_paths_from ( const NodePathCollection & other )

Removes from this collection all of the NodePaths listed in the other collection.

Definition at line 94 of file nodePathCollection.cxx.

References get_num_paths.

◆ reparent_to()

void NodePathCollection::reparent_to ( const NodePath & other )

Reparents all the NodePaths in the collection to the indicated node.

Definition at line 253 of file nodePathCollection.cxx.

◆ reserve()

void NodePathCollection::reserve ( size_t num )

This is a hint to Panda to allocate enough memory to hold the given number of NodePaths, if you know ahead of time how many you will be adding.

Definition at line 159 of file nodePathCollection.cxx.

◆ set_attrib()

void NodePathCollection::set_attrib	(	const RenderAttrib *	attrib,
		int	priority = `0`
	)

Applies the indicated RenderAttrib to all NodePaths in the collection.

An effort is made to apply the attrib to many NodePaths as quickly as possible; redundant RenderState compositions are not duplicated.

Definition at line 538 of file nodePathCollection.cxx.

Referenced by set_color().

◆ set_collide_mask()

void NodePathCollection::set_collide_mask	(	CollideMask	new_mask,
		CollideMask	bits_to_change = `CollideMask::all_on()`,
		TypeHandle	node_type = `TypeHandle::none()`
	)

Recursively applies the indicated CollideMask to the into_collide_masks for all nodes at this level and below.

The default is to change all bits, but if bits_to_change is not all bits on, then only the bits that are set in bits_to_change are modified, allowing this call to change only a subset of the bits in the subgraph.

Definition at line 345 of file nodePathCollection.cxx.

◆ set_color() [1/2]

void NodePathCollection::set_color	(	PN_stdfloat	r,
		PN_stdfloat	g,
		PN_stdfloat	b,
		PN_stdfloat	a = `1.0`,
		int	priority = `0`
	)

inline

Colors all NodePaths in the collection.

Definition at line 64 of file nodePathCollection.I.

◆ set_color() [2/2]

void NodePathCollection::set_color	(	const LColor &	color,
		int	priority = `0`
	)

Colors all NodePaths in the collection.

Definition at line 478 of file nodePathCollection.cxx.

References set_attrib().

◆ set_color_scale() [1/2]

void NodePathCollection::set_color_scale	(	PN_stdfloat	r,
		PN_stdfloat	g,
		PN_stdfloat	b,
		PN_stdfloat	a = `1.0`,
		int	priority = `0`
	)

inline

Applies color scales to all NodePaths in the collection.

The existing color scale is replaced.

Definition at line 73 of file nodePathCollection.I.

◆ set_color_scale() [2/2]

void NodePathCollection::set_color_scale	(	const LVecBase4 &	scale,
		int	priority = `0`
	)

Applies color scales to all NodePaths in the collection.

The existing color scale is replaced.

Definition at line 487 of file nodePathCollection.cxx.

◆ set_texture() [1/2]

void NodePathCollection::set_texture	(	Texture *	tex,
		int	priority = `0`
	)

Adds the indicated texture to the list of textures that will be rendered on the default texture stage.

This is the deprecated single-texture variant of this method; it is now superceded by set_texture() that accepts a stage and texture. However, this method may be used in the presence of multitexture if you just want to adjust the default stage.

Definition at line 402 of file nodePathCollection.cxx.

◆ set_texture() [2/2]

void NodePathCollection::set_texture	(	TextureStage *	stage,
		Texture *	tex,
		int	priority = `0`
	)

Adds the indicated texture to the list of textures that will be rendered on the indicated multitexture stage.

If there are multiple texture stages specified (possibly on multiple different nodes at different levels), they will all be applied to geometry together, according to the stage specification set up in the TextureStage object.

Definition at line 415 of file nodePathCollection.cxx.

◆ set_texture_off() [1/2]

void NodePathCollection::set_texture_off ( int priority = 0 )

Sets the geometry at this level and below to render using no texture, on any stage.

This is different from not specifying a texture; rather, this specifically contradicts set_texture() at a higher node level (or, with a priority, overrides a set_texture() at a lower level).

Definition at line 442 of file nodePathCollection.cxx.

◆ set_texture_off() [2/2]

void NodePathCollection::set_texture_off	(	TextureStage *	stage,
		int	priority = `0`
	)

Sets the geometry at this level and below to render using no texture, on the indicated stage.

This is different from not specifying a texture; rather, this specifically contradicts set_texture() at a higher node level (or, with a priority, overrides a set_texture() at a lower level).

Definition at line 454 of file nodePathCollection.cxx.

◆ show()

void NodePathCollection::show ( )

Shows all NodePaths in the collection.

Definition at line 274 of file nodePathCollection.cxx.

◆ size()

size_t NodePathCollection::size ( ) const

Returns the number of paths in the collection.

This is the same thing as get_num_paths().

Definition at line 205 of file nodePathCollection.cxx.

◆ stash()

void NodePathCollection::stash ( )

Stashes all NodePaths in the collection.

Definition at line 294 of file nodePathCollection.cxx.

◆ unstash()

void NodePathCollection::unstash ( )

Unstashes all NodePaths in the collection.

Definition at line 304 of file nodePathCollection.cxx.

Referenced by NodePath::unstash_all().

◆ write()

void NodePathCollection::write	(	std::ostream &	out,
		int	indent_level = `0`
	)		const

Writes a complete multi-line description of the NodePathCollection to the indicated output stream.

Definition at line 576 of file nodePathCollection.cxx.

◆ wrt_reparent_to()

void NodePathCollection::wrt_reparent_to ( const NodePath & other )

Reparents all the NodePaths in the collection to the indicated node, adjusting each transform so as not to move in world coordinates.

Definition at line 264 of file nodePathCollection.cxx.

Member Data Documentation

◆ get_num_paths

int NodePathCollection::get_num_paths

Returns the number of NodePaths in the collection.

Definition at line 47 of file nodePathCollection.h.

Referenced by add_paths_from(), FindApproxLevelEntry::consider_node(), output(), remove_duplicate_paths(), and remove_paths_from().

◆ get_path

NodePath NodePathCollection::get_path

Returns the nth NodePath in the collection.

Definition at line 47 of file nodePathCollection.h.

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

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

Public Member Functions

Public Attributes

Detailed Description

Member Function Documentation

◆ add_path()

◆ add_paths_from()

◆ append()

◆ calc_tight_bounds()

◆ clear()

◆ compose_color_scale() [1/2]

◆ compose_color_scale() [2/2]

◆ detach()

◆ extend()

◆ find_all_matches()

◆ get_collide_mask()

◆ has_path()

◆ hide()

◆ is_empty()

◆ ls() [1/2]

◆ ls() [2/2]

◆ operator []()

◆ operator+()

◆ operator+=()

◆ output()

◆ remove_duplicate_paths()

◆ remove_path()

◆ remove_paths_from()

◆ reparent_to()

◆ reserve()

◆ set_attrib()

◆ set_collide_mask()

◆ set_color() [1/2]

◆ set_color() [2/2]

◆ set_color_scale() [1/2]

◆ set_color_scale() [2/2]

◆ set_texture() [1/2]

◆ set_texture() [2/2]

◆ set_texture_off() [1/2]

◆ set_texture_off() [2/2]

◆ show()

◆ size()

◆ stash()

◆ unstash()

◆ write()

◆ wrt_reparent_to()

Member Data Documentation

◆ get_num_paths

◆ get_path