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

digraph inheritance3246d5a800 { bgcolor=transparent; rankdir=BT; size="8.0, 12.0"; "ClipPlaneAttrib" [URL="acron.core.ClipPlaneAttrib.html#acron.core.ClipPlaneAttrib",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=11,height=0.25,shape=box,style="",target="_top",tooltip="/**"]; "RenderAttrib" -> "ClipPlaneAttrib" [arrowsize=0.75,style=""]; "DTOOL_SUPER_BASE" [fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=11,height=0.25,shape=box,style=""]; "ReferenceCount" [URL="acron.core.ReferenceCount.html#acron.core.ReferenceCount",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=11,height=0.25,shape=box,style="",target="_top",tooltip="/**"]; "DTOOL_SUPER_BASE" -> "ReferenceCount" [arrowsize=0.75,style=""]; "RenderAttrib" [URL="acron.core.RenderAttrib.html#acron.core.RenderAttrib",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=11,height=0.25,shape=box,style="",target="_top",tooltip="/**"]; "TypedWritableReferenceCount" -> "RenderAttrib" [arrowsize=0.75,style=""]; "TypedObject" [URL="acron.core.TypedObject.html#acron.core.TypedObject",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=11,height=0.25,shape=box,style="",target="_top",tooltip="/**"]; "DTOOL_SUPER_BASE" -> "TypedObject" [arrowsize=0.75,style=""]; "TypedWritable" [URL="acron.core.TypedWritable.html#acron.core.TypedWritable",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=11,height=0.25,shape=box,style="",target="_top",tooltip="/**"]; "TypedObject" -> "TypedWritable" [arrowsize=0.75,style=""]; "TypedWritableReferenceCount" [URL="acron.core.TypedWritableReferenceCount.html#acron.core.TypedWritableReferenceCount",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=11,height=0.25,shape=box,style="",target="_top",tooltip="/**"]; "TypedWritable" -> "TypedWritableReferenceCount" [arrowsize=0.75,style=""]; "ReferenceCount" -> "TypedWritableReferenceCount" [arrowsize=0.75,style=""]; }

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¶

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

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

ClipPlaneAttrib.add_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.

ClipPlaneAttrib.filter_to_max()¶: 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 ClipPlaneAttrib.get_class_slot()¶

static ClipPlaneAttrib.get_class_type()¶

ClipPlaneAttrib.get_num_off_planes()¶: Returns the number of planes that are disabled by the attribute.

ClipPlaneAttrib.get_num_on_planes()¶: Returns the number of planes that are enabled by the attribute.

ClipPlaneAttrib.get_num_planes()¶

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.

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

ClipPlaneAttrib.get_on_plane()¶: Returns the nth plane enabled by the attribute, sorted in render order.

ClipPlaneAttrib.get_operation()¶

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.

ClipPlaneAttrib.get_plane()¶

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.

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

ClipPlaneAttrib.has_off_plane()¶: Returns true if the indicated plane is disabled by the attrib, false otherwise.

ClipPlaneAttrib.has_on_plane()¶: Returns true if the indicated plane is enabled by the attrib, false otherwise.

ClipPlaneAttrib.has_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.

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

static ClipPlaneAttrib.make()¶

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 ClipPlaneAttrib.make_all_off()¶: Constructs a new ClipPlaneAttrib object that disables all planes (and hence disables clipping).

static ClipPlaneAttrib.make_default()¶: Returns a RenderAttrib that corresponds to whatever the standard default properties for render attributes of this type ought to be.

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

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

ClipPlaneAttrib.remove_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.