# PlaneNode¶

from panda3d.core import PlaneNode

class PlaneNode

Bases: PandaNode

A node that contains a plane. This is most often used as a clipping plane, but it can serve other purposes as well; whenever a plane is needed to be defined in some coordinate space in the world.

Inheritance diagram

enum ClipEffect
enumerator CE_visible = 1
enumerator CE_collision = 2
__init__(name: str, plane: LPlane)
static getClassType()TypeHandle
getClipEffect()int

Returns the clip_effect bits for this clip plane. See setClipEffect().

getPlane()LPlane

Returns the plane represented by the PlaneNode.

getPriority()int

Returns the priority associated with this clip plane. See setPriority().

getVizScale()float

Returns the size of the visual representation of the plane that is drawn if the PlaneNode is shown.

setClipEffect(clip_effect: int)None

Specifies the sort of things this plane will actually clip (when it is used as a clip plane). This is a bitmask union of PlaneNodeClipEffect values. If it includes CE_visible, then it will clip visible geometry; if it includes CE_collision, then it will clip collision polygons. If it includes neither bit, it will still affect culling, but objects will either be wholly behind the clipping plane, or wholly present.

setPlane(plane: LPlane)None

Sets the particular plane represented by the PlaneNode.

setPriority(priority: int)None

Changes the relative importance of this PlaneNode (when it is used as a clip plane) relative to the other clip planes that are applied simultaneously.

The priority number is used to decide which of the requested clip planes are to be activated when more clip planes are requested than the hardware will support. The highest-priority n planes are selected for rendering.

This is similar to TextureStage.setPriority().

setVizScale(viz_scale: float)None

Specifies the size of the visual representation of the plane that is drawn if the PlaneNode is shown.