CMS 3D CMS Logo

List of all members | Public Member Functions | Static Public Attributes | Private Attributes
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::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 22 of file FWDisplayProperties.cc.

Member Function Documentation

◆ color()

Color_t FWDisplayProperties::color ( ) const
inline

◆ isVisible()

bool FWDisplayProperties::isVisible ( ) const
inline

◆ operator!=()

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

Definition at line 56 of file FWDisplayProperties.h.

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

◆ operator==()

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

Definition at line 53 of file FWDisplayProperties.h.

53  {
54  return m_color == iRHS.m_color && m_isVisible == iRHS.m_isVisible && m_transparency == iRHS.m_transparency;
55  }

References m_color, m_isVisible, and m_transparency.

◆ setColor()

void FWDisplayProperties::setColor ( Color_t  iColor)
inline

◆ setIsVisible()

void FWDisplayProperties::setIsVisible ( bool  iSet)
inline

◆ setTransparency()

void FWDisplayProperties::setTransparency ( Char_t  transparency)
inline

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

Definition at line 65 of file FWDisplayProperties.h.

65  {
67  transparency = transparency > 100 ? 100 : transparency;
69  }

References m_transparency, and transparency().

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

◆ transparency()

Char_t FWDisplayProperties::transparency ( ) const
inline

Member Data Documentation

◆ defaultProperties

const FWDisplayProperties FWDisplayProperties::defaultProperties
static

Definition at line 30 of file FWDisplayProperties.h.

Referenced by FWGUIEventDataAdder::addNewItem().

◆ m_color

Color_t FWDisplayProperties::m_color
private

Definition at line 80 of file FWDisplayProperties.h.

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

◆ m_isVisible

bool FWDisplayProperties::m_isVisible
private

Definition at line 81 of file FWDisplayProperties.h.

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

◆ m_transparency

Char_t FWDisplayProperties::m_transparency
private

Definition at line 82 of file FWDisplayProperties.h.

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

FWDisplayProperties::isVisible
bool isVisible() const
Definition: FWDisplayProperties.h:51
FWDisplayProperties::m_isVisible
bool m_isVisible
Definition: FWDisplayProperties.h:81
FWDisplayProperties::m_color
Color_t m_color
Definition: FWDisplayProperties.h:80
FWDisplayProperties::transparency
Char_t transparency() const
Definition: FWDisplayProperties.h:49
FWDisplayProperties::m_transparency
Char_t m_transparency
Definition: FWDisplayProperties.h:82