Property handler for viewer properties. More...
Public Types | |
enum | PropertyKey { ANIMATION_FRAMES_PER_SECOND, ANIMATION_FIRST_FRAME_DELAY, ANIMATION_LAST_FRAME_DELAY, NUM_PARTICLE_TRACE_STEPS, START_ANIMATION, HALO_COLOR, CUTTING_PLANE_INDEX_TO_ANIMATE, CUTTING_PLANE_NUM_ANIM_FRAMES, CUTTING_PLANE_ANIM_FRAME_DISTANCE, VIEW_TITLE } |
List of property keys for ViewerPropertyHandler. More... | |
Public Member Functions | |
ViewerPropertyHandler (PropertySet *propSet) | |
Creates a viewer 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... | |
double | defaultFramesPerSecond () const |
Returns the frames per second for the animation. More... | |
void | setDefaultFramesPerSecond (double animationFPS) |
Sets the frames per second for the animation. More... | |
int | firstFrameDelay () const |
Returns the first frame delay in milliseconds. More... | |
void | setFirstFrameDelay (int milliSeconds) |
Sets the first frame delay in milliseconds. More... | |
int | lastFrameDelay () const |
Returns the last frame delay in milliseconds. More... | |
void | setLastFrameDelay (int milliSeconds) |
Sets the last frame delay in milliseconds. More... | |
int | numberOfParticleTraceAnimationSteps () const |
Returns the number of steps to use for the particle trace animation. More... | |
void | setNumberOfParticleTraceAnimationSteps (int numAnimationSteps) |
Sets the number of steps to use for particle trace animation. More... | |
bool | hasStartAnimation () const |
Returns the flag that controls automatic start of the animation, if any. More... | |
void | setStartAnimation (bool start) |
Sets the flag that controls automatic start of the animation, if any. More... | |
Color3f | haloColor () const |
Returns the color of halos used in the viewer, e.g to highlight parts. More... | |
void | setHaloColor (const Color3f &color) |
Sets the color of halos used in the viewer, e.g to highlight parts. More... | |
int | animatedCuttingPlaneIndex () const |
Returns the index of the cutting plane to animate. More... | |
void | setAnimatedCuttingPlaneIndex (int index) |
Sets the index of the cutting plane to animate. More... | |
int | animatedCuttingPlaneNumberOfFrames () const |
Returns the number of frames for the cutting plane animation. More... | |
void | setAnimatedCuttingPlaneNumberOfFrames (int numFrames) |
Sets the number of frames for the cutting plane animation. More... | |
double | animatedCuttingPlaneDistancePerFrame () const |
Returns the distance per frame for the cutting plane animation. More... | |
void | setAnimatedCuttingPlaneDistancePerFrame (double distance) |
Sets the distance per frame for the cutting plane animation. More... | |
Str | viewTitle () const |
Returns view title. More... | |
void | setViewTitle (const Str &title) |
Sets view title. 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 viewer property set. More... | |
Property handler for viewer properties.
List of property keys for ViewerPropertyHandler.
cee::ug::ViewerPropertyHandler::ViewerPropertyHandler | ( | PropertySet * | propSet | ) |
Creates a viewer property handler from a given property set propSet.
double cee::ug::ViewerPropertyHandler::animatedCuttingPlaneDistancePerFrame | ( | ) | const |
Returns the distance per frame for the cutting plane animation.
int cee::ug::ViewerPropertyHandler::animatedCuttingPlaneIndex | ( | ) | const |
Returns the index of the cutting plane to animate.
int cee::ug::ViewerPropertyHandler::animatedCuttingPlaneNumberOfFrames | ( | ) | const |
Returns the number of frames for the cutting plane animation.
double cee::ug::ViewerPropertyHandler::defaultFramesPerSecond | ( | ) | const |
Returns the frames per second for the animation.
int cee::ug::ViewerPropertyHandler::firstFrameDelay | ( | ) | const |
Returns the first frame delay in milliseconds.
Color3f cee::ug::ViewerPropertyHandler::haloColor | ( | ) | const |
Returns the color of halos used in the viewer, e.g to highlight parts.
bool cee::ug::ViewerPropertyHandler::hasStartAnimation | ( | ) | const |
Returns the flag that controls automatic start of the animation, if any.
|
static |
Returns true if the specified property set is a valid viewer property set.
int cee::ug::ViewerPropertyHandler::lastFrameDelay | ( | ) | const |
Returns the last frame delay in milliseconds.
int cee::ug::ViewerPropertyHandler::numberOfParticleTraceAnimationSteps | ( | ) | const |
Returns the number of steps to use for the particle trace animation.
|
static |
Returns the class type of the property set.
cee::Variant cee::ug::ViewerPropertyHandler::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::ViewerPropertyHandler::setAnimatedCuttingPlaneDistancePerFrame | ( | double | distance | ) |
Sets the distance per frame for the cutting plane animation.
void cee::ug::ViewerPropertyHandler::setAnimatedCuttingPlaneIndex | ( | int | index | ) |
Sets the index of the cutting plane to animate.
void cee::ug::ViewerPropertyHandler::setAnimatedCuttingPlaneNumberOfFrames | ( | int | numFrames | ) |
Sets the number of frames for the cutting plane animation.
void cee::ug::ViewerPropertyHandler::setDefaultFramesPerSecond | ( | double | animationFPS | ) |
Sets the frames per second for the animation.
void cee::ug::ViewerPropertyHandler::setFirstFrameDelay | ( | int | milliSeconds | ) |
Sets the first frame delay in milliseconds.
void cee::ug::ViewerPropertyHandler::setHaloColor | ( | const Color3f & | color | ) |
Sets the color of halos used in the viewer, e.g to highlight parts.
void cee::ug::ViewerPropertyHandler::setLastFrameDelay | ( | int | milliSeconds | ) |
Sets the last frame delay in milliseconds.
void cee::ug::ViewerPropertyHandler::setNumberOfParticleTraceAnimationSteps | ( | int | numAnimationSteps | ) |
Sets the number of steps to use for particle trace animation.
void cee::ug::ViewerPropertyHandler::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 cee::ug::ViewerPropertyHandler::setStartAnimation | ( | bool | start | ) |
Sets the flag that controls automatic start of the animation, if any.
void cee::ug::ViewerPropertyHandler::setViewTitle | ( | const Str & | title | ) |
Sets view title.
cee::Str cee::ug::ViewerPropertyHandler::viewTitle | ( | ) | const |
Returns view title.