Panda3D
|
A Light Ramp is any unary operator that takes a rendered pixel as input, and adjusts the brightness of that pixel. More...
Public Types | |
enum | LightRampMode { LRTDefault = 0, LRTIdentity = 1, LRTSingleThreshold = 2, LRTDoubleThreshold = 3, LRTHdr0 = 4, LRTHdr1 = 5, LRTHdr2 = 6 } |
enum | PandaCompareFunc { MNone = 0, MNever = 1, MLess = 2, MEqual = 3, MLessEqual = 4, MGreater = 5, MNotEqual = 6, MGreaterEqual = 7, MAlways = 8 } |
enum | TexGenMode { MOff = 0, MEyeSphereMap = 1, MWorldCubeMap = 2, MEyeCubeMap = 3, MWorldNormal = 4, MEyeNormal = 5, MWorldPosition = 6, MUnused = 7, MEyePosition = 8, MPointSprite = 9, MLightVector = 10, MConstant = 11 } |
Public Member Functions | |
int | compareTo (RenderAttrib const other) |
Provides an arbitrary ordering among all unique RenderAttribs, so we can store the essentially different ones in a big set and throw away the rest. | |
RenderAttrib const | compose (RenderAttrib const other) |
Returns a new RenderAttrib object that represents the composition of this attrib with the other attrib. | |
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. | |
float | getLevel (int n) |
Returns the nth lighting level. | |
LightRampMode | getMode () |
Returns the LightRampAttrib mode. | |
int | getRefCount () |
Returns the current reference count. | |
int | getSlot () |
float | getThreshold (int n) |
Returns the nth threshold level. | |
TypeHandle | getType () |
int | getTypeIndex () |
Returns the internal index number associated with this object's TypeHandle, a unique number for each different type. | |
RenderAttrib const | getUnique () |
Returns the pointer to the unique RenderAttrib in the cache that is equivalent to this one. | |
RenderAttrib const | invertCompose (RenderAttrib const other) |
Returns a new RenderAttrib object that represents the composition of the inverse of this attrib with the other attrib. | |
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. | |
bool | lowerAttribCanOverride () |
Intended to be overridden by derived RenderAttrib types to specify how two consecutive RenderAttrib objects of the same type interact. | |
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. | |
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 int | getClassSlot () |
static TypeHandle | getClassType () |
static int | getNumAttribs () |
Returns the total number of unique RenderAttrib objects allocated in the world. | |
static | listAttribs (ostream out) |
Lists all of the RenderAttribs in the cache to the output stream, one per line. | |
static RenderAttrib const | makeDefault () |
Constructs a new LightRampAttrib object. | |
static RenderAttrib const | makeDoubleThreshold (float thresh0, float lev0, float thresh1, float lev1) |
Constructs a new LightRampAttrib object. | |
static RenderAttrib const | makeHdr0 () |
Constructs a new LightRampAttrib object. | |
static RenderAttrib const | makeHdr1 () |
Constructs a new LightRampAttrib object. | |
static RenderAttrib const | makeHdr2 () |
Constructs a new LightRampAttrib object. | |
static RenderAttrib const | makeIdentity () |
Constructs a new LightRampAttrib object. | |
static RenderAttrib const | makeSingleThreshold (float thresh0, float lev0) |
Constructs a new LightRampAttrib object. | |
static bool | validateAttribs () |
Ensures that the cache is still stored in sorted order. |
A Light Ramp is any unary operator that takes a rendered pixel as input, and adjusts the brightness of that pixel.
For example, gamma correction is a kind of light ramp. So is HDR tone mapping. So is cartoon shading. See the constructors for an explanation of each kind of ramp.
enum LightRampMode |
enum PandaCompareFunc [inherited] |
enum TexGenMode [inherited] |
int compareTo | ( | RenderAttrib const | other | ) | [inherited] |
Provides an arbitrary ordering among all unique RenderAttribs, 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 RenderAttrib class because all equivalent RenderAttrib objects are guaranteed to share the same pointer; thus, a pointer comparison is always sufficient.
RenderAttrib const compose | ( | RenderAttrib const | other | ) | [inherited] |
Returns a new RenderAttrib object that represents the composition of this attrib with the other attrib.
In most cases, this is the same as the other attrib; a compose b produces b. Some kinds of attributes, like a TextureTransform, for instance, might produce a new result: a compose b produces c.
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.
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.
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.
UpdateSeq getBamModified | ( | ) | [inherited] |
Returns the current bam_modified counter.
This counter is normally incremented automatically whenever the object is modified.
static int getClassSlot | ( | ) | [static] |
static TypeHandle getClassType | ( | ) | [static] |
Reimplemented from RenderAttrib.
float getLevel | ( | int | n | ) |
Returns the nth lighting level.
LightRampMode getMode | ( | ) |
Returns the LightRampAttrib mode.
static int getNumAttribs | ( | ) | [static, inherited] |
Returns the total number of unique RenderAttrib objects allocated in the world.
This will go up and down during normal operations.
int getRefCount | ( | ) | [inherited] |
Returns the current reference count.
int getSlot | ( | ) | [inherited] |
float getThreshold | ( | int | n | ) |
Returns the nth threshold level.
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().
RenderAttrib const getUnique | ( | ) | [inherited] |
Returns the pointer to the unique RenderAttrib in the cache that is equivalent to this one.
This may be the same pointer as this object, or it may be a different pointer; but it will be an equivalent object, and it will be a shared pointer. This may be called from time to time to improve cache benefits.
RenderAttrib const invertCompose | ( | RenderAttrib const | other | ) | [inherited] |
Returns a new RenderAttrib object that represents the composition of the inverse of this attrib with the other attrib.
In most cases, this is the same as the other attrib; !a compose b produces b. Some kinds of attributes, like a TextureTransform, for instance, might produce a new result: !a compose b produces c.
This is similar to compose() except that the source attrib is inverted first. This is used to compute the relative attribute for one node as viewed from some other node, which is especially useful for transform-type attributes.
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 listAttribs | ( | ostream | out | ) | [static, inherited] |
Lists all of the RenderAttribs 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.
bool lowerAttribCanOverride | ( | ) | [inherited] |
Intended to be overridden by derived RenderAttrib types to specify how two consecutive RenderAttrib objects of the same type interact.
This should return false if a RenderAttrib on a higher node will compose into a RenderAttrib on a lower node that has a higher override value, or true if the lower RenderAttrib will completely replace the state.
The default behavior is false: normally, a RenderAttrib in the graph cannot completely override a RenderAttrib above it, regardless of its override value--instead, the two attribs are composed. But for some kinds of RenderAttribs, it is useful to allow this kind of override.
This method only handles the one special case of a lower RenderAttrib with a higher override value. If the higher RenderAttrib has a higher override value, it always completely overrides. And if both RenderAttribs have the same override value, they are always composed.
static RenderAttrib const makeDefault | ( | ) | [static] |
Constructs a new LightRampAttrib object.
This is the standard OpenGL lighting ramp, which clamps the final light total to the 0-1 range.
static RenderAttrib const makeDoubleThreshold | ( | float | thresh0, |
float | lev0, | ||
float | thresh1, | ||
float | lev1 | ||
) | [static] |
Constructs a new LightRampAttrib object.
This causes the luminance of the diffuse lighting contribution to be quantized using two thresholds:
if (original_luminance > threshold1) { luminance = level1; } else if (original_luminance > threshold0) { luminance = level0; } else { luminance = 0.0; }
static RenderAttrib const makeHdr0 | ( | ) | [static] |
Constructs a new LightRampAttrib object.
This causes an HDR tone mapping operation to be applied.
Normally, brightness values greater than 1 cannot be distinguished from each other, causing very brightly lit objects to wash out white and all detail to be erased. HDR tone mapping remaps brightness values in the range 0-infinity into the range (0,1), making it possible to distinguish detail in scenes whose brightness exceeds 1.
However, the monitor has finite contrast. Normally, all of that contrast is used to represent brightnesses in the range 0-1. The HDR0 tone mapping operator 'steals' one quarter of that contrast to represent brightnesses in the range 1-infinity.
FINAL_RGB = (RGB^3 + RGB^2 + RGB) / (RGB^3 + RGB^2 + RGB + 1)
static RenderAttrib const makeHdr1 | ( | ) | [static] |
Constructs a new LightRampAttrib object.
This causes an HDR tone mapping operation to be applied.
Normally, brightness values greater than 1 cannot be distinguished from each other, causing very brightly lit objects to wash out white and all detail to be erased. HDR tone mapping remaps brightness values in the range 0-infinity into the range (0,1), making it possible to distinguish detail in scenes whose brightness exceeds 1.
However, the monitor has finite contrast. Normally, all of that contrast is used to represent brightnesses in the range 0-1. The HDR1 tone mapping operator 'steals' one third of that contrast to represent brightnesses in the range 1-infinity.
FINAL_RGB = (RGB^2 + RGB) / (RGB^2 + RGB + 1)
static RenderAttrib const makeHdr2 | ( | ) | [static] |
Constructs a new LightRampAttrib object.
This causes an HDR tone mapping operation to be applied.
Normally, brightness values greater than 1 cannot be distinguished from each other, causing very brightly lit objects to wash out white and all detail to be erased. HDR tone mapping remaps brightness values in the range 0-infinity into the range (0,1), making it possible to distinguish detail in scenes whose brightness exceeds 1.
However, the monitor has finite contrast. Normally, all of that contrast is used to represent brightnesses in the range 0-1. The HDR2 tone mapping operator 'steals' one half of that contrast to represent brightnesses in the range 1-infinity.
FINAL_RGB = (RGB) / (RGB + 1)
static RenderAttrib const makeIdentity | ( | ) | [static] |
Constructs a new LightRampAttrib object.
This differs from the usual OpenGL lighting model in that it does not clamp the final lighting total to (0,1).
static RenderAttrib const makeSingleThreshold | ( | float | thresh0, |
float | lev0 | ||
) | [static] |
Constructs a new LightRampAttrib object.
This causes the luminance of the diffuse lighting contribution to be quantized using a single threshold:
if (original_luminance > threshold0) { luminance = level0; } else { luminance = 0.0; }
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.
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 validateAttribs | ( | ) | [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 RenderAttrib objects).