cee::ug::OverlayImagePropertyHandler Class Reference

Property handler for overlay image properties. More...

Public Types

enum  PropertyKey {
  IMAGE_NAME, IMAGE_SCALE_WIDTH, IMAGE_SCALE_HEIGHT, LAYOUT_CORNER,
  LAYOUT_DIRECTION, BLENDING_MODE, GLOBAL_ALPHA
}
 List of property keys for OverlayImagePropertyHandler. More...
 

Public Member Functions

 OverlayImagePropertyHandler (PropertySet *propSet, ImageResources *imageResources)
 Creates an overlay image property handler from a given property set propSet. More...
 
Variant propertyValue (PropertyKey key) const
 Returns the property value for the specified property key. More...
 
void setPropertyValue (PropertyKey key, Variant data)
 Sets the property key and value to this handlers property set. More...
 
void applyToOverlayImage (vis::OverlayImage *overlayImage, vis::OverlayItem::LayoutCorner *layoutCorner, vis::OverlayItem::LayoutDirection *layoutDirection) const
 Applies the properties in this property set to the specified overlay image. More...
 
void buildProperties (const vis::OverlayImage &overlayImage, vis::OverlayItem::LayoutCorner layoutCorner, vis::OverlayItem::LayoutDirection layoutDirection)
 Sets the property keys and values for this property set from the overlay image. More...
 

Static Public Member Functions

static Str propertySetClassType ()
 Returns the class type of the property set. More...
 
static bool isValidPropertySet (const PropertySet &propSet)
 Returns true if the specified property set is a valid overlay image property set. More...
 

Detailed Description

Property handler for overlay image properties.

Member Enumeration Documentation

List of property keys for OverlayImagePropertyHandler.

Enumerator
IMAGE_NAME 

Image name

IMAGE_SCALE_WIDTH 

Image scale width

IMAGE_SCALE_HEIGHT 

Image scale height

LAYOUT_CORNER 

Image layout corner

LAYOUT_DIRECTION 

Image layout direction

BLENDING_MODE 

Blending mode.

GLOBAL_ALPHA 

Global alpha value.

Constructor & Destructor Documentation

cee::ug::OverlayImagePropertyHandler::OverlayImagePropertyHandler ( PropertySet propSet,
ImageResources imageResources 
)

Creates an overlay image property handler from a given property set propSet.

Member Function Documentation

void cee::ug::OverlayImagePropertyHandler::applyToOverlayImage ( vis::OverlayImage overlayImage,
vis::OverlayItem::LayoutCorner layoutCorner,
vis::OverlayItem::LayoutDirection layoutDirection 
) const

Applies the properties in this property set to the specified overlay image.

void cee::ug::OverlayImagePropertyHandler::buildProperties ( const vis::OverlayImage overlayImage,
vis::OverlayItem::LayoutCorner  layoutCorner,
vis::OverlayItem::LayoutDirection  layoutDirection 
)

Sets the property keys and values for this property set from the overlay image.

bool cee::ug::OverlayImagePropertyHandler::isValidPropertySet ( const PropertySet propSet)
static

Returns true if the specified property set is a valid overlay image property set.

Str cee::ug::OverlayImagePropertyHandler::propertySetClassType ( )
static

Returns the class type of the property set.

cee::Variant cee::ug::OverlayImagePropertyHandler::propertyValue ( PropertyKey  key) const

Returns the property value for the specified property key.

Returns an empty Variant if the property key was not found.

void cee::ug::OverlayImagePropertyHandler::setPropertyValue ( PropertyKey  key,
Variant  data 
)

Sets the property key and value to this handlers property set.

If key exists in the property set, the paired property value is updated to data. Otherwise the key/value pair is added to the property set.