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

#include "scissorEffect.h"

Inheritance diagram for ScissorEffect:

Public Member Functions
ConstPointerTo< RenderEffect >	add_point (const LPoint3 &point, const NodePath &node=NodePath()) const
	Returns a new ScissorEffect with the indicated point added.

virtual void	cull_callback (CullTraverser *trav, CullTraverserData &data, ConstPointerTo< TransformState > &node_transform, ConstPointerTo< 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.

virtual TypeHandle	force_init_type ()

bool	get_clip () const
	Returns true if this ScissorEffect actually enables scissoring, or false if it culls only.

const LVecBase4 &	get_frame () const
	If is_screen() returns true, this method may be called to query the screen- based scissor frame.

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
	Should be overridden by derived classes to return true if cull_callback() has been defined.

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.

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.

virtual ConstPointerTo< RenderEffect >	xform (const LMatrix4 &mat) const
	Returns a new RenderEffect transformed by the indicated matrix.

Public Member Functions inherited from RenderEffect
	RenderEffect (const RenderEffect &copy)=delete

virtual	~RenderEffect ()
	The destructor is responsible for removing the RenderEffect from the global set if it is there.

virtual void	adjust_transform (ConstPointerTo< TransformState > &net_transform, ConstPointerTo< TransformState > &node_transform, const PandaNode *node) const
	Performs some operation on the node's apparent net and/or local transforms.

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.

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 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.

RenderEffect &	operator= (const RenderEffect &copy)=delete

virtual ConstPointerTo< TransformState >	prepare_flatten_transform (const TransformState *net_transform) const
	Preprocesses the accumulated transform that is about to be applied to (or through) this node due to a flatten operation.

virtual bool	safe_to_combine () const
	Returns true if this kind of effect can safely be combined with sibling nodes that share the exact same effect, or false if this is not a good idea.

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.

virtual void	write (std::ostream &out, int indent_level) const

Public Member Functions inherited from TypedWritableReferenceCount
	TypedWritableReferenceCount (const TypedWritableReferenceCount &copy)

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 &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().

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 &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.

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 &copy)=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 &copy)=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.

virtual bool	unref () const
	Explicitly decrements the reference count.

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 TypeHandle	get_class_type ()

static void	init_type ()

static ConstPointerTo< RenderEffect >	make_node (bool clip=true)
	Constructs a new node-relative ScissorEffect, with no points.

static ConstPointerTo< RenderEffect >	make_node (const LPoint3 &a, const LPoint3 &b, const LPoint3 &c, const LPoint3 &d, const NodePath &node=NodePath())
	Constructs a new node-relative ScissorEffect.

static ConstPointerTo< RenderEffect >	make_node (const LPoint3 &a, const LPoint3 &b, const NodePath &node=NodePath())
	Constructs a new node-relative ScissorEffect.

static ConstPointerTo< RenderEffect >	make_screen (const LVecBase4 &frame, bool clip=true)
	Constructs a new screen-relative ScissorEffect.

static void	register_with_read_factory ()
	Tells the BamReader how to create objects of type ScissorEffect.

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.

static TypeHandle	get_class_type ()

static int	get_num_effects ()
	Returns the total number of unique RenderEffect objects allocated in the world.

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.

static bool	validate_effects ()
	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_node
	Returns the node to which the nth point is relative, or empty NodePath to indicate the current node.

	get_num_points
	Returns the number of node-based scissor points.

	get_point
	If is_screen() returns false, then get_num_points() and get_point() may be called to query the node-based scissor frame.

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

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

◆ add_point()

ConstPointerTo< RenderEffect > ScissorEffect::add_point	(	const LPoint3 &	p,
		const NodePath &	node = NodePath() ) const

Returns a new ScissorEffect with the indicated point added.

It is only valid to call this on a "node" type ScissorEffect. The full set of points, projected into screen space, defines the bounding volume of the rectangular scissor region.

Each point may be relative to a different node, if desired.

Definition at line 125 of file scissorEffect.cxx.

References is_screen().

◆ cull_callback()

void ScissorEffect::cull_callback	(	CullTraverser *	trav,
		CullTraverserData &	data,
		ConstPointerTo< TransformState > &	node_transform,
		ConstPointerTo< 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 204 of file scissorEffect.cxx.

References RenderState::compose(), SceneSetup::get_lens(), Lens::get_projection_mat(), CullTraverser::get_scene(), NodePath::is_empty(), is_screen(), and RenderState::make().

◆ force_init_type()

virtual TypeHandle ScissorEffect::force_init_type ( )

inlinevirtual

Reimplemented from RenderEffect.

Definition at line 103 of file scissorEffect.h.

◆ get_class_type()

static TypeHandle ScissorEffect::get_class_type ( )

inlinestatic

Definition at line 92 of file scissorEffect.h.

◆ get_clip()

bool ScissorEffect::get_clip ( ) const

inline

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

Definition at line 68 of file scissorEffect.I.

◆ get_frame()

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 29 of file scissorEffect.I.

◆ get_type()

virtual TypeHandle ScissorEffect::get_type ( ) const

inlinevirtual

Reimplemented from RenderEffect.

Definition at line 100 of file scissorEffect.h.

◆ has_cull_callback()

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 187 of file scissorEffect.cxx.

◆ init_type()

static void ScissorEffect::init_type ( )

inlinestatic

Definition at line 95 of file scissorEffect.h.

◆ is_screen()

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 18 of file scissorEffect.I.

Referenced by add_point(), cull_callback(), and xform().

◆ make_node() [1/3]

ConstPointerTo< RenderEffect > ScissorEffect::make_node ( bool clip = true )

static

Constructs a new node-relative ScissorEffect, with no points.

This empty ScissorEffect does nothing. You must then call add_point a number of times to add the points you require.

Definition at line 73 of file scissorEffect.cxx.

Referenced by PGVirtualFrame::set_clip_frame(), NodePath::set_scissor(), NodePath::set_scissor(), NodePath::set_scissor(), and NodePath::set_scissor().

◆ make_node() [2/3]

ConstPointerTo< RenderEffect > ScissorEffect::make_node	(	const LPoint3 &	a,
		const LPoint3 &	b,
		const LPoint3 &	c,
		const LPoint3 &	d,
		const NodePath &	node = NodePath() )

static

Constructs a new node-relative ScissorEffect.

The four points are understood to be relative to the indicated node, or the current node if the indicated NodePath is empty, and determine four points surrounding the scissor region.

Definition at line 102 of file scissorEffect.cxx.

◆ make_node() [3/3]

ConstPointerTo< RenderEffect > ScissorEffect::make_node	(	const LPoint3 &	a,
		const LPoint3 &	b,
		const NodePath &	node = NodePath() )

static

Constructs a new node-relative ScissorEffect.

The two points are understood to be relative to the indicated node, or the current node if the NodePath is empty, and determine the diagonally opposite corners of the scissor region.

Definition at line 85 of file scissorEffect.cxx.

◆ make_screen()

ConstPointerTo< RenderEffect > ScissorEffect::make_screen	(	const LVecBase4 &	frame,
		bool	clip = true )

static

Constructs a new screen-relative ScissorEffect.

The frame defines a left, right, bottom, top region, relative to the DisplayRegion. See ScissorAttrib.

Definition at line 62 of file scissorEffect.cxx.

Referenced by NodePath::set_scissor().

◆ output()

void ScissorEffect::output ( std::ostream & out ) const

virtual

Reimplemented from RenderEffect.

Definition at line 160 of file scissorEffect.cxx.

◆ register_with_read_factory()

void ScissorEffect::register_with_read_factory ( )

static

Tells the BamReader how to create objects of type ScissorEffect.

Definition at line 335 of file scissorEffect.cxx.

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

Referenced by init_libpgraph().

◆ write_datagram()

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 344 of file scissorEffect.cxx.

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

◆ xform()

ConstPointerTo< RenderEffect > ScissorEffect::xform ( const LMatrix4 & mat ) const

virtual

Returns a new RenderEffect transformed by the indicated matrix.

Reimplemented from RenderEffect.

Definition at line 139 of file scissorEffect.cxx.

References NodePath::is_empty(), and is_screen().

Member Data Documentation

◆ get_node

NodePath ScissorEffect::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

int ScissorEffect::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

const LPoint3 & ScissorEffect::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

Public Member Functions

Static Public Member Functions

Public Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ add_point()

◆ cull_callback()

◆ force_init_type()

◆ get_class_type()

◆ get_clip()

◆ get_frame()

◆ get_type()

◆ has_cull_callback()

◆ init_type()

◆ is_screen()

◆ make_node() [1/3]

◆ make_node() [2/3]

◆ make_node() [3/3]

◆ make_screen()

◆ output()

◆ register_with_read_factory()

◆ write_datagram()

◆ xform()

Member Data Documentation

◆ get_node

◆ get_num_points

◆ get_point