Panda3D
Public Member Functions | Static Public Member Functions | List of all members
OccluderEffect Class Reference

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

Inheritance diagram for OccluderEffect:
RenderEffect TypedWritableReferenceCount TypedWritable ReferenceCount TypedObject

Public Member Functions

const RenderEffect addOnOccluder (const NodePath occluder)
 Returns a new OccluderEffect, just like this one, but with the indicated occluder added to the list of occluders enabled by this effect. More...
 
int getNumOnOccluders ()
 Returns the number of occluders that are enabled by the effectute. More...
 
NodePath getOnOccluder (int n)
 Returns the nth occluder enabled by the effectute, sorted in render order. More...
 
list getOnOccluders ()
 
bool hasOnOccluder (const NodePath occluder)
 Returns true if the indicated occluder is enabled by the effect, false otherwise. More...
 
bool isIdentity ()
 Returns true if this is an identity effect: it does not change the set of occluders in use. More...
 
const RenderEffect removeOnOccluder (const NodePath occluder)
 Returns a new OccluderEffect, just like this one, but with the indicated occluder removed from the list of occluders enabled by this effect. More...
 
- Public Member Functions inherited from RenderEffect
int compareTo (const RenderEffect other)
 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...
 
 output (Ostream out)
 
 write (Ostream out, int indent_level)
 
- Public Member Functions inherited from TypedWritable
object __reduce__ ()
 
object __reduce_persist__ (object pickler)
 
VectorUchar encodeToBamStream ()
 Converts the TypedWritable object into a single stream of data using a BamWriter, and returns that data as a bytes object. More...
 
bool encodeToBamStream (VectorUchar data, BamWriter writer)
 Converts the TypedWritable object into a single stream of data using a BamWriter, and stores that data in the indicated string. More...
 
 fillin (DatagramIterator scan, BamReader manager)
 This internal function is intended to be called by each class's make_from_bam() method to read in all of the relevant data from the BamFile for the new object. More...
 
UpdateSeq getBamModified ()
 Returns the current bam_modified counter. More...
 
 markBamModified ()
 Increments the bam_modified counter, so that this object will be invalidated and retransmitted on any open bam streams. More...
 
- Public Member Functions inherited from TypedObject
TypeHandle getType ()
 
int getTypeIndex ()
 Returns the internal index number associated with this object's TypeHandle, a unique number for each different type. More...
 
bool isExactType (TypeHandle handle)
 Returns true if the current object is the indicated type exactly. More...
 
bool isOfType (TypeHandle handle)
 Returns true if the current object is or derives from the indicated type. More...
 
- Public Member Functions inherited from ReferenceCount
int getRefCount ()
 Returns the current reference count. More...
 
 ref ()
 Explicitly increments the reference count. More...
 
bool testRefCountIntegrity ()
 Does some easy checks to make sure that the reference count isn't completely bogus. More...
 
bool testRefCountNonzero ()
 Does some easy checks to make sure that the reference count isn't zero, or completely bogus. More...
 
bool unref ()
 Explicitly decrements the reference count. More...
 

Static Public Member Functions

static TypeHandle getClassType ()
 
static const RenderEffect make ()
 Constructs a new OccluderEffect object that does nothing. More...
 
- Static Public Member Functions inherited from RenderEffect
static TypeHandle getClassType ()
 
static int getNumEffects ()
 Returns the total number of unique RenderEffect objects allocated in the world. More...
 
static listEffects (Ostream out)
 Lists all of the RenderEffects in the cache to the output stream, one per line. More...
 
static bool validateEffects ()
 Ensures that the cache is still stored in sorted order. More...
 
- Static Public Member Functions inherited from TypedWritableReferenceCount
static TypedWritableReferenceCount decodeFromBamStream (VectorUchar data, BamReader reader)
 Reads the bytes created by a previous call to encode_to_bam_stream(), and extracts and returns the single object on those bytes. More...
 
static TypeHandle getClassType ()
 
- Static Public Member Functions inherited from TypedWritable
static TypeHandle getClassType ()
 
- Static Public Member Functions inherited from TypedObject
static TypeHandle getClassType ()
 
- Static Public Member Functions inherited from ReferenceCount
static TypeHandle getClassType ()
 

Additional Inherited Members

- Public Attributes inherited from TypedObject
TypeHandle type
 Returns the TypeHandle representing this object's type. More...
 
- Public Attributes inherited from ReferenceCount
int ref_count
 The current reference count. More...
 

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.

Member Function Documentation

◆ addOnOccluder()

const RenderEffect addOnOccluder ( const NodePath  occluder)

Returns a new OccluderEffect, just like this one, but with the indicated occluder added to the list of occluders enabled by this effect.

◆ getClassType()

static TypeHandle getClassType ( )
static

◆ getNumOnOccluders()

int getNumOnOccluders ( )

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

◆ getOnOccluder()

NodePath getOnOccluder ( int  n)

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

◆ getOnOccluders()

list getOnOccluders ( )

◆ hasOnOccluder()

bool hasOnOccluder ( const NodePath  occluder)

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

◆ isIdentity()

bool isIdentity ( )

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

◆ make()

static const RenderEffect make ( )
static

Constructs a new OccluderEffect object that does nothing.

◆ removeOnOccluder()

const RenderEffect removeOnOccluder ( const NodePath  occluder)

Returns a new OccluderEffect, just like this one, but with the indicated occluder removed from the list of occluders enabled by this effect.