cee::ug::DisplacementSettings Class Reference

Settings for a specific displacement result. More...

Public Member Functions

double scaleFactor () const
 Returns scale factor. More...
 
void setScaleFactor (double scaleFactor)
 Sets the absolute scale factor to scaleFactor. More...
 
- Public Member Functions inherited from cee::RefCountedObject
void addRef () const
 Increments the reference count for this object. More...
 
void release () const
 Decrements the reference count for this object. More...
 
int refCount () const
 Returns the reference count for this object. More...
 
void setRefCountZero () const
 Sets the ref count to zero, but DOES NOT delete the object. More...
 
Inheritance diagram for cee::ug::DisplacementSettings:
cee::RefCountedObject

Detailed Description

Settings for a specific displacement result.

A displacement result is a collection of displacement values. Displacement results are always node based. The displacement result has settings that can be configured to tailor the visual appearance of your result data.

Each displacement result has its own settings. Get displacement settings for a specific displacement result by calling UnstructGridModel::displacementSettings() with the requested id.

cee::ug::DisplacementSettings* settings = ugModel->displacementSettings(displacementId);
See also
UnstructGridModel

Member Function Documentation

double cee::ug::DisplacementSettings::scaleFactor ( ) const

Returns scale factor.

void cee::ug::DisplacementSettings::setScaleFactor ( double  scaleFactor)

Sets the absolute scale factor to scaleFactor.

Warning
The specified scale factor must be greater that 0.