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

explicit PlaneNode(std::string const &name, LPlane const &plane = LPlane())

static TypeHandle get_class_type(void)

int get_clip_effect(void) const

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

LPlane const &get_plane(void) const

Returns the plane represented by the PlaneNode.

int get_priority(void) const

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

PN_stdfloat get_viz_scale(void) const

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

void set_clip_effect(int clip_effect)

Specifies the sort of things this plane will actually clip (when it is used as a clip plane). This is a bitmask union of ClipEffect 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.

void set_plane(LPlane const &plane)

Sets the particular plane represented by the PlaneNode.

void set_priority(int priority)

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::set_priority().

void set_viz_scale(PN_stdfloat viz_scale)

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