cee::ug::CameraPropertyHandler Class Reference

Property handler for camera properties. More...

Public Types

enum  PropertyKey {
  EYE, VRP, VUP, PROJECTION_TYPE,
  FIELD_OF_VIEW_Y_DEGREES, ORTHO_HEIGHT
}
 List of property keys for CameraPropertyHandler. More...
 

Public Member Functions

 CameraPropertyHandler (PropertySet *propSet)
 Creates a camera 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 applyToCamera (vis::Camera *camera, const BoundingBox *viewBoundingBox) const
 Applies the properties in this property set to the camera settings. More...
 
void buildProperties (const vis::Camera &camera)
 Sets the property keys and values for this property set from the camera 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 camera property set. More...
 

Detailed Description

Property handler for camera properties.

Member Enumeration Documentation

List of property keys for CameraPropertyHandler.

Enumerator
EYE 

Eye position.

VRP 

View reference point.

VUP 

Up vector.

PROJECTION_TYPE 

Projection type.

FIELD_OF_VIEW_Y_DEGREES 

Field of view.

ORTHO_HEIGHT 

Ortho height.

Constructor & Destructor Documentation

cee::ug::CameraPropertyHandler::CameraPropertyHandler ( PropertySet propSet)

Creates a camera property handler from a given property set propSet.

Member Function Documentation

void cee::ug::CameraPropertyHandler::applyToCamera ( vis::Camera camera,
const BoundingBox viewBoundingBox 
) const

Applies the properties in this property set to the camera settings.

void cee::ug::CameraPropertyHandler::buildProperties ( const vis::Camera camera)

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

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

Returns true if the specified property set is a valid camera property set.

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

Returns the class type of the property set.

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