Panda3D
|
This is the base class for a number of render attributes (other than transform) that may be set on scene graph nodes to control the appearance of geometry. More...
#include <pandadoc.hpp>
Public Types | |
enum | PandaCompareFunc { M_none = 0 , M_never = 1 , M_less = 2 , M_equal = 3 , M_less_equal = 4 , M_greater = 5 , M_not_equal = 6 , M_greater_equal = 7 , M_always = 8 } |
enum | TexGenMode { M_off = 0 , M_eye_sphere_map = 1 , M_world_cube_map = 2 , M_eye_cube_map = 3 , M_world_normal = 4 , M_eye_normal = 5 , M_world_position = 6 , M_unused = 7 , M_eye_position = 8 , M_point_sprite = 9 , M_unused2 = 10 , M_constant = 11 } |
Public Member Functions | |
int | compareTo (const RenderAttrib 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. | |
const RenderAttrib | compose (const RenderAttrib other) |
Returns a new RenderAttrib object that represents the composition of this attrib with the other attrib. | |
int | getHash () |
Returns a suitable hash value for phash_map. | |
int | getSlot () |
const RenderAttrib | getUnique () |
Returns the pointer to the unique RenderAttrib in the cache that is equivalent to this one. | |
const RenderAttrib | invertCompose (const RenderAttrib other) |
Returns a new RenderAttrib object that represents the composition of the inverse of this attrib with the other attrib. | |
bool | lowerAttribCanOverride () |
Intended to be overridden by derived RenderAttrib types to specify how two consecutive RenderAttrib objects of the same type interact. | |
output (Ostream out) | |
write (Ostream out, int indent_level) | |
![]() | |
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. | |
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. | |
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. | |
UpdateSeq | getBamModified () |
Returns the current bam_modified counter. | |
markBamModified () | |
Increments the bam_modified counter, so that this object will be invalidated and retransmitted on any open bam streams. | |
![]() | |
TypeHandle | getType () |
int | getTypeIndex () |
Returns the internal index number associated with this object's TypeHandle, a unique number for each different type. | |
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. | |
![]() | |
int | getRefCount () |
Returns the current reference count. | |
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. | |
Static Public Member Functions | |
static int | garbageCollect () |
Performs a garbage-collection cycle. | |
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 bool | validateAttribs () |
Ensures that the cache is still stored in sorted order. | |
![]() | |
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. | |
static TypeHandle | getClassType () |
![]() | |
static TypeHandle | getClassType () |
![]() | |
static TypeHandle | getClassType () |
![]() | |
static TypeHandle | getClassType () |
Public Attributes | |
int | slot |
![]() | |
TypeHandle | type |
Returns the TypeHandle representing this object's type. | |
![]() | |
int | ref_count |
The current reference count. | |
This is the base class for a number of render attributes (other than transform) that may be set on scene graph nodes to control the appearance of geometry.
This includes TextureAttrib, ColorAttrib, etc.
RenderAttrib represents render attributes that always propagate down to the leaves without regard to the particular node they are assigned to. A RenderAttrib will have the same effect on a leaf node whether it is assigned to the graph at the leaf or several nodes above. This is different from RenderEffect, which represents a particular render property that is applied immediately to the node on which it is encountered, like billboarding or decaling.
You should not attempt to create or modify a RenderAttrib directly; instead, use the make() method of the appropriate kind of attrib you want. This will allocate and return a new RenderAttrib of the appropriate type, and it may share pointers if possible. Do not modify the new RenderAttrib if you wish to change its properties; instead, create a new one.
enum PandaCompareFunc |
enum TexGenMode |
Enumerator | |
---|---|
M_off | |
M_eye_sphere_map | Sphere maps are classic static reflection maps. They are supported on just about any hardware, and require a precomputed 360-degree fisheye image. Sphere maps only make sense in eye coordinate space. |
M_world_cube_map |
|
M_eye_cube_map | |
M_world_normal | Normal maps are most useful for applying diffuse lighting effects via a pregenerated cube map. |
M_eye_normal | |
M_world_position | Position maps convert XYZ coordinates directly to texture coordinates. This is particularly useful for implementing projective texturing (see NodePath::project_texture()). |
M_unused | formerly M_object_position, now deprecated. |
M_eye_position | |
M_point_sprite |
|
M_unused2 | M_light_vector generated special 3-d texture coordinates that represented the vector to a particular Light in the scene graph, expressed in each vertex's tangent space. This has now been removed. We need to reserve the slot in the enum, though, to make sure the following enum value still has the same value. |
M_constant | M_constant generates the same fixed texture coordinates at each vertex. Not terribly useful, of course, except for certain special effects involving moving a flat color over an object. |
int compareTo | ( | const RenderAttrib | 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.
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.
const RenderAttrib compose | ( | const RenderAttrib | other | ) |
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 |
Performs a garbage-collection cycle.
This is called automatically from RenderState::garbage_collect(); see that method for more information.
|
static |
int getHash | ( | ) |
Returns a suitable hash value for phash_map.
|
static |
Returns the total number of unique RenderAttrib objects allocated in the world.
This will go up and down during normal operations.
int getSlot | ( | ) |
const RenderAttrib getUnique | ( | ) |
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.
const RenderAttrib invertCompose | ( | const RenderAttrib | other | ) |
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.
|
static |
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 | ( | ) |
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.
output | ( | Ostream | out | ) |
|
static |
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).
write | ( | Ostream | out, |
int | indent_level ) |
int slot |