ShowBoundsEffect Class Reference

Applied to a GeomNode to cause a visible bounding volume to be drawn for this node. More...

#include "showBoundsEffect.h"

Inheritance diagram for ShowBoundsEffect:

Public Member Functions
virtual TypeHandle	force_init_type ()
bool	get_tight () const
	Returns true if the "tight" flag was set, meaning the effect should compute and draw the tight bounding-box of the node's vertices every frame.
virtual TypeHandle	get_type () 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.
Public Member Functions inherited from RenderEffect
	RenderEffect (const RenderEffect &copy)=delete
virtual	~RenderEffect ()
	The destructor is responsible for removing the RenderEffect from the global set if it is there.
virtual void	adjust_transform (ConstPointerTo< TransformState > &net_transform, ConstPointerTo< TransformState > &node_transform, const PandaNode *node) const
	Performs some operation on the node's apparent net and/or local transforms.
int	compare_to (const RenderEffect &other) const
	Provides an arbitrary ordering among all unique RenderEffects, so we can store the essentially different ones in a big set and throw away the rest.
virtual void	cull_callback (CullTraverser *trav, CullTraverserData &data, ConstPointerTo< TransformState > &node_transform, ConstPointerTo< RenderState > &node_state) const
	If has_cull_callback() returns true, this function will be called during the cull traversal to perform any additional operations that should be performed at cull time.
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.
virtual bool	has_adjust_transform () const
	Should be overridden by derived classes to return true if adjust_transform() has been defined, and therefore the RenderEffect has some effect on the node's apparent local and net transforms.
virtual bool	has_cull_callback () const
	Should be overridden by derived classes to return true if cull_callback() has been defined.
RenderEffect &	operator= (const RenderEffect &copy)=delete
virtual void	output (std::ostream &out) const
virtual ConstPointerTo< TransformState >	prepare_flatten_transform (const TransformState *net_transform) const
	Preprocesses the accumulated transform that is about to be applied to (or through) this node due to a flatten operation.
virtual bool	safe_to_transform () const
	Returns true if it is generally safe to transform this particular kind of RenderEffect by calling the xform() method, false otherwise.
virtual void	write (std::ostream &out, int indent_level) const
virtual ConstPointerTo< RenderEffect >	xform (const LMatrix4 &mat) const
	Returns a new RenderEffect transformed by the indicated matrix.
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.
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().
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.
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.
UpdateSeq	get_bam_modified () const
	Returns the current bam_modified counter.
void	mark_bam_modified ()
	Increments the bam_modified counter, so that this object will be invalidated and retransmitted on any open bam streams.
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.
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.
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.

Static Public Member Functions
static TypeHandle	get_class_type ()
static void	init_type ()
static ConstPointerTo< RenderEffect >	make (bool tight=false)
	Constructs a new ShowBoundsEffect object.
static void	register_with_read_factory ()
	Tells the BamReader how to create objects of type ShowBoundsEffect.
Static Public Member Functions inherited from RenderEffect
static TypedWritable *	change_this (TypedWritable *old_ptr, BamReader *manager)
	Called immediately after complete_pointers(), this gives the object a chance to adjust its own pointer if desired.
static TypeHandle	get_class_type ()
static int	get_num_effects ()
	Returns the total number of unique RenderEffect objects allocated in the world.
static void	init_type ()
static void	list_effects (std::ostream &out)
	Lists all of the RenderEffects in the cache to the output stream, one per line.
static bool	validate_effects ()
	Ensures that the cache is still stored in sorted order.
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.
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 ()

Additional Inherited Members
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.
Static Public Attributes inherited from TypedWritable
static TypedWritable *const	Null = nullptr

Detailed Description

Applied to a GeomNode to cause a visible bounding volume to be drawn for this node.

This is generally used only during development to help identify bounding volume issues.

Definition at line 28 of file showBoundsEffect.h.

Member Function Documentation

force_init_type()

virtual TypeHandle ShowBoundsEffect::force_init_type ( )

inlinevirtual

Reimplemented from RenderEffect.

Definition at line 64 of file showBoundsEffect.h.

get_class_type()

static TypeHandle ShowBoundsEffect::get_class_type ( )

inlinestatic

Definition at line 53 of file showBoundsEffect.h.

get_tight()

bool ShowBoundsEffect::get_tight ( ) const

inline

Returns true if the "tight" flag was set, meaning the effect should compute and draw the tight bounding-box of the node's vertices every frame.

Definition at line 27 of file showBoundsEffect.I.

get_type()

virtual TypeHandle ShowBoundsEffect::get_type ( ) const

inlinevirtual

Reimplemented from RenderEffect.

Definition at line 61 of file showBoundsEffect.h.

init_type()

static void ShowBoundsEffect::init_type ( )

inlinestatic

Definition at line 56 of file showBoundsEffect.h.

make()

ConstPointerTo< RenderEffect > ShowBoundsEffect::make ( bool tight = false )

static

Constructs a new ShowBoundsEffect object.

Definition at line 25 of file showBoundsEffect.cxx.

Referenced by NodePath::show_bounds(), and NodePath::show_tight_bounds().

register_with_read_factory()

void ShowBoundsEffect::register_with_read_factory ( )

static

Tells the BamReader how to create objects of type ShowBoundsEffect.

Definition at line 65 of file showBoundsEffect.cxx.

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

Referenced by init_libpgraph().

write_datagram()

void ShowBoundsEffect::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 RenderEffect.

Definition at line 74 of file showBoundsEffect.cxx.

References Datagram::add_bool(), and RenderEffect::write_datagram().

---

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

• panda/src/pgraph/showBoundsEffect.h
• panda/src/pgraph/showBoundsEffect.cxx
• panda/src/pgraph/showBoundsEffect.I