Panda3D
Classes | Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
ClipPlaneAttrib Class Reference

This functions similarly to a LightAttrib. More...

#include "clipPlaneAttrib.h"

Inheritance diagram for ClipPlaneAttrib:
RenderAttrib TypedWritableReferenceCount TypedWritable ReferenceCount TypedObject MemoryBase MemoryBase

Classes

class  BamAuxData
 

Public Types

typedef pvector< PT(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

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 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...
 
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. More...
 
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. More...
 
PlaneNodeget_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...
 
virtual void output (std::ostream &out) const
 
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...
 
- Public Member Functions inherited from RenderAttrib
 RenderAttrib (const RenderAttrib &copy)=delete
 
virtual ~RenderAttrib ()
 The destructor is responsible for removing the RenderAttrib from the global set if it is there. More...
 
int compare_to (const RenderAttrib &other) const
 
 CPT (RenderAttrib) compose(const RenderAttrib *other) const
 
 CPT (RenderAttrib) invert_compose(const RenderAttrib *other) const
 
 CPT (RenderAttrib) get_unique() 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...
 
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. 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...
 
RenderAttriboperator= (const RenderAttrib &copy)=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. More...
 
virtual void write (std::ostream &out, int indent_level) const
 
- Public Member Functions inherited from TypedWritableReferenceCount
 TypedWritableReferenceCount (const TypedWritableReferenceCount &copy)
 
virtual ReferenceCountas_reference_count ()
 Returns the pointer cast to a ReferenceCount pointer, if it is in fact of that type. More...
 
void operator= (const TypedWritableReferenceCount &copy)
 
- Public Member Functions inherited from TypedWritable
 TypedWritable (const TypedWritable &copy)
 
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. More...
 
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. 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 &copy)
 
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 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...
 
- Public Member Functions inherited from TypedObject
 TypedObject (const TypedObject &copy)=default
 
TypedObjectas_typed_object ()
 Returns the object, upcast (if necessary) to a TypedObject pointer. More...
 
const TypedObjectas_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...
 
TypedObjectoperator= (const TypedObject &copy)=default
 
- Public Member Functions inherited from ReferenceCount
int get_ref_count () const
 
WeakReferenceListget_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 ref_if_nonzero () const
 Atomically increases the reference count of this object if it is not zero. 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...
 
WeakReferenceListweak_ref ()
 Adds the indicated PointerToVoid as a weak reference to this object. More...
 
void weak_unref ()
 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 Public Member Functions inherited from RenderAttrib
static TypedWritablechange_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 (std::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, RenderAttrib *default_attrib)
 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 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. More...
 
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. More...
 
- 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. More...
 
 get_num_on_planes
 Returns the number of planes that are enabled by the attribute. More...
 
 get_off_plane
 Returns the nth plane disabled by the attribute, sorted in arbitrary (pointer) order. More...
 
 get_on_plane
 Returns the nth plane enabled by the attribute, sorted in render order. More...
 
static PlaneNodeplane
 
static PlaneNodeplane1
 
static PlaneNode PlaneNodeplane2
 
static PlaneNode PlaneNode PlaneNodeplane3
 
static PlaneNode PlaneNode PlaneNode PlaneNodeplane4
 
- Public Attributes inherited from RenderAttrib
 get_slot
 
- Public Attributes inherited from TypedWritableReferenceCount
static BamReaderreader = nullptr)
 
- Public Attributes inherited from TypedObject
 get_type
 
- Public Attributes inherited from ReferenceCount
 get_ref_count
 Returns the current reference count. More...
 

Additional Inherited Members

- Static Public Attributes inherited from TypedWritable
static TypedWritable *const Null = nullptr
 

Detailed Description

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.

Member Function Documentation

◆ complete_pointers()

int ClipPlaneAttrib::complete_pointers ( TypedWritable **  p_list,
BamReader manager 
)
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 901 of file clipPlaneAttrib.cxx.

◆ finalize()

void ClipPlaneAttrib::finalize ( BamReader manager)
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 942 of file clipPlaneAttrib.cxx.

References BamReader::get_file_minor_ver().

◆ get_num_planes()

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 248 of file clipPlaneAttrib.cxx.

References get_num_off_planes, and get_num_on_planes.

◆ get_operation()

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.

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 225 of file clipPlaneAttrib.cxx.

References get_num_off_planes, and has_all_off().

◆ get_plane()

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 267 of file clipPlaneAttrib.cxx.

References get_num_off_planes.

◆ has_all_off()

bool ClipPlaneAttrib::has_all_off ( ) const
inline

Returns true if this attrib disables all planes (although it may also enable some).

Definition at line 93 of file clipPlaneAttrib.I.

Referenced by get_operation().

◆ has_off_plane()

bool ClipPlaneAttrib::has_off_plane ( const NodePath plane) const
inline

Returns true if the indicated plane is disabled by the attrib, false otherwise.

Definition at line 83 of file clipPlaneAttrib.I.

References ordered_vector< Key, Compare, Vector >::end(), and has_on_plane().

Referenced by has_plane().

◆ has_on_plane()

bool ClipPlaneAttrib::has_on_plane ( const NodePath plane) const
inline

Returns true if the indicated plane is enabled by the attrib, false otherwise.

Definition at line 56 of file clipPlaneAttrib.I.

References ordered_vector< Key, Compare, Vector >::end().

Referenced by has_off_plane(), and has_plane().

◆ 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 287 of file clipPlaneAttrib.cxx.

References get_num_off_planes, has_off_plane(), and has_on_plane().

◆ is_identity()

bool ClipPlaneAttrib::is_identity ( ) const
inline

Returns true if this is an identity attrib: it does not change the set of planes in use.

Definition at line 102 of file clipPlaneAttrib.I.

References ordered_vector< Key, Compare, Vector >::empty().

◆ register_with_read_factory()

void ClipPlaneAttrib::register_with_read_factory ( )
static

Tells the BamReader how to create objects of type ClipPlaneAttrib.

Definition at line 851 of file clipPlaneAttrib.cxx.

References BamReader::get_factory(), and Factory< Type >::register_factory().

Referenced by init_libpgraph().

◆ write_datagram()

void ClipPlaneAttrib::write_datagram ( BamWriter manager,
Datagram dg 
)
virtual

Member Data Documentation

◆ get_num_off_planes

int ClipPlaneAttrib::get_num_off_planes
inline

Returns the number of planes that are disabled by the attribute.

Definition at line 79 of file clipPlaneAttrib.h.

Referenced by get_num_planes(), get_operation(), get_plane(), has_plane(), and write_datagram().

◆ get_num_on_planes

int ClipPlaneAttrib::get_num_on_planes
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(), get_num_planes(), and write_datagram().

◆ get_off_plane

NodePath ClipPlaneAttrib::get_off_plane
inline

Returns the nth plane disabled by the attribute, sorted in arbitrary (pointer) order.

Definition at line 79 of file clipPlaneAttrib.h.

◆ get_on_plane

NodePath ClipPlaneAttrib::get_on_plane
inline

Returns the nth plane enabled by the attribute, sorted in render order.

Definition at line 74 of file clipPlaneAttrib.h.


The documentation for this class was generated from the following files: