ColorBoxPointRep Class Reference

#include <ColorBoxPointRep.h>

Inheritance diagram for ColorBoxPointRep:

[legend]Collaboration diagram for ColorBoxPointRep:

[legend]List of all members.

Detailed Description

A PointRep class that draws a colored box to represent the value.

The following image was made with ColorBoxPointRep.

Plot with ColorBoxPointRep

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

Definition at line 29 of file ColorBoxPointRep.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.

ColorBoxPointRep (const ColorBoxPointRep &point_rep)

The copy constructor.

ColorBoxPointRep ()

The default constructor.

virtual void displayError (ViewBase &view)

Display an error message.

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

Draws the projected values.

virtual const Color & getColor () const

Get the color of the representation.

virtual unsigned int getStyle () const

Returns the style of the point representation.

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

Sets the color of the representation.

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

Sets the error representation on specified axis, if any, to yes.

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 style)

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

~ColorBoxPointRep ()

The destructor.

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.

float m_size

The size of the representation.

std::string m_text

The text to be displayed before the statistics.

Static Protected Attributes

static const Color s_desel_color

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

Private Attributes

BinToColor * m_bin_to_color

The following function transforms the projected value to a color scale.

bool m_need_background

Flag to indicated that background needs to be draw.

Constructor & Destructor Documentation

ColorBoxPointRep::ColorBoxPointRep ( )

The default constructor.

Definition at line 33 of file ColorBoxPointRep.cxx.
References BinToColorFactory::instance(), and m_bin_to_color.
Referenced by clone().

ColorBoxPointRep::ColorBoxPointRep ( const ColorBoxPointRep & point_rep )

The copy constructor.

Definition at line 40 of file ColorBoxPointRep.cxx.
References clone(), and m_bin_to_color.

ColorBoxPointRep::~ColorBoxPointRep ( )

The destructor.

Definition at line 48 of file ColorBoxPointRep.cxx.
References m_bin_to_color.

Member Function Documentation

RepBase * ColorBoxPointRep::clone ( ) [virtual]

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

Implements PointRepBase.
Definition at line 53 of file ColorBoxPointRep.cxx.
References ColorBoxPointRep().
Referenced by ColorBoxPointRep().

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(), ColorSymbolPointRep::drawProjectedValues(), 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.

void ColorBoxPointRep::drawProjectedValues ( const DataSource * ntuple,

TransformBase * transform,

ViewBase * view

) [virtual]

Draws the projected values.
Draws the projected values contained in the DataSource ntuple. Each row of the ntuple is data point tuple of some dimension. Derived classes expect the DataSoruce to be of the correct dimension. The drawn points undergo a transform represented by transform and are drawn to the view view. If highlighting is on, uses the ranges to control highlighting.
Implements RepBase.
Definition at line 77 of file ColorBoxPointRep.cxx.
References RepBase::color(), Color::getBlue(), Color::getGreen(), Color::getRed(), HippoRectangle::getZ(), Range::high(), HippoRectangle::isInDepth(), Range::low(), m_bin_to_color, RepBase::m_desel, HippoRectangle::makeInBounds(), BinToColor::setRange(), RepBase::size(), hippodraw::Axes::X, hippodraw::DataPoint2DTuple::XERR, hippodraw::Axes::Y, hippodraw::DataPoint2DTuple::YERR, 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 RepBase::getStyle ( ) const [virtual, inherited]

Returns the style of the point representation.
Derived class should override this member function if they support styles. This base class implementation returns 0.
Reimplemented in ColumnPointRep, LinePointRep, LinePointRep, and SymbolPointRep.
Definition at line 108 of file RepBase.cxx.
Referenced by PointRepXML::setAttributes().

const BinToColor * ColorBoxPointRep::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 60 of file ColorBoxPointRep.cxx.
References m_bin_to_color.

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 RepBase::setColor ( const Color & ) [virtual, inherited]

Sets the color of the representation.

Reimplemented in ColumnPointRep, and SymbolPointRep.
Definition at line 51 of file RepBase.cxx.
References RepBase::m_color.
Referenced by PointRepXML::createObject(), CutRangeRep::CutRangeRep(), FunctionRep::FunctionRep(), LineDataRep::LineDataRep(), SymbolPointRep::setColor(), ColumnPointRep::setColor(), and DataRep::setRepColor().

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

bool yes = true

) [virtual, inherited]

Sets the error representation on specified axis, if any, to yes.

Todo:
This member Needs to be implemented in some derived classes.

Reimplemented in ColumnPointRep, and SymbolPointRep.
Definition at line 128 of file RepBase.cxx.
Referenced by PointRepXML::createObject(), and DataRep::setErrorDisplay().

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 RepBase::setStyle ( unsigned int style ) [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 in ColumnPointRep, LinePointRep, LinePointRep, and SymbolPointRep.
Definition at line 101 of file RepBase.cxx.
Referenced by DataRep::setRepStyle().

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 ColorBoxPointRep::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 67 of file ColorBoxPointRep.cxx.
References m_bin_to_color.

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(), ColorSymbolPointRep::drawProjectedValues(), drawProjectedValues(), DisplayController::pointSize(), and PointRepXML::setAttributes().

bool RepBase::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 in SymbolPointRep.
Definition at line 114 of file RepBase.cxx.
Referenced by DataRep::isErrorDisplayed(), and PointRepXML::setAttributes().

bool RepBase::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 in ColumnPointRep, and SymbolPointRep.
Definition at line 120 of file RepBase.cxx.
Referenced by DataRep::isErrorDisplayed(), and PointRepXML::setAttributes().

Member Data Documentation

BinToColor* ColorBoxPointRep::m_bin_to_color [private]

The following function transforms the projected value to a color scale.

Definition at line 35 of file ColorBoxPointRep.h.
Referenced by ColorBoxPointRep(), drawProjectedValues(), getValueTransform(), setValueTransform(), and ~ColorBoxPointRep().

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

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(), 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::ColorSymbolPointRep(), RepBase::displayError(), ContourPointRep::init(), and RepBase::name().

bool ColorBoxPointRep::m_need_background [private]

Flag to indicated that background needs to be draw.

Definition at line 38 of file ColorBoxPointRep.h.

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

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.
	ColorBoxPointRep (const ColorBoxPointRep &point_rep)
	The copy constructor.
	ColorBoxPointRep ()
	The default constructor.
virtual void	displayError (ViewBase &view)
	Display an error message.
virtual void	drawProjectedValues (const DataSource ntuple, TransformBase transform, ViewBase *view)
	Draws the projected values.
virtual const Color &	getColor () const
	Get the color of the representation.
virtual unsigned int	getStyle () const
	Returns the style of the point representation.
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 &)
	Sets the color of the representation.
virtual void	setErrorOn (const std::string &axis, bool yes=true)
	Sets the error representation on specified axis, if any, to yes.
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 style)
	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 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.
	~ColorBoxPointRep ()
	The destructor.
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.
float	m_size
	The size of the representation.
std::string	m_text
	The text to be displayed before the statistics.
Static Protected Attributes
static const Color	s_desel_color
	The color of the representation when it is de-selected.
Private Attributes
BinToColor *	m_bin_to_color
	The following function transforms the projected value to a color scale.
bool	m_need_background
	Flag to indicated that background needs to be draw.