ClipPlaneAttrib

class ClipPlaneAttrib

Bases: RenderAttrib

This functions similarly to a LightAttrib. It indicates the set of clipping planes that modify the geometry at this level and below. A ClipPlaneAttrib can either add planes or remove planes from the total set of clipping planes in effect.

Inheritance diagram

enum Operation

This is the old, deprecated interface to ClipPlaneAttrib. Do not use any of these methods for new code; these methods will be removed soon.

enumerator O_set = 0

enumerator O_add = 1

enumerator O_remove = 2

ConstPointerTo<RenderAttrib> add_off_plane(NodePath const &plane) const

Returns a new ClipPlaneAttrib, just like this one, but with the indicated plane added to the list of planes disabled by this attrib.

ConstPointerTo<RenderAttrib> add_on_plane(NodePath const &plane) const

Returns a new ClipPlaneAttrib, just like this one, but with the indicated plane added to the list of planes enabled by this attrib.

ConstPointerTo<RenderAttrib> add_plane(PlaneNode *plane) const

Returns a new ClipPlaneAttrib, just like this one, but with the indicated plane added to the list of planes.

Deprecated: Use add_on_plane() or add_off_plane() instead.

ConstPointerTo<ClipPlaneAttrib> filter_to_max(int max_clip_planes) const

Returns a new ClipPlaneAttrib, very much like this one, but with the number of on_planes reduced to be no more than max_clip_planes. The number of off_planes in the new ClipPlaneAttrib is undefined.

static int get_class_slot(void)

static TypeHandle get_class_type(void)

int get_num_off_planes(void) const

Returns the number of planes that are disabled by the attribute.

int get_num_on_planes(void) const

Returns the number of planes that are enabled by the attribute.

int get_num_planes(void) const

Returns the number of planes listed in the attribute.

Deprecated: ClipPlaneAttribs nowadays have a separate list of on_planes and

off_planes, so this method no longer makes sense. Query the lists independently.

NodePath get_off_plane(int n) const

Returns the nth plane disabled by the attribute, sorted in arbitrary (pointer) order.

NodePath get_on_plane(int n) const

Returns the nth plane enabled by the attribute, sorted in render order.

Operation get_operation(void) const

Returns the basic operation type of the ClipPlaneAttrib. If this is O_set, the planes listed here completely replace any planes that were already on. If this is O_add, the planes here are added to the set of planes that were already on, and if O_remove, the planes here are removed from the set of planes that were on.

Deprecated: ClipPlaneAttribs nowadays have a separate list of on_planes and

off_planes, so this method no longer makes sense. Query the lists independently.

PlaneNode *get_plane(int n) const

Returns the nth plane listed in the attribute.

Deprecated: ClipPlaneAttribs nowadays have a separate list of on_planes and

off_planes, so this method no longer makes sense. Query the lists independently.

bool has_all_off(void) const

Returns true if this attrib disables all planes (although it may also enable some).

bool has_off_plane(NodePath const &plane) const

Returns true if the indicated plane is disabled by the attrib, false otherwise.

bool has_on_plane(NodePath const &plane) const

Returns true if the indicated plane is enabled by the attrib, false otherwise.

bool has_plane(PlaneNode *plane) const

Returns true if the indicated plane is listed in the attrib, false otherwise.

Deprecated: ClipPlaneAttribs nowadays have a separate list of on_planes and

off_planes, so this method no longer makes sense. Query the lists independently.

bool is_identity(void) const

Returns true if this is an identity attrib: it does not change the set of planes in use.

static ConstPointerTo<RenderAttrib> make(ClipPlaneAttrib::Operation op, PlaneNode *plane)

static ConstPointerTo<RenderAttrib> make(ClipPlaneAttrib::Operation op, PlaneNode *plane1, PlaneNode *plane2)

static ConstPointerTo<RenderAttrib> make(ClipPlaneAttrib::Operation op, PlaneNode *plane1, PlaneNode *plane2, PlaneNode *plane3)

static ConstPointerTo<RenderAttrib> make(ClipPlaneAttrib::Operation op, PlaneNode *plane1, PlaneNode *plane2, PlaneNode *plane3, PlaneNode *plane4)

static ConstPointerTo<RenderAttrib> make(void)

The following is the new, more general interface to the ClipPlaneAttrib.

Constructs a new ClipPlaneAttrib object that enables (or disables, according to op) the indicated plane(s).

Deprecated: Use add_on_plane() or add_off_plane() instead.

Constructs a new ClipPlaneAttrib object that turns on (or off, according to op) the indicate plane(s).

Deprecated: Use add_on_plane() or add_off_plane() instead.

Constructs a new ClipPlaneAttrib object that turns on (or off, according to op) the indicate plane(s).

Deprecated: Use add_on_plane() or add_off_plane() instead.

Constructs a new ClipPlaneAttrib object that turns on (or off, according to op) the indicate plane(s).

Deprecated: Use add_on_plane() or add_off_plane() instead.

Constructs a new ClipPlaneAttrib object that does nothing.

static ConstPointerTo<RenderAttrib> make_all_off(void)

Constructs a new ClipPlaneAttrib object that disables all planes (and hence disables clipping).

static ConstPointerTo<RenderAttrib> make_default(void)

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

ConstPointerTo<RenderAttrib> remove_off_plane(NodePath const &plane) const

Returns a new ClipPlaneAttrib, just like this one, but with the indicated plane removed from the list of planes disabled by this attrib.

ConstPointerTo<RenderAttrib> remove_on_plane(NodePath const &plane) const

Returns a new ClipPlaneAttrib, just like this one, but with the indicated plane removed from the list of planes enabled by this attrib.

ConstPointerTo<RenderAttrib> remove_plane(PlaneNode *plane) const

Returns a new ClipPlaneAttrib, just like this one, but with the indicated plane removed from the list of planes.

Deprecated: Use remove_on_plane() or remove_off_plane() instead.