ClipPlaneAttrib

from panda3d.core import 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

Inheritance diagram of ClipPlaneAttrib

OAdd = 1
ORemove = 2
OSet = 0
O_add = 1
O_remove = 2
O_set = 0
__init__(*args, **kwargs)
addOffPlane()

C++ Interface: add_off_plane(ClipPlaneAttrib self, const NodePath plane)

/**

  • Returns a new ClipPlaneAttrib, just like this one, but with the indicated

  • plane added to the list of planes disabled by this attrib.

*/

addOnPlane()

C++ Interface: add_on_plane(ClipPlaneAttrib self, const NodePath plane)

/**

  • Returns a new ClipPlaneAttrib, just like this one, but with the indicated

  • plane added to the list of planes enabled by this attrib.

*/

addPlane()

C++ Interface: add_plane(ClipPlaneAttrib self, PlaneNode plane)

/**

  • 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.

*/

add_off_plane()

C++ Interface: add_off_plane(ClipPlaneAttrib self, const NodePath plane)

/**

  • Returns a new ClipPlaneAttrib, just like this one, but with the indicated

  • plane added to the list of planes disabled by this attrib.

*/

add_on_plane()

C++ Interface: add_on_plane(ClipPlaneAttrib self, const NodePath plane)

/**

  • Returns a new ClipPlaneAttrib, just like this one, but with the indicated

  • plane added to the list of planes enabled by this attrib.

*/

add_plane()

C++ Interface: add_plane(ClipPlaneAttrib self, PlaneNode plane)

/**

  • 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.

*/

class_slot = 5
filterToMax()

C++ Interface: filter_to_max(ClipPlaneAttrib self, int max_clip_planes)

/**

  • 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.

*/

filter_to_max()

C++ Interface: filter_to_max(ClipPlaneAttrib self, int max_clip_planes)

/**

  • 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.

*/

getClassSlot()

C++ Interface: get_class_slot()

getClassType()

C++ Interface: get_class_type()

getNumOffPlanes()

C++ Interface: get_num_off_planes(ClipPlaneAttrib self)

/**

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

*/

getNumOnPlanes()

C++ Interface: get_num_on_planes(ClipPlaneAttrib self)

/**

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

*/

getNumPlanes()

C++ Interface: get_num_planes(ClipPlaneAttrib self)

/**

  • 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.

*/

getOffPlane()

C++ Interface: get_off_plane(ClipPlaneAttrib self, int n)

/**

  • Returns the nth plane disabled by the attribute, sorted in arbitrary

  • (pointer) order.

*/

getOffPlanes()
getOnPlane()

C++ Interface: get_on_plane(ClipPlaneAttrib self, int n)

/**

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

*/

getOnPlanes()
getOperation()

C++ Interface: get_operation(ClipPlaneAttrib self)

/**

  • 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.

*/

getPlane()

C++ Interface: get_plane(ClipPlaneAttrib self, int n)

/**

  • 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.

*/

get_class_slot()

C++ Interface: get_class_slot()

get_class_type()

C++ Interface: get_class_type()

get_num_off_planes()

C++ Interface: get_num_off_planes(ClipPlaneAttrib self)

/**

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

*/

get_num_on_planes()

C++ Interface: get_num_on_planes(ClipPlaneAttrib self)

/**

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

*/

get_num_planes()

C++ Interface: get_num_planes(ClipPlaneAttrib self)

/**

  • 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.

*/

get_off_plane()

C++ Interface: get_off_plane(ClipPlaneAttrib self, int n)

/**

  • Returns the nth plane disabled by the attribute, sorted in arbitrary

  • (pointer) order.

*/

get_off_planes()
get_on_plane()

C++ Interface: get_on_plane(ClipPlaneAttrib self, int n)

/**

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

*/

get_on_planes()
get_operation()

C++ Interface: get_operation(ClipPlaneAttrib self)

/**

  • 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.

*/

get_plane()

C++ Interface: get_plane(ClipPlaneAttrib self, int n)

