|
Panda3D
|
This functions similarly to a LightAttrib. More...
#include "clipPlaneAttrib.h"
Classes | |
| class | BamAuxData |
Public Types | |
| typedef pvector< PointerTo< PandaNode > > | NodeList |
| enum | Operation { O_set , O_add , O_remove } |
Public Types inherited from RenderAttrib | |
| 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 | |
| ConstPointerTo< RenderAttrib > | add_off_plane (const NodePath &plane) const |
| Returns a new ClipPlaneAttrib, just like this one, but with the indicated plane added to the list of planes disabled by this attrib. | |
| ConstPointerTo< RenderAttrib > | add_on_plane (const NodePath &plane) const |
| Returns a new ClipPlaneAttrib, just like this one, but with the indicated plane added to the list of planes enabled by this attrib. | |
| ConstPointerTo< RenderAttrib > | add_plane (PlaneNode *plane) const |
| Returns a new ClipPlaneAttrib, just like this one, but with the indicated plane added to the list of planes. | |
| virtual int | complete_pointers (TypedWritable **plist, BamReader *manager) |
| Receives an array of pointers, one for each time manager->read_pointer() was called in fillin(). | |
| ConstPointerTo< RenderAttrib > | compose_off (const RenderAttrib *other) const |
| This is a special method which composes two ClipPlaneAttribs with regard only to their set of "off" clip planes, for the purposes of deriving PandaNode::get_off_clip_planes(). | |
| ConstPointerTo< ClipPlaneAttrib > | filter_to_max (int max_clip_planes) const |
| Returns a new ClipPlaneAttrib, very much like this one, but with the number of on_planes reduced to be no more than max_clip_planes. | |
| 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. | |
| virtual TypeHandle | force_init_type () |
| int | get_num_off_planes () const |
| int | get_num_on_planes () const |
| int | get_num_planes () const |
| Returns the number of planes listed in the attribute. | |
| NodePath | get_off_plane (int n) const |
| NodePath | get_on_plane (int n) const |
| Operation | get_operation () const |
| Returns the basic operation type of the ClipPlaneAttrib. | |
| PlaneNode * | get_plane (int n) const |
| Returns the nth plane listed in the attribute. | |
| 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). | |
| bool | has_off_plane (const NodePath &plane) const |
| Returns true if the indicated plane is disabled by the attrib, false otherwise. | |
| bool | has_on_plane (const NodePath &plane) const |
| Returns true if the indicated plane is enabled by the attrib, false otherwise. | |
| bool | has_plane (PlaneNode *plane) const |
| Returns true if the indicated plane is listed in the attrib, false otherwise. | |
| bool | is_identity () const |
| Returns true if this is an identity attrib: it does not change the set of planes in use. | |
| virtual void | output (std::ostream &out) const |
| ConstPointerTo< RenderAttrib > | remove_off_plane (const NodePath &plane) const |
| Returns a new ClipPlaneAttrib, just like this one, but with the indicated plane removed from the list of planes disabled by this attrib. | |
| ConstPointerTo< RenderAttrib > | remove_on_plane (const NodePath &plane) const |
| Returns a new ClipPlaneAttrib, just like this one, but with the indicated plane removed from the list of planes enabled by this attrib. | |
| ConstPointerTo< RenderAttrib > | remove_plane (PlaneNode *plane) const |
| Returns a new ClipPlaneAttrib, just like this one, but with the indicated plane removed from the list of planes. | |
| virtual void | write_datagram (BamWriter *manager, Datagram &dg) |
| Writes the contents of this object to the datagram for shipping out to a Bam file. | |
Public Member Functions inherited from RenderAttrib | |
| RenderAttrib (const RenderAttrib ©)=delete | |
| virtual | ~RenderAttrib () |
| The destructor is responsible for removing the RenderAttrib from the global set if it is there. | |
| int | compare_to (const RenderAttrib &other) const |
| CPT (RenderAttrib) compose(const RenderAttrib *other) const | |
| CPT (RenderAttrib) get_unique() const | |
| CPT (RenderAttrib) invert_compose(const RenderAttrib *other) 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. | |
| size_t | get_hash () const |
| virtual bool | has_cull_callback () const |
| Should be overridden by derived classes to return true if cull_callback() has been defined. | |
| 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. | |
| RenderAttrib & | operator= (const RenderAttrib ©)=delete |
| virtual bool | unref () const final |
| This method overrides ReferenceCount::unref() to clear the pointer from the global object pool when its reference count goes to zero. | |
| virtual void | write (std::ostream &out, int indent_level) const |
Public Member Functions inherited from TypedWritableReferenceCount | |
| TypedWritableReferenceCount (const TypedWritableReferenceCount ©) | |
| virtual ReferenceCount * | as_reference_count () |
| Returns the pointer cast to a ReferenceCount pointer, if it is in fact of that type. | |
| void | operator= (const TypedWritableReferenceCount ©) |
Public Member Functions inherited from TypedWritable | |
| TypedWritable (const TypedWritable ©) | |
| vector_uchar | encode_to_bam_stream () const |
| Converts the TypedWritable object into a single stream of data using a BamWriter, and returns that data as a bytes object. | |
| bool | encode_to_bam_stream (vector_uchar &data, BamWriter *writer=nullptr) const |
| Converts the TypedWritable object into a single stream of data using a BamWriter, and stores that data in the indicated string. | |
| UpdateSeq | get_bam_modified () const |
| Returns the current bam_modified counter. | |
| void | mark_bam_modified () |
| Increments the bam_modified counter, so that this object will be invalidated and retransmitted on any open bam streams. | |
| void | operator= (const TypedWritable ©) |
| 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. | |
| 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. | |
Public Member Functions inherited from TypedObject | |
| TypedObject (const TypedObject ©)=default | |
| TypedObject * | as_typed_object () |
| Returns the object, upcast (if necessary) to a TypedObject pointer. | |
| const TypedObject * | as_typed_object () const |
| Returns the object, upcast (if necessary) to a TypedObject pointer. | |
| 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. | |
| bool | is_exact_type (TypeHandle handle) const |
| Returns true if the current object is the indicated type exactly. | |
| bool | is_of_type (TypeHandle handle) const |
| Returns true if the current object is or derives from the indicated type. | |
| TypedObject & | operator= (const TypedObject ©)=default |
Public Member Functions inherited from MemoryBase | |
| void | operator delete (void *, void *) |
| void | operator delete (void *ptr) |
| void | operator delete[] (void *, void *) |
| void | operator delete[] (void *ptr) |
| void * | operator new (size_t size) |
| void * | operator new (size_t size, void *ptr) |
| void * | operator new[] (size_t size) |
| void * | operator new[] (size_t size, void *ptr) |
Public Member Functions inherited from ReferenceCount | |
| int | get_ref_count () const |
| WeakReferenceList * | get_weak_list () const |
| Returns the WeakReferenceList associated with this ReferenceCount object. | |
| bool | has_weak_list () const |
| Returns true if this particular ReferenceCount object has a WeakReferenceList created, false otherwise. | |
| void | local_object () |
| This function should be called, once, immediately after creating a new instance of some ReferenceCount-derived object on the stack. | |
| void | ref () const |
| Explicitly increments the reference count. | |
| bool | ref_if_nonzero () const |
| Atomically increases the reference count of this object if it is not zero. | |
| bool | test_ref_count_integrity () const |
| Does some easy checks to make sure that the reference count isn't completely bogus. | |
| bool | test_ref_count_nonzero () const |
| Does some easy checks to make sure that the reference count isn't zero, or completely bogus. | |
| bool | unref_if_one () const |
| Atomically decreases the reference count of this object if it is one. | |
| WeakReferenceList * | weak_ref () |
| Adds the indicated PointerToVoid as a weak reference to this object. | |
| void | weak_unref () |
| Removes the indicated PointerToVoid as a weak reference to this object. | |
Static Public Member Functions | |
| static int | get_class_slot () |
| static TypeHandle | get_class_type () |
| static void | init_type () |
| static ConstPointerTo< RenderAttrib > | make () |
| Constructs a new ClipPlaneAttrib object that does nothing. | |
| static ConstPointerTo< RenderAttrib > | make (Operation op, PlaneNode *plane) |
| Constructs a new ClipPlaneAttrib object that enables (or disables, according to op) the indicated plane(s). | |
| static ConstPointerTo< RenderAttrib > | make (Operation op, PlaneNode *plane1, PlaneNode *plane2) |
| Constructs a new ClipPlaneAttrib object that turns on (or off, according to op) the indicate plane(s). | |
| static ConstPointerTo< RenderAttrib > | make (Operation op, PlaneNode *plane1, PlaneNode *plane2, PlaneNode *plane3) |
| Constructs a new ClipPlaneAttrib object that turns on (or off, according to op) the indicate plane(s). | |
| static ConstPointerTo< RenderAttrib > | make (Operation op, PlaneNode *plane1, PlaneNode *plane2, PlaneNode *plane3, PlaneNode *plane4) |
| Constructs a new ClipPlaneAttrib object that turns on (or off, according to op) the indicate plane(s). | |
| static ConstPointerTo< RenderAttrib > | make_all_off () |
| Constructs a new ClipPlaneAttrib object that disables all planes (and hence disables clipping). | |
| static ConstPointerTo< RenderAttrib > | make_default () |
| Returns a RenderAttrib that corresponds to whatever the standard default properties for render attributes of this type ought to be. | |
| static void | register_with_read_factory () |
| Tells the BamReader how to create objects of type ClipPlaneAttrib. | |
Static Public Member Functions inherited from RenderAttrib | |
| 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. | |
| static int | garbage_collect () |
| Performs a garbage-collection cycle. | |
| static TypeHandle | get_class_type () |
| static int | get_num_attribs () |
| Returns the total number of unique RenderAttrib objects allocated in the world. | |
| static void | init_attribs () |
| Make sure the global _attribs map is allocated. | |
| static void | init_type () |
| static void | list_attribs (std::ostream &out) |
| Lists all of the RenderAttribs in the cache to the output stream, one per line. | |
| static int | register_slot (TypeHandle type_handle, int sort, RenderAttrib *default_attrib) |
| Adds the indicated TypeHandle to the registry, if it is not there already, and returns a unique slot number. | |
| static bool | validate_attribs () |
| Ensures that the cache is still stored in sorted order. | |
Static Public Member Functions inherited from TypedWritableReferenceCount | |
| static TypeHandle | get_class_type () |
| static void | init_type () |
| static | PT (TypedWritableReferenceCount) decode_from_bam_stream(vector_uchar data |
Static Public Member Functions inherited from TypedWritable | |
| static bool | decode_raw_from_bam_stream (TypedWritable *&ptr, ReferenceCount *&ref_ptr, vector_uchar data, BamReader *reader=nullptr) |
| Reads the bytes created by a previous call to encode_to_bam_stream(), and extracts the single object on those bytes. | |
| static TypeHandle | get_class_type () |
| static void | init_type () |
Static Public Member Functions inherited from TypedObject | |
| 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. | |
Static Public Member Functions inherited from ReferenceCount | |
| static TypeHandle | get_class_type () |
| static void | init_type () |
Public Attributes | |
| get_class_slot | |
| get_num_off_planes | |
| Returns the number of planes that are disabled by the attribute. | |
| get_num_on_planes | |
| Returns the number of planes that are enabled by the attribute. | |
| get_off_plane | |
| Returns the nth plane disabled by the attribute, sorted in arbitrary (pointer) order. | |
| get_on_plane | |
| Returns the nth plane enabled by the attribute, sorted in render order. | |
Public Attributes inherited from RenderAttrib | |
| get_slot | |
Public Attributes inherited from TypedWritableReferenceCount | |
| static BamReader * | reader = nullptr) |
Public Attributes inherited from TypedObject | |
| get_type | |
Public Attributes inherited from ReferenceCount | |
| get_ref_count | |
| Returns the current reference count. | |
Additional Inherited Members | |
Static Public Attributes inherited from TypedWritable | |
| static TypedWritable *const | Null = nullptr |
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 31 of file clipPlaneAttrib.h.
| typedef pvector< PointerTo< PandaNode > > ClipPlaneAttrib::NodeList |
Definition at line 130 of file clipPlaneAttrib.h.
| enum ClipPlaneAttrib::Operation |
Definition at line 40 of file clipPlaneAttrib.h.
| ConstPointerTo< RenderAttrib > ClipPlaneAttrib::add_off_plane | ( | const NodePath & | plane | ) | const |
Returns a new ClipPlaneAttrib, just like this one, but with the indicated plane added to the list of planes disabled by this attrib.
Definition at line 398 of file clipPlaneAttrib.cxx.
References NodePath::is_empty(), TypedObject::is_of_type(), and NodePath::node().
Referenced by add_plane(), and NodePath::set_clip_plane_off().
| ConstPointerTo< RenderAttrib > ClipPlaneAttrib::add_on_plane | ( | const NodePath & | plane | ) | const |
Returns a new ClipPlaneAttrib, just like this one, but with the indicated plane added to the list of planes enabled by this attrib.
Definition at line 365 of file clipPlaneAttrib.cxx.
References NodePath::is_empty(), TypedObject::is_of_type(), and NodePath::node().
Referenced by add_plane(), and NodePath::set_clip_plane().
| ConstPointerTo< RenderAttrib > ClipPlaneAttrib::add_plane | ( | PlaneNode * | plane | ) | const |
Returns a new ClipPlaneAttrib, just like this one, but with the indicated plane added to the list of planes.
Definition at line 300 of file clipPlaneAttrib.cxx.
References add_off_plane(), add_on_plane(), and get_num_off_planes.
|
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 894 of file clipPlaneAttrib.cxx.
References TypedWritable::complete_pointers(), BamReader::get_aux_data(), and BamReader::get_file_minor_ver().
| ConstPointerTo< RenderAttrib > ClipPlaneAttrib::compose_off | ( | const RenderAttrib * | other | ) | const |
This is a special method which composes two ClipPlaneAttribs with regard only to their set of "off" clip planes, for the purposes of deriving PandaNode::get_off_clip_planes().
The result will be a ClipPlaneAttrib that represents the union of all of the clip planes turned off in either attrib. The set of on planes in the result is undefined and should be ignored.
Definition at line 481 of file clipPlaneAttrib.cxx.
References ordered_vector< Key, Compare, Vector >::begin(), ordered_vector< Key, Compare, Vector >::empty(), and ordered_vector< Key, Compare, Vector >::end().
| ConstPointerTo< ClipPlaneAttrib > ClipPlaneAttrib::filter_to_max | ( | int | max_clip_planes | ) | const |
Returns a new ClipPlaneAttrib, very much like this one, but with the number of on_planes reduced to be no more than max_clip_planes.
The number of off_planes in the new ClipPlaneAttrib is undefined.
Definition at line 426 of file clipPlaneAttrib.cxx.
References ordered_vector< Key, Compare, Vector >::begin(), ordered_vector< Key, Compare, Vector >::end(), and ov_set< Key, Compare, Vector >::sort().
Referenced by GraphicsStateGuardian::do_issue_clip_plane().
|
virtual |
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.
Reimplemented from RenderAttrib.
Definition at line 935 of file clipPlaneAttrib.cxx.
References AttribNodeRegistry::find_node(), BamReader::get_aux_data(), BamReader::get_file_minor_ver(), and AttribNodeRegistry::get_node.
|
inlinevirtual |
Reimplemented from RenderAttrib.
Definition at line 166 of file clipPlaneAttrib.h.
|
inlinestatic |
Definition at line 120 of file clipPlaneAttrib.h.
|
inlinestatic |
Definition at line 154 of file clipPlaneAttrib.h.
| int ClipPlaneAttrib::get_num_planes | ( | ) | const |
Returns the number of planes listed in the attribute.
Definition at line 243 of file clipPlaneAttrib.cxx.
References get_num_off_planes, and get_num_on_planes.
| 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 planes that were already on, and if O_remove, the planes here are removed from the set of planes that were on.
Definition at line 220 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.
Definition at line 262 of file clipPlaneAttrib.cxx.
References get_num_off_planes, get_off_plane, and get_on_plane.
|
inlinevirtual |
Implements RenderAttrib.
Definition at line 123 of file clipPlaneAttrib.h.
|
inlinevirtual |
Reimplemented from RenderAttrib.
Definition at line 163 of file clipPlaneAttrib.h.
|
inline |
Returns true if this attrib disables all planes (although it may also enable some).
Definition at line 92 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 82 of file clipPlaneAttrib.I.
References has_on_plane().
Referenced by CullPlanes::apply_state(), 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 55 of file clipPlaneAttrib.I.
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.
Definition at line 282 of file clipPlaneAttrib.cxx.
References get_num_off_planes, has_off_plane(), and has_on_plane().
|
inlinestatic |
Definition at line 157 of file clipPlaneAttrib.h.
|
inline |
Returns true if this is an identity attrib: it does not change the set of planes in use.
Definition at line 101 of file clipPlaneAttrib.I.
|
static |
Constructs a new ClipPlaneAttrib object that does nothing.
Definition at line 333 of file clipPlaneAttrib.cxx.
Referenced by PortalNode::enable_clipping_planes(), make(), make(), make(), and make().
|
static |
Constructs a new ClipPlaneAttrib object that enables (or disables, according to op) the indicated plane(s).
Definition at line 50 of file clipPlaneAttrib.cxx.
References make(), and make_all_off().
Referenced by NodePath::set_clip_plane(), and NodePath::set_clip_plane_off().
|
static |
Constructs a new ClipPlaneAttrib object that turns on (or off, according to op) the indicate plane(s).
Definition at line 84 of file clipPlaneAttrib.cxx.
References make(), and make_all_off().
|
static |
Constructs a new ClipPlaneAttrib object that turns on (or off, according to op) the indicate plane(s).
Definition at line 121 of file clipPlaneAttrib.cxx.
References make(), and make_all_off().
|
static |
Constructs a new ClipPlaneAttrib object that turns on (or off, according to op) the indicate plane(s).
Definition at line 162 of file clipPlaneAttrib.cxx.
References make(), and make_all_off().
|
static |
Constructs a new ClipPlaneAttrib object that disables all planes (and hence disables clipping).
Definition at line 348 of file clipPlaneAttrib.cxx.
Referenced by make(), make(), make(), make(), and NodePath::set_clip_plane_off().
|
static |
Returns a RenderAttrib that corresponds to whatever the standard default properties for render attributes of this type ought to be.
Definition at line 204 of file clipPlaneAttrib.cxx.
|
virtual |
Reimplemented from RenderAttrib.
Definition at line 548 of file clipPlaneAttrib.cxx.
|
static |
Tells the BamReader how to create objects of type ClipPlaneAttrib.
Definition at line 844 of file clipPlaneAttrib.cxx.
References BamReader::get_factory(), and Factory< Type >::register_factory().
Referenced by init_libpgraph().
| ConstPointerTo< RenderAttrib > ClipPlaneAttrib::remove_off_plane | ( | const NodePath & | plane | ) | const |
Returns a new ClipPlaneAttrib, just like this one, but with the indicated plane removed from the list of planes disabled by this attrib.
Definition at line 413 of file clipPlaneAttrib.cxx.
References NodePath::is_empty(), TypedObject::is_of_type(), and NodePath::node().
Referenced by NodePath::clear_clip_plane(), and remove_plane().
| ConstPointerTo< RenderAttrib > ClipPlaneAttrib::remove_on_plane | ( | const NodePath & | plane | ) | const |
Returns a new ClipPlaneAttrib, just like this one, but with the indicated plane removed from the list of planes enabled by this attrib.
Definition at line 386 of file clipPlaneAttrib.cxx.
References NodePath::is_empty(), TypedObject::is_of_type(), and NodePath::node().
Referenced by NodePath::clear_clip_plane(), CullPlanes::do_cull(), and remove_plane().
| ConstPointerTo< RenderAttrib > ClipPlaneAttrib::remove_plane | ( | PlaneNode * | plane | ) | const |
Returns a new ClipPlaneAttrib, just like this one, but with the indicated plane removed from the list of planes.
Definition at line 318 of file clipPlaneAttrib.cxx.
References get_num_off_planes, remove_off_plane(), and remove_on_plane().
Writes the contents of this object to the datagram for shipping out to a Bam file.
Reimplemented from RenderAttrib.
Definition at line 853 of file clipPlaneAttrib.cxx.
References Datagram::add_bool(), Datagram::add_uint16(), BamWriter::get_file_minor_ver(), get_num_off_planes, get_num_on_planes, RenderAttrib::write_datagram(), and BamWriter::write_pointer().
| ClipPlaneAttrib::get_class_slot |
Definition at line 126 of file clipPlaneAttrib.h.
|
inline |
Returns the number of planes that are disabled by the attribute.
Definition at line 79 of file clipPlaneAttrib.h.
Referenced by add_plane(), get_num_planes(), get_operation(), get_plane(), has_plane(), remove_plane(), and write_datagram().
|
inline |
Returns the number of planes that are enabled by the attribute.
Definition at line 74 of file clipPlaneAttrib.h.
Referenced by CollisionBox::apply_clip_plane(), CullPlanes::apply_state(), GraphicsStateGuardian::fetch_specified_part(), get_num_planes(), and write_datagram().
|
inline |
Returns the nth plane disabled by the attribute, sorted in arbitrary (pointer) order.
Definition at line 79 of file clipPlaneAttrib.h.
Referenced by get_plane().
|
inline |
Returns the nth plane enabled by the attribute, sorted in render order.
Definition at line 74 of file clipPlaneAttrib.h.
Referenced by CollisionBox::apply_clip_plane(), CullPlanes::apply_state(), GraphicsStateGuardian::fetch_specified_part(), and get_plane().