cee::ug::ViewClippingPlanePropertyHandler Class Reference

Property handler for view clipping plane properties. More...

Public Types

enum  PropertyKey { POINT, NORMAL }
 List of property keys for CameraPropertyHandler. More...
 

Public Member Functions

 ViewClippingPlanePropertyHandler (PropertySet *propSet)
 Creates a view clipping plane 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 applyToClippingPlane (Plane *plane) const
 Applies the properties in this property set to the view clipping plane. More...
 
void buildProperties (const Plane &plane)
 Sets the property keys and values for this property set from the view clipping plane. 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 view clipping plane property set. More...
 

Detailed Description

Property handler for view clipping plane properties.

Member Enumeration Documentation

List of property keys for CameraPropertyHandler.

Enumerator
POINT 

Point in plane.

NORMAL 

Plane normal.

Constructor & Destructor Documentation

cee::ug::ViewClippingPlanePropertyHandler::ViewClippingPlanePropertyHandler ( PropertySet propSet)

Creates a view clipping plane property handler from a given property set propSet.

Member Function Documentation

void cee::ug::ViewClippingPlanePropertyHandler::applyToClippingPlane ( Plane plane) const

Applies the properties in this property set to the view clipping plane.

void cee::ug::ViewClippingPlanePropertyHandler::buildProperties ( const Plane plane)

Sets the property keys and values for this property set from the view clipping plane.

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

Returns true if the specified property set is a valid view clipping plane property set.

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

Returns the class type of the property set.

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