cee::ug::OverlayImagePropertyHandler
-
class
OverlayImagePropertyHandler
Property handler for overlay image properties.
Public Types
-
enum
PropertyKey
List of property keys for OverlayImagePropertyHandler.
Values:
-
enumerator
IMAGE_NAME
Image name
-
enumerator
IMAGE_SCALE_WIDTH
Image scale width
-
enumerator
IMAGE_SCALE_HEIGHT
Image scale height
-
enumerator
LAYOUT_CORNER
Image layout corner
-
enumerator
LAYOUT_DIRECTION
Image layout direction
-
enumerator
BLENDING_MODE
Blending mode.
-
enumerator
GLOBAL_ALPHA
Global alpha value.
-
enumerator
Public Functions
-
OverlayImagePropertyHandler
(PropertySet *propSet, ImageResources *imageResources) Creates an overlay image property handler from a given property set propSet.
-
Variant
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
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.
-
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.
-
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.
Public Static Functions
-
static bool
isValidPropertySet
(const PropertySet &propSet) Returns true if the specified property set is a valid overlay image property set.
-
enum