Records a set of button events that happened recently. More...

#include "buttonEventList.h"

Inheritance diagram for ButtonEventList:

Public Member Functions
	ButtonEventList (const ButtonEventList &copy)

void	add_event (ButtonEvent event)
	Adds a new event to the end of the list. More...

void	add_events (const ButtonEventList &other)
	Appends the events from the other list onto the end of this one. More...

void	clear ()
	Empties all the events from the list. More...

void	fillin (DatagramIterator &scan, BamReader *manager)
	This internal function is called by make_from_bam to read in all of the relevant data from the BamFile for the new ButtonEventList. More...

virtual TypeHandle	force_init_type ()

const ButtonEvent &	get_event (int n) const
	Returns the nth event in the list. More...

int	get_num_events () const
	Returns the number of events in the list. More...

virtual TypeHandle	get_type () const

void	operator= (const ButtonEventList &copy)

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

void	update_mods (ModifierButtons &mods) const
	Updates the indicated ModifierButtons object with all of the button up/down transitions indicated in the list. More...

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

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

Public Member Functions inherited from ParamValueBase
virtual TypeHandle	get_value_type () const
	Returns the type of the underlying value. More...

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

void	operator= (const TypedWritableReferenceCount &copy)

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

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

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

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

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

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

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

Public Member Functions inherited from ReferenceCount
int	get_ref_count () const

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	ref_if_nonzero () const
	Atomically increases the reference count of this object if it is not zero. 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...

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

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

Static Public Member Functions
static TypeHandle	get_class_type ()

static void	init_type ()

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

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

static void	init_type ()

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

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

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

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

Detailed Description

Records a set of button events that happened recently.

This class is usually used only in the data graph, to transmit the recent button presses, but it may be used anywhere a list of ButtonEvents is desired.

Definition at line 33 of file buttonEventList.h.

Member Function Documentation

◆ add_event()

void ButtonEventList::add_event ( ButtonEvent event )

inline

Adds a new event to the end of the list.

Definition at line 42 of file buttonEventList.I.

◆ add_events()

void ButtonEventList::add_events ( const ButtonEventList & other )

Appends the events from the other list onto the end of this one.

Definition at line 24 of file buttonEventList.cxx.

◆ clear()

void ButtonEventList::clear ( )

inline

Empties all the events from the list.

Definition at line 72 of file buttonEventList.I.

◆ fillin()

void ButtonEventList::fillin	(	DatagramIterator &	scan,
		BamReader *	manager
	)

virtual

This internal function is called by make_from_bam to read in all of the relevant data from the BamFile for the new ButtonEventList.

This function is normally protected, but it is declared public in this case so that MouseRecorder may call it to read a ButtonEventList from the middle of a datagram.

Reimplemented from TypedWritable.

Definition at line 125 of file buttonEventList.cxx.

References TypedWritable::fillin(), and DatagramIterator::get_uint16().

◆ get_event()

const ButtonEvent & ButtonEventList::get_event ( int n ) const

inline

Returns the nth event in the list.

This does not remove the event from the list; the only way to remove events is to empty the whole list with clear().

Definition at line 60 of file buttonEventList.I.

◆ get_num_events()

int ButtonEventList::get_num_events ( ) const

inline

Returns the number of events in the list.

Definition at line 50 of file buttonEventList.I.

◆ register_with_read_factory()

void ButtonEventList::register_with_read_factory ( )

static

Tells the BamReader how to create objects of type Lens.

Definition at line 80 of file buttonEventList.cxx.

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

◆ update_mods()

void ButtonEventList::update_mods ( ModifierButtons & mods ) const

Updates the indicated ModifierButtons object with all of the button up/down transitions indicated in the list.

Definition at line 37 of file buttonEventList.cxx.

◆ write_datagram()

void ButtonEventList::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 TypedWritable.

Definition at line 89 of file buttonEventList.cxx.

References Datagram::add_uint16(), and TypedWritable::write_datagram().

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

panda/src/event/buttonEventList.h
panda/src/event/buttonEventList.cxx
panda/src/event/buttonEventList.I

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ add_event()

◆ add_events()

◆ clear()

◆ fillin()

◆ get_event()

◆ get_num_events()

◆ register_with_read_factory()

◆ update_mods()

◆ write_datagram()