This functions similarly to a LightAttrib. More...
#include "clipPlaneAttrib.h"
Public Types | |
enum | Operation { O_set, O_add, O_remove } |
![]() | |
enum | PandaCompareFunc { M_none =0, M_never, M_less, M_equal, M_less_equal, M_greater, M_not_equal, M_greater_equal, M_always } |
enum | TexGenMode { M_off, M_eye_sphere_map, M_world_cube_map, M_eye_cube_map, M_world_normal, M_eye_normal, M_world_position, M_unused, M_eye_position, M_point_sprite, M_unused2, M_constant } |
Public Member Functions | |
virtual int | complete_pointers (TypedWritable **plist, BamReader *manager) |
Receives an array of pointers, one for each time manager->read_pointer() was called in fillin(). More... | |
CPT (RenderAttrib) add_plane(PlaneNode *plane) const | |
CPT (RenderAttrib) remove_plane(PlaneNode *plane) const | |
CPT (RenderAttrib) add_on_plane(const NodePath &plane) const | |
CPT (RenderAttrib) remove_on_plane(const NodePath &plane) const | |
CPT (RenderAttrib) add_off_plane(const NodePath &plane) const | |
CPT (RenderAttrib) remove_off_plane(const NodePath &plane) const | |
CPT (ClipPlaneAttrib) filter_to_max(int max_clip_planes) const | |
CPT (RenderAttrib) compose_off(const RenderAttrib *other) const | |
virtual TypeHandle | force_init_type () |
int | get_num_off_planes () const |
Returns the number of planes that are disabled by the attribute. More... | |
int | get_num_on_planes () const |
Returns the number of planes that are enabled by the attribute. More... | |
int | get_num_planes () const |
Returns the number of planes listed in the attribute. More... | |
NodePath | get_off_plane (int n) const |
Returns the nth plane disabled by the attribute, sorted in arbitrary (pointer) order. More... | |
NodePath | get_on_plane (int n) const |
Returns the nth plane enabled by the attribute, sorted in render order. More... | |
Operation | get_operation () const |
Returns the basic operation type of the ClipPlaneAttrib. More... | |
PlaneNode * | get_plane (int n) const |
Returns the nth plane listed in the attribute. More... | |
virtual int | get_slot () const |
virtual TypeHandle | get_type () const |
bool | has_all_off () const |
Returns true if this attrib disables all planes (although it may also enable some). More... | |
bool | has_off_plane (const NodePath &plane) const |
Returns true if the indicated plane is disabled by the attrib, false otherwise. More... | |
bool | has_on_plane (const NodePath &plane) const |
Returns true if the indicated plane is enabled by the attrib, false otherwise. More... | |
bool | has_plane (PlaneNode *plane) const |
Returns true if the indicated plane is listed in the attrib, false otherwise. More... | |
bool | is_identity () const |
Returns true if this is an identity attrib: it does not change the set of planes in use. More... | |
MAKE_SEQ (get_on_planes, get_num_on_planes, get_on_plane) | |
MAKE_SEQ (get_off_planes, get_num_off_planes, get_off_plane) | |
virtual void | output (ostream &out) const |
virtual bool | require_fully_complete () const |
Some objects require all of their nested pointers to have been completed before the objects themselves can be completed. More... | |
virtual void | write_datagram (BamWriter *manager, Datagram &dg) |
Writes the contents of this object to the datagram for shipping out to a Bam file. More... | |
![]() | |
virtual | ~RenderAttrib () |
The destructor is responsible for removing the RenderAttrib from the global set if it is there. More... | |
bool | always_reissue () const |
int | compare_to (const RenderAttrib &other) const |
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. More... | |
CPT (RenderAttrib) compose(const RenderAttrib *other) const | |
CPT (RenderAttrib) invert_compose(const RenderAttrib *other) const | |
CPT (RenderAttrib) get_unique() const | |
CPT (RenderAttrib) get_auto_shader_attrib(const RenderState *state) const | |
virtual bool | cull_callback (CullTraverser *trav, const CullTraverserData &data) const |
If has_cull_callback() returns true, this function will be called during the cull traversal to perform any additional operations that should be performed at cull time. More... | |
virtual void | finalize (BamReader *manager) |
Called by the BamReader to perform any final actions needed for setting up the object after all objects have been read and all pointers have been completed. More... | |
size_t | get_hash () const |
Returns a suitable hash value for phash_map. More... | |
virtual bool | has_cull_callback () const |
Should be overridden by derived classes to return true if cull_callback() has been defined. More... | |
virtual bool | lower_attrib_can_override () const |
Intended to be overridden by derived RenderAttrib types to specify how two consecutive RenderAttrib objects of the same type interact. More... | |
virtual bool | unref () const FINAL |
Explicitly decrements the reference count. More... | |
virtual void | write (ostream &out, int indent_level) const |
![]() | |
TypedWritableReferenceCount (const TypedWritableReferenceCount ©) | |
virtual ReferenceCount * | as_reference_count () |
Returns the pointer cast to a ReferenceCount pointer, if it is in fact of that type. More... | |
void | operator= (const TypedWritableReferenceCount ©) |
![]() | |
TypedWritable (const TypedWritable ©) | |
string | encode_to_bam_stream () const |
Converts the TypedWritable object into a single stream of data using a BamWriter, and returns that data as a string string. More... | |
bool | encode_to_bam_stream (string &data, BamWriter *writer=NULL) const |
Converts the TypedWritable object into a single stream of data using a BamWriter, and stores that data in the indicated string. More... | |
UpdateSeq | get_bam_modified () const |
Returns the current bam_modified counter. More... | |
void | mark_bam_modified () |
Increments the bam_modified counter, so that this object will be invalidated and retransmitted on any open bam streams. More... | |
void | operator= (const TypedWritable ©) |
virtual void | update_bam_nested (BamWriter *manager) |
Called by the BamWriter when this object has not itself been modified recently, but it should check its nested objects for updates. More... | |
![]() | |
TypedObject (const TypedObject ©) | |
TypedObject * | as_typed_object () |
Returns the object, upcast (if necessary) to a TypedObject pointer. More... | |
const TypedObject * | as_typed_object () const |
Returns the object, upcast (if necessary) to a TypedObject pointer. More... | |
int | get_best_parent_from_Set (const std::set< int > &) const |
int | get_type_index () const |
Returns the internal index number associated with this object's TypeHandle, a unique number for each different type. More... | |
bool | is_exact_type (TypeHandle handle) const |
Returns true if the current object is the indicated type exactly. More... | |
bool | is_of_type (TypeHandle handle) const |
Returns true if the current object is or derives from the indicated type. More... | |
void | operator= (const TypedObject ©) |
![]() | |
int | get_ref_count () const |
Returns the current reference count. More... | |
WeakReferenceList * | get_weak_list () const |
Returns the WeakReferenceList associated with this ReferenceCount object. More... | |
bool | has_weak_list () const |
Returns true if this particular ReferenceCount object has a WeakReferenceList created, false otherwise. More... | |
void | local_object () |
This function should be called, once, immediately after creating a new instance of some ReferenceCount-derived object on the stack. More... | |
void | ref () const |
Explicitly increments the reference count. More... | |
bool | test_ref_count_integrity () const |
Does some easy checks to make sure that the reference count isn't completely bogus. More... | |
bool | test_ref_count_nonzero () const |
Does some easy checks to make sure that the reference count isn't zero, or completely bogus. More... | |
void | weak_ref (WeakPointerToVoid *ptv) |
Adds the indicated PointerToVoid as a weak reference to this object. More... | |
void | weak_unref (WeakPointerToVoid *ptv) |
Removes the indicated PointerToVoid as a weak reference to this object. More... | |
Static Public Member Functions | |
static | CPT (RenderAttrib) make(Operation op |
static | CPT (RenderAttrib) make(Operation op |
static | CPT (RenderAttrib) make(Operation op |
static | CPT (RenderAttrib) make(Operation op |
static | CPT (RenderAttrib) make_default() |
static | CPT (RenderAttrib) make() |
static | CPT (RenderAttrib) make_all_off() |
static int | get_class_slot () |
static TypeHandle | get_class_type () |
static void | init_type () |
static void | register_with_read_factory () |
Tells the BamReader how to create objects of type ClipPlaneAttrib. More... | |
![]() | |
static TypedWritable * | change_this (TypedWritable *old_ptr, BamReader *manager) |
Called immediately after complete_pointers(), this gives the object a chance to adjust its own pointer if desired. More... | |
static int | garbage_collect () |
Performs a garbage-collection cycle. More... | |
static TypeHandle | get_class_type () |
static int | get_num_attribs () |
Returns the total number of unique RenderAttrib objects allocated in the world. More... | |
static void | init_attribs () |
Make sure the global _attribs map is allocated. More... | |
static void | init_type () |
static void | list_attribs (ostream &out) |
Lists all of the RenderAttribs in the cache to the output stream, one per line. More... | |
static int | register_slot (TypeHandle type_handle, int sort, RenderAttribRegistry::MakeDefaultFunc *make_default_func) |
Adds the indicated TypeHandle to the registry, if it is not there already, and returns a unique slot number. More... | |
static bool | validate_attribs () |
Ensures that the cache is still stored in sorted order. More... | |
![]() | |
static TypeHandle | get_class_type () |
static void | init_type () |
static | PT (TypedWritableReferenceCount) decode_from_bam_stream(const string &data |
![]() | |
static bool | decode_raw_from_bam_stream (TypedWritable *&ptr, ReferenceCount *&ref_ptr, const string &data, BamReader *reader=NULL) |
Reads the string created by a previous call to encode_to_bam_stream(), and extracts the single object on that string. More... | |
static TypeHandle | get_class_type () |
static void | init_type () |
![]() | |
static TypeHandle | get_class_type () |
static void | init_type () |
This function is declared non-inline to work around a compiler bug in g++ 2.96. More... | |
![]() | |
static TypeHandle | get_class_type () |
static void | init_type () |
Public Attributes | |
static PlaneNode * | plane |
static PlaneNode * | plane1 |
static PlaneNode PlaneNode * | plane2 |
static PlaneNode PlaneNode PlaneNode * | plane3 |
static PlaneNode PlaneNode PlaneNode PlaneNode * | plane4 |
![]() | |
static BamReader * | reader = NULL) |
Additional Inherited Members | |
![]() | |
static TypedWritable *const | Null = (TypedWritable*)0L |
This functions similarly to a LightAttrib.
It indicates the set of clipping planes that modify the geometry at this level and below. A ClipPlaneAttrib can either add planes or remove planes from the total set of clipping planes in effect.
Definition at line 34 of file clipPlaneAttrib.h.
|
virtual |
Receives an array of pointers, one for each time manager->read_pointer() was called in fillin().
Returns the number of pointers processed.
Reimplemented from TypedWritable.
Definition at line 989 of file clipPlaneAttrib.cxx.
References ordered_vector< Key, Compare, Vector >::begin(), TypedWritable::complete_pointers(), ordered_vector< Key, Compare, Vector >::end(), AttribNodeRegistry::find_node(), AttribNodeRegistry::get_node(), and ov_set< Key, Compare, Vector >::sort().
|
inline |
Returns the number of planes that are disabled by the attribute.
Definition at line 83 of file clipPlaneAttrib.I.
References ordered_vector< Key, Compare, Vector >::size().
Referenced by get_num_planes(), get_operation(), get_plane(), has_plane(), and write_datagram().
|
inline |
Returns the number of planes that are enabled by the attribute.
Definition at line 49 of file clipPlaneAttrib.I.
References ordered_vector< Key, Compare, Vector >::size().
Referenced by PGItem::activate_region(), GraphicsStateGuardian::fetch_specified_part(), get_num_planes(), and write_datagram().
int ClipPlaneAttrib::get_num_planes | ( | ) | const |
Returns the number of planes listed in the attribute.
This method is now deprecated. ClipPlaneAttribs nowadays have a separate list of on_planes and off_planes, so this method doesn't make sense. Query the lists independently.
Definition at line 268 of file clipPlaneAttrib.cxx.
References get_num_off_planes(), and get_num_on_planes().
|
inline |
Returns the nth plane disabled by the attribute, sorted in arbitrary (pointer) order.
Definition at line 94 of file clipPlaneAttrib.I.
References NodePath::fail(), and ordered_vector< Key, Compare, Vector >::size().
Referenced by get_plane().
|
inline |
Returns the nth plane enabled by the attribute, sorted in render order.
Definition at line 60 of file clipPlaneAttrib.I.
References NodePath::fail(), and ordered_vector< Key, Compare, Vector >::size().
Referenced by PGItem::activate_region(), GraphicsStateGuardian::fetch_specified_part(), and get_plane().
ClipPlaneAttrib::Operation ClipPlaneAttrib::get_operation | ( | ) | const |
Returns the basic operation type of the ClipPlaneAttrib.
If this is O_set, the planes listed here completely replace any planes that were already on. If this is O_add, the planes here are added to the set of of planes that were already on, and if O_remove, the planes here are removed from the set of planes that were on.
This method is now deprecated. ClipPlaneAttribs nowadays have a separate list of on_planes and off_planes, so this method doesn't make sense. Query the lists independently.
Definition at line 242 of file clipPlaneAttrib.cxx.
References get_num_off_planes(), and has_all_off().
PlaneNode * ClipPlaneAttrib::get_plane | ( | int | n | ) | const |
Returns the nth plane listed in the attribute.
This method is now deprecated. ClipPlaneAttribs nowadays have a separate list of on_planes and off_planes, so this method doesn't make sense. Query the lists independently.
Definition at line 290 of file clipPlaneAttrib.cxx.
References get_num_off_planes(), get_off_plane(), and get_on_plane().
|
inline |
Returns true if this attrib disables all planes (although it may also enable some).
Definition at line 118 of file clipPlaneAttrib.I.
Referenced by get_operation(), and NodePath::has_clip_plane_off().
|
inline |
Returns true if the indicated plane is disabled by the attrib, false otherwise.
Definition at line 106 of file clipPlaneAttrib.I.
References ordered_vector< Key, Compare, Vector >::end(), and has_on_plane().
Referenced by NodePath::has_clip_plane_off(), and has_plane().
|
inline |
Returns true if the indicated plane is enabled by the attrib, false otherwise.
Definition at line 72 of file clipPlaneAttrib.I.
References ordered_vector< Key, Compare, Vector >::end().
Referenced by NodePath::has_clip_plane(), has_off_plane(), and has_plane().
bool ClipPlaneAttrib::has_plane | ( | PlaneNode * | plane | ) | const |
Returns true if the indicated plane is listed in the attrib, false otherwise.
This method is now deprecated. ClipPlaneAttribs nowadays have a separate list of on_planes and off_planes, so this method doesn't make sense. Query the lists independently.
Definition at line 313 of file clipPlaneAttrib.cxx.
References get_num_off_planes(), has_off_plane(), and has_on_plane().
|
inline |
Returns true if this is an identity attrib: it does not change the set of planes in use.
Definition at line 129 of file clipPlaneAttrib.I.
References ordered_vector< Key, Compare, Vector >::empty().
|
static |
Tells the BamReader how to create objects of type ClipPlaneAttrib.
Definition at line 942 of file clipPlaneAttrib.cxx.
References BamReader::get_factory(), and Factory< Type >::register_factory().
|
virtual |
Some objects require all of their nested pointers to have been completed before the objects themselves can be completed.
If this is the case, override this method to return true, and be careful with circular references (which would make the object unreadable from a bam file).
Reimplemented from TypedWritable.
Definition at line 1041 of file clipPlaneAttrib.cxx.
Writes the contents of this object to the datagram for shipping out to a Bam file.
Reimplemented from RenderAttrib.
Definition at line 953 of file clipPlaneAttrib.cxx.
References Datagram::add_bool(), Datagram::add_uint16(), ordered_vector< Key, Compare, Vector >::begin(), ordered_vector< Key, Compare, Vector >::end(), get_num_off_planes(), get_num_on_planes(), NodePath::node(), RenderAttrib::write_datagram(), and BamWriter::write_pointer().