This is an abstract base class for several different kinds of graphs that have a few things in common, like labels and guide bars. More...

#include "pStatGraph.h"

Inheritance diagram for PStatGraph:

Classes
class	GuideBar

Public Types
enum	GuideBarStyle { GBS_normal, GBS_target, GBS_user }

enum	GuideBarUnits { GBU_hz = 0x0001, GBU_ms = 0x0002, GBU_named = 0x0004, GBU_show_units = 0x0008 }

Public Member Functions
	PStatGraph (PStatMonitor *monitor, int xsize, int ysize)

int	add_user_guide_bar (double height)
	Creates a new user guide bar and returns its index number. More...

int	find_user_guide_bar (double from_height, double to_height) const
	Returns the index number of the first user guide bar found whose height is within the indicated range, or -1 if no user guide bars fall within the range. More...

const GuideBar &	get_guide_bar (int n) const
	Returns the nth horizontal guide bar. More...

const std::string &	get_guide_bar_unit_name () const
	Returns the name of the units to be used for the guide bars if the units type is set to GBU_named \| GBU_show_units. More...

int	get_guide_bar_units () const
	Returns the units that are displayed for the guide bar labels. More...

int	get_label_collector (int n) const
	Returns the collector index associated with the nth label. More...

LRGBColor	get_label_color (int n) const
	Returns the color associated with the nth label. More...

std::string	get_label_name (int n) const
	Returns the text associated with the nth label. More...

PStatMonitor *	get_monitor () const
	Returns the monitor associated with this chart. More...

int	get_num_guide_bars () const
	Returns the number of horizontal guide bars that should be drawn, based on the indicated target frame rate. More...

int	get_num_labels () const
	Returns the number of labels to be drawn for this chart. More...

int	get_num_user_guide_bars () const
	Returns the current number of user-defined guide bars. More...

double	get_target_frame_rate () const
	Returns the indicated target frame rate in Hz. More...

GuideBar	get_user_guide_bar (int n) const
	Returns the nth user-defined guide bar. More...

int	get_xsize () const
	Returns the width of the chart in pixels. More...

int	get_ysize () const
	Returns the height of the chart in pixels. More...

void	move_user_guide_bar (int n, double height)
	Adjusts the height of the nth user-defined guide bar. More...

void	remove_user_guide_bar (int n)
	Removes the user guide bar with the indicated index number. More...

void	set_guide_bar_unit_name (const std::string &unit_name)
	Sets the name of the units to be used for the guide bars if the units type is set to GBU_named \| GBU_show_units. More...

void	set_guide_bar_units (int unit_mask)
	Sets the units that are displayed for the guide bar labels. More...

void	set_target_frame_rate (double frame_rate)
	Sets the target frame rate of the application in Hz. More...

Static Public Member Functions
static std::string	format_number (double value)
	Returns a string representing the value nicely formatted for its range. More...

static std::string	format_number (double value, int guide_bar_units, const std::string &unit_name=std::string())
	Returns a string representing the value nicely formatted for its range, including the units as indicated. More...

Detailed Description

This is an abstract base class for several different kinds of graphs that have a few things in common, like labels and guide bars.

Definition at line 33 of file pStatGraph.h.

Member Function Documentation

◆ add_user_guide_bar()

int PStatGraph::add_user_guide_bar ( double height )

Creates a new user guide bar and returns its index number.

Definition at line 125 of file pStatGraph.cxx.

◆ find_user_guide_bar()

int PStatGraph::find_user_guide_bar	(	double	from_height,
		double	to_height
	)		const

Returns the index number of the first user guide bar found whose height is within the indicated range, or -1 if no user guide bars fall within the range.

Definition at line 144 of file pStatGraph.cxx.

◆ format_number() [1/2]

string PStatGraph::format_number ( double value )

static

Returns a string representing the value nicely formatted for its range.

Definition at line 153 of file pStatGraph.cxx.

Referenced by format_number().

◆ format_number() [2/2]

string PStatGraph::format_number	(	double	value,
		int	guide_bar_units,
		const std::string &	unit_name = `std::string()`
	)

static

Returns a string representing the value nicely formatted for its range, including the units as indicated.

Definition at line 176 of file pStatGraph.cxx.

References format_number().

◆ get_guide_bar()

const PStatGraph::GuideBar & PStatGraph::get_guide_bar ( int n ) const

Returns the nth horizontal guide bar.

This should be drawn as a horizontal line across the chart at the y pixel location determined by height_to_pixel(bar._height).

It is possible that this bar will be off the top of the chart.

Definition at line 87 of file pStatGraph.cxx.

◆ get_guide_bar_unit_name()

const std::string & PStatGraph::get_guide_bar_unit_name ( ) const

inline

Returns the name of the units to be used for the guide bars if the units type is set to GBU_named | GBU_show_units.

Definition at line 129 of file pStatGraph.I.

◆ get_guide_bar_units()

int PStatGraph::get_guide_bar_units ( ) const

inline

Returns the units that are displayed for the guide bar labels.

This may be a union of one or more members of the GuideBarUnits enum.

Definition at line 111 of file pStatGraph.I.

Referenced by WinStatsStripChart::set_time_units().

◆ get_label_collector()

int PStatGraph::get_label_collector ( int n ) const

inline

Returns the collector index associated with the nth label.

Definition at line 34 of file pStatGraph.I.

◆ get_label_color()

LRGBColor PStatGraph::get_label_color ( int n ) const

inline

Returns the color associated with the nth label.

Definition at line 52 of file pStatGraph.I.

◆ get_label_name()

std::string PStatGraph::get_label_name ( int n ) const

inline

Returns the text associated with the nth label.

Definition at line 43 of file pStatGraph.I.

◆ get_monitor()

PStatMonitor * PStatGraph::get_monitor ( ) const

inline

Returns the monitor associated with this chart.

Definition at line 18 of file pStatGraph.I.

Referenced by PStatStripChart::update().

◆ get_num_guide_bars()

int PStatGraph::get_num_guide_bars ( ) const

Returns the number of horizontal guide bars that should be drawn, based on the indicated target frame rate.

Not all of these may be visible; some may be off the top of the chart because of the vertical scale.

Definition at line 75 of file pStatGraph.cxx.

◆ get_num_labels()

int PStatGraph::get_num_labels ( ) const

inline

Returns the number of labels to be drawn for this chart.

Definition at line 26 of file pStatGraph.I.

◆ get_num_user_guide_bars()

int PStatGraph::get_num_user_guide_bars ( ) const

Returns the current number of user-defined guide bars.

Not all of these may be visible.

Definition at line 100 of file pStatGraph.cxx.

◆ get_target_frame_rate()

double PStatGraph::get_target_frame_rate ( ) const

inline

Returns the indicated target frame rate in Hz.

See set_target_frame_rate().

Definition at line 74 of file pStatGraph.I.

Referenced by PStatStripChart::set_default_vertical_scale().

◆ get_user_guide_bar()

PStatGraph::GuideBar PStatGraph::get_user_guide_bar ( int n ) const

Returns the nth user-defined guide bar.

Definition at line 108 of file pStatGraph.cxx.

◆ get_xsize()

int PStatGraph::get_xsize ( ) const

inline

Returns the width of the chart in pixels.

Definition at line 82 of file pStatGraph.I.

Referenced by PStatStripChart::pixel_to_timestamp(), and PStatStripChart::timestamp_to_pixel().

◆ get_ysize()

int PStatGraph::get_ysize ( ) const

inline

Returns the height of the chart in pixels.

Definition at line 90 of file pStatGraph.I.

Referenced by PStatStripChart::height_to_pixel(), and PStatStripChart::pixel_to_height().

◆ move_user_guide_bar()

void PStatGraph::move_user_guide_bar	(	int	n,
		double	height
	)

Adjusts the height of the nth user-defined guide bar.

Definition at line 117 of file pStatGraph.cxx.

◆ remove_user_guide_bar()

void PStatGraph::remove_user_guide_bar ( int n )

Removes the user guide bar with the indicated index number.

All subsequent index numbers are adjusted down one.

Definition at line 134 of file pStatGraph.cxx.

◆ set_guide_bar_unit_name()

void PStatGraph::set_guide_bar_unit_name ( const std::string & unit_name )

inline

Sets the name of the units to be used for the guide bars if the units type is set to GBU_named | GBU_show_units.

Definition at line 120 of file pStatGraph.I.

◆ set_guide_bar_units()

void PStatGraph::set_guide_bar_units ( int guide_bar_units )

inline

Sets the units that are displayed for the guide bar labels.

This may be a union of one or more members of the GuideBarUnits enum.

Definition at line 99 of file pStatGraph.I.

Referenced by WinStatsStripChart::set_time_units().

◆ set_target_frame_rate()

void PStatGraph::set_target_frame_rate ( double frame_rate )

inline

Sets the target frame rate of the application in Hz.

This only affects the choice of initial scale and the placement of guide bars.

Definition at line 62 of file pStatGraph.I.

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

pandatool/src/pstatserver/pStatGraph.h
pandatool/src/pstatserver/pStatGraph.cxx
pandatool/src/pstatserver/pStatGraph.I

Classes

Public Types

Public Member Functions

Static Public Member Functions

Detailed Description

Member Function Documentation

◆ add_user_guide_bar()

◆ find_user_guide_bar()

◆ format_number() [1/2]

◆ format_number() [2/2]

◆ get_guide_bar()

◆ get_guide_bar_unit_name()

◆ get_guide_bar_units()

◆ get_label_collector()

◆ get_label_color()

◆ get_label_name()

◆ get_monitor()

◆ get_num_guide_bars()

◆ get_num_labels()

◆ get_num_user_guide_bars()

◆ get_target_frame_rate()

◆ get_user_guide_bar()

◆ get_xsize()

◆ get_ysize()

◆ move_user_guide_bar()

◆ remove_user_guide_bar()

◆ set_guide_bar_unit_name()

◆ set_guide_bar_units()

◆ set_target_frame_rate()