Panda3D
|
A PolylightEffect can be used on a node to define a LightGroup for that node. More...
Public Types | |
enum | ContribType { CTProximal = 0, CTAll = 1 } |
Public Member Functions | |
RenderEffect const | addLight (NodePath const newlight) |
Add a PolylightNode object to this effect and return a new effect. | |
int | compareTo (RenderEffect const 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. | |
string | encodeToBamStream () |
Converts the TypedWritable object into a single stream of data using a BamWriter, and returns that data as a string string. | |
bool | encodeToBamStream (basic_stringchar data, BamWriter writer) |
Converts the TypedWritable object into a single stream of data using a BamWriter, and stores that data in the indicated string. | |
bool | encodeToBamStream (basic_stringchar data) |
Converts the TypedWritable object into a single stream of data using a BamWriter, and stores that data in the indicated string. | |
UpdateSeq | getBamModified () |
Returns the current bam_modified counter. | |
ContribType | getContrib () |
Returns CT_all or CT_proximal. | |
Point3 | getEffectCenter () |
Return the value of the _effect_center. | |
int | getRefCount () |
Returns the current reference count. | |
TypeHandle | getType () |
int | getTypeIndex () |
Returns the internal index number associated with this object's TypeHandle, a unique number for each different type. | |
float | getWeight () |
Get the weight value. | |
bool | hasLight (NodePath const light) |
Returns true if the indicated light is listed in the PolylightEffect, false otherwise. | |
bool | isExactType (TypeHandle handle) |
Returns true if the current object is the indicated type exactly. | |
bool | isOfType (TypeHandle handle) |
Returns true if the current object is or derives from the indicated type. | |
markBamModified () | |
Increments the bam_modified counter, so that this object will be invalidated and retransmitted on any open bam streams. | |
output (ostream out) | |
PyObject | reduce (PyObject self) |
This special Python method is implement to provide support for the pickle module. | |
PyObject | reducePersist (PyObject self, PyObject pickler) |
This special Python method is implement to provide support for the pickle module. | |
ref () | |
Explicitly increments the reference count. | |
RenderEffect const | removeLight (NodePath const newlight) |
Remove a light from this effect. | |
RenderEffect const | setContrib (ContribType c) |
Set Contrib Type and return a new effect... | |
RenderEffect const | setEffectCenter (Point3 ec) |
Set weight and return a new effect... | |
RenderEffect const | setWeight (float w) |
Set weight and return a new effect... | |
bool | testRefCountIntegrity () |
Does some easy checks to make sure that the reference count isn't completely bogus. | |
bool | testRefCountNonzero () |
Does some easy checks to make sure that the reference count isn't zero, or completely bogus. | |
bool | unref () |
Explicitly decrements the reference count. | |
write (ostream out, int indent_level) | |
Static Public Member Functions | |
static TypedWritableReferenceCount | decodeFromBamStream (string data, BamReader reader) |
Reads the string created by a previous call to encode_to_bam_stream(), and extracts and returns the single object on that string. | |
static TypedWritableReferenceCount | decodeFromBamStream (string data) |
Reads the string created by a previous call to encode_to_bam_stream(), and extracts and returns the single object on that string. | |
static TypeHandle | getClassType () |
static int | getNumEffects () |
Returns the total number of unique RenderEffect objects allocated in the world. | |
static | listEffects (ostream out) |
Lists all of the RenderEffects in the cache to the output stream, one per line. | |
static RenderEffect const | make () |
Constructs a new PolylightEffect object. | |
static RenderEffect const | make (float weight, ContribType contrib, Point3 effect_center) |
Constructs a new PolylightEffect object. | |
static RenderEffect const | make (float weight, ContribType contrib, Point3 effect_center, vectorNodePath const lights) |
Constructs a new PolylightEffect object. | |
static bool | validateEffects () |
Ensures that the cache is still stored in sorted order. |
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
enum ContribType |
RenderEffect const addLight | ( | NodePath const | newlight | ) |
Add a PolylightNode object to this effect and return a new effect.
int compareTo | ( | RenderEffect const | other | ) | [inherited] |
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.
This method is not needed outside of the RenderEffect class because all equivalent RenderEffect objects are guaranteed to share the same pointer; thus, a pointer comparison is always sufficient.
static TypedWritableReferenceCount decodeFromBamStream | ( | string | data, |
BamReader | reader | ||
) | [static, inherited] |
Reads the string created by a previous call to encode_to_bam_stream(), and extracts and returns the single object on that string.
Returns NULL on error.
This method is intended to replace decode_raw_from_bam_stream() when you know the stream in question returns an object of type TypedWritableReferenceCount, allowing for easier reference count management. Note that the caller is still responsible for maintaining the reference count on the return value.
static TypedWritableReferenceCount decodeFromBamStream | ( | string | data | ) | [static, inherited] |
Reads the string created by a previous call to encode_to_bam_stream(), and extracts and returns the single object on that string.
Returns NULL on error.
This method is intended to replace decode_raw_from_bam_stream() when you know the stream in question returns an object of type TypedWritableReferenceCount, allowing for easier reference count management. Note that the caller is still responsible for maintaining the reference count on the return value.
string encodeToBamStream | ( | ) | [inherited] |
Converts the TypedWritable object into a single stream of data using a BamWriter, and returns that data as a string string.
Returns empty string on failure.
This is a convenience method particularly useful for cases when you are only serializing a single object. If you have many objects to process, it is more efficient to use the same BamWriter to serialize all of them together.
bool encodeToBamStream | ( | basic_stringchar | data, |
BamWriter | writer | ||
) | [inherited] |
Converts the TypedWritable object into a single stream of data using a BamWriter, and stores that data in the indicated string.
Returns true on success, false on failure.
This is a convenience method particularly useful for cases when you are only serializing a single object. If you have many objects to process, it is more efficient to use the same BamWriter to serialize all of them together.
bool encodeToBamStream | ( | basic_stringchar | data | ) | [inherited] |
Converts the TypedWritable object into a single stream of data using a BamWriter, and stores that data in the indicated string.
Returns true on success, false on failure.
This is a convenience method particularly useful for cases when you are only serializing a single object. If you have many objects to process, it is more efficient to use the same BamWriter to serialize all of them together.
UpdateSeq getBamModified | ( | ) | [inherited] |
Returns the current bam_modified counter.
This counter is normally incremented automatically whenever the object is modified.
static TypeHandle getClassType | ( | ) | [static] |
Reimplemented from RenderEffect.
ContribType getContrib | ( | ) |
Returns CT_all or CT_proximal.
Point3 getEffectCenter | ( | ) |
Return the value of the _effect_center.
static int getNumEffects | ( | ) | [static, inherited] |
Returns the total number of unique RenderEffect objects allocated in the world.
This will go up and down during normal operations.
int getRefCount | ( | ) | [inherited] |
Returns the current reference count.
TypeHandle getType | ( | ) | [inherited] |
Reimplemented in AnimChannelBase.
int getTypeIndex | ( | ) | [inherited] |
Returns the internal index number associated with this object's TypeHandle, a unique number for each different type.
This is equivalent to get_type().get_index().
float getWeight | ( | ) |
Get the weight value.
bool hasLight | ( | NodePath const | light | ) |
Returns true if the indicated light is listed in the PolylightEffect, false otherwise.
bool isExactType | ( | TypeHandle | handle | ) | [inherited] |
Returns true if the current object is the indicated type exactly.
bool isOfType | ( | TypeHandle | handle | ) | [inherited] |
Returns true if the current object is or derives from the indicated type.
static listEffects | ( | ostream | out | ) | [static, inherited] |
Lists all of the RenderEffects in the cache to the output stream, one per line.
This can be quite a lot of output if the cache is large, so be prepared.
static RenderEffect const make | ( | float | weight, |
ContribType | contrib, | ||
Point3 | effect_center | ||
) | [static] |
Constructs a new PolylightEffect object.
static RenderEffect const make | ( | float | weight, |
ContribType | contrib, | ||
Point3 | effect_center, | ||
vectorNodePath const | lights | ||
) | [static] |
Constructs a new PolylightEffect object.
static RenderEffect const make | ( | ) | [static] |
Constructs a new PolylightEffect object.
markBamModified | ( | ) | [inherited] |
Increments the bam_modified counter, so that this object will be invalidated and retransmitted on any open bam streams.
This should normally not need to be called by user code; it should be called internally when the object has been changed in a way that legitimately requires its retransmission to any connected clients.
output | ( | ostream | out | ) | [inherited] |
PyObject reduce | ( | PyObject | self | ) | [inherited] |
This special Python method is implement to provide support for the pickle module.
This hooks into the native pickle and cPickle modules, but it cannot properly handle self-referential BAM objects.
PyObject reducePersist | ( | PyObject | self, |
PyObject | pickler | ||
) | [inherited] |
This special Python method is implement to provide support for the pickle module.
This is similar to __reduce__, but it provides additional support for the missing persistent-state object needed to properly support self-referential BAM objects written to the pickle stream. This hooks into the pickle and cPickle modules implemented in direct/src/stdpy.
ref | ( | ) | [inherited] |
Explicitly increments the reference count.
User code should avoid using ref() and unref() directly, which can result in missed reference counts. Instead, let a PointerTo object manage the reference counting automatically.
This function is const, even though it changes the object, because generally fiddling with an object's reference count isn't considered part of fiddling with the object. An object might be const in other ways, but we still need to accurately count the number of references to it.
RenderEffect const removeLight | ( | NodePath const | newlight | ) |
Remove a light from this effect.
Return the new updated effect
RenderEffect const setContrib | ( | 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
RenderEffect const setEffectCenter | ( | Point3 | 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
RenderEffect const 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
bool testRefCountIntegrity | ( | ) | [inherited] |
Does some easy checks to make sure that the reference count isn't completely bogus.
Returns true if ok, false otherwise.
Reimplemented in NodeReferenceCount, CachedTypedWritableReferenceCount, and NodeCachedReferenceCount.
bool testRefCountNonzero | ( | ) | [inherited] |
Does some easy checks to make sure that the reference count isn't zero, or completely bogus.
Returns true if ok, false otherwise.
bool unref | ( | ) | [inherited] |
Explicitly decrements the reference count.
Note that the object will not be implicitly deleted by unref() simply because the reference count drops to zero. (Having a member function delete itself is problematic.) However, see the helper function unref_delete().
User code should avoid using ref() and unref() directly, which can result in missed reference counts. Instead, let a PointerTo object manage the reference counting automatically.
This function is const, even though it changes the object, because generally fiddling with an object's reference count isn't considered part of fiddling with the object. An object might be const in other ways, but we still need to accurately count the number of references to it.
The return value is true if the new reference count is nonzero, false if it is zero.
Reimplemented in GeomVertexArrayFormat, and GeomVertexFormat.
static bool validateEffects | ( | ) | [static, inherited] |
Ensures that the cache is still stored in sorted order.
Returns true if so, false if there is a problem (which implies someone has modified one of the supposedly-const RenderEffect objects).