STTree Class Reference

Encapsulates a single tree model in the SpeedTree library, as loaded from an SRT file. More...

#include "stTree.h"

Inheritance diagram for STTree:

Public Member Functions
	STTree (const Filename &fullpath)
	The constructor reads the indicated SRT file immediately.
	STTree (const STTree &copy)=delete
virtual TypeHandle	force_init_type ()
const Filename &	get_fullpath () const
	Returns the full pathname to the SRT file that was loaded for this tree, as passed to the constructor.
const SpeedTree::CTreeRender *	get_tree () const
	Returns a const pointer to the internal SpeedTree object.
virtual TypeHandle	get_type () const
bool	is_valid () const
	Returns true if the tree was successfully loaded and is ready to be used, false otherwise.
SpeedTree::CTreeRender *	modify_tree ()
	Returns a modifiable pointer to the internal SpeedTree object.
virtual void	output (std::ostream &out) const
Public Member Functions inherited from TypedReferenceCount
	TypedReferenceCount (const TypedReferenceCount &copy)
void	operator= (const TypedReferenceCount &copy)
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.
const TypedObject *	as_typed_object () const
	Returns the object, upcast (if necessary) to a TypedObject pointer.
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.
bool	is_exact_type (TypeHandle handle) const
	Returns true if the current object is the indicated type exactly.
bool	is_of_type (TypeHandle handle) const
	Returns true if the current object is or derives from the indicated type.
TypedObject &	operator= (const TypedObject &copy)=default
Public Member Functions inherited from MemoryBase
void	operator delete (void *, void *)
void	operator delete (void *ptr)
void	operator delete[] (void *, void *)
void	operator delete[] (void *ptr)
void *	operator new (size_t size)
void *	operator new (size_t size, void *ptr)
void *	operator new[] (size_t size)
void *	operator new[] (size_t size, void *ptr)
Public Member Functions inherited from ReferenceCount
int	get_ref_count () const
WeakReferenceList *	get_weak_list () const
	Returns the WeakReferenceList associated with this ReferenceCount object.
bool	has_weak_list () const
	Returns true if this particular ReferenceCount object has a WeakReferenceList created, false otherwise.
void	local_object ()
	This function should be called, once, immediately after creating a new instance of some ReferenceCount-derived object on the stack.
void	ref () const
	Explicitly increments the reference count.
bool	ref_if_nonzero () const
	Atomically increases the reference count of this object if it is not zero.
bool	test_ref_count_integrity () const
	Does some easy checks to make sure that the reference count isn't completely bogus.
bool	test_ref_count_nonzero () const
	Does some easy checks to make sure that the reference count isn't zero, or completely bogus.
virtual bool	unref () const
	Explicitly decrements the reference count.
bool	unref_if_one () const
	Atomically decreases the reference count of this object if it is one.
WeakReferenceList *	weak_ref ()
	Adds the indicated PointerToVoid as a weak reference to this object.
void	weak_unref ()
	Removes the indicated PointerToVoid as a weak reference to this object.
Public Member Functions inherited from Namable
	Namable (const std::string &initial_name="")
void	clear_name ()
	Resets the Namable's name to empty.
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.
void	output (std::ostream &out) const
	Outputs the Namable.
void	set_name (const std::string &name)

Static Public Member Functions
static TypeHandle	get_class_type ()
static void	init_type ()
Static Public Member Functions inherited from TypedReferenceCount
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.
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 ()

Additional Inherited Members
Public Attributes inherited from TypedObject
	get_type
Public Attributes inherited from ReferenceCount
	get_ref_count
	Returns the current reference count.
Public Attributes inherited from Namable
	get_name
	set_name

Detailed Description

Encapsulates a single tree model in the SpeedTree library, as loaded from an SRT file.

Definition at line 28 of file stTree.h.

Constructor & Destructor Documentation

STTree()

STTree::STTree

(

const Filename &

fullpath

)

The constructor reads the indicated SRT file immediately.

Check is_valid() to determine whether the read was successful or not. Note that the filename must be a fully-qualified pathname; the STTree constructor does not search the model-path.

Definition at line 25 of file stTree.cxx.

References SpeedTreeNode::authorize().

Member Function Documentation

force_init_type()

virtual TypeHandle STTree::force_init_type ( )

inlinevirtual

Reimplemented from TypedReferenceCount.

Definition at line 61 of file stTree.h.

get_class_type()

static TypeHandle STTree::get_class_type ( )

inlinestatic

Definition at line 50 of file stTree.h.

get_fullpath()

const Filename & STTree::get_fullpath ( ) const

inline

Returns the full pathname to the SRT file that was loaded for this tree, as passed to the constructor.

Definition at line 18 of file stTree.I.

Referenced by SpeedTreeNode::add_tree(), SpeedTreeNode::remove_all_trees(), and SpeedTreeNode::remove_tree().

get_tree()

const SpeedTree::CTreeRender * STTree::get_tree ( ) const

inline

Returns a const pointer to the internal SpeedTree object.

Definition at line 35 of file stTree.I.

Referenced by SpeedTreeNode::add_tree(), SpeedTreeNode::compute_internal_bounds(), SpeedTreeNode::remove_all_trees(), and SpeedTreeNode::remove_tree().

get_type()

virtual TypeHandle STTree::get_type ( ) const

inlinevirtual

Reimplemented from TypedReferenceCount.

Definition at line 58 of file stTree.h.

init_type()

static void STTree::init_type ( )

inlinestatic

Definition at line 53 of file stTree.h.

is_valid()

bool STTree::is_valid ( ) const

inline

Returns true if the tree was successfully loaded and is ready to be used, false otherwise.

Definition at line 27 of file stTree.I.

Referenced by SpeedTreeNode::add_tree().

modify_tree()

SpeedTree::CTreeRender * STTree::modify_tree ( )

inline

Returns a modifiable pointer to the internal SpeedTree object.

Definition at line 43 of file stTree.I.

output()

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

virtual

Definition at line 67 of file stTree.cxx.

---

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

• panda/src/speedtree/stTree.h
• panda/src/speedtree/stTree.cxx
• panda/src/speedtree/stTree.I