Interfaces with the SpeedTree library to render SpeedTree objects, especially trees, within the Panda3D scene graph. More...

#include "speedTreeNode.h"

Inheritance diagram for SpeedTreeNode:

Classes
class	InstanceList

Public Member Functions
	SpeedTreeNode (const std::string &name)

	SpeedTreeNode (const SpeedTreeNode &copy)

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

bool	add_from_stf (const Filename &stf_filename, const LoaderOptions &options=LoaderOptions())
	Opens and reads the named STF (SpeedTree Forest) file, and adds the SRT files named within as instances of this node. More...

bool	add_from_stf (std::istream &in, const Filename &pathname, const LoaderOptions &options=LoaderOptions(), Loader *loader=nullptr)
	Reads text data from the indicated stream, which is understood to represent the named STF (SpeedTree Forest) file, and adds the SRT files named within as instances of this node. More...

void	add_instance (const STTree *tree, const STTransform &transform)
	Adds a new instance of the indicated tree at the indicated transform. More...

void	add_instances (const NodePath &root, const TransformState *transform=TransformState::make_identity())
	Walks the scene graph beginning at root, looking for nested SpeedTreeNodes. More...

void	add_instances_from (const SpeedTreeNode *other)
	Adds all of the instances defined within the indicated SpeedTreeNode as instances of this node. More...

void	add_instances_from (const SpeedTreeNode other, const TransformState transform)
	Adds all of the instances defined within the indicated SpeedTreeNode as instances of this node, after applying the indicated scene-graph transform. More...

void	add_random_instances (const STTree *tree, int quantity, PN_stdfloat x_min, PN_stdfloat x_max, PN_stdfloat y_min, PN_stdfloat y_max, PN_stdfloat scale_min, PN_stdfloat scale_max, PN_stdfloat height_min, PN_stdfloat height_max, PN_stdfloat slope_min, PN_stdfloat slope_max, Randomizer &randomizer=Randomizer())
	Creates a number of random instances of the indicated true, within the indicated range. More...

InstanceList &	add_tree (const STTree *tree)
	Adds a new tree for rendering. 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...

void	clear_terrain ()
	Removes the terrain associated with the node. More...

virtual PandaNode *	combine_with (PandaNode *other)
	Collapses this node with the other node, if possible, and returns a pointer to the combined node, or NULL if the two nodes cannot safely be combined. More...

virtual void	compute_internal_bounds (CPT(BoundingVolume) &internal_bounds, int &internal_vertices, int pipeline_stage, Thread *current_thread) const
	Returns a newly-allocated BoundingVolume that represents the internal contents of the node. More...

int	count_total_instances () const
	Returns the total number of trees that will be rendered by this node, counting all instances of all trees. More...

virtual bool	cull_callback (CullTraverser *trav, CullTraverserData &data)
	This function will be called during the cull traversal to perform any additional operations that should be performed at cull time. More...

virtual TypeHandle	force_init_type ()

const InstanceList &	get_instance_list (int n) const

const InstanceList &	get_instance_list (const STTree *tree) const

int	get_num_trees () const

STTerrain *	get_terrain () const
	Returns the terrain associated with the node, or NULL if there is no terrain. More...

double	get_time_delta () const

const STTree *	get_tree (int n) const

virtual TypeHandle	get_type () const

bool	has_instance_list (const STTree *tree) const
	Returns true if the indicated tree has any instances within this node, false otherwise. More...

bool	has_terrain () const
	Returns true if a valid terrain has been associated with the node, false otherwise. More...

virtual bool	is_renderable () const
	Returns true if there is some value to visiting this particular node during the cull traversal for any camera, false otherwise. More...

bool	is_valid () const
	Returns true if the node is valid and ready to render, false otherwise. More...

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

InstanceList &	modify_instance_list (const STTree *tree)
	Returns a modifiable list of transforms that corresponds to the instances of this tree. More...

STTree *	modify_tree (int n)
	Returns a modifiable STTree pointer for the nth tree instance. More...

virtual void	output (std::ostream &out) const
	Writes a brief description of the node to the indicated output stream. More...

