ScissorEffect
from panda3d.core import ScissorEffect
- class ScissorEffect
Bases:
RenderEffectThis 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.
Inheritance diagram
- __init__(*args, **kwargs)
- addPoint()
C++ Interface: add_point(ScissorEffect self, const LPoint3f point, const NodePath node)
- /**
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.
*/
- add_point()
C++ Interface: add_point(ScissorEffect self, const LPoint3f point, const NodePath node)
- /**
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.
*/
- getClassType()
C++ Interface: get_class_type()
- getClip()
C++ Interface: get_clip(ScissorEffect self)
- /**
Returns true if this ScissorEffect actually enables scissoring, or false if
it culls only.
*/
- getFrame()
C++ Interface: get_frame(ScissorEffect self)
- /**
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.
*/
- getNode()
C++ Interface: get_node(ScissorEffect self, int n)
- /**
Returns the node to which the nth point is relative, or empty NodePath to
indicate the current node.
*/
- getNodes()
- getNumPoints()
C++ Interface: get_num_points(ScissorEffect self)
- /**
Returns the number of node-based scissor points. See get_point().
*/
- getPoint()
C++ Interface: get_point(ScissorEffect self, int n)
- /**
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.
*/
- getPoints()
- get_class_type()
C++ Interface: get_class_type()
- get_clip()
C++ Interface: get_clip(ScissorEffect self)
- /**
Returns true if this ScissorEffect actually enables scissoring, or false if
it culls only.
*/
- get_frame()
C++ Interface: get_frame(ScissorEffect self)
- /**
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.
*/
- get_node()
C++ Interface: get_node(ScissorEffect self, int n)
- /**
Returns the node to which the nth point is relative, or empty NodePath to
indicate the current node.
*/
- get_nodes()
- get_num_points()
C++ Interface: get_num_points(ScissorEffect self)
- /**
Returns the number of node-based scissor points. See get_point().
*/
- get_point()
C++ Interface: get_point(ScissorEffect self, int n)
- /**
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.
*/
- get_points()
- isScreen()
C++ Interface: is_screen(ScissorEffect self)
- /**
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.
*/
- is_screen()
C++ Interface: is_screen(ScissorEffect self)
- /**
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.
*/
- makeNode()
C++ Interface: make_node() make_node(bool clip) make_node(const LPoint3f a, const LPoint3f b) make_node(const LPoint3f a, const LPoint3f b, const NodePath node) make_node(const LPoint3f a, const LPoint3f b, const LPoint3f c, const LPoint3f d, const NodePath node)
- /**
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.
*/
- /**
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.
*/
- /**
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.
*/
- makeScreen()
C++ Interface: make_screen(const LVecBase4f frame, bool clip)
- /**
Constructs a new screen-relative ScissorEffect. The frame defines a left,
right, bottom, top region, relative to the DisplayRegion. See
ScissorAttrib.
*/
- make_node()
C++ Interface: make_node() make_node(bool clip) make_node(const LPoint3f a, const LPoint3f b) make_node(const LPoint3f a, const LPoint3f b, const NodePath node) make_node(const LPoint3f a, const LPoint3f b, const LPoint3f c, const LPoint3f d, const NodePath node)
- /**
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.
*/
- /**
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.
*/
- /**
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.
*/