Panda3D
 All Classes Functions Variables Enumerations
Classes | Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
ScissorEffect Class Reference

This provides a higher-level wrapper around ScissorAttrib. More...

#include "scissorEffect.h"

Inheritance diagram for ScissorEffect:
RenderEffect TypedWritableReferenceCount TypedWritable ReferenceCount TypedObject MemoryBase MemoryBase

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
 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 TypeHandle force_init_type ()
 
bool get_clip () const
 Returns true if this ScissorEffect actually enables scissoring, or false if it culls only. More...
 
const LVecBase4get_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
 Returns the node to which the nth point is relative, or empty NodePath to indicate the current node. More...
 
int get_num_points () const
 Returns the number of node-based scissor points. More...
 
const LPoint3get_point (int n) const
 If is_screen() returns false, then get_num_points() and get_point() may be called to query the node-based scissor frame. More...
 
virtual TypeHandle get_type () const
 
virtual bool has_cull_callback () const
 Should be overridden by derived classes to return true if cull_callback() has been defined. More...
 
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...
 
 MAKE_SEQ (get_points, get_num_points, get_point)
 
 MAKE_SEQ (get_nodes, get_num_points, get_node)
 
virtual void output (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
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, PandaNode *node) const
 Performs some operation on the node's apparent net and/or local transforms. More...
 
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
 Should be overridden by derived classes to return true if adjust_transform() has been defined, and therefore the RenderEffect has some effect on the node's apparent local and net transforms. More...
 
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 (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)
 
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...
 
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 &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)
 
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...
 
void operator= (const TypedObject &copy)
 
- Public Member Functions inherited from ReferenceCount
int get_ref_count () const
 Returns the current reference count. More...
 
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 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...
 
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 (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 ()
 Tells the BamReader how to create objects of type ScissorEffect. More...
 
- Static Public Member Functions inherited from RenderEffect
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 TypeHandle get_class_type ()
 
static int get_num_effects ()
 Returns the total number of unique RenderEffect objects allocated in the world. More...
 
static void init_type ()
 
static void list_effects (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(const string &data
 
- Static Public Member Functions inherited from TypedWritable
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 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 LPoint3b
 
static const LPoint3 const
LPoint3
c
 
static bool clip = true)
 
static const LPoint3 const
LPoint3 const LPoint3
d
 
static const LPoint3 const
NodePath
node = NodePath())
 
static const LPoint3 const
LPoint3 const LPoint3 const
NodePath
node = NodePath())
 
const NodePathnode = NodePath()) const
 
- Public Attributes inherited from TypedWritableReferenceCount
static BamReaderreader = NULL)
 

Additional Inherited Members

- Static Public Attributes inherited from TypedWritable
static TypedWritable *const Null = (TypedWritable*)0L
 

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 35 of file scissorEffect.h.

Member Function Documentation

void ScissorEffect::cull_callback ( CullTraverser trav,
CullTraverserData data,
CPT(TransformState)&  node_transform,
CPT(RenderState)&  node_state 
) const
virtual

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.

This may include additional manipulation of render state or additional visible/invisible decisions, or any other arbitrary operation.

At the time this function is called, the current node's transform and state have not yet been applied to the net_transform and net_state. This callback may modify the node_transform and node_state to apply an effective change to the render state at this level.

Reimplemented from RenderEffect.

Definition at line 238 of file scissorEffect.cxx.

References SceneSetup::get_lens(), Lens::get_projection_mat(), CullTraverser::get_scene(), and is_screen().

bool ScissorEffect::get_clip ( ) const
inline

Returns true if this ScissorEffect actually enables scissoring, or false if it culls only.

Definition at line 88 of file scissorEffect.I.

const LVecBase4 & ScissorEffect::get_frame ( ) const
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 38 of file scissorEffect.I.

NodePath ScissorEffect::get_node ( int  n) const
inline

Returns the node to which the nth point is relative, or empty NodePath to indicate the current node.

Definition at line 76 of file scissorEffect.I.

int ScissorEffect::get_num_points ( ) const
inline

Returns the number of node-based scissor points.

See get_point().

Definition at line 49 of file scissorEffect.I.

const LPoint3 & ScissorEffect::get_point ( int  n) const
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 64 of file scissorEffect.I.

References LPoint3f::zero().

bool ScissorEffect::has_cull_callback ( ) const
virtual

Should be overridden by derived classes to return true if cull_callback() has been defined.

Otherwise, returns false to indicate cull_callback() does not need to be called for this effect during the cull traversal.

Reimplemented from RenderEffect.

Definition at line 216 of file scissorEffect.cxx.

bool ScissorEffect::is_screen ( ) const
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 24 of file scissorEffect.I.

Referenced by cull_callback().

void ScissorEffect::register_with_read_factory ( )
static

Tells the BamReader how to create objects of type ScissorEffect.

Definition at line 375 of file scissorEffect.cxx.

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

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

Writes the contents of this object to the datagram for shipping out to a Bam file.

Reimplemented from RenderEffect.

Definition at line 386 of file scissorEffect.cxx.

References Datagram::add_bool(), Datagram::add_uint16(), RenderEffect::write_datagram(), and LVecBase4f::write_datagram().


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