A certain object (especcially input types) might have multiple implementations by the GUI or alternative input mechanism. More...
#include <ocean/plankton/VCreationPreferences.hpp>
Classes | |
| struct | ConstIterator |
| struct | Iterator |
| Iterator class. More... | |
Public Member Functions | |
| bool | contains (const string &p) const |
| Check if a certain property is contained in this preference list. | |
| 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 std::initializer_list< const char * > &) | |
| Create creation preferences from list of strings. | |
| VCreationPreferences (const std::initializer_list< string > &) | |
| Create creation preferences from list of strings. | |
| 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 VCreationPreferences &A, const VCreationPreferences &B) | |
| Create new preferences from two preferences by joining both properties. | |
| VCreationPreferences (const VCreationPreferences &VP) | |
| Copy constructor. | |
| VCreationPreferences (const VCreationPreferencesPtr &VP) | |
| Copy from pointer constructor, copy all elements by value. | |
| 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 Member Functions inherited from MemCore::Interface< VCreationPreferences > | |
| const type_info & | getInterfaceDomain () const |
| Run-time information about the type used for InterCube registration. | |
| Public Member Functions inherited from MemCore::InterfaceBase | |
| virtual bool | apply (Intercube &I, const RefPtr< InterfaceIterationParameter > &) |
| modifyable callback function | |
| virtual bool | apply_const (const Intercube &I, const RefPtr< InterfaceIterationParameter > &) |
| constant callback function | |
| InterfaceBase () throw () | |
| Constructor. | |
| Public Member Functions inherited from MemCore::ReferenceBase< InterfaceBase > | |
| auto | getObjectCountID () const noexcept |
| Get a unique ID for this object in the given domain. | |
| bool | isIdentical (const WeakPtr< InterfaceBase, InterfaceBase > &PossibleSelf) const noexcept |
| Check if this object is identical to the one used by the given pointer. | |
| void | mkAutoDestructive () |
| Marks this object as being automatically destructed, e.g. | |
| refcount_t | refcount () const noexcept |
| The strong reference count. | |
| ReferenceBase (InterfaceBase *that) noexcept | |
| Constructor, initializes reference counter to zero. | |
| const auto & | self () const |
| Return weak pointer to the object self. | |
| refcount_t | wrefcount () const noexcept |
| The weak reference count. | |
Additional Inherited Members | |
| Public Types inherited from MemCore::Interface< VCreationPreferences > | |
| using | InterfaceDomain_t = VCreationPreferences |
| Compile-time information about the type used for InterCube registration. | |
| Public Types inherited from MemCore::ReferenceBase< InterfaceBase > | |
| using | reference_domain_t = InterfaceBase |
| The type of the base class. | |
| using | SelfPtr_t = WeakPtr< InterfaceBase, InterfaceBase > |
| Type for a pointer to this object itself. | |
| Protected Member Functions inherited from MemCore::InterfaceBase | |
| ~InterfaceBase () | |
| Destructor. | |
| Protected Member Functions inherited from MemCore::ReferenceBase< InterfaceBase > | |
| virtual void | extremeUnction () |
| A virtual function that will be called just before the object is destroyed. | |
| ReferenceBase & | operator= (const ReferenceBase &R) |
| Protected assignment operator (should not be called). | |
| void | suicide () |
| Delete this. | |
| virtual | ~ReferenceBase () |
| Virtual destructor. | |
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
- AnemoneBoundingVolume.cpp, and DynamicBackground.cpp.
Member Function Documentation
◆ weight()
| 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.
References weight().
