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

A PolylightEffect can be used on a node to define a LightGroup for that node. More...

Inheritance diagram for PolylightEffect:
RenderEffect TypedWritableReferenceCount TypedWritable ReferenceCount TypedObject

Public Types

enum  ContribType { CT_proximal = 0, CT_all = 1 }
 

Public Member Functions

const RenderEffect addLight (const NodePath newlight)
 Add a PolylightNode object to this effect and return a new effect. More...
 
PolylightEffect::ContribType getContrib ()
 Returns CT_all or CT_proximal. More...
 
LPoint3 getEffectCenter ()
 Return the value of the _effect_center. More...
 
float getWeight ()
 Get the weight value. More...
 
bool hasLight (const NodePath light)
 Returns true if the indicated light is listed in the PolylightEffect, false otherwise. More...
 
const RenderEffect removeLight (const NodePath newlight)
 Remove a light from this effect. More...
 
const RenderEffect setContrib (PolylightEffect::ContribType c)
 Set Contrib Type and return a new effect... More...
 
const RenderEffect setEffectCenter (const LPoint3 ec)
 Set weight and return a new effect... More...
 
const RenderEffect setWeight (float w)
 Set weight and return a new 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 PolylightEffect object. More...
 
static const RenderEffect make (float weight, PolylightEffect::ContribType contrib, const LPoint3 effect_center)
 Constructs a new PolylightEffect object. More...
 
static const RenderEffect make (float weight, PolylightEffect::ContribType contrib, const LPoint3 effect_center, const PolylightEffect::LightGroup lights)
 Constructs a new PolylightEffect object. 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

A PolylightEffect can be used on a node to define a LightGroup for that node.

A LightGroup contains PolylightNodes which are essentially nodes that add color to the polygons of a model based on distance. PolylightNode is a cheap way to get lighting effects specially for night scenes

Member Enumeration Documentation

◆ ContribType

Enumerator
CT_proximal 
CT_all 

Member Function Documentation

◆ addLight()

const RenderEffect addLight ( const NodePath  newlight)

Add a PolylightNode object to this effect and return a new effect.

◆ getClassType()

static TypeHandle getClassType ( )
static

◆ getContrib()

Returns CT_all or CT_proximal.

◆ getEffectCenter()

LPoint3 getEffectCenter ( )

Return the value of the _effect_center.

◆ getWeight()

float getWeight ( )

Get the weight value.

◆ hasLight()

bool hasLight ( const NodePath  light)

Returns true if the indicated light is listed in the PolylightEffect, false otherwise.

◆ make() [1/3]

static const RenderEffect make ( )
static

Constructs a new PolylightEffect object.

◆ make() [2/3]

static const RenderEffect make ( float  weight,
PolylightEffect::ContribType  contrib,
const LPoint3  effect_center 
)
static

Constructs a new PolylightEffect object.

◆ make() [3/3]

static const RenderEffect make ( float  weight,
PolylightEffect::ContribType  contrib,
const LPoint3  effect_center,
const PolylightEffect::LightGroup  lights 
)
static

Constructs a new PolylightEffect object.

◆ removeLight()

const RenderEffect removeLight ( const NodePath  newlight)

Remove a light from this effect.

Return the new updated effect

◆ setContrib()

const RenderEffect setContrib ( PolylightEffect::ContribType  c)

Set Contrib Type and return a new effect...

the reason this couldnt be done through make was because that would return a new effect without the lightgroup which is static and cant be accessed Here, we just pass that to the make

◆ setEffectCenter()

const RenderEffect setEffectCenter ( const LPoint3  ec)

Set weight and return a new effect...

the reason this couldnt be done through make was because that would return a new effect without the lightgroup which is static and cant be accessed Here, we just pass that to the make

◆ setWeight()

const RenderEffect setWeight ( float  w)

Set weight and return a new effect...

the reason this couldnt be done through make was because that would return a new effect without the lightgroup which is static and cant be accessed Here, we just pass that to the make