Indicates that geometry at this node should automatically rotate to face the camera, or any other arbitrary node. More...

#include "billboardEffect.h"

Inheritance diagram for BillboardEffect:

Public Member Functions
virtual void	adjust_transform (ConstPointerTo< TransformState > &net_transform, ConstPointerTo< TransformState > &node_transform, const PandaNode *node) const
	Performs some operation on the node's apparent net and/or local transforms.

virtual int	complete_pointers (TypedWritable *plist, BamReader manager)
	Receives an array of pointers, one for each time manager->read_pointer() was called in fillin().

virtual void	cull_callback (CullTraverser *trav, CullTraverserData &data, ConstPointerTo< TransformState > &node_transform, ConstPointerTo< 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.

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.

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.

bool	get_fixed_depth () const
	Returns true if this billboard always appears at a fixed distance from the camera.

const NodePath &	get_look_at () const
	Returns the node this billboard will rotate to look towards.

const LPoint3 &	get_look_at_point () const
	Returns the point, relative to the look_at node, towards which the billboard will rotate.

PN_stdfloat	get_offset () const
	Returns the distance toward the camera (or the look_at_point) the billboard is moved towards, after rotating.

virtual TypeHandle	get_type () const

const LVector3 &	get_up_vector () const
	Returns the up vector in effect for this billboard.

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.

virtual bool	has_cull_callback () const
	Should be overridden by derived classes to return true if cull_callback() has been defined.

bool	is_off () const
	Returns true if the BillboardEffect is an 'off' BillboardEffect, indicating that it does not enable billboarding.

virtual void	output (std::ostream &out) const

virtual ConstPointerTo< TransformState >	prepare_flatten_transform (const TransformState *net_transform) const
	Preprocesses the accumulated transform that is about to be applied to (or through) this node due to a flatten operation.

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.

virtual void	write_datagram (BamWriter *manager, Datagram &dg)
	Writes the contents of this object to the datagram for shipping out to a Bam file.

Public Member Functions inherited from RenderEffect
	RenderEffect (const RenderEffect &copy)=delete

virtual	~RenderEffect ()
	The destructor is responsible for removing the RenderEffect from the global set if it is there.

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.

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.

RenderEffect &	operator= (const RenderEffect &copy)=delete

virtual bool	safe_to_combine () const
	Returns true if this kind of effect can safely be combined with sibling nodes that share the exact same effect, or false if this is not a good idea.

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

virtual ConstPointerTo< RenderEffect >	xform (const LMatrix4 &mat) const
	Returns a new RenderEffect transformed by the indicated matrix.

Public Member Functions inherited from TypedWritableReferenceCount
	TypedWritableReferenceCount (const TypedWritableReferenceCount &copy)

virtual ReferenceCount *	as_reference_count ()
	Returns the pointer cast to a ReferenceCount pointer, if it is in fact of that type.

void	operator= (const TypedWritableReferenceCount &copy)

Public Member Functions inherited from TypedWritable
	TypedWritable (const TypedWritable &copy)

vector_uchar	encode_to_bam_stream () const
	Converts the TypedWritable object into a single stream of data using a BamWriter, and returns that data as a bytes object.

bool	encode_to_bam_stream (vector_uchar &data, BamWriter *writer=nullptr) const
	Converts the TypedWritable object into a single stream of data using a BamWriter, and stores that data in the indicated string.

UpdateSeq	get_bam_modified () const
	Returns the current bam_modified counter.

void	mark_bam_modified ()
	Increments the bam_modified counter, so that this object will be invalidated and retransmitted on any open bam streams.

void	operator= (const TypedWritable &copy)

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.

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.

Public Member Functions inherited from TypedObject
	TypedObject (const TypedObject &copy)=default

TypedObject *	as_typed_object ()
	Returns the object, upcast (if necessary) to a TypedObject pointer.

const TypedObject *	as_typed_object () const
	Returns the object, upcast (if necessary) to a TypedObject pointer.

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.

bool	is_exact_type (TypeHandle handle) const
	Returns true if the current object is the indicated type exactly.

bool	is_of_type (TypeHandle handle) const
	Returns true if the current object is or derives from the indicated type.

TypedObject &	operator= (const TypedObject &copy)=default

Public Member Functions inherited from MemoryBase
void	operator delete (void , void )

void	operator delete (void *ptr)

void	operator delete[] (void , void )

void	operator delete[] (void *ptr)

void *	operator new (size_t size)

void *	operator new (size_t size, void *ptr)

void *	operator new[] (size_t size)

void *	operator new[] (size_t size, void *ptr)

Public Member Functions inherited from ReferenceCount
int	get_ref_count () const

WeakReferenceList *	get_weak_list () const
	Returns the WeakReferenceList associated with this ReferenceCount object.

bool	has_weak_list () const
	Returns true if this particular ReferenceCount object has a WeakReferenceList created, false otherwise.

void	local_object ()
	This function should be called, once, immediately after creating a new instance of some ReferenceCount-derived object on the stack.

void	ref () const
	Explicitly increments the reference count.

bool	ref_if_nonzero () const
	Atomically increases the reference count of this object if it is not zero.

bool	test_ref_count_integrity () const
	Does some easy checks to make sure that the reference count isn't completely bogus.

bool	test_ref_count_nonzero () const
	Does some easy checks to make sure that the reference count isn't zero, or completely bogus.

virtual bool	unref () const
	Explicitly decrements the reference count.

bool	unref_if_one () const
	Atomically decreases the reference count of this object if it is one.

WeakReferenceList *	weak_ref ()
	Adds the indicated PointerToVoid as a weak reference to this object.

void	weak_unref ()
	Removes the indicated PointerToVoid as a weak reference to this object.

Static Public Member Functions
static TypeHandle	get_class_type ()

static void	init_type ()

static ConstPointerTo< RenderEffect >	make (const LVector3 &up_vector, bool eye_relative, bool axial_rotate, PN_stdfloat offset, const NodePath &look_at, const LPoint3 &look_at_point, bool fixed_depth=false)
	Constructs a new BillboardEffect object with the indicated properties.

static ConstPointerTo< RenderEffect >	make_axis ()

static ConstPointerTo< RenderEffect >	make_point_eye ()

static ConstPointerTo< RenderEffect >	make_point_world ()

static void	register_with_read_factory ()
	Tells the BamReader how to create objects of type BillboardEffect.

Static Public Member Functions inherited from RenderEffect
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.

static TypeHandle	get_class_type ()

static int	get_num_effects ()
	Returns the total number of unique RenderEffect objects allocated in the world.

static void	init_type ()

static void	list_effects (std::ostream &out)
	Lists all of the RenderEffects in the cache to the output stream, one per line.

static bool	validate_effects ()
	Ensures that the cache is still stored in sorted order.

Static Public Member Functions inherited from TypedWritableReferenceCount
static TypeHandle	get_class_type ()

static void	init_type ()

static	PT (TypedWritableReferenceCount) decode_from_bam_stream(vector_uchar data

Static Public Member Functions inherited from TypedWritable
static bool	decode_raw_from_bam_stream (TypedWritable &ptr, ReferenceCount &ref_ptr, vector_uchar data, BamReader *reader=nullptr)
	Reads the bytes created by a previous call to encode_to_bam_stream(), and extracts the single object on those bytes.

static TypeHandle	get_class_type ()

static void	init_type ()

Static Public Member Functions inherited from TypedObject
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.

Static Public Member Functions inherited from ReferenceCount
static TypeHandle	get_class_type ()

static void	init_type ()

Additional Inherited Members
Public Attributes inherited from TypedWritableReferenceCount
static BamReader *	reader = nullptr)

Public Attributes inherited from TypedObject
	get_type

Public Attributes inherited from ReferenceCount
	get_ref_count
	Returns the current reference count.

Static Public Attributes inherited from TypedWritable
static TypedWritable *const	Null = nullptr

Detailed Description

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

Definition at line 27 of file billboardEffect.h.

Member Function Documentation

◆ adjust_transform()

void BillboardEffect::adjust_transform	(	ConstPointerTo< TransformState > &	net_transform,
		ConstPointerTo< TransformState > &	node_transform,
		const PandaNode *	node ) const

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 167 of file billboardEffect.cxx.

◆ complete_pointers()

int BillboardEffect::complete_pointers	(	TypedWritable **	p_list,
		BamReader *	manager )

virtual

Receives an array of pointers, one for each time manager->read_pointer() was called in fillin().

Returns the number of pointers processed.

Reimplemented from TypedWritable.

Definition at line 332 of file billboardEffect.cxx.

References TypedWritable::complete_pointers(), and BamReader::get_file_minor_ver().

◆ cull_callback()

void BillboardEffect::cull_callback	(	CullTraverser *	trav,
		CullTraverserData &	data,
		ConstPointerTo< TransformState > &	node_transform,
		ConstPointerTo< RenderState > &	node_state ) const

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 123 of file billboardEffect.cxx.

References CullTraverser::get_camera_transform().

◆ force_init_type()

virtual TypeHandle BillboardEffect::force_init_type ( )

inlinevirtual

Reimplemented from RenderEffect.

Definition at line 107 of file billboardEffect.h.

◆ get_axial_rotate()

bool BillboardEffect::get_axial_rotate ( ) const

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 84 of file billboardEffect.I.

◆ get_class_type()

static TypeHandle BillboardEffect::get_class_type ( )

inlinestatic

Definition at line 96 of file billboardEffect.h.

◆ get_eye_relative()

bool BillboardEffect::get_eye_relative ( ) const

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 75 of file billboardEffect.I.

◆ get_fixed_depth()

bool BillboardEffect::get_fixed_depth ( ) const

inline

Returns true if this billboard always appears at a fixed distance from the camera.

Definition at line 93 of file billboardEffect.I.

◆ get_look_at()

const NodePath & BillboardEffect::get_look_at ( ) const

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 113 of file billboardEffect.I.

◆ get_look_at_point()

const LPoint3 & BillboardEffect::get_look_at_point ( ) const

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 122 of file billboardEffect.I.

◆ get_offset()

PN_stdfloat BillboardEffect::get_offset ( ) const

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 103 of file billboardEffect.I.

◆ get_type()

virtual TypeHandle BillboardEffect::get_type ( ) const

inlinevirtual

Reimplemented from RenderEffect.

Definition at line 104 of file billboardEffect.h.

◆ get_up_vector()

const LVector3 & BillboardEffect::get_up_vector ( ) const

inline

Returns the up vector in effect for this billboard.

Definition at line 66 of file billboardEffect.I.

◆ has_adjust_transform()

bool BillboardEffect::has_adjust_transform ( ) const

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 151 of file billboardEffect.cxx.

◆ has_cull_callback()

bool BillboardEffect::has_cull_callback ( ) const

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 106 of file billboardEffect.cxx.

◆ init_type()

static void BillboardEffect::init_type ( )

inlinestatic

Definition at line 99 of file billboardEffect.h.

◆ is_off()

bool BillboardEffect::is_off ( ) const

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 58 of file billboardEffect.I.

◆ make()

ConstPointerTo< RenderEffect > BillboardEffect::make	(	const LVector3 &	up_vector,
		bool	eye_relative,
		bool	axial_rotate,
		PN_stdfloat	offset,
		const NodePath &	look_at,
		const LPoint3 &	look_at_point,
		bool	fixed_depth = false )

static

Constructs a new BillboardEffect object with the indicated properties.

Definition at line 29 of file billboardEffect.cxx.

Referenced by CPT(), NodePath::set_billboard_axis(), NodePath::set_billboard_point_eye(), and NodePath::set_billboard_point_world().

◆ output()

void BillboardEffect::output ( std::ostream & out ) const

virtual

Reimplemented from RenderEffect.

Definition at line 69 of file billboardEffect.cxx.

◆ prepare_flatten_transform()

ConstPointerTo< TransformState > BillboardEffect::prepare_flatten_transform ( const TransformState * net_transform ) const

virtual

Preprocesses the accumulated transform that is about to be applied to (or through) this node due to a flatten operation.

The returned value will be used instead.

Reimplemented from RenderEffect.

Definition at line 59 of file billboardEffect.cxx.

◆ register_with_read_factory()

void BillboardEffect::register_with_read_factory ( )

static

Tells the BamReader how to create objects of type BillboardEffect.

Definition at line 302 of file billboardEffect.cxx.

References BamReader::get_factory(), and Factory< Type >::register_factory().

Referenced by init_libpgraph().

◆ safe_to_transform()

bool BillboardEffect::safe_to_transform ( ) const

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 49 of file billboardEffect.cxx.

◆ write_datagram()

void BillboardEffect::write_datagram	(	BamWriter *	manager,
		Datagram &	dg )

virtual

Writes the contents of this object to the datagram for shipping out to a Bam file.

Reimplemented from RenderEffect.

Definition at line 311 of file billboardEffect.cxx.

References Datagram::add_bool(), Datagram::add_stdfloat(), BamWriter::get_file_minor_ver(), and RenderEffect::write_datagram().

The documentation for this class was generated from the following files:

panda/src/pgraph/billboardEffect.h
panda/src/pgraph/billboardEffect.cxx
panda/src/pgraph/billboardEffect.I

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ adjust_transform()

◆ complete_pointers()

◆ cull_callback()

◆ force_init_type()

◆ get_axial_rotate()

◆ get_class_type()

◆ get_eye_relative()

◆ get_fixed_depth()

◆ get_look_at()

◆ get_look_at_point()

◆ get_offset()

◆ get_type()

◆ get_up_vector()

◆ has_adjust_transform()

◆ has_cull_callback()

◆ init_type()

◆ is_off()

◆ make()

◆ output()

◆ prepare_flatten_transform()

◆ register_with_read_factory()

◆ safe_to_transform()

◆ write_datagram()