ColorSymbolPointRep Class Reference

#include <ColorSymbolPointRep.h>

Inheritance diagram for ColorSymbolPointRep:

[legend]Collaboration diagram for ColorSymbolPointRep:

[legend]List of all members.

Detailed Description

A PointRep class draws a symbol to represent the coordinate in a color that represents the value.

Todo:: Unlike the class it inherits from, this class doesn't currently support the drawing of error bars.

Or, maybe a class that can draw error bars should be a derived class of one that only draws symbols.

Author:: Paul F. Kunz <Paul_Kunz@slac.stanford.edu>

Definition at line 31 of file ColorSymbolPointRep.h.

Public Member Functions

virtual RepBase * clone ()

The clone function returns an object of its own kind which is a copy of this object at this moment.

virtual const Color & color () const

Returns the representation's color.

ColorSymbolPointRep (const ColorSymbolPointRep &point_rep)

The copy constructor.

ColorSymbolPointRep ()

The default constructor.

ColorSymbolPointRep (hippodraw::Symbol::Type symbol, float size)

The following constructor takes the symbol and size as arguments.

virtual void displayError (ViewBase &view)

Display an error message.

virtual void drawProjectedValues (const DataSource *ntuple, TransformBase *transform, ViewBase *view)

virtual const Color & getColor () const

Get the color of the representation.

virtual unsigned int getStyle () const

Returns the style of the point symbol.

virtual const BinToColor * getValueTransform () const

Returns the value transform.

virtual bool isSelected () const

Returns true if representation is in selected state, otherwise returns false.

const std::string & name () const

Returns the name of the representation.

virtual void setColor (const Color &color)

Sets the color of the representation.

virtual void setErrorOn (const std::string &axis, bool yes=true)

Sets the display of the error bar.

virtual void setHighLighted (bool yes)

Sets the highlighted state of the point representation.

virtual void setSelected (bool yes)

Sets the selection state of the representation.

void setSize (float value)

Sets the size of the representation.

virtual void setStyle (unsigned int symbol)

Sets the symbol of the representation.

void setText (const std::string &text)

Sets the text.

virtual void setValueTransform (BinToColor *)

Sets the value transform.

float size () const

Returns the size of the representation.

virtual void transformPoints (const TransformBase &transform, ViewBase &view)

Transforms the cached coordinates using transform.

virtual bool xError () const

Returns true if the point representation displays error on the X axis.

virtual bool yError () const

Returns true if the point representation displays error on the Y axis.

~ColorSymbolPointRep ()

The destructor.

Protected Member Functions

void beginPlot (unsigned int size, const BinaryTransform *tf, const ViewBase *view)

Sets the value of cached data members.

bool drawProjectedValue (unsigned int i, const DataSource *ntuple, const BinaryTransform *transform, ViewBase *view)

Draws a projected value.

Protected Attributes

Color m_color

The color of the representation.

bool m_desel

A flag to indicate the representation is de-selected.

ErrorBarRep * m_error_rep

The error bar representation.

bool m_highlite

Sets the state of highlighting.

std::string m_name

The name of the representation.

hippodraw::Symbol::Type m_plot_symbol

The PlotSymbol currently used.

float m_size

The size of the representation.

std::string m_text

The text to be displayed before the statistics.

std::vector< double > m_x

A cache of the points to be drawn on the X axis.

bool m_x_flag

The x error flag.

std::vector< double > m_y

A cache of the points to be drawn on the Y axis.

bool m_y_flag

The y error flag.

Static Protected Attributes

static const Color s_desel_color

The color of the representation when it is de-selected.

Private Attributes

BinToColor * m_color_gen

The color scale generator.

std::vector< Color > m_colors

A cache of the colors to be used.

Constructor & Destructor Documentation

ColorSymbolPointRep::ColorSymbolPointRep ( hippodraw::Symbol::Type symbol,

float size

)

The following constructor takes the symbol and size as arguments.

Definition at line 34 of file ColorSymbolPointRep.cxx.
References BinToColorFactory::instance(), m_color_gen, and RepBase::m_name.

ColorSymbolPointRep::ColorSymbolPointRep ( )

The default constructor.

Definition at line 42 of file ColorSymbolPointRep.cxx.
References BinToColorFactory::instance(), m_color_gen, and RepBase::m_name.
Referenced by clone().

ColorSymbolPointRep::ColorSymbolPointRep ( const ColorSymbolPointRep & point_rep )

The copy constructor.

Definition at line 50 of file ColorSymbolPointRep.cxx.

ColorSymbolPointRep::~ColorSymbolPointRep ( )

The destructor.

Definition at line 56 of file ColorSymbolPointRep.cxx.

Member Function Documentation

void SymbolPointRep::beginPlot ( unsigned int size,

const BinaryTransform * tf,

const ViewBase * view

) [protected, inherited]

Sets the value of cached data members.
This member function should be called before any projected values are transformed.
Definition at line 209 of file SymbolPointRep.cxx.
References SymbolPointRep::c_beta, SymbolPointRep::c_gamma, SymbolPointRep::c_periodic_tf, SymbolPointRep::c_x_range, SymbolPointRep::c_y_range, SymbolPointRep::m_x, SymbolPointRep::m_y, hippodraw::Axes::X, and hippodraw::Axes::Y.
Referenced by SymbolPointRep::drawProjectedValues(), and drawProjectedValues().

RepBase * ColorSymbolPointRep::clone ( ) [virtual]

The clone function returns an object of its own kind which is a copy of this object at this moment.

Reimplemented from SymbolPointRep.
Definition at line 60 of file ColorSymbolPointRep.cxx.
References ColorSymbolPointRep().

const Color & RepBase::color ( ) const [virtual, inherited]

Returns the representation's color.

Todo:
Remove this member in favor of getColor().

Definition at line 61 of file RepBase.cxx.
References RepBase::m_color, RepBase::m_desel, and RepBase::s_desel_color.
Referenced by ContourPointRep::createContours(), SymbolPointRep::drawProjectedValues(), LinePointRep::drawProjectedValues(), ErrorBarRep::drawProjectedValues(), ColumnPointRep::drawProjectedValues(), drawProjectedValues(), ColorBoxPointRep::drawProjectedValues(), and DataRep::getRepColor().

void RepBase::displayError ( ViewBase & view ) [virtual, inherited]

Display an error message.
Display an error message instead of drawing a point. This base class implementation displays a message with the name of the RepBase object.
Definition at line 153 of file RepBase.cxx.
References ViewBase::drawText(), RepBase::m_name, and RepBase::m_size.

bool SymbolPointRep::drawProjectedValue ( unsigned int i,

const DataSource * ntuple,

const BinaryTransform * transform,

ViewBase * view

) [protected, inherited]

Draws a projected value.
Draws the projected value index by index if the coordinate is within range. Returns true if the point is drawn, otherwise returns false.

Attention:
The member function beginPlot must be called before a call this member function.

Definition at line 231 of file SymbolPointRep.cxx.
References SymbolPointRep::c_beta, SymbolPointRep::c_gamma, SymbolPointRep::c_periodic_tf, Range::includes(), SymbolPointRep::m_x, SymbolPointRep::m_y, SymbolPointRep::rotate(), hippodraw::Axes::X, and hippodraw::Axes::Y.
Referenced by SymbolPointRep::drawProjectedValues(), and drawProjectedValues().

void ColorSymbolPointRep::drawProjectedValues ( const DataSource * ntuple,

TransformBase * transform,

ViewBase * view

) [virtual]

Todo:
Should transform be const in this method.

Reimplemented from SymbolPointRep.
Definition at line 84 of file ColorSymbolPointRep.cxx.
References SymbolPointRep::beginPlot(), RepBase::color(), SymbolPointRep::drawProjectedValue(), Range::high(), Range::includes(), Range::low(), m_color_gen, m_colors, SymbolPointRep::m_plot_symbol, RepBase::m_size, SymbolPointRep::m_x, SymbolPointRep::m_y, Range::pos(), BinToColor::setRange(), RepBase::size(), and hippodraw::Axes::Z.

const Color & RepBase::getColor ( ) const [virtual, inherited]

Get the color of the representation.

Definition at line 56 of file RepBase.cxx.
References RepBase::m_color.
Referenced by PointRepXML::createElement().

unsigned int SymbolPointRep::getStyle ( ) const [virtual, inherited]

Returns the style of the point symbol.

Reimplemented from RepBase.
Definition at line 89 of file SymbolPointRep.cxx.
References SymbolPointRep::m_plot_symbol.

const BinToColor * ColorSymbolPointRep::getValueTransform ( ) const [virtual]

Returns the value transform.
A value transform changes a binary value to some graphical representations such as color. The implementation in this base class returns a null pointer. Derived classes that implement value transform should return a pointer to the object it uses.
Reimplemented from RepBase.
Definition at line 67 of file ColorSymbolPointRep.cxx.
References m_color_gen.

bool RepBase::isSelected ( ) const [virtual, inherited]

Returns true if representation is in selected state, otherwise returns false.

Definition at line 77 of file RepBase.cxx.
References RepBase::m_desel.
Referenced by DataRep::isSelected().

const string & RepBase::name ( ) const [inherited]

Returns the name of the representation.
This name might be used by a Factory.
Definition at line 45 of file RepBase.cxx.
References RepBase::m_name.
Referenced by FuncParmRep::drawProjectedValues(), PointRepXML::setAttributes(), QtDisplay::setContourLevels(), and Inspector::updatePlotTab().

void SymbolPointRep::setColor ( const Color & color ) [virtual, inherited]

Sets the color of the representation.

Reimplemented from RepBase.
Definition at line 73 of file SymbolPointRep.cxx.
References PointRepBase::m_error_rep, and RepBase::setColor().

void SymbolPointRep::setErrorOn ( const std::string & axis,

bool yes = true

) [virtual, inherited]

Sets the display of the error bar.
Sets the display of the error bar on the specified axis to on or off.
Reimplemented from RepBase.
Definition at line 96 of file SymbolPointRep.cxx.
References PointRepBase::m_error_rep, SymbolPointRep::m_x_flag, SymbolPointRep::m_y_flag, ErrorBarRep::setXError(), and ErrorBarRep::setYError().

void RepBase::setHighLighted ( bool yes ) [virtual, inherited]

Sets the highlighted state of the point representation.
If yes is true, then the point representation should show the non highlighted regions in some fashion, typically using light gray color instead of its normal color.
See also:
setSelected (bool)
m_ranges.

Definition at line 84 of file RepBase.cxx.
References RepBase::m_highlite.

void PointRepBase::setSelected ( bool yes ) [virtual, inherited]

Sets the selection state of the representation.
Also sets the selection state of the ErrorBarRep representation, if any. If yes is false, the point representation should shows its deselected stated by some fashion, typically using a light gray color instead of its normal color.
Reimplemented from RepBase.
Definition at line 36 of file PointRepBase.cxx.
References PointRepBase::m_error_rep, and RepBase::setSelected().

void RepBase::setSize ( float value ) [inherited]

Sets the size of the representation.

Definition at line 94 of file RepBase.cxx.
References RepBase::m_size.
Referenced by PointRepXML::createObject(), FunctionRep::FunctionRep(), and DataRep::setRepSize().

void SymbolPointRep::setStyle ( unsigned int symbol ) [virtual, inherited]

Sets the symbol of the representation.
Derived classes may use this method to set the style of the representation, if they have various styles. This base class implementation does nothing.
Reimplemented from RepBase.
Definition at line 82 of file SymbolPointRep.cxx.
References hippodraw::Axes::convert(), and SymbolPointRep::m_plot_symbol.

void RepBase::setText ( const std::string & text ) [inherited]

Sets the text.

Definition at line 132 of file RepBase.cxx.
References RepBase::m_text.
Referenced by DisplayController::createTextDataRep().

void ColorSymbolPointRep::setValueTransform ( BinToColor * ) [virtual]

Sets the value transform.
The implementation in this base class does nothing. Derived classes that implement a value transform should override this method and take possession of the received object.

Todo:
Should have base class that doesn't know about color and BinToColor class should derive from it.

Reimplemented from RepBase.
Definition at line 74 of file ColorSymbolPointRep.cxx.
References m_color_gen.

float RepBase::size ( ) const [inherited]

Returns the size of the representation.

Definition at line 89 of file RepBase.cxx.
References RepBase::m_size.
Referenced by ContourPointRep::createContours(), ContourPointRep::drawContourTicks(), SymbolPointRep::drawProjectedValues(), LinePointRep::drawProjectedValues(), ErrorBarRep::drawProjectedValues(), ContourPointRep::drawProjectedValues(), ColumnPointRep::drawProjectedValues(), drawProjectedValues(), ColorBoxPointRep::drawProjectedValues(), DisplayController::pointSize(), and PointRepXML::setAttributes().

void SymbolPointRep::transformPoints ( const TransformBase & transform,

ViewBase & view

) [virtual, inherited]

Transforms the cached coordinates using transform.

Definition at line 118 of file SymbolPointRep.cxx.
References SymbolPointRep::m_x, SymbolPointRep::m_y, and BinaryTransform::transform().

bool SymbolPointRep::xError ( ) const [virtual, inherited]

Returns true if the point representation displays error on the X axis.
The default implementation returns false. May be overridden by derived classes.
Reimplemented from RepBase.
Definition at line 108 of file SymbolPointRep.cxx.
References SymbolPointRep::m_x_flag.

bool SymbolPointRep::yError ( ) const [virtual, inherited]

Returns true if the point representation displays error on the Y axis.
The default implementation returns false. May be overridden by derived classes.
Reimplemented from RepBase.
Definition at line 113 of file SymbolPointRep.cxx.
References SymbolPointRep::m_y_flag.

Member Data Documentation

Color RepBase::m_color [protected, inherited]

The color of the representation.

Definition at line 55 of file RepBase.h.
Referenced by RepBase::color(), CutRangeRep::drawInvertedRange1D(), CutRangeRep::drawInvertedRange2D(), CutRangeRep::drawNormalRange(), RepBase::getColor(), and RepBase::setColor().

BinToColor* ColorSymbolPointRep::m_color_gen [private]

The color scale generator.

Definition at line 40 of file ColorSymbolPointRep.h.
Referenced by ColorSymbolPointRep(), drawProjectedValues(), getValueTransform(), and setValueTransform().

std::vector< Color > ColorSymbolPointRep::m_colors [private]

A cache of the colors to be used.

Definition at line 37 of file ColorSymbolPointRep.h.
Referenced by drawProjectedValues().

bool RepBase::m_desel [protected, inherited]

A flag to indicate the representation is de-selected.

Definition at line 64 of file RepBase.h.
Referenced by RepBase::color(), CutRangeRep::drawInvertedRange1D(), CutRangeRep::drawInvertedRange2D(), CutRangeRep::drawNormalRange(), ColorBoxPointRep::drawProjectedValues(), RepBase::isSelected(), and RepBase::setSelected().

ErrorBarRep* PointRepBase::m_error_rep [protected, inherited]

The error bar representation.
Will be a null pointer if a derived class doesn't have one.
Definition at line 42 of file PointRepBase.h.
Referenced by ColumnPointRep::ColumnPointRep(), SymbolPointRep::drawProjectedValues(), ColumnPointRep::drawProjectedValues(), SymbolPointRep::setColor(), ColumnPointRep::setColor(), SymbolPointRep::setErrorOn(), ColumnPointRep::setErrorOn(), PointRepBase::setSelected(), SymbolPointRep::SymbolPointRep(), ColumnPointRep::~ColumnPointRep(), and SymbolPointRep::~SymbolPointRep().

bool RepBase::m_highlite [protected, inherited]

Sets the state of highlighting.

Definition at line 68 of file RepBase.h.
Referenced by RepBase::setHighLighted().

std::string RepBase::m_name [protected, inherited]

The name of the representation.

Definition at line 49 of file RepBase.h.
Referenced by AverageTextRep::AverageTextRep(), ColorSymbolPointRep(), RepBase::displayError(), ContourPointRep::init(), and RepBase::name().

hippodraw::Symbol::Type SymbolPointRep::m_plot_symbol [protected, inherited]

The PlotSymbol currently used.

Definition at line 99 of file SymbolPointRep.h.
Referenced by SymbolPointRep::drawProjectedValues(), drawProjectedValues(), SymbolPointRep::getStyle(), and SymbolPointRep::setStyle().

std::string RepBase::m_text [protected, inherited]

The text to be displayed before the statistics.

Definition at line 52 of file RepBase.h.
Referenced by BoxTextRep::drawProjectedValues(), and RepBase::setText().

std::vector< double > SymbolPointRep::m_x [protected, inherited]

A cache of the points to be drawn on the X axis.
A cache is used so that all the points are delivered to the View with one call. The cache is cleared with a call to beginPlot. However, X and Y caches are separate so that they can be transformed independently.
Definition at line 56 of file SymbolPointRep.h.
Referenced by SymbolPointRep::beginPlot(), SymbolPointRep::drawProjectedValue(), SymbolPointRep::drawProjectedValues(), drawProjectedValues(), and SymbolPointRep::transformPoints().

bool SymbolPointRep::m_x_flag [protected, inherited]

The x error flag.
If set true, error bars along the X axis are generated.
Definition at line 63 of file SymbolPointRep.h.
Referenced by SymbolPointRep::drawProjectedValues(), SymbolPointRep::setErrorOn(), and SymbolPointRep::xError().

std::vector< double > SymbolPointRep::m_y [protected, inherited]

A cache of the points to be drawn on the Y axis.

See also:
m_x

Definition at line 59 of file SymbolPointRep.h.
Referenced by SymbolPointRep::beginPlot(), SymbolPointRep::drawProjectedValue(), SymbolPointRep::drawProjectedValues(), drawProjectedValues(), and SymbolPointRep::transformPoints().

bool SymbolPointRep::m_y_flag [protected, inherited]

The y error flag.
If set true, error bars along the Y axis are generated.
Definition at line 67 of file SymbolPointRep.h.
Referenced by SymbolPointRep::drawProjectedValues(), SymbolPointRep::setErrorOn(), and SymbolPointRep::yError().

const Color RepBase::s_desel_color [static, protected, inherited]

The color of the representation when it is de-selected.

Referenced by RepBase::color(), CutRangeRep::drawInvertedRange1D(), CutRangeRep::drawInvertedRange2D(), and CutRangeRep::drawNormalRange().

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

Generated for HippoDraw-1.14.8.5 by

1.4.3


Public Member Functions
virtual RepBase *	clone ()
	The clone function returns an object of its own kind which is a copy of this object at this moment.
virtual const Color &	color () const
	Returns the representation's color.
	ColorSymbolPointRep (const ColorSymbolPointRep &point_rep)
	The copy constructor.
	ColorSymbolPointRep ()
	The default constructor.
	ColorSymbolPointRep (hippodraw::Symbol::Type symbol, float size)
	The following constructor takes the symbol and size as arguments.
virtual void	displayError (ViewBase &view)
	Display an error message.
virtual void	drawProjectedValues (const DataSource ntuple, TransformBase transform, ViewBase *view)
virtual const Color &	getColor () const
	Get the color of the representation.
virtual unsigned int	getStyle () const
	Returns the style of the point symbol.
virtual const BinToColor *	getValueTransform () const
	Returns the value transform.
virtual bool	isSelected () const
	Returns `true` if representation is in selected state, otherwise returns `false`.
const std::string &	name () const
	Returns the name of the representation.
virtual void	setColor (const Color &color)
	Sets the color of the representation.
virtual void	setErrorOn (const std::string &axis, bool yes=true)
	Sets the display of the error bar.
virtual void	setHighLighted (bool yes)
	Sets the highlighted state of the point representation.
virtual void	setSelected (bool yes)
	Sets the selection state of the representation.
void	setSize (float value)
	Sets the size of the representation.
virtual void	setStyle (unsigned int symbol)
	Sets the symbol of the representation.
void	setText (const std::string &text)
	Sets the text.
virtual void	setValueTransform (BinToColor *)
	Sets the value transform.
float	size () const
	Returns the size of the representation.
virtual void	transformPoints (const TransformBase &transform, ViewBase &view)
	Transforms the cached coordinates using transform.
virtual bool	xError () const
	Returns true if the point representation displays error on the X axis.
virtual bool	yError () const
	Returns true if the point representation displays error on the Y axis.
	~ColorSymbolPointRep ()
	The destructor.
Protected Member Functions
void	beginPlot (unsigned int size, const BinaryTransform tf, const ViewBase view)
	Sets the value of cached data members.
bool	drawProjectedValue (unsigned int i, const DataSource ntuple, const BinaryTransform transform, ViewBase *view)
	Draws a projected value.
Protected Attributes
Color	m_color
	The color of the representation.
bool	m_desel
	A flag to indicate the representation is de-selected.
ErrorBarRep *	m_error_rep
	The error bar representation.
bool	m_highlite
	Sets the state of highlighting.
std::string	m_name
	The name of the representation.
hippodraw::Symbol::Type	m_plot_symbol
	The `PlotSymbol` currently used.
float	m_size
	The size of the representation.
std::string	m_text
	The text to be displayed before the statistics.
std::vector< double >	m_x
	A cache of the points to be drawn on the X axis.
bool	m_x_flag
	The x error flag.
std::vector< double >	m_y
	A cache of the points to be drawn on the Y axis.
bool	m_y_flag
	The y error flag.
Static Protected Attributes
static const Color	s_desel_color
	The color of the representation when it is de-selected.
Private Attributes
BinToColor *	m_color_gen
	The color scale generator.
std::vector< Color >	m_colors
	A cache of the colors to be used.