Panda3D
 All Classes Functions Variables Enumerations
Public Member Functions | Static Public Member Functions | List of all members
OccluderEffect Class Reference

This functions similarly to a LightAttrib or ClipPlaneAttrib. More...

#include "occluderEffect.h"

Inheritance diagram for OccluderEffect:
RenderEffect TypedWritableReferenceCount TypedWritable ReferenceCount TypedObject MemoryBase MemoryBase

Public Member Functions

virtual int complete_pointers (TypedWritable **plist, BamReader *manager)
 Receives an array of pointers, one for each time manager->read_pointer() was called in fillin(). More...
 
 CPT (RenderEffect) add_on_occluder(const NodePath &occluder) const
 
 CPT (RenderEffect) remove_on_occluder(const NodePath &occluder) const
 
virtual TypeHandle force_init_type ()
 
int get_num_on_occluders () const
 Returns the number of occluders that are enabled by the effectute. More...
 
NodePath get_on_occluder (int n) const
 Returns the nth occluder enabled by the effectute, sorted in render order. More...
 
virtual TypeHandle get_type () const
 
bool has_on_occluder (const NodePath &occluder) const
 Returns true if the indicated occluder is enabled by the effect, false otherwise. More...
 
bool is_identity () const
 Returns true if this is an identity effect: it does not change the set of occluders in use. More...
 
 MAKE_SEQ (get_on_occluders, get_num_on_occluders, get_on_occluder)
 
virtual void output (ostream &out) const
 
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...
 
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 RenderEffect
virtual ~RenderEffect ()
 The destructor is responsible for removing the RenderEffect from the global set if it is there. More...
 
virtual void adjust_transform (CPT(TransformState)&net_transform, CPT(TransformState)&node_transform, PandaNode *node) const
 Performs some operation on the node's apparent net and/or local transforms. More...
 
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. More...
 
virtual CPT (TransformState) prepare_flatten_transform(const TransformState *net_transform) const
 
