The SKIRT project
advanced radiative transfer for astrophysics
Public Member Functions | Protected Member Functions | Private Types | Private Attributes | Friends | List of all members
WidthDecorator Class Reference

#include <WidthDecorator.hpp>

Inheritance diagram for WidthDecorator:
Inheritance graph
[legend]

Public Member Functions

double width () const
 
- Public Member Functions inherited from ShapeDecorator
Shapeshape () const
 
- Public Member Functions inherited from ShapeItem
virtual void paint ()
 
- Public Member Functions inherited from Item
 Item (const Item &)=delete
 
virtual ~Item ()
 
void addChild (Item *child)
 
const vector< Item * > & children () const
 
virtual void clearItemListProperty (const PropertyDef *property)
 
void destroyChild (Item *child)
 
virtual bool getBoolProperty (const PropertyDef *property) const
 
virtual vector< double > getDoubleListProperty (const PropertyDef *property) const
 
virtual double getDoubleProperty (const PropertyDef *property) const
 
virtual string getEnumProperty (const PropertyDef *property) const
 
virtual int getIntProperty (const PropertyDef *property) const
 
virtual vector< Item * > getItemListProperty (const PropertyDef *property) const
 
virtual ItemgetItemProperty (const PropertyDef *property) const
 
virtual string getStringProperty (const PropertyDef *property) const
 
int getUtilityProperty (string name) const
 
virtual void insertIntoItemListProperty (const PropertyDef *property, int index, Item *item)
 
Itemoperator= (const Item &)=delete
 
Itemparent () const
 
virtual void removeFromItemListProperty (const PropertyDef *property, int index)
 
virtual void setBoolProperty (const PropertyDef *property, bool value)
 
virtual void setDoubleListProperty (const PropertyDef *property, vector< double > value)
 
virtual void setDoubleProperty (const PropertyDef *property, double value)
 
virtual void setEnumProperty (const PropertyDef *property, string value)
 
virtual void setIntProperty (const PropertyDef *property, int value)
 
virtual void setItemProperty (const PropertyDef *property, Item *item)
 
virtual void setStringProperty (const PropertyDef *property, string value)
 
void setUtilityProperty (string name, int value)
 
virtual string type () const
 

Protected Member Functions

 WidthDecorator ()
 
void paintSelf () override
 
- Protected Member Functions inherited from ShapeDecorator
 ShapeDecorator ()
 
- Protected Member Functions inherited from Shape
 Shape ()
 
- Protected Member Functions inherited from ShapeItem
 ShapeItem ()
 
virtual void drawLine (double x1, double y1, double x2, double y2)
 
virtual void paintSelf ()
 
virtual void popState ()
 
virtual void pushState ()
 
virtual void setColor (double r, double g, double b)
 
virtual void setWidth (double w)
 
- Protected Member Functions inherited from Item
 Item ()
 

Private Types

using BaseType = ShapeDecorator
 
using ItemType = WidthDecorator
 

Private Attributes

double _width
 

Friends

class ItemRegistry
 

Detailed Description

The WidthDecorator class represents a decorator that sets the line width for the shape or group of shapes being decorated.

This item type is allowed only if the Boolean expression "!PolygonShape" evaluates to true after replacing the names by true or false depending on their presence.

Constructor & Destructor Documentation

◆ WidthDecorator()

WidthDecorator::WidthDecorator ( )
inlineprotected

Default constructor for concrete Item subclass WidthDecorator : "a decorator that sets the line width of a shape or group of shapes" .

Member Function Documentation

◆ paintSelf()

void WidthDecorator::paintSelf ( )
overrideprotectedvirtual

This function sets the line width in the current graphics state by calling the setWidth() function.

Reimplemented from ShapeItem.

◆ width()

WidthDecorator::width ( ) const
inline

This function returns the value of the discoverable double property width : "the line width of the decorated shape or group of shapes" .

The minimum value for this property is "0" .

The maximum value for this property is "1" .

The default value for this property is given by the conditional value expression "0.01" .


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