ClipPlaneAttrib

Inheritance:

Methods of ClipPlaneAttrib:

Methods of RenderAttrib:

Methods of TypedWritableReferenceCount:

Methods of TypedWritable:

Methods of TypedObject:

Methods of ReferenceCount:

addOffPlane
ConstPointerTo< RenderAttrib > ClipPlaneAttrib::add_off_plane(NodePath const &plane) const;

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

addOnPlane
ConstPointerTo< RenderAttrib > ClipPlaneAttrib::add_on_plane(NodePath const &plane) const;

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

addPlane
ConstPointerTo< RenderAttrib > ClipPlaneAttrib::add_plane(PlaneNode *plane) const;

Description: 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
ConstPointerTo< ClipPlaneAttrib > ClipPlaneAttrib::filter_to_max(int max_clip_planes) const;

Description: 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.

getClassType
static TypeHandle ClipPlaneAttrib::get_class_type(void);

Undocumented function.

getNumOffPlanes
int ClipPlaneAttrib::get_num_off_planes(void) const;

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

getNumOnPlanes
int ClipPlaneAttrib::get_num_on_planes(void) const;

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

getNumPlanes
int ClipPlaneAttrib::get_num_planes(void) const;

Description: 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 ClipPlaneAttrib::get_off_plane(int n) const;

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

getOnPlane
NodePath ClipPlaneAttrib::get_on_plane(int n) const;

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

getOperation
ClipPlaneAttrib::Operation ClipPlaneAttrib::get_operation(void) const;

Description: 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 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 *ClipPlaneAttrib::get_plane(int n) const;

Description: 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 ClipPlaneAttrib::has_all_off(void) const;

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

hasOffPlane
bool ClipPlaneAttrib::has_off_plane(NodePath const &plane) const;

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

hasOnPlane
bool ClipPlaneAttrib::has_on_plane(NodePath const &plane) const;

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

hasPlane
bool ClipPlaneAttrib::has_plane(PlaneNode *plane) const;

Description: 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 ClipPlaneAttrib::is_identity(void) const;

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

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

The following is the new, more general interface to the ClipPlaneAttrib.
Description: 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.
Description: Constructs a new ClipPlaneAttrib object that turns on (or off, according to op) the indicate plane(s).
Description: Constructs a new ClipPlaneAttrib object that does nothing.

makeAllOff
static ConstPointerTo< RenderAttrib > ClipPlaneAttrib::make_all_off(void);

The following is the new, more general interface to the ClipPlaneAttrib.
Description: Constructs a new ClipPlaneAttrib object that disables all planes (and hence disables clipping).

removeOffPlane
ConstPointerTo< RenderAttrib > ClipPlaneAttrib::remove_off_plane(NodePath const &plane) const;

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

removeOnPlane
ConstPointerTo< RenderAttrib > ClipPlaneAttrib::remove_on_plane(NodePath const &plane) const;

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

removePlane
ConstPointerTo< RenderAttrib > ClipPlaneAttrib::remove_plane(PlaneNode *plane) const;

Description: 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.

compareTo
int RenderAttrib::compare_to(RenderAttrib const &other) const;

Description: 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.
This method is not needed outside of the RenderAttrib class because all equivalent RenderAttrib objects are guaranteed to share the same pointer; thus, a pointer comparison is always sufficient.

getClassType
static TypeHandle RenderAttrib::get_class_type(void);

Undocumented function.

getNumAttribs
static int RenderAttrib::get_num_attribs(void);

Description: Returns the total number of unique RenderAttrib objects allocated in the world. This will go up and down during normal operations.

listAttribs
static void RenderAttrib::list_attribs(ostream &out);

Description: Lists all of the RenderAttribs in the cache to the output stream, one per line. This can be quite a lot of output if the cache is large, so be prepared.

output
virtual void RenderAttrib::output(ostream &out) const;

Description:

validateAttribs
static bool RenderAttrib::validate_attribs(void);

Description: Ensures that the cache is still stored in sorted order. Returns true if so, false if there is a problem (which implies someone has modified one of the supposedly-const RenderAttrib objects).

write
virtual void RenderAttrib::write(ostream &out, int indent_level) const;

Description:

getClassType
static TypeHandle TypedWritableReferenceCount::get_class_type(void);

Undocumented function.

getClassType
static TypeHandle TypedWritable::get_class_type(void);

Undocumented function.

getBestParentFromSet
int TypedObject::get_best_parent_from_Set(set< int > const &) const;

Description: Returns true if the current object is the indicated type exactly.

getClassType
static TypeHandle TypedObject::get_class_type(void);

Undocumented function.

getType
virtual TypeHandle TypedObject::get_type(void) const = 0;

Derived classes should override this function to return get_class_type().

getTypeIndex
int TypedObject::get_type_index(void) const;

Description: Returns the internal index number associated with this object's TypeHandle, a unique number for each different type. This is equivalent to get_type().get_index().

isExactType
bool TypedObject::is_exact_type(TypeHandle handle) const;

Description: Returns true if the current object is the indicated type exactly.

isOfType
bool TypedObject::is_of_type(TypeHandle handle) const;

Description: Returns true if the current object is or derives from the indicated type.

getClassType
static TypeHandle ReferenceCount::get_class_type(void);

Undocumented function.

getRefCount
int ReferenceCount::get_ref_count(void) const;

Description: Returns the current reference count.

ref
int ReferenceCount::ref(void) const;

Description: Explicitly increments the reference count. User code should avoid using ref() and unref() directly, which can result in missed reference counts. Instead, let a PointerTo object manage the reference counting automatically.
This function is const, even though it changes the object, because generally fiddling with an object's reference count isn't considered part of fiddling with the object. An object might be const in other ways, but we still need to accurately count the number of references to it.
The return value is the new reference count.

testRefCountIntegrity
bool ReferenceCount::test_ref_count_integrity(void) const;

Description: Does some easy checks to make sure that the reference count isn't completely bogus. Returns true if ok, false otherwise.

unref
int ReferenceCount::unref(void) const;

Description: Explicitly decrements the reference count. Note that the object will not be implicitly deleted by unref() simply because the reference count drops to zero. (Having a member function delete itself is problematic; plus, we don't have a virtual destructor anyway.) However, see the helper function unref_delete().
User code should avoid using ref() and unref() directly, which can result in missed reference counts. Instead, let a PointerTo object manage the reference counting automatically.
This function is const, even though it changes the object, because generally fiddling with an object's reference count isn't considered part of fiddling with the object. An object might be const in other ways, but we still need to accurately count the number of references to it.
The return value is the new reference count.