void	prepare_scene (GraphicsStateGuardianBase gsgbase, const RenderState net_state)
	Walks through the scene graph beginning at this node, and does whatever initialization is required to render the scene properly with the indicated GSG. More...

void	reload_config ()
	Re-reads the current setting of all of the relevant config variables and applies them to this node. More...

void	remove_all_trees ()
	Removes all instances of all trees from the node. More...

int	remove_tree (const STTree *tree)
	Removes all instances of the indicated tree. More...

void	set_terrain (STTerrain *terrain)
	Associated a terrain with the node. More...

void	set_time_delta (double delta)

void	set_wind (double strength, const LVector3 &direction)
	Specifies the overall wind strength and direction. More...

bool	setup_terrain (const Filename &terrain_file)
	A convenience function to set up terrain geometry by reading a terrain.txt file as defined by SpeedTree. More...

void	snap_to_terrain ()
	Adjusts all the trees in this node so that their Z position matches the height of the terrain at their X, Y position. 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...

Public Member Functions inherited from PandaNode
	PandaNode (const std::string &name)

void	add_child (PandaNode child_node, int sort=0, Thread current_thread=Thread::get_current_thread())

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

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

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

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

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

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

void	mark_internal_bounds_stale (Thread *current_thread=Thread::get_current_thread())

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

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 bool	authorize (const std::string &license="")
	Make this call to initialized the SpeedTree API and verify the license. More...

static TypeHandle	get_class_type ()

static double	get_global_time_delta ()

static void	init_type ()

static void	register_with_read_factory ()
	Tells the BamReader how to create objects of type SpeedTreeNode. More...

static void	set_global_time_delta (double delta)

static void	write_error (std::ostream &out)
	Writes the current SpeedTree error message to the indicated stream. More...

Static Public Member Functions inherited from PandaNode
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
	get_global_time_delta
	Returns an offset that is to be added each frame to the global clock's frame_time for the purpose of animating the trees in all SpeedTreeNodes. More...

	get_instance_list
	Returns a list of transforms that corresponds to the instances at which the indicated tree appears. More...

	get_num_trees
	Returns the number of unique tree objects that have been added to the node. More...

	get_time_delta
	Returns an offset that is to be added each frame to the global clock's frame_time for the purpose of animating the trees in this particular node. More...

	get_tree
	Returns the STTree pointer for the nth tree. More...

	set_global_time_delta
	Specifies an offset that is to be added each frame to the global clock's frame_time for the purpose of animating the trees in all SpeedTreeNodes. More...

	set_time_delta
	Specifies an offset that is to be added each frame to the global clock's frame_time for the purpose of animating the trees in this particular node. More...

Public Attributes inherited from PandaNode
	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	SpeedTreeNode::DrawCallback

Additional Inherited Members
Public Types inherited from PandaNode
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 }

Static Public Attributes inherited from TypedWritable
static TypedWritable *const	Null = nullptr

Detailed Description

Interfaces with the SpeedTree library to render SpeedTree objects, especially trees, within the Panda3D scene graph.

SpeedTree also includes some support for a simple terrain system, which is available here as well. SpeedTree's rather lame grass system is not presently exposed.

Definition at line 50 of file speedTreeNode.h.

Member Function Documentation

◆ add_for_draw()

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

Definition at line 1022 of file speedTreeNode.cxx.

◆ add_from_stf() [1/2]

bool SpeedTreeNode::add_from_stf	(	const Filename &	stf_filename,
		const LoaderOptions &	options = `LoaderOptions()`
	)

Opens and reads the named STF (SpeedTree Forest) file, and adds the SRT files named within as instances of this node.

Returns true on success, false on failure.

Definition at line 402 of file speedTreeNode.cxx.

◆ add_from_stf() [2/2]

bool SpeedTreeNode::add_from_stf	(	std::istream &	in,
		const Filename &	pathname,
		const LoaderOptions &	options = `LoaderOptions()`,
		Loader *	loader = `nullptr`
	)

Reads text data from the indicated stream, which is understood to represent the named STF (SpeedTree Forest) file, and adds the SRT files named within as instances of this node.

Returns true on success, false on failure.

The pathname is used for reference only; if nonempty, it provides a search directory for named SRT files.

The Loader and LoaderOptions, if provided, are used to load the SRT files. If the Loader pointer is NULL, the default global Loader is used instead.

Definition at line 446 of file speedTreeNode.cxx.

◆ add_instance()

void SpeedTreeNode::add_instance	(	const STTree *	tree,
		const STTransform &	transform
	)

Adds a new instance of the indicated tree at the indicated transform.

Definition at line 275 of file speedTreeNode.cxx.

◆ add_instances()

void SpeedTreeNode::add_instances	(	const NodePath &	root,
		const TransformState *	transform = `TransformState::make_identity()`
	)

Walks the scene graph beginning at root, looking for nested SpeedTreeNodes.

For each SpeedTreeNode found, adds all of the instances defined within that SpeedTreeNode as instances of this node, after applying the indicated scene-graph transform.

Definition at line 292 of file speedTreeNode.cxx.

◆ add_instances_from() [1/2]

void SpeedTreeNode::add_instances_from ( const SpeedTreeNode * other )

Adds all of the instances defined within the indicated SpeedTreeNode as instances of this node.

Does not recurse to children.

Definition at line 303 of file speedTreeNode.cxx.

References add_tree(), get_instance_list, SpeedTreeNode::InstanceList::get_num_instances, get_num_trees, and SpeedTreeNode::InstanceList::get_tree().

◆ add_instances_from() [2/2]

void SpeedTreeNode::add_instances_from	(	const SpeedTreeNode *	other,
		const TransformState *	transform
	)

Adds all of the instances defined within the indicated SpeedTreeNode as instances of this node, after applying the indicated scene-graph transform.

Does not recurse to children.

Definition at line 324 of file speedTreeNode.cxx.

References add_tree(), get_instance_list, SpeedTreeNode::InstanceList::get_num_instances, get_num_trees, and SpeedTreeNode::InstanceList::get_tree().

◆ add_random_instances()

void SpeedTreeNode::add_random_instances	(	const STTree *	tree,
		int	quantity,
		PN_stdfloat	x_min,
		PN_stdfloat	x_max,
		PN_stdfloat	y_min,
		PN_stdfloat	y_max,
		PN_stdfloat	scale_min,
		PN_stdfloat	scale_max,
		PN_stdfloat	height_min,
		PN_stdfloat	height_max,
		PN_stdfloat	slope_min,
		PN_stdfloat	slope_max,
		Randomizer &	randomizer = `Randomizer()`
	)

Creates a number of random instances of the indicated true, within the indicated range.

If a terrain is present, height_min and height_max restrict trees to the (x, y) positions that fall within the indicated terrain, and slope_min and slope_max restrict trees to the (x, y) positions that have a matching slope. If a terrain is not present, height_min and height_max specify a random range of Z heights, and slope_min and slope_max are ignored.

Definition at line 358 of file speedTreeNode.cxx.

References add_tree().

◆ add_tree()

SpeedTreeNode::InstanceList & SpeedTreeNode::add_tree ( const STTree * tree )

Adds a new tree for rendering.

Returns the InstanceList which can be used to add to the instances for this tree. If the tree has previously been added, returns the existing InstanceList.

Definition at line 151 of file speedTreeNode.cxx.

References ordered_vector< Key, Compare, Vector >::end(), STTree::is_valid(), and is_valid().

Referenced by add_instances_from(), add_random_instances(), and modify_instance_list().

◆ apply_attribs_to_vertices()

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

Definition at line 847 of file speedTreeNode.cxx.

References ordered_vector< Key, Compare, Vector >::begin(), ordered_vector< Key, Compare, Vector >::end(), and PandaNode::xform().

◆ authorize()

bool SpeedTreeNode::authorize ( const std::string & license = "" )

static

Make this call to initialized the SpeedTree API and verify the license.