virtual void cull_callback (CullTraverser *trav, CullTraverserData &data, CPT(TransformState)&node_transform, CPT(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. 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...
 
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. More...
 
virtual bool has_cull_callback () const
 
virtual bool safe_to_combine () const
 
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. More...
 
virtual void write (ostream &out, int indent_level) const
 
- Public Member Functions inherited from TypedWritableReferenceCount
 TypedWritableReferenceCount (const TypedWritableReferenceCount &copy)
 
virtual ReferenceCountas_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)
 
string encode_to_bam_stream () const
 Converts the TypedWritable object into a single stream of data using a BamWriter, and returns that data as a string string. More...
 
bool encode_to_bam_stream (string &data, BamWriter *writer=NULL) const
 Converts the TypedWritable object into a single stream of data using a BamWriter, and stores that data in the indicated string. 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 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...
 
- Public Member Functions inherited from TypedObject
 TypedObject (const TypedObject &copy)
 
TypedObjectas_typed_object ()
 Returns the object, upcast (if necessary) to a TypedObject pointer. More...
 
const TypedObjectas_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...
 
void operator= (const TypedObject &copy)
 
- Public Member Functions inherited from ReferenceCount
int get_ref_count () const
 Returns the current reference count. More...
 
WeakReferenceListget_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 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...
 
void weak_ref (WeakPointerToVoid *ptv)
 Adds the indicated PointerToVoid as a weak reference to this object. More...
 
void weak_unref (WeakPointerToVoid *ptv)
 Removes the indicated PointerToVoid as a weak reference to this object. More...
 

Static Public Member Functions

static CPT (RenderEffect) make()
 
static TypeHandle get_class_type ()
 
static void init_type ()
 
static void register_with_read_factory ()
 Tells the BamReader how to create objects of type OccluderEffect. More...
 
- Static Public Member Functions inherited from RenderEffect
static TypedWritablechange_this (TypedWritable *old_ptr, BamReader *manager)
 Called immediately after complete_pointers(), this gives the object a chance to adjust its own pointer if desired. More...
 
static TypeHandle get_class_type ()
 
static int get_num_effects ()
 Returns the total number of unique RenderEffect objects allocated in the world. More...
 
static void init_type ()
 
static void list_effects (ostream &out)
 Lists all of the RenderEffects in the cache to the output stream, one per line. More...
 
static bool validate_effects ()
 Ensures that the cache is still stored in sorted order. More...
 
- Static Public Member Functions inherited from TypedWritableReferenceCount
static TypeHandle get_class_type ()
 
static void init_type ()
 
static PT (TypedWritableReferenceCount) decode_from_bam_stream(const string &data
 
- Static Public Member Functions inherited from TypedWritable
static bool decode_raw_from_bam_stream (TypedWritable *&ptr, ReferenceCount *&ref_ptr, const string &data, BamReader *reader=NULL)
 Reads the string created by a previous call to encode_to_bam_stream(), and extracts the single object on that string. 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 ()
 

Additional Inherited Members

- Public Attributes inherited from TypedWritableReferenceCount
static BamReaderreader = NULL)
 
- Static Public Attributes inherited from TypedWritable
static TypedWritable *const Null = (TypedWritable*)0L
 

Detailed Description

This functions similarly to a LightAttrib or ClipPlaneAttrib.

It indicates the set of occluders that modify the geometry at this level and below. Unlike a ClipPlaneAttrib, an OccluderEffect takes effect immediately when it is encountered during traversal, and thus can only add occluders; it may not remove them.

Definition at line 36 of file occluderEffect.h.

Member Function Documentation

int OccluderEffect::complete_pointers ( TypedWritable **  p_list,
BamReader manager 
)
virtual

Receives an array of pointers, one for each time manager->read_pointer() was called in fillin().

Returns the number of pointers processed.

Reimplemented from TypedWritable.

Definition at line 185 of file occluderEffect.cxx.

References ordered_vector< Key, Compare, Vector >::begin(), TypedWritable::complete_pointers(), ordered_vector< Key, Compare, Vector >::end(), AttribNodeRegistry::find_node(), AttribNodeRegistry::get_node(), and ov_set< Key, Compare, Vector >::sort().

int OccluderEffect::get_num_on_occluders ( ) const
inline

Returns the number of occluders that are enabled by the effectute.

Definition at line 46 of file occluderEffect.I.

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

Referenced by write_datagram().

NodePath OccluderEffect::get_on_occluder ( int  n) const
inline

Returns the nth occluder enabled by the effectute, sorted in render order.

Definition at line 57 of file occluderEffect.I.

References NodePath::fail(), and ordered_vector< Key, Compare, Vector >::size().

bool OccluderEffect::has_on_occluder ( const NodePath occluder) const
inline

Returns true if the indicated occluder is enabled by the effect, false otherwise.

Definition at line 69 of file occluderEffect.I.

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

Referenced by NodePath::has_occluder().

bool OccluderEffect::is_identity ( ) const
inline

Returns true if this is an identity effect: it does not change the set of occluders in use.

Definition at line 80 of file occluderEffect.I.

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

void OccluderEffect::register_with_read_factory ( )
static

Tells the BamReader how to create objects of type OccluderEffect.

Definition at line 153 of file occluderEffect.cxx.

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

bool OccluderEffect::require_fully_complete ( ) const
virtual

Some objects require all of their nested pointers to have been completed before the objects themselves can be completed.

If this is the case, override this method to return true, and be careful with circular references (which would make the object unreadable from a bam file).

Reimplemented from TypedWritable.

Definition at line 219 of file occluderEffect.cxx.

void OccluderEffect::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 164 of file occluderEffect.cxx.

References Datagram::add_uint16(), ordered_vector< Key, Compare, Vector >::begin(), ordered_vector< Key, Compare, Vector >::end(), get_num_on_occluders(), NodePath::node(), RenderEffect::write_datagram(), and BamWriter::write_pointer().


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