cee::ug::PropertyApplierVTFx Class Reference

Applies VTFx properties in a property set collection and image resources to an existing model or view. More...

Public Member Functions

 PropertyApplierVTFx (PropertySetCollection *propSetCollection, ImageResources *resources)
 Constructs a property applier from a property set collection and image resources. More...
 
void applyToModel (UnstructGridModel *model)
 Applies the properties in the property set collection to the specified model. More...
 
void applyToView (vis::View *view)
 Applies properties from the property set collection to the specified view. More...
 
bool logoOverlayImage (vis::OverlayImage *image, vis::OverlayItem::LayoutCorner *layoutCorner, vis::OverlayItem::LayoutDirection *layoutDirection) const
 Returns image data an position for the logo overlay image found in the property set collection. More...
 
double defaultFramesPerSecond () const
 Returns number of frames per second from the property set collection. More...
 
int firstFrameDelay () const
 Returns first frame delay from the property set collection. More...
 
int lastFrameDelay () const
 Returns last frame delay from the property set collection. More...
 
int numberOfParticleTraceAnimationSteps () const
 Returns number of frames per second from the property set collection. More...
 
bool hasStartAnimation () const
 Returns the flag that indicates if animations should be started when the file is opened. More...
 
int animatedCuttingPlaneIndex () const
 Returns index of animated cutting plane from the property set collection. More...
 
int animatedCuttingPlaneFrameCount () const
 Returns number of frames in cutting plane animation from the property set collection. More...
 
double animatedCuttingPlaneDistancePerFrame () const
 Returns per frame distance in cutting plane animation from the property set collection. More...
 
Str viewTitle () const
 Returns view title from the property set collection. More...
 

Detailed Description

Applies VTFx properties in a property set collection and image resources to an existing model or view.

Constructor & Destructor Documentation

cee::ug::PropertyApplierVTFx::PropertyApplierVTFx ( PropertySetCollection propSetCollection,
ImageResources resources 
)

Constructs a property applier from a property set collection and image resources.

Member Function Documentation

double cee::ug::PropertyApplierVTFx::animatedCuttingPlaneDistancePerFrame ( ) const

Returns per frame distance in cutting plane animation from the property set collection.

int cee::ug::PropertyApplierVTFx::animatedCuttingPlaneFrameCount ( ) const

Returns number of frames in cutting plane animation from the property set collection.

int cee::ug::PropertyApplierVTFx::animatedCuttingPlaneIndex ( ) const

Returns index of animated cutting plane from the property set collection.

void cee::ug::PropertyApplierVTFx::applyToModel ( UnstructGridModel model)

Applies the properties in the property set collection to the specified model.

void cee::ug::PropertyApplierVTFx::applyToView ( vis::View view)

Applies properties from the property set collection to the specified view.

double cee::ug::PropertyApplierVTFx::defaultFramesPerSecond ( ) const

Returns number of frames per second from the property set collection.

int cee::ug::PropertyApplierVTFx::firstFrameDelay ( ) const

Returns first frame delay from the property set collection.

bool cee::ug::PropertyApplierVTFx::hasStartAnimation ( ) const

Returns the flag that indicates if animations should be started when the file is opened.

int cee::ug::PropertyApplierVTFx::lastFrameDelay ( ) const

Returns last frame delay from the property set collection.

bool cee::ug::PropertyApplierVTFx::logoOverlayImage ( vis::OverlayImage image,
vis::OverlayItem::LayoutCorner layoutCorner,
vis::OverlayItem::LayoutDirection layoutDirection 
) const

Returns image data an position for the logo overlay image found in the property set collection.

int cee::ug::PropertyApplierVTFx::numberOfParticleTraceAnimationSteps ( ) const

Returns number of frames per second from the property set collection.

cee::Str cee::ug::PropertyApplierVTFx::viewTitle ( ) const

Returns view title from the property set collection.