CompassEffect

Inheritance:

Methods of CompassEffect:

Methods of RenderEffect:

Methods of TypedWritableReferenceCount:

Methods of TypedWritable:

Methods of TypedObject:

Methods of ReferenceCount:

getClassType
static TypeHandle CompassEffect::get_class_type(void);

Undocumented function.

getProperties
int CompassEffect::get_properties(void) const;

Description: Returns the bitmask of properties that this CompassEffect object inherits from its reference node (or from the root).

getReference
NodePath const &CompassEffect::get_reference(void) const;

Description: Returns the reference node from which the CompassEffect inherits its transform. If this is empty, it means the root of the scene graph.

make
static ConstPointerTo< RenderEffect > CompassEffect::make(NodePath const &reference, int properties = (P_rot));

Description: Constructs a new CompassEffect object. If the reference is an empty NodePath, it means the CompassEffect is relative to the root of the scene graph; otherwise, it's relative to the indicated node. The properties bitmask specifies the set of properties that the compass node inherits from the reference instead of from its parent.

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

Filename: renderEffect.I Created by: drose (14Mar02)
PANDA 3D SOFTWARE Copyright (c) 2001 - 2004, Disney Enterprises, Inc. All rights reserved
All use of this software is subject to the terms of the Panda 3d Software license. You should have received a copy of this license along with this source code; you will also find a current copy of the license at http://etc.cmu.edu/panda3d/docs/license/ .
To contact the maintainers of this program write to panda3d-general@lists.sourceforge.net .
Description: Provides an arbitrary ordering among all unique RenderEffects, 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 RenderEffect class because all equivalent RenderEffect objects are guaranteed to share the same pointer; thus, a pointer comparison is always sufficient.

getClassType
static TypeHandle RenderEffect::get_class_type(void);

Undocumented function.

getNumEffects
static int RenderEffect::get_num_effects(void);

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

listEffects
static void RenderEffect::list_effects(ostream &out);

Description: Lists all of the RenderEffects 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 RenderEffect::output(ostream &out) const;

Description:

validateEffects
static bool RenderEffect::validate_effects(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 RenderEffect objects).

write
virtual void RenderEffect::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.