# BillboardEffect

from pandac.PandaModules import BillboardEffect

Class : BillboardEffect
Description : Indicates that geometry at this node should automatically rotate to face the camera, or any other arbitrary node.

## Inheritance:

BillboardEffect: RenderEffect
RenderEffect: TypedWritableReferenceCount
TypedWritableReferenceCount: TypedWritable ReferenceCount
TypedWritable: TypedObject
TypedObject:
ReferenceCount:

## Methods of BillboardEffect:

getAxialRotate
getClassType
getEyeRelative
getLookAt
getLookAtPoint
getOffset
getUpVector
isOff
make
makeAxis
makePointEye
makePointWorld

## Methods of RenderEffect:

compareTo
getClassType
getNumEffects
listEffects
output
validateEffects
write

## Methods of TypedWritableReferenceCount:

getClassType

## Methods of TypedWritable:

getClassType

## Methods of TypedObject:

getClassType
getType
getTypeIndex
isExactType
isOfType

## Methods of ReferenceCount:

getClassType
getRefCount
ref
testRefCountIntegrity
testRefCountNonzero
unref

getAxialRotate bool BillboardEffect::get_axial_rotate(void) const; Description: Returns true if this billboard rotates only around the axis of the up vector, or false if it rotates freely in three dimensions.

getClassType static TypeHandle BillboardEffect::get_class_type(void); Undocumented function.

getEyeRelative bool BillboardEffect::get_eye_relative(void) const; Description: Returns true if this billboard interprets the up vector relative to the camera, or false if it is relative to the world.

getLookAt NodePath const &BillboardEffect::get_look_at(void) const; Description: Returns the node this billboard will rotate to look towards. If this is empty, it means the billboard will rotate towards the current camera node, wherever that might be.

getLookAtPoint LPoint3f const &BillboardEffect::get_look_at_point(void) const; Description: Returns the point, relative to the look_at node, towards which the billboard will rotate. Normally this is (0, 0, 0).

getOffset float BillboardEffect::get_offset(void) const; Description: Returns the distance toward the camera (or the look_at_point) the billboard is moved towards, after rotating. This can be used to ensure the billboard is not obscured by nearby geometry.

getUpVector LVector3f const &BillboardEffect::get_up_vector(void) const; Description: Returns the up vector in effect for this billboard.

isOff bool BillboardEffect::is_off(void) const; Description: Returns true if the BillboardEffect is an 'off' BillboardEffect, indicating that it does not enable billboarding. This kind of BillboardEffect isn't particularly useful and isn't normally created or stored in the graph; it might be implicitly discovered as the result of a NodePath::get_rel_state().

make static ConstPointerTo< RenderEffect > BillboardEffect::make(LVector3f const &up_vector, bool eye_relative, bool axial_rotate, float offset, NodePath const &look_at, LPoint3f const &look_at_point); Description: Constructs a new BillboardEffect object with the indicated properties.

makeAxis static ConstPointerTo< RenderEffect > BillboardEffect::make_axis(void); Description: A convenience function to make a typical axis-rotating billboard.

makePointEye static ConstPointerTo< RenderEffect > BillboardEffect::make_point_eye(void); Description: A convenience function to make a typical eye-relative point-rotating billboard.

makePointWorld static ConstPointerTo< RenderEffect > BillboardEffect::make_point_world(void); Description: A convenience function to make a typical world-relative point-rotating billboard.

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.

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

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.

testRefCountNonzero bool ReferenceCount::test_ref_count_nonzero(void) const; Description: Does some easy checks to make sure that the reference count isn't zero, or completely bogus. Returns true if ok, false otherwise.

unref bool 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 true if the new reference count is nonzero, false if it is zero.