Panda3D
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
ClipPlaneAttrib Class Reference

This functions similarly to a LightAttrib. More...

Inheritance diagram for ClipPlaneAttrib:
RenderAttrib TypedWritableReferenceCount TypedWritable ReferenceCount TypedObject

Public Types

enum  Operation { O_set = 0, O_add = 1, O_remove = 2 }
 
- Public Types inherited from RenderAttrib
enum  PandaCompareFunc {
  M_none = 0, M_never = 1, M_less = 2, M_equal = 3,
  M_less_equal = 4, M_greater = 5, M_not_equal = 6, M_greater_equal = 7,
  M_always = 8
}
 
enum  TexGenMode {
  M_off = 0, M_eye_sphere_map = 1, M_world_cube_map = 2, M_eye_cube_map = 3,
  M_world_normal = 4, M_eye_normal = 5, M_world_position = 6, M_unused = 7,
  M_eye_position = 8, M_point_sprite = 9, M_unused2 = 10, M_constant = 11
}
 

Public Member Functions

const RenderAttrib addOffPlane (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. More...
 
const RenderAttrib addOnPlane (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. More...
 
const RenderAttrib addPlane (PlaneNode plane)
 Returns a new ClipPlaneAttrib, just like this one, but with the indicated plane added to the list of planes. More...
 
const ClipPlaneAttrib filterToMax (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. More...
 
int getNumOffPlanes ()
 Returns the number of planes that are disabled by the attribute. More...
 
int getNumOnPlanes ()
 Returns the number of planes that are enabled by the attribute. More...
 
int getNumPlanes ()
 Returns the number of planes listed in the attribute. More...
 
NodePath getOffPlane (int n)
 Returns the nth plane disabled by the attribute, sorted in arbitrary (pointer) order. More...
 
list getOffPlanes ()
 
NodePath getOnPlane (int n)
 Returns the nth plane enabled by the attribute, sorted in render order. More...
 
list getOnPlanes ()
 
ClipPlaneAttrib::Operation getOperation ()
 Returns the basic operation type of the ClipPlaneAttrib. More...
 
PlaneNode getPlane (int n)
 Returns the nth plane listed in the attribute. More...
 
bool hasAllOff ()
 Returns true if this attrib disables all planes (although it may also enable some). More...
 
bool hasOffPlane (const NodePath plane)
 Returns true if the indicated plane is disabled by the attrib, false otherwise. More...
 
bool hasOnPlane (const NodePath plane)
 Returns true if the indicated plane is enabled by the attrib, false otherwise. More...
 
bool hasPlane (PlaneNode plane)
 Returns true if the indicated plane is listed in the attrib, false otherwise. More...
 
bool isIdentity ()
 Returns true if this is an identity attrib: it does not change the set of planes in use. More...
 
const RenderAttrib removeOffPlane (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. More...
 
const RenderAttrib removeOnPlane (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. More...
 
const RenderAttrib removePlane (PlaneNode plane)
 Returns a new ClipPlaneAttrib, just like this one, but with the indicated plane removed from the list of planes. More...
 
- Public Member Functions inherited from RenderAttrib
int compareTo (const RenderAttrib other)
 Provides an arbitrary ordering among all unique RenderAttribs, so we can store the essentially different ones in a big set and throw away the rest. More...
 
const RenderAttrib compose (const RenderAttrib other)
 Returns a new RenderAttrib object that represents the composition of this attrib with the other attrib. More...
 
int getHash ()
 Returns a suitable hash value for phash_map. More...
 
int getSlot ()
 
const RenderAttrib getUnique ()
 Returns the pointer to the unique RenderAttrib in the cache that is equivalent to this one. More...
 
const RenderAttrib invertCompose (const RenderAttrib other)
 Returns a new RenderAttrib object that represents the composition of the inverse of this attrib with the other attrib. More...
 
bool lowerAttribCanOverride ()
 Intended to be overridden by derived RenderAttrib types to specify how two consecutive RenderAttrib objects of the same type interact. More...
 
 output (Ostream out)
 
 write (Ostream out, int indent_level)
 
- Public Member Functions inherited from TypedWritable
object __reduce__ ()
 
object __reduce_persist__ (object pickler)
 
VectorUchar encodeToBamStream ()
 Converts the TypedWritable object into a single stream of data using a BamWriter, and returns that data as a bytes object. More...
 
bool encodeToBamStream (VectorUchar data, BamWriter writer)
 Converts the TypedWritable object into a single stream of data using a BamWriter, and stores that data in the indicated string. More...
 
 fillin (DatagramIterator scan, BamReader manager)
 This internal function is intended to be called by each class's make_from_bam() method to read in all of the relevant data from the BamFile for the new object. More...
 
UpdateSeq getBamModified ()
 Returns the current bam_modified counter. More...
 
 markBamModified ()
 Increments the bam_modified counter, so that this object will be invalidated and retransmitted on any open bam streams. More...
 
- Public Member Functions inherited from TypedObject
TypeHandle getType ()
 
int getTypeIndex ()
 Returns the internal index number associated with this object's TypeHandle, a unique number for each different type. More...
 
bool isExactType (TypeHandle handle)
 Returns true if the current object is the indicated type exactly. More...
 
bool isOfType (TypeHandle handle)
 Returns true if the current object is or derives from the indicated type. More...
 
- Public Member Functions inherited from ReferenceCount
int getRefCount ()
 Returns the current reference count. More...
 
 ref ()
 Explicitly increments the reference count. More...
 
bool testRefCountIntegrity ()
 Does some easy checks to make sure that the reference count isn't completely bogus. More...
 
bool testRefCountNonzero ()
 Does some easy checks to make sure that the reference count isn't zero, or completely bogus. More...
 
bool unref ()
 Explicitly decrements the reference count. More...
 

Static Public Member Functions

static int getClassSlot ()
 
static TypeHandle getClassType ()
 
static const RenderAttrib make ()
 
static const RenderAttrib make (ClipPlaneAttrib::Operation op, PlaneNode plane)
 Constructs a new ClipPlaneAttrib object that enables (or disables, according to op) the indicated plane(s). More...
 
static const RenderAttrib make (ClipPlaneAttrib::Operation op, PlaneNode plane1, PlaneNode plane2)
 Constructs a new ClipPlaneAttrib object that turns on (or off, according to op) the indicate plane(s). More...
 
static const RenderAttrib make (ClipPlaneAttrib::Operation op, PlaneNode plane1, PlaneNode plane2, PlaneNode plane3)
 Constructs a new ClipPlaneAttrib object that turns on (or off, according to op) the indicate plane(s). More...
 
static const RenderAttrib make (ClipPlaneAttrib::Operation op, PlaneNode plane1, PlaneNode plane2, PlaneNode plane3, PlaneNode plane4)
 Constructs a new ClipPlaneAttrib object that turns on (or off, according to op) the indicate plane(s). More...
 
static const RenderAttrib makeAllOff ()
 Constructs a new ClipPlaneAttrib object that disables all planes (and hence disables clipping). More...
 
static const RenderAttrib makeDefault ()
 Returns a RenderAttrib that corresponds to whatever the standard default properties for render attributes of this type ought to be. More...
 
- Static Public Member Functions inherited from RenderAttrib
static int garbageCollect ()
 Performs a garbage-collection cycle. More...
 
static TypeHandle getClassType ()
 
static int getNumAttribs ()
 Returns the total number of unique RenderAttrib objects allocated in the world. More...
 
static listAttribs (Ostream out)
 Lists all of the RenderAttribs in the cache to the output stream, one per line. More...
 
static bool validateAttribs ()
 Ensures that the cache is still stored in sorted order. More...
 
- Static Public Member Functions inherited from TypedWritableReferenceCount
static TypedWritableReferenceCount decodeFromBamStream (VectorUchar data, BamReader reader)
 Reads the bytes created by a previous call to encode_to_bam_stream(), and extracts and returns the single object on those bytes. More...
 
static TypeHandle getClassType ()
 
- Static Public Member Functions inherited from TypedWritable
static TypeHandle getClassType ()
 
- Static Public Member Functions inherited from TypedObject
static TypeHandle getClassType ()
 
- Static Public Member Functions inherited from ReferenceCount
static TypeHandle getClassType ()
 

Public Attributes

int class_slot
 
- Public Attributes inherited from RenderAttrib
int slot
 
- Public Attributes inherited from TypedObject
TypeHandle type
 Returns the TypeHandle representing this object's type. More...
 
- Public Attributes inherited from ReferenceCount
int ref_count
 The current reference count. More...
 

Detailed Description

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.

Member Enumeration Documentation

◆ Operation

enum Operation
Enumerator
O_set 
O_add 
O_remove 

Member Function Documentation

◆ addOffPlane()

const RenderAttrib addOffPlane ( 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()

const RenderAttrib addOnPlane ( 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()

const RenderAttrib addPlane ( PlaneNode  plane)

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

This method is now deprecated. Use add_on_plane() or add_off_plane() instead.

◆ filterToMax()

const ClipPlaneAttrib filterToMax ( 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()

static int getClassSlot ( )
static

◆ getClassType()

static TypeHandle getClassType ( )
static

◆ getNumOffPlanes()

int getNumOffPlanes ( )

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

◆ getNumOnPlanes()

int getNumOnPlanes ( )

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

◆ getNumPlanes()

int getNumPlanes ( )

Returns the number of planes listed in the attribute.

This method is now deprecated. ClipPlaneAttribs nowadays have a separate list of on_planes and off_planes, so this method doesn't make sense. Query the lists independently.

◆ getOffPlane()

NodePath getOffPlane ( int  n)

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

◆ getOffPlanes()

list getOffPlanes ( )

◆ getOnPlane()

NodePath getOnPlane ( int  n)

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

◆ getOnPlanes()

list getOnPlanes ( )

◆ getOperation()

ClipPlaneAttrib::Operation getOperation ( )

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.

This method is now deprecated. ClipPlaneAttribs nowadays have a separate list of on_planes and off_planes, so this method doesn't make sense. Query the lists independently.

◆ getPlane()

PlaneNode getPlane ( int  n)

Returns the nth plane listed in the attribute.

This method is now deprecated. ClipPlaneAttribs nowadays have a separate list of on_planes and off_planes, so this method doesn't make sense. Query the lists independently.

◆ hasAllOff()

bool hasAllOff ( )

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

◆ hasOffPlane()

bool hasOffPlane ( const NodePath  plane)

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

◆ hasOnPlane()

bool hasOnPlane ( const NodePath  plane)

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

◆ hasPlane()

bool hasPlane ( PlaneNode  plane)

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

This method is now deprecated. ClipPlaneAttribs nowadays have a separate list of on_planes and off_planes, so this method doesn't make sense. Query the lists independently.

◆ isIdentity()

bool isIdentity ( )

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

◆ make() [1/5]

static const RenderAttrib make ( )
static

◆ make() [2/5]

static const RenderAttrib make ( ClipPlaneAttrib::Operation  op,
PlaneNode  plane 
)
static

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

This method is now deprecated. Use add_on_plane() or add_off_plane() instead.

◆ make() [3/5]

static const RenderAttrib make ( ClipPlaneAttrib::Operation  op,
PlaneNode  plane1,
PlaneNode  plane2 
)
static

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

This method is now deprecated. Use add_on_plane() or add_off_plane() instead.

◆ make() [4/5]

static const RenderAttrib make ( ClipPlaneAttrib::Operation  op,
PlaneNode  plane1,
PlaneNode  plane2,
PlaneNode  plane3 
)
static

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

This method is now deprecated. Use add_on_plane() or add_off_plane() instead.

◆ make() [5/5]

static const RenderAttrib make ( ClipPlaneAttrib::Operation  op,
PlaneNode  plane1,
PlaneNode  plane2,
PlaneNode  plane3,
PlaneNode  plane4 
)
static

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

This method is now deprecated. Use add_on_plane() or add_off_plane() instead.

◆ makeAllOff()

static const RenderAttrib makeAllOff ( )
static

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

◆ makeDefault()

static const RenderAttrib makeDefault ( )
static

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

◆ removeOffPlane()

const RenderAttrib removeOffPlane ( 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()

const RenderAttrib removeOnPlane ( 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()

const RenderAttrib removePlane ( PlaneNode  plane)

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

This method is now deprecated. Use remove_on_plane() or remove_off_plane() instead.

Member Data Documentation

◆ class_slot

int class_slot