If an empty string is passed for the license, the config variable speedtree- license is consulted. Returns true on success, false on failure. If this call is not made explicitly, it will be made implicitly the first time a SpeedTreeNode is created.

Definition at line 720 of file speedTreeNode.cxx.

Referenced by STTree::STTree().

◆ clear_terrain()

void SpeedTreeNode::clear_terrain ( )

inline

Removes the terrain associated with the node.

Definition at line 72 of file speedTreeNode.I.

References set_terrain().

◆ combine_with()

PandaNode * SpeedTreeNode::combine_with ( PandaNode * other )

virtual

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

The return value may be this, other, or a new node 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 nodes and what the collapsed node should look like.

Reimplemented from PandaNode.

Definition at line 815 of file speedTreeNode.cxx.

References TypedObject::is_exact_type().

◆ compute_internal_bounds()

void SpeedTreeNode::compute_internal_bounds	(	CPT(BoundingVolume) &	internal_bounds,
		int &	internal_vertices,
		int	pipeline_stage,
		Thread *	current_thread
	)		const

virtual

Returns a newly-allocated BoundingVolume that represents the internal contents of the node.

Should be overridden by PandaNode classes that contain something internally.

Reimplemented from PandaNode.

Definition at line 1059 of file speedTreeNode.cxx.

◆ count_total_instances()

int SpeedTreeNode::count_total_instances ( ) const

Returns the total number of trees that will be rendered by this node, counting all instances of all trees.

Definition at line 134 of file speedTreeNode.cxx.

References ordered_vector< Key, Compare, Vector >::begin(), ordered_vector< Key, Compare, Vector >::end(), and SpeedTreeNode::InstanceList::get_num_instances.

Referenced by output().

◆ cull_callback()

bool SpeedTreeNode::cull_callback	(	CullTraverser *	trav,
		CullTraverserData &	data
	)

virtual

This function will be called during the cull traversal to perform any additional operations that should be performed at cull time.

This may include additional manipulation of render state or additional visible/invisible decisions, or any other arbitrary operation.

Note that this function will *not* be called unless set_cull_callback() is called in the constructor of the derived class. It is necessary to call set_cull_callback() to indicated that we require cull_callback() to be called.

By the time this function is called, the node has already passed the bounding-volume test for the viewing frustum, and the node's transform and state have already been applied to the indicated CullTraverserData object.

The return value is true if this node should be visible, or false if it should be culled.

Reimplemented from PandaNode.

Definition at line 884 of file speedTreeNode.cxx.

◆ get_terrain()

STTerrain * SpeedTreeNode::get_terrain ( ) const

inline

Returns the terrain associated with the node, or NULL if there is no terrain.

Definition at line 90 of file speedTreeNode.I.

◆ has_instance_list()

bool SpeedTreeNode::has_instance_list ( const STTree * tree ) const

Returns true if the indicated tree has any instances within this node, false otherwise.

Definition at line 237 of file speedTreeNode.cxx.

References ordered_vector< Key, Compare, Vector >::end().

◆ has_terrain()

bool SpeedTreeNode::has_terrain ( ) const

inline

Returns true if a valid terrain has been associated with the node, false otherwise.

Definition at line 81 of file speedTreeNode.I.

◆ is_renderable()

bool SpeedTreeNode::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 from PandaNode.

Definition at line 1012 of file speedTreeNode.cxx.

◆ is_valid()

bool SpeedTreeNode::is_valid ( ) const

inline

Returns true if the node is valid and ready to render, false otherwise.

Note that this might not become false until after the first time the node is rendered.

Definition at line 20 of file speedTreeNode.I.

Referenced by add_tree().

◆ make_copy()

PandaNode * SpeedTreeNode::make_copy ( ) const

virtual

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

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

Reimplemented from PandaNode.

Definition at line 800 of file speedTreeNode.cxx.

◆ modify_instance_list()

SpeedTreeNode::InstanceList & SpeedTreeNode::modify_instance_list ( const STTree * tree )

Returns a modifiable list of transforms that corresponds to the instances of this tree.

This is equivalent to add_tree().

