PGVirtualFrame¶

from panda3d.core import PGVirtualFrame

class PGVirtualFrame

Bases: PGItem

This represents a frame that is rendered as a window onto another (possibly much larger) canvas. You can only see the portion of the canvas that is below the window at any given time.

This works simply by automatically defining a scissor effect to be applied to a special child node, called the canvas_node, of the PGVirtualFrame node. Every object that is parented to the canvas_node will be clipped by the scissor effect. Also, you can modify the canvas_transform through convenience methods here, which actually modifies the transform on the canvas_node.

The net effect is that the virtual canvas is arbitrarily large, and we can peek at it through the scissor region, and scroll through different parts of it by modifying the canvas_transform.

See PGScrollFrame for a specialization of this class that handles the traditional scrolling canvas, with scroll bars.

Inheritance diagram

__init__(name: str)
clearClipFrame()None

Removes the clip frame from the item. This disables clipping.

getCanvasNode()PandaNode

Returns the special node that holds all of the children that appear in the virtual canvas.

getCanvasParent()PandaNode

Returns the parent node of the canvas_node.

getCanvasTransform()TransformState

Returns the transform of the virtual canvas. This transform is applied to all child nodes of the canvas_node.

static getClassType()TypeHandle
getClipFrame()LVecBase4

Returns the bounding rectangle of the clip frame. See setClipFrame(). If hasClipFrame() is false, this returns the item’s actual frame.

hasClipFrame()bool

Returns true if the clip frame has been set; see setClipFrame(). If it has not been set, objects in the virtual frame will not be clipped.

setCanvasTransform(transform: TransformState)None

Changes the transform of the virtual canvas. This transform is applied to all child nodes of the canvas_node.

setClipFrame(clip_frame: LVecBase4)None

Sets the bounding rectangle of the clip frame. This is the size of the small window through which we can see the virtual canvas. Normally, this is the same size as the actual frame or smaller (typically it is smaller by the size of the bevel, or to make room for scroll bars).

setClipFrame(left: float, right: float, bottom: float, top: float)None

Sets the bounding rectangle of the clip frame. This is the size of the small window through which we can see the virtual canvas. Normally, this is the same size as the actual frame or smaller (typically it is smaller by the size of the bevel, or to make room for scroll bars).

setup(width: float, height: float)None

Creates a PGVirtualFrame with the indicated dimensions.