This provides a higher-level wrapper around ScissorAttrib. More...
#include "scissorEffect.h"
Inheritance diagram for ScissorEffect:
Public Member Functions | |
| CPT (RenderEffect) add_point(const LPoint3 &point | |
| virtual | CPT (RenderEffect) xform(const LMatrix4 &mat) const |
| virtual void | cull_callback (CullTraverser *trav, CullTraverserData &data, CPT(TransformState) &node_transform, CPT(RenderState) &node_state) const |
| virtual TypeHandle | force_init_type () |
| bool | get_clip () const |
| Returns true if this ScissorEffect actually enables scissoring, or false if it culls only. More... | |
| const LVecBase4 & | get_frame () const |
| If is_screen() returns true, this method may be called to query the screen- based scissor frame. More... | |
| NodePath | get_node (int n) const |
| int | get_num_points () const |
| const LPoint3 & | get_point (int n) const |
| virtual TypeHandle | get_type () const |
| virtual bool | has_cull_callback () const |
| bool | is_screen () const |
| Returns true if the ScissorEffect is a screen-based effect, meaning get_frame() has a meaningful value, but get_a() and get_b() do not. 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 RenderEffect | |
| RenderEffect (const RenderEffect ©)=delete | |
| virtual | ~RenderEffect () |
| The destructor is responsible for removing the RenderEffect from the global set if it is there. More... | |
| virtual void | adjust_transform (CPT(TransformState) &net_transform, CPT(TransformState) &node_transform, const PandaNode *node) const |
| int | compare_to (const RenderEffect &other) const |
| Provides an arbitrary ordering among all unique RenderEffects, so we can store the essentially different ones in a big set and throw away the rest. More... | |
| virtual | CPT (TransformState) prepare_flatten_transform(const TransformState *net_transform) 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 bool | has_adjust_transform () const |
| RenderEffect & | operator= (const RenderEffect ©)=delete |
| virtual bool | safe_to_combine () const |
| virtual bool | safe_to_transform () const |
| Returns true if it is generally safe to transform this particular kind of RenderEffect by calling the xform() method, false otherwise. More... | |
| 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. More... | |
| void | operator= (const TypedWritableReferenceCount ©) |
| Public Member Functions inherited from TypedWritable | |
| TypedWritable (const TypedWritable ©) | |
| virtual int | complete_pointers (TypedWritable **p_list, BamReader *manager) |
| Receives an array of pointers, one for each time manager->read_pointer() was called in fillin(). More... | |
| 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 ©) |
| 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 ©)=default | |
| 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... | |
| TypedObject & | operator= (const TypedObject ©)=default |
| Public Member Functions inherited from ReferenceCount | |
| int | get_ref_count () const |
| 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 | 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... | |
| virtual bool | unref () const |
| Explicitly decrements the reference count. More... | |
| WeakReferenceList * | weak_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 (RenderEffect) make_screen(const LVecBase4 &frame |
| static | CPT (RenderEffect) make_node(bool clip |
| static | CPT (RenderEffect) make_node(const LPoint3 &a |
| static | CPT (RenderEffect) make_node(const LPoint3 &a |
| static TypeHandle | get_class_type () |
| static void | init_type () |
| static void | register_with_read_factory () |
| Static Public Member Functions inherited from RenderEffect | |
| 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 TypeHandle | get_class_type () |
| static int | get_num_effects () |
| static void | init_type () |
| static void | list_effects (std::ostream &out) |
| Lists all of the RenderEffects in the cache to the output stream, one per line. More... | |
| static bool | validate_effects () |
| 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 | |
| static const LPoint3 & | b |
| static const LPoint3 const LPoint3 & | c |
| static bool | clip = true) |
| static const LPoint3 const LPoint3 const LPoint3 & | d |
| get_node | |
| Returns the node to which the nth point is relative, or empty NodePath to indicate the current node. More... | |
| get_num_points | |
| Returns the number of node-based scissor points. More... | |
| get_point | |
| If is_screen() returns false, then get_num_points() and get_point() may be called to query the node-based scissor frame. More... | |
| static const LPoint3 const NodePath & | node = NodePath()) |
| static const LPoint3 const LPoint3 const LPoint3 const NodePath & | node = NodePath()) |
| const NodePath & | node = NodePath()) const |
| 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. More... | |
Additional Inherited Members | |
| Static Public Attributes inherited from TypedWritable | |
| static TypedWritable *const | Null = nullptr |
Detailed Description
This provides a higher-level wrapper around ScissorAttrib.
It allows for the scissor region to be defined via points relative to the current node, and also performs culling based on the scissor region.
Definition at line 31 of file scissorEffect.h.
Member Function Documentation
◆ get_clip()
|
inline |
Returns true if this ScissorEffect actually enables scissoring, or false if it culls only.
Definition at line 69 of file scissorEffect.I.
◆ get_frame()
|
inline |
If is_screen() returns true, this method may be called to query the screen- based scissor frame.
This is a series of left, right, bottom, top, representing the scissor frame relative to the current DisplayRegion. See ScissorAttrib.
Definition at line 30 of file scissorEffect.I.
◆ is_screen()
|
inline |
Returns true if the ScissorEffect is a screen-based effect, meaning get_frame() has a meaningful value, but get_a() and get_b() do not.
Definition at line 19 of file scissorEffect.I.
◆ write_datagram()
Writes the contents of this object to the datagram for shipping out to a Bam file.
Reimplemented from RenderEffect.
Definition at line 345 of file scissorEffect.cxx.
References Datagram::add_bool(), Datagram::add_uint16(), and RenderEffect::write_datagram().
Member Data Documentation
◆ get_node
|
inline |
Returns the node to which the nth point is relative, or empty NodePath to indicate the current node.
Definition at line 57 of file scissorEffect.h.
◆ get_num_points
|
inline |
Returns the number of node-based scissor points.
See get_point().
Definition at line 55 of file scissorEffect.h.
◆ get_point
|
inline |
If is_screen() returns false, then get_num_points() and get_point() may be called to query the node-based scissor frame.
These return n points (at least two), which are understood to be in the space of this node, and which define any opposite corners of the scissor frame.
Definition at line 55 of file scissorEffect.h.
The documentation for this class was generated from the following files:
- panda/src/pgraph/scissorEffect.h
- panda/src/pgraph/scissorEffect.cxx
- panda/src/pgraph/scissorEffect.I