Definition at line 267 of file speedTreeNode.cxx.

References add_tree().

◆ modify_tree()

STTree * SpeedTreeNode::modify_tree ( int n )

inline

Returns a modifiable STTree pointer for the nth tree instance.

Definition at line 61 of file speedTreeNode.I.

◆ output()

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

virtual

Writes a brief description of the node to the indicated output stream.

This is invoked by the << operator. It may be overridden in derived classes to include some information relevant to the class.

Reimplemented from PandaNode.

Definition at line 1094 of file speedTreeNode.cxx.

References count_total_instances(), and get_num_trees.

◆ prepare_scene()

void SpeedTreeNode::prepare_scene	(	GraphicsStateGuardianBase *	gsgbase,
		const RenderState *	net_state
	)

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

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

In particular, this will ensure that textures within the scene are loaded in texture memory, and display lists are built up from static geometry.

Definition at line 1046 of file speedTreeNode.cxx.

◆ register_with_read_factory()

void SpeedTreeNode::register_with_read_factory ( )

static

Tells the BamReader how to create objects of type SpeedTreeNode.

Definition at line 1678 of file speedTreeNode.cxx.

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

Referenced by init_libspeedtree().

◆ reload_config()

void SpeedTreeNode::reload_config ( )

Re-reads the current setting of all of the relevant config variables and applies them to this node.

This can be called after changing config settings, to make them apply to this particular node.

Definition at line 643 of file speedTreeNode.cxx.

◆ remove_all_trees()

void SpeedTreeNode::remove_all_trees ( )

Removes all instances of all trees from the node.

Definition at line 214 of file speedTreeNode.cxx.

References ordered_vector< Key, Compare, Vector >::begin(), ordered_vector< Key, Compare, Vector >::clear(), ordered_vector< Key, Compare, Vector >::end(), STTree::get_fullpath(), STTree::get_tree(), SpeedTreeNode::InstanceList::get_tree(), and write_error().

◆ remove_tree()

int SpeedTreeNode::remove_tree ( const STTree * tree )

Removes all instances of the indicated tree.

Returns the number of instances removed.

Definition at line 185 of file speedTreeNode.cxx.

References ordered_vector< Key, Compare, Vector >::end(), STTree::get_fullpath(), SpeedTreeNode::InstanceList::get_num_instances, STTree::get_tree(), and write_error().

◆ set_terrain()

void SpeedTreeNode::set_terrain ( STTerrain * terrain )

Associated a terrain with the node.

If the terrain has not already been loaded prior to this call, load_data() will be called immediately.

The terrain will be rendered using SpeedTree callbacks, and trees may be repositioned with a call to snap_to_terrain().

Definition at line 558 of file speedTreeNode.cxx.

References STTerrain::is_valid(), and STTerrain::load_data().

Referenced by clear_terrain(), and setup_terrain().

◆ set_wind()

void SpeedTreeNode::set_wind	(	double	strength,
		const LVector3 &	direction
	)

Specifies the overall wind strength and direction.

Gusts are controlled internally.

Definition at line 707 of file speedTreeNode.cxx.

◆ setup_terrain()

bool SpeedTreeNode::setup_terrain ( const Filename & terrain_file )

A convenience function to set up terrain geometry by reading a terrain.txt file as defined by SpeedTree.

This file names the various map files that define the terrain, as well as defining parameters size as its size and color.

This method implicitly creates a STBasicTerrain object and passes it to set_terrain().

Definition at line 540 of file speedTreeNode.cxx.

References set_terrain().

◆ snap_to_terrain()

void SpeedTreeNode::snap_to_terrain ( )

Adjusts all the trees in this node so that their Z position matches the height of the terrain at their X, Y position.

Definition at line 609 of file speedTreeNode.cxx.

References ordered_vector< Key, Compare, Vector >::begin(), ordered_vector< Key, Compare, Vector >::end(), and SpeedTreeNode::InstanceList::get_num_instances.

◆ write_datagram()

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

Definition at line 1687 of file speedTreeNode.cxx.

References Datagram::add_uint32(), ordered_vector< Key, Compare, Vector >::begin(), ordered_vector< Key, Compare, Vector >::end(), ordered_vector< Key, Compare, Vector >::size(), SpeedTreeNode::InstanceList::write_datagram(), and PandaNode::write_datagram().

◆ write_error()

void SpeedTreeNode::write_error ( std::ostream & out )

static

Writes the current SpeedTree error message to the indicated stream.

Definition at line 1124 of file speedTreeNode.cxx.

Referenced by remove_all_trees(), remove_tree(), and STTree::STTree().

Member Data Documentation

◆ get_global_time_delta

double SpeedTreeNode::get_global_time_delta

inline

Returns an offset that is to be added each frame to the global clock's frame_time for the purpose of animating the trees in all SpeedTreeNodes.

Also see get_time_delta().

Definition at line 146 of file speedTreeNode.h.

◆ get_instance_list

const SpeedTreeNode::InstanceList & SpeedTreeNode::get_instance_list

inline

Returns a list of transforms that corresponds to the instances at which the indicated tree appears.

Returns a list of transforms that corresponds to the instances at which the nth tree appears.

You should ensure that has_instance_list() returns true before calling this method.

Definition at line 97 of file speedTreeNode.h.

Referenced by add_instances_from().

◆ get_num_trees

int SpeedTreeNode::get_num_trees

inline

Returns the number of unique tree objects that have been added to the node.

This count does not include multiple instances of the same tree that appear in different transforms.

Definition at line 95 of file speedTreeNode.h.

Referenced by add_instances_from(), and output().

◆ get_time_delta

double SpeedTreeNode::get_time_delta

inline

Returns an offset that is to be added each frame to the global clock's frame_time for the purpose of animating the trees in this particular node.

Also see get_global_time_delta().

Definition at line 144 of file speedTreeNode.h.

◆ get_tree

const STTree * SpeedTreeNode::get_tree

inline

Returns the STTree pointer for the nth tree.

See get_num_trees().

Definition at line 95 of file speedTreeNode.h.

◆ set_global_time_delta

void SpeedTreeNode::set_global_time_delta

inline

Specifies an offset that is to be added each frame to the global clock's frame_time for the purpose of animating the trees in all SpeedTreeNodes.

Also see set_time_delta().

Definition at line 146 of file speedTreeNode.h.

◆ set_time_delta

void SpeedTreeNode::set_time_delta

inline

Specifies an offset that is to be added each frame to the global clock's frame_time for the purpose of animating the trees in this particular node.

Also see set_global_time_delta().

Definition at line 144 of file speedTreeNode.h.

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

panda/src/speedtree/speedTreeNode.h
panda/src/speedtree/speedTreeNode.cxx
panda/src/speedtree/speedTreeNode.I

Classes

Public Member Functions

Static Public Member Functions

Public Attributes

Friends

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ add_for_draw()

◆ add_from_stf() [1/2]

◆ add_from_stf() [2/2]

◆ add_instance()

◆ add_instances()

◆ add_instances_from() [1/2]

◆ add_instances_from() [2/2]

◆ add_random_instances()

◆ add_tree()

◆ apply_attribs_to_vertices()

◆ authorize()

◆ clear_terrain()

◆ combine_with()

◆ compute_internal_bounds()

◆ count_total_instances()

◆ cull_callback()

◆ get_terrain()

◆ has_instance_list()

◆ has_terrain()

◆ is_renderable()

◆ is_valid()

◆ make_copy()

◆ modify_instance_list()

◆ modify_tree()

◆ output()

◆ prepare_scene()

◆ register_with_read_factory()

◆ reload_config()

◆ remove_all_trees()

◆ remove_tree()

◆ set_terrain()

◆ set_wind()

◆ setup_terrain()

◆ snap_to_terrain()

◆ write_datagram()

◆ write_error()

Member Data Documentation

◆ get_global_time_delta

◆ get_instance_list

◆ get_num_trees

◆ get_time_delta

◆ get_tree

◆ set_global_time_delta

◆ set_time_delta