/**

  • 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.

*/

hasAllOff()

C++ Interface: has_all_off(ClipPlaneAttrib self)

/**

  • Returns true if this attrib disables all planes (although it may also

  • enable some).

*/

hasOffPlane()

C++ Interface: has_off_plane(ClipPlaneAttrib self, const NodePath plane)

/**

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

  • otherwise.

*/

hasOnPlane()

C++ Interface: has_on_plane(ClipPlaneAttrib self, const NodePath plane)

/**

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

  • otherwise.

*/

hasPlane()

C++ Interface: has_plane(ClipPlaneAttrib self, PlaneNode plane)

/**

  • 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.

*/

has_all_off()

C++ Interface: has_all_off(ClipPlaneAttrib self)

/**

  • Returns true if this attrib disables all planes (although it may also

  • enable some).

*/

has_off_plane()

C++ Interface: has_off_plane(ClipPlaneAttrib self, const NodePath plane)

/**

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

  • otherwise.

*/

has_on_plane()

C++ Interface: has_on_plane(ClipPlaneAttrib self, const NodePath plane)

/**

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

  • otherwise.

*/

has_plane()

C++ Interface: has_plane(ClipPlaneAttrib self, PlaneNode plane)

/**

  • 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.

*/

isIdentity()

C++ Interface: is_identity(ClipPlaneAttrib self)

/**

  • Returns true if this is an identity attrib: it does not change the set of

  • planes in use.

*/

is_identity()

C++ Interface: is_identity(ClipPlaneAttrib self)

/**

  • Returns true if this is an identity attrib: it does not change the set of

  • planes in use.

*/

make()

C++ Interface: make() make(int op, PlaneNode plane) make(int op, PlaneNode plane1, PlaneNode plane2) make(int op, PlaneNode plane1, PlaneNode plane2, PlaneNode plane3) make(int op, PlaneNode plane1, PlaneNode plane2, PlaneNode plane3, PlaneNode plane4)

// 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.

*/

makeAllOff()

C++ Interface: make_all_off()

/**

  • Constructs a new ClipPlaneAttrib object that disables all planes (and hence

  • disables clipping).

*/

makeDefault()

C++ Interface: make_default()

/**

  • Returns a RenderAttrib that corresponds to whatever the standard default

  • properties for render attributes of this type ought to be.

*/

make_all_off()

C++ Interface: make_all_off()

/**

  • Constructs a new ClipPlaneAttrib object that disables all planes (and hence

  • disables clipping).

*/

make_default()

C++ Interface: make_default()

/**

  • Returns a RenderAttrib that corresponds to whatever the standard default

  • properties for render attributes of this type ought to be.

*/

removeOffPlane()

C++ Interface: remove_off_plane(ClipPlaneAttrib self, const NodePath plane)

/**

  • Returns a new ClipPlaneAttrib, just like this one, but with the indicated

  • plane removed from the list of planes disabled by this attrib.

*/

removeOnPlane()

C++ Interface: remove_on_plane(ClipPlaneAttrib self, const NodePath plane)

/**

  • Returns a new ClipPlaneAttrib, just like this one, but with the indicated

  • plane removed from the list of planes enabled by this attrib.

*/

removePlane()

C++ Interface: remove_plane(ClipPlaneAttrib self, PlaneNode plane)

/**

  • 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.

*/

remove_off_plane()

C++ Interface: remove_off_plane(ClipPlaneAttrib self, const NodePath plane)

/**

  • Returns a new ClipPlaneAttrib, just like this one, but with the indicated

  • plane removed from the list of planes disabled by this attrib.

*/

remove_on_plane()

C++ Interface: remove_on_plane(ClipPlaneAttrib self, const NodePath plane)

/**

  • Returns a new ClipPlaneAttrib, just like this one, but with the indicated

  • plane removed from the list of planes enabled by this attrib.

*/

remove_plane()

C++ Interface: remove_plane(ClipPlaneAttrib self, PlaneNode plane)

/**

  • 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.

*/