cee::ug::MirrorSettingsPropertyHandler Class Reference

Property handler for mirror settings properties. More...

Public Types

enum  PropertyKey {
  NUM_MIRROR_PASSES, PLANE_FIRST_A, PLANE_FIRST_B, PLANE_FIRST_C,
  PLANE_FIRST_D, PLANE_SECOND_A, PLANE_SECOND_B, PLANE_SECOND_C,
  PLANE_SECOND_D, PLANE_MASTER_A, PLANE_MASTER_B, PLANE_MASTER_C,
  PLANE_MASTER_D, REFLECTIVE
}
 List of property keys for MirrorSettingsPropertyHandler. More...
 

Public Member Functions

 MirrorSettingsPropertyHandler (PropertySet *propSet)
 Creates a mirror settings 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 applyToMirrorSettings (ug::MirrorSettings *mirrorSettings) const
 Applies the properties in this property set to the specified mirror settings. More...
 
void buildProperties (const ug::MirrorSettings &mirrorSettings)
 Sets the property keys and values for this property set from the mirror settings. 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 mirror settings property set. More...
 

Detailed Description

Property handler for mirror settings properties.

Member Enumeration Documentation

List of property keys for MirrorSettingsPropertyHandler.

Enumerator
NUM_MIRROR_PASSES 

Number of mirror passes.

PLANE_FIRST_A 

Plane first A

PLANE_FIRST_B 

Plane first B

PLANE_FIRST_C 

Plane first C

PLANE_FIRST_D 

Plane first D

PLANE_SECOND_A 

Plane second A

PLANE_SECOND_B 

Plane second B

PLANE_SECOND_C 

Plane second C

PLANE_SECOND_D 

Plane second D

PLANE_MASTER_A 

Plane master A

PLANE_MASTER_B 

Plane master B

PLANE_MASTER_C 

Plane master C

PLANE_MASTER_D 

Plane master D

REFLECTIVE 

Reflective mirroring flag.

Constructor & Destructor Documentation

cee::ug::MirrorSettingsPropertyHandler::MirrorSettingsPropertyHandler ( PropertySet propSet)

Creates a mirror settings property handler from a given property set propSet.

Member Function Documentation

void cee::ug::MirrorSettingsPropertyHandler::applyToMirrorSettings ( ug::MirrorSettings mirrorSettings) const

Applies the properties in this property set to the specified mirror settings.

void cee::ug::MirrorSettingsPropertyHandler::buildProperties ( const ug::MirrorSettings mirrorSettings)

Sets the property keys and values for this property set from the mirror settings.

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

Returns true if the specified property set is a valid mirror settings property set.

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

Returns the class type of the property set.

cee::Variant cee::ug::MirrorSettingsPropertyHandler::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::MirrorSettingsPropertyHandler::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.