Wizt::VCreationPreferences Class Reference

A certain object (especcially input types) might have multiple implementations by the GUI or alternative input mechanism. More...

#include </home/werner/origo/vish/ocean/plankton/VCreationPreferences.hpp>

List of all members.

Classes

• struct ConstIterator
• struct Iterator

  Iterator class. More...
  

Public Types

• typedef std::map< string, double > PropertyList_t
• typedef std::string string

Public Member Functions

• bool contains (const string &p) const

  Check if a certain property is contained in this preference list.
  

• int iterate (Iterator &I)
• int iterate (ConstIterator &I) const
• VCreationPreferences & operator+= (const string &p)

  Add a property.
  

• size_t size () const

  How many entries do we have here?
  

• VCreationPreferences ()

  Empty creation preferences.
  

• VCreationPreferences (const string &p1)

  Create creation preferences with one entry of weight 1.0.
  

• VCreationPreferences (const string &p1, const string &p2)

  Create creation preferences with two entries of weight 1.0.
  

• VCreationPreferences (const string &p1, const string &p2, const string &p3)

  Create creation preferences with three entries of weight 1.0.
  

• VCreationPreferences (const RefPtr< VCreationPreferences > &VP)

  Copy from pointer constructor, copy all elements by value.
  

• VCreationPreferences (const VCreationPreferences &VP)
• double weight (const string &p) const

  What is the stored weight for this entry?
  

• double weight (const VCreationPreferences &) const

  Compute the correlation of the current creation preference with another one.
  

Public Attributes

• PropertyList_t PropertyList

---

Detailed Description

A certain object (especcially input types) might have multiple implementations by the GUI or alternative input mechanism.

An object may request one specific implementation in preference to others. As not all interface imlementations might provide the same variety of input objects, the preference for such a specific implementation is specified through an abstraction layer casted into this VCreationPreferences class.

A list of desired properties which are requested from an input parameter. Each property is specified via a textual description and is assigned an weight which indicates the importance of this property.

Examples:

ClippingPlane.cpp, DynamicBackground.cpp, and MouseBackground.cpp.

---

Member Function Documentation

double Wizt::VCreationPreferences::weight

(

const VCreationPreferences &

P

)

const

Compute the correlation of the current creation preference with another one.

The returned value is the sum of the product of all desired weights with all found weights. Properties which are not available in both preference list are ignored and thus do not contribute.

---

The documentation for this class was generated from the following files:

• ocean/plankton/VCreationPreferences.hpp
• ocean/plankton/VCreationPreferences.cpp