ScissorAttrib

class ScissorAttrib

Bases: RenderAttrib

This restricts rendering to within a rectangular region of the scene, without otherwise affecting the viewport or lens properties. Geometry that falls outside the scissor region is not rendered. It is akin to the OpenGL glScissor() function.

The ScissorAttrib always specifies its region relative to its enclosing DisplayRegion, in screen space, and performs no culling.

See ScissorEffect if you wish to define a region relative to 2-D or 3-D coordinates in the scene graph, with culling.

Inheritance diagram

digraph inheritance568377b6d7 { bgcolor=transparent; rankdir=BT; size="8.0, 12.0"; "DTOOL_SUPER_BASE" [fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=11,height=0.25,shape=box,style=""]; "ReferenceCount" [URL="acron.core.ReferenceCount.html#acron.core.ReferenceCount",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=11,height=0.25,shape=box,style="",target="_top",tooltip="/**"]; "DTOOL_SUPER_BASE" -> "ReferenceCount" [arrowsize=0.75,style=""]; "RenderAttrib" [URL="acron.core.RenderAttrib.html#acron.core.RenderAttrib",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=11,height=0.25,shape=box,style="",target="_top",tooltip="/**"]; "TypedWritableReferenceCount" -> "RenderAttrib" [arrowsize=0.75,style=""]; "ScissorAttrib" [URL="acron.core.ScissorAttrib.html#acron.core.ScissorAttrib",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=11,height=0.25,shape=box,style="",target="_top",tooltip="/**"]; "RenderAttrib" -> "ScissorAttrib" [arrowsize=0.75,style=""]; "TypedObject" [URL="acron.core.TypedObject.html#acron.core.TypedObject",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=11,height=0.25,shape=box,style="",target="_top",tooltip="/**"]; "DTOOL_SUPER_BASE" -> "TypedObject" [arrowsize=0.75,style=""]; "TypedWritable" [URL="acron.core.TypedWritable.html#acron.core.TypedWritable",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=11,height=0.25,shape=box,style="",target="_top",tooltip="/**"]; "TypedObject" -> "TypedWritable" [arrowsize=0.75,style=""]; "TypedWritableReferenceCount" [URL="acron.core.TypedWritableReferenceCount.html#acron.core.TypedWritableReferenceCount",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=11,height=0.25,shape=box,style="",target="_top",tooltip="/**"]; "TypedWritable" -> "TypedWritableReferenceCount" [arrowsize=0.75,style=""]; "ReferenceCount" -> "TypedWritableReferenceCount" [arrowsize=0.75,style=""]; }
static ScissorAttrib.get_class_slot()
static ScissorAttrib.get_class_type()
ScissorAttrib.get_frame()

Returns the left, right, bottom, top coordinates of the scissor frame. This defines a frame within the current DisplayRegion, where 0,0 is the lower-left corner of the DisplayRegion, and 1,1 is the upper-right corner.

ScissorAttrib.is_off()

Returns true if the ScissorAttrib is an ‘off’ ScissorAttrib, indicating that scissor testing is disabled.

static ScissorAttrib.make()

Constructs a ScissorAttrib that restricts rendering to the indicated frame within the current DisplayRegion. (0,0) is the lower-left corner of the DisplayRegion, and (1,1) is the upper-right corner.

Constructs a ScissorAttrib that restricts rendering to the indicated frame within the current DisplayRegion. (0,0) is the lower-left corner of the DisplayRegion, and (1,1) is the upper-right corner.

static ScissorAttrib.make_default()

Returns a RenderAttrib that corresponds to whatever the standard default properties for render attributes of this type ought to be.

static ScissorAttrib.make_off()

Constructs a new ScissorAttrib object that removes the scissor region and fills the DisplayRegion.