Indicates that geometry at this node should automatically rotate to face the camera, or any other arbitrary node. More...
#include "billboardEffect.h"
Public Member Functions | |
virtual void | adjust_transform (CPT(TransformState)&net_transform, CPT(TransformState)&node_transform, PandaNode *node) const |
Performs some operation on the node's apparent net and/or local transforms. More... | |
virtual | CPT (TransformState) prepare_flatten_transform(const TransformState *net_transform) const |
virtual void | cull_callback (CullTraverser *trav, CullTraverserData &data, CPT(TransformState)&node_transform, CPT(RenderState)&node_state) const |
If has_cull_callback() returns true, this function will be called during the cull traversal to perform any additional operations that should be performed at cull time. More... | |
virtual TypeHandle | force_init_type () |
bool | get_axial_rotate () const |
Returns true if this billboard rotates only around the axis of the up vector, or false if it rotates freely in three dimensions. More... | |
bool | get_eye_relative () const |
Returns true if this billboard interprets the up vector relative to the camera, or false if it is relative to the world. More... | |
const NodePath & | get_look_at () const |
Returns the node this billboard will rotate to look towards. More... | |
const LPoint3 & | get_look_at_point () const |
Returns the point, relative to the look_at node, towards which the billboard will rotate. More... | |
PN_stdfloat | get_offset () const |
Returns the distance toward the camera (or the look_at_point) the billboard is moved towards, after rotating. More... | |
virtual TypeHandle | get_type () const |
const LVector3 & | get_up_vector () const |
Returns the up vector in effect for this billboard. More... | |
virtual bool | has_adjust_transform () const |
Should be overridden by derived classes to return true if adjust_transform() has been defined, and therefore the RenderEffect has some effect on the node's apparent local and net transforms. More... | |
virtual bool | has_cull_callback () const |
Should be overridden by derived classes to return true if cull_callback() has been defined. More... | |
bool | is_off () const |
Returns true if the BillboardEffect is an 'off' BillboardEffect, indicating that it does not enable billboarding. More... | |
virtual void | output (ostream &out) const |
virtual bool | safe_to_transform () const |
Returns true if it is generally safe to transform this particular kind of RenderEffect by calling the xform() method, false otherwise. More... | |
virtual void | write_datagram (BamWriter *manager, Datagram &dg) |
Writes the contents of this object to the datagram for shipping out to a Bam file. More... | |
![]() | |
virtual | ~RenderEffect () |
The destructor is responsible for removing the RenderEffect from the global set if it is there. More... | |
int | compare_to (const RenderEffect &other) const |
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. More... | |
virtual void | finalize (BamReader *manager) |
Called by the BamReader to perform any final actions needed for setting up the object after all objects have been read and all pointers have been completed. More... | |
virtual bool | safe_to_combine () const |
virtual void | write (ostream &out, int indent_level) const |
![]() | |
TypedWritableReferenceCount (const TypedWritableReferenceCount ©) | |
virtual ReferenceCount * | as_reference_count () |
Returns the pointer cast to a ReferenceCount pointer, if it is in fact of that type. More... | |
void | operator= (const TypedWritableReferenceCount ©) |
![]() | |
TypedWritable (const TypedWritable ©) | |
virtual int | complete_pointers (TypedWritable **p_list, BamReader *manager) |
Receives an array of pointers, one for each time manager->read_pointer() was called in fillin(). More... | |
string | encode_to_bam_stream () const |
Converts the TypedWritable object into a single stream of data using a BamWriter, and returns that data as a string string. More... | |
bool | encode_to_bam_stream (string &data, BamWriter *writer=NULL) const |
Converts the TypedWritable object into a single stream of data using a BamWriter, and stores that data in the indicated string. More... | |
UpdateSeq | get_bam_modified () const |
Returns the current bam_modified counter. More... | |
void | mark_bam_modified () |
Increments the bam_modified counter, so that this object will be invalidated and retransmitted on any open bam streams. More... | |
void | operator= (const TypedWritable ©) |
virtual bool | require_fully_complete () const |
Some objects require all of their nested pointers to have been completed before the objects themselves can be completed. More... | |
virtual void | update_bam_nested (BamWriter *manager) |
Called by the BamWriter when this object has not itself been modified recently, but it should check its nested objects for updates. More... | |
![]() | |
TypedObject (const TypedObject ©) | |
TypedObject * | as_typed_object () |
Returns the object, upcast (if necessary) to a TypedObject pointer. More... | |
const TypedObject * | as_typed_object () const |
Returns the object, upcast (if necessary) to a TypedObject pointer. More... | |
int | get_best_parent_from_Set (const std::set< int > &) const |
int | get_type_index () const |
Returns the internal index number associated with this object's TypeHandle, a unique number for each different type. More... | |
bool | is_exact_type (TypeHandle handle) const |
Returns true if the current object is the indicated type exactly. More... | |
bool | is_of_type (TypeHandle handle) const |
Returns true if the current object is or derives from the indicated type. More... | |
void | operator= (const TypedObject ©) |
![]() | |
int | get_ref_count () const |
Returns the current reference count. More... | |
WeakReferenceList * | get_weak_list () const |
Returns the WeakReferenceList associated with this ReferenceCount object. More... | |
bool | has_weak_list () const |
Returns true if this particular ReferenceCount object has a WeakReferenceList created, false otherwise. More... | |
void | local_object () |
This function should be called, once, immediately after creating a new instance of some ReferenceCount-derived object on the stack. More... | |
void | ref () const |
Explicitly increments the reference count. More... | |
bool | test_ref_count_integrity () const |
Does some easy checks to make sure that the reference count isn't completely bogus. More... | |
bool | test_ref_count_nonzero () const |
Does some easy checks to make sure that the reference count isn't zero, or completely bogus. More... | |
virtual bool | unref () const |
Explicitly decrements the reference count. More... | |
void | weak_ref (WeakPointerToVoid *ptv) |
Adds the indicated PointerToVoid as a weak reference to this object. More... | |
void | weak_unref (WeakPointerToVoid *ptv) |
Removes the indicated PointerToVoid as a weak reference to this object. More... | |
Static Public Member Functions | |
static | CPT (RenderEffect) make(const LVector3 &up_vector |
static | CPT (RenderEffect) make_axis() |
static | CPT (RenderEffect) make_point_eye() |
static | CPT (RenderEffect) make_point_world() |
static TypeHandle | get_class_type () |
static void | init_type () |
static void | register_with_read_factory () |
Tells the BamReader how to create objects of type BillboardEffect. More... | |
![]() | |
static TypedWritable * | change_this (TypedWritable *old_ptr, BamReader *manager) |
Called immediately after complete_pointers(), this gives the object a chance to adjust its own pointer if desired. More... | |
static TypeHandle | get_class_type () |
static int | get_num_effects () |
Returns the total number of unique RenderEffect objects allocated in the world. More... | |
static void | init_type () |
static void | list_effects (ostream &out) |
Lists all of the RenderEffects in the cache to the output stream, one per line. More... | |
static bool | validate_effects () |
Ensures that the cache is still stored in sorted order. More... | |
![]() | |
static TypeHandle | get_class_type () |
static void | init_type () |
static | PT (TypedWritableReferenceCount) decode_from_bam_stream(const string &data |
![]() | |
static bool | decode_raw_from_bam_stream (TypedWritable *&ptr, ReferenceCount *&ref_ptr, const string &data, BamReader *reader=NULL) |
Reads the string created by a previous call to encode_to_bam_stream(), and extracts the single object on that string. More... | |
static TypeHandle | get_class_type () |
static void | init_type () |
![]() | |
static TypeHandle | get_class_type () |
static void | init_type () |
This function is declared non-inline to work around a compiler bug in g++ 2.96. More... | |
![]() | |
static TypeHandle | get_class_type () |
static void | init_type () |
Public Attributes | |
static bool bool | axial_rotate |
static bool | eye_relative |
static bool bool PN_stdfloat const NodePath & | look_at |
static bool bool PN_stdfloat const NodePath const LPoint3 & | look_at_point |
static bool bool PN_stdfloat | offset |
![]() | |
static BamReader * | reader = NULL) |
Additional Inherited Members | |
![]() | |
static TypedWritable *const | Null = (TypedWritable*)0L |
Indicates that geometry at this node should automatically rotate to face the camera, or any other arbitrary node.
Definition at line 30 of file billboardEffect.h.
|
virtual |
Performs some operation on the node's apparent net and/or local transforms.
This will only be called if has_adjust_transform() is redefined to return true.
Both parameters are in/out. The original transforms will be passed in, and they may (or may not) be modified in-place by the RenderEffect.
Reimplemented from RenderEffect.
Definition at line 195 of file billboardEffect.cxx.
References NodePath::is_empty().
|
virtual |
If has_cull_callback() returns true, this function will be called during the cull traversal to perform any additional operations that should be performed at cull time.
This may include additional manipulation of render state or additional visible/invisible decisions, or any other arbitrary operation.
At the time this function is called, the current node's transform and state have not yet been applied to the net_transform and net_state. This callback may modify the node_transform and node_state to apply an effective change to the render state at this level.
Reimplemented from RenderEffect.
Definition at line 143 of file billboardEffect.cxx.
References CullTraverser::get_camera_transform(), and NodePath::is_empty().
|
inline |
Returns true if this billboard rotates only around the axis of the up vector, or false if it rotates freely in three dimensions.
Definition at line 109 of file billboardEffect.I.
|
inline |
Returns true if this billboard interprets the up vector relative to the camera, or false if it is relative to the world.
Definition at line 97 of file billboardEffect.I.
|
inline |
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.
Definition at line 135 of file billboardEffect.I.
|
inline |
Returns the point, relative to the look_at node, towards which the billboard will rotate.
Normally this is (0, 0, 0).
Definition at line 147 of file billboardEffect.I.
|
inline |
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.
Definition at line 122 of file billboardEffect.I.
|
inline |
Returns the up vector in effect for this billboard.
Definition at line 85 of file billboardEffect.I.
|
virtual |
Should be overridden by derived classes to return true if adjust_transform() has been defined, and therefore the RenderEffect has some effect on the node's apparent local and net transforms.
Reimplemented from RenderEffect.
Definition at line 175 of file billboardEffect.cxx.
References NodePath::is_empty().
|
virtual |
Should be overridden by derived classes to return true if cull_callback() has been defined.
Otherwise, returns false to indicate cull_callback() does not need to be called for this effect during the cull traversal.
Reimplemented from RenderEffect.
Definition at line 121 of file billboardEffect.cxx.
|
inline |
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().
Definition at line 75 of file billboardEffect.I.
|
static |
Tells the BamReader how to create objects of type BillboardEffect.
Definition at line 333 of file billboardEffect.cxx.
References BamReader::get_factory(), and Factory< Type >::register_factory().
|
virtual |
Returns true if it is generally safe to transform this particular kind of RenderEffect by calling the xform() method, false otherwise.
Reimplemented from RenderEffect.
Definition at line 56 of file billboardEffect.cxx.
Writes the contents of this object to the datagram for shipping out to a Bam file.
Reimplemented from RenderEffect.
Definition at line 344 of file billboardEffect.cxx.
References Datagram::add_bool(), Datagram::add_stdfloat(), RenderEffect::write_datagram(), and LVecBase3f::write_datagram().