RAIDA  1.9.0
Public Member Functions | List of all members
AIDA::IBrushStyle Class Referenceabstract

Superclass for anything which can be drawn in different colours and with (possibly) transparent/opaque/translucent effect. More...

#include <IBrushStyle.h>

Inheritance diagram for AIDA::IBrushStyle:
AIDA::IBaseStyle AIDA::IBrushStyleROOT AIDA::IFillStyle AIDA::ILineStyle AIDA::IMarkerStyle AIDA::ITextStyle AIDA::IFillStyleROOT AIDA::ILineStyleROOT AIDA::IMarkerStyleROOT AIDA::ITextStyleROOT AIDA::IFillStyleROOT AIDA::ILineStyleROOT AIDA::IMarkerStyleROOT AIDA::ITextStyleROOT

Public Member Functions

virtual ~IBrushStyle ()
 Destructor.
 
virtual std::vector< std::string > availableColors () const =0
 Get a list of the colours supported by this implementation.
 
virtual std::string color () const =0
 Current colour of this brush style.
 
virtual double opacity () const =0
 Current opacity (alpha) of this brush style.
 
virtual bool setColor (const std::string &newColor)=0
 Set current colour, e.g. More...
 
virtual bool setOpacity (double newOpacity)=0
 Set opacity (alpha), e.g. More...
 
- Public Member Functions inherited from AIDA::IBaseStyle
virtual ~IBaseStyle ()
 Destructor.
 
virtual void reset ()=0
 Return to original (construction time) state. More...
 
virtual bool setParameter (const std::string &paramName, const std::string &options="")=0
 Set a parameter. More...
 
virtual std::string parameterValue (const std::string &parameter) const =0
 Get value of a parameter. More...
 
virtual std::vector< std::string > availableParameters () const =0
 Get list of the available parameters (implementation-dependent)
 
virtual std::vector< std::string > availableParameterOptions (const std::string &paramName) const =0
 Get list of the available options for a given parameter (implementation-dependent).
 

Detailed Description

Superclass for anything which can be drawn in different colours and with (possibly) transparent/opaque/translucent effect.

Author
The AIDA team (http://aida.freehep.org/)

Member Function Documentation

virtual bool AIDA::IBrushStyle::setColor ( const std::string &  newColor)
pure virtual

Set current colour, e.g.

"darkGreen"

Returns
false if colour not recognised by the implementation.

Implemented in AIDA::IBrushStyleROOT.

virtual bool AIDA::IBrushStyle::setOpacity ( double  newOpacity)
pure virtual

Set opacity (alpha), e.g.

0 (transparent), 1 (opaque), 0.5 (halfway).

Returns
false if value not supported by the implementation.

Implemented in AIDA::IBrushStyleROOT.


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