FWDisplayProperties Class Reference

#include <Fireworks/Core/interface/FWDisplayProperties.h>

Public Member Functions
Color_t	color () const
	FWDisplayProperties (Color_t iColor, bool isVisible, Char_t transparency)
bool	isVisible () const
bool	operator!= (const FWDisplayProperties &iRHS) const
bool	operator== (const FWDisplayProperties &iRHS) const
void	setColor (Color_t iColor)
void	setIsVisible (bool iSet)
void	setTransparency (Char_t transparency)
Char_t	transparency () const

Static Public Attributes
static const FWDisplayProperties	defaultProperties

Private Attributes
Color_t	m_color
bool	m_isVisible
Char_t	m_transparency

Detailed Description

Description: <one line="" class="" summary>="">

Usage: <usage>

Definition at line 28 of file FWDisplayProperties.h.

Constructor & Destructor Documentation

FWDisplayProperties::FWDisplayProperties	(	Color_t	iColor,
		bool	isVisible,
		Char_t	transparency
	)

Note that I removed the default values to make sure that properties do not get copied around via the not so uncommon paradigm:

FWDisplayProperties new(old.color(), old.isVisible());

or similar which has the drawback of not carring over transparency information.

In general it's a good idea to have a copy and modify approach when changing updating only one value.

Definition at line 23 of file FWDisplayProperties.cc.

   : m_color(iColor),
     m_isVisible(isVisible),
     m_transparency(transparency)
{}

Member Function Documentation

Color_t FWDisplayProperties::color ( ) const

inline

Definition at line 51 of file FWDisplayProperties.h.

References m_color.

Referenced by cuy.plotElement::__init__(), cuy.superimposeElement::__init__(), cuy.graphElement::__init__(), FWEventItemsManager::add(), FWDigitSetProxyBuilder::addBox(), FWInteractionList::added(), FWTrackHitsDetailView::addHits(), FWConvTrackHitsDetailView::addHits(), FWTrackHitsDetailView::addModules(), FWConvTrackHitsDetailView::addModules(), FWPFCandidateWithHitsProxyBuilder::build(), FWBeamSpotProxyBuilder::build(), FWPFClusterRPZProxyBuilder::build(), FWTauProxyBuilderBase::buildBaseTau(), FWJetProxyBuilder::buildViewType(), FWCollectionSummaryWidget::colorClicked(), CmsShowModelPopup::colorSetChanged(), CmsShowEDI::colorSetChanged(), FWCollectionSummaryWidget::createColorPopup(), FWProxyBuilderBase::createCompound(), FWCollectionSummaryWidget::displayChanged(), CmsShowEDI::fillEDIFrame(), CmsShowModelPopup::fillModelPopup(), FWInteractionList::itemChanged(), FWCollectionSummaryWidget::itemColorClicked(), FWPFCandidatesLegoProxyBuilder::localModelChanges(), FWCandidateLegoProxyBuilder::localModelChanges(), FWPFPatJetLegoProxyBuilder< T >::localModelChanges(), FWPFClusterLegoProxyBuilder::localModelChanges(), FWPFEcalRecHitLegoProxyBuilder::localModelChanges(), fireworks::makeRhoPhiSuperCluster(), FWInteractionList::modelChanges(), FWDigitSetProxyBuilder::modelChanges(), FWCollectionSummaryWidget::setBackgroundToWhite(), FWCollectionSummaryModelCellRenderer::setData(), FWEventItem::setDefaultDisplayProperties(), fireworks::setupAddElement(), FWPFBlockProxyBuilder::setupClusterElement(), FWProxyBuilderBase::setupElement(), CmsShowModelPopup::updateDisplay(), and CmsShowEDI::updateDisplay().

                         {
      return m_color;
   }

bool FWDisplayProperties::isVisible ( ) const

inline

Definition at line 59 of file FWDisplayProperties.h.

References m_isVisible.

Referenced by FWDigitSetProxyBuilder::addBox(), FWInteractionList::added(), FWPFEcalRecHitRPProxyBuilder::build(), FWSimpleProxyBuilder::build(), FWPFEcalClusterRPZProxyBuilder::build(), FWPFHcalClusterRPZProxyBuilder::build(), FWSimpleProxyBuilder::buildViewType(), FWCollectionSummaryTableManager::buttonReleasedInRowHeader(), FWTableViewTableManager::cellRenderer(), FWModelContextMenuHandler::chosenItem(), FWFromSliceSelector::clear(), FWTableViewTableManager::dataChanged(), FWCollectionSummaryWidget::displayChanged(), FWCaloTowerSliceSelector::doSelect(), FWHFTowerSliceSelector::doSelect(), FWCaloTowerSliceSelector::doUnselect(), FWHFTowerSliceSelector::doUnselect(), FWHFTowerProxyBuilderBase::fillCaloData(), FWCaloTowerProxyBuilderBase::fillCaloData(), CmsShowEDI::fillEDIFrame(), CmsShowModelPopup::fillModelPopup(), FWInteractionList::itemChanged(), FWInteractionList::modelChanges(), FWDigitSetProxyBuilder::modelChanges(), FWEventItem::modelInfo(), FWTableViewTableManager::rowHeader(), Vispa.Gui.VispaWidget.VispaWidget::setBodyWidget(), FWCollectionSummaryModelCellRenderer::setData(), FWEventItem::setDefaultDisplayProperties(), FWEventItem::setDisplayProperties(), FWModelContextMenuHandler::showSelectedModelContext(), CmsShowModelPopup::updateDisplay(), CmsShowEDI::updateDisplay(), FWTrackProxyBuilderFullFramework::visibilityModelChanges(), and FWSimpleProxyBuilder::visibilityModelChanges().

                          {
      return m_isVisible;
   }

bool FWDisplayProperties::operator!= ( const FWDisplayProperties &  iRHS ) const

inline

Definition at line 68 of file FWDisplayProperties.h.

                                                          {
      return not (*this == iRHS);
   }

bool FWDisplayProperties::operator== ( const FWDisplayProperties &  iRHS ) const

inline

Definition at line 63 of file FWDisplayProperties.h.

References m_color, m_isVisible, and m_transparency.

                                                          {
      return m_color == iRHS.m_color 
             && m_isVisible == iRHS.m_isVisible
             && m_transparency == iRHS.m_transparency;
   }

void FWDisplayProperties::setColor ( Color_t  iColor )

inline

Definition at line 76 of file FWDisplayProperties.h.

References m_color.

Referenced by CmsShowEDI::changeItemColor(), CmsShowModelPopup::changeModelColor(), CmsShowEDI::changeSelectionColor(), FWModelContextMenuHandler::colorChangeRequested(), FWCollectionSummaryWidget::colorChangeRequested(), FWModelExpressionSelector::select(), and FWEventItem::setDefaultDisplayProperties().

                                 {
      m_color = iColor;
   }

void FWDisplayProperties::setIsVisible ( bool  iSet )

inline

Definition at line 87 of file FWDisplayProperties.h.

References m_isVisible.

Referenced by FWCollectionSummaryTableManager::buttonReleasedInRowHeader(), FWEventItem::modelInfo(), FWEventItem::setDisplayProperties(), FWCollectionSummaryWidget::toggleItemVisible(), CmsShowEDI::toggleItemVisible(), and CmsShowModelPopup::toggleModelVisible().

                                {
      m_isVisible = iSet;
   }

void FWDisplayProperties::setTransparency ( Char_t  transparency )

inline

Notice that transparency in root is in the range [0, 100]

Definition at line 81 of file FWDisplayProperties.h.

References m_transparency, and transparency().

Referenced by CmsShowEDI::changeItemOpacity(), CmsShowModelPopup::changeModelOpacity(), and FWEventItem::setDefaultDisplayProperties().

                                             {
      transparency = transparency < 0 ? 0 : transparency; 
      transparency = transparency > 100 ? 100 : transparency; 
      m_transparency = transparency;
   }

Char_t FWDisplayProperties::transparency ( ) const

inline

Definition at line 55 of file FWDisplayProperties.h.

References m_transparency.

Referenced by FWDigitSetProxyBuilder::addBox(), FWInteractionList::added(), FWTauProxyBuilderBase::buildBaseTau(), FWJetProxyBuilder::buildViewType(), FWProxyBuilderBase::createCompound(), CmsShowEDI::fillEDIFrame(), CmsShowModelPopup::fillModelPopup(), FWProxyBuilderBase::increaseComponentTransparency(), FWInteractionList::itemChanged(), FWInteractionList::modelChanges(), FWDigitSetProxyBuilder::modelChanges(), FWEventItem::setDefaultDisplayProperties(), setTransparency(), fireworks::setupAddElement(), FWProxyBuilderBase::setupElement(), CmsShowModelPopup::updateDisplay(), and CmsShowEDI::updateDisplay().

                               {
      return m_transparency;
   }

Member Data Documentation

const FWDisplayProperties FWDisplayProperties::defaultProperties

static

Definition at line 32 of file FWDisplayProperties.h.

Referenced by FWGUIEventDataAdder::addNewItem().

Color_t FWDisplayProperties::m_color

private

Definition at line 98 of file FWDisplayProperties.h.

Referenced by color(), operator==(), and setColor().

bool FWDisplayProperties::m_isVisible

private

Definition at line 99 of file FWDisplayProperties.h.

Referenced by isVisible(), operator==(), and setIsVisible().

Char_t FWDisplayProperties::m_transparency

private

Definition at line 100 of file FWDisplayProperties.h.

Referenced by operator==(), setTransparency(), and transparency().