Inviwo 0.9.12-pre
Inviwo documentation
Loading...
Searching...
No Matches
inviwo::Settings Class Reference
+ Inheritance diagram for inviwo::Settings:

Public Member Functions

 Settings (const std::string &id, InviwoApplication *app)
 
 Settings (const std::string &id="")
 
virtual void addProperty (Property *property, bool owner=true) override
 
virtual void addProperty (Property &property) override
 
void load ()
 
void save ()
 
virtual const std::string & getIdentifier () const override
 
virtual InviwoApplicationgetInviwoApplication () override
 
- Public Member Functions inherited from inviwo::PropertyOwner
virtual ~PropertyOwner ()
 Removes all properties and notifies its observers of the removal.
 
virtual PropertyaddProperty (std::unique_ptr< Property > property)
 
template<typename... Ts>
void addProperties (Ts &... properties)
 
virtual void insertProperty (size_t index, Property *property, bool owner=true)
 insert property property at position index If index is not valid, the property is appended.
 
virtual void insertProperty (size_t index, Property &property)
 insert property property at position index If index is not valid, the property is appended.
 
virtual PropertyinsertProperty (size_t index, std::unique_ptr< Property > property)
 insert property property at position index If index is not valid, the property is appended.
 
virtual PropertyremoveProperty (std::string_view identifier)
 
virtual PropertyremoveProperty (Property *property)
 
virtual PropertyremoveProperty (Property &property)
 
virtual PropertyremoveProperty (size_t index)
 remove property referred to by index
 
virtual bool move (Property *property, size_t newIndex)
 
virtual void clear ()
 Remove all properties; Owned properties will be deleted.
 
const std::vector< Property * > & getProperties () const
 
const std::vector< CompositeProperty * > & getCompositeProperties () const
 
std::vector< Property * > getPropertiesRecursive () const
 
std::vector< Property * > & getPropertiesRecursive (std::vector< Property * > &destination) const
 
PropertygetPropertyByIdentifier (std::string_view identifier, bool recursiveSearch=false) const
 
PropertygetPropertyByPath (std::string_view path) const
 
template<class T >
std::vector< T * > getPropertiesByType (bool recursiveSearch=false) const
 
bool empty () const
 
size_t size () const
 
Propertyoperator[] (size_t)
 
const Propertyoperator[] (size_t) const
 
const_iterator find (Property *property) const
 
iterator begin ()
 
iterator end ()
 
const_iterator begin () const
 
const_iterator end () const
 
const_iterator cbegin () const
 
const_iterator cend () const
 
virtual bool isValid () const
 
virtual void setValid ()
 
InvalidationLevel getInvalidationLevel () const
 
virtual void invalidate (InvalidationLevel invalidationLevel, Property *modifiedProperty)
 
virtual ProcessorgetProcessor ()
 
virtual const ProcessorgetProcessor () const
 
virtual const PropertyOwnergetOwner () const
 
virtual PropertyOwnergetOwner ()
 
virtual void serialize (Serializer &s) const override
 
virtual void deserialize (Deserializer &d) override
 
virtual void setAllPropertiesCurrentStateAsDefault ()
 
virtual void resetAllProperties ()
 
virtual void invokeEvent (Event *event) override
 
- Public Member Functions inherited from inviwo::PropertyOwnerObservable
void notifyObserversWillAddProperty (PropertyOwner *owner, Property *property, size_t index)
 
void notifyObserversDidAddProperty (Property *property, size_t index)
 
void notifyObserversWillRemoveProperty (Property *property, size_t index)
 
void notifyObserversDidRemoveProperty (PropertyOwner *owner, Property *property, size_t index)
 
- Public Member Functions inherited from inviwo::Observable< PropertyOwnerObserver >
 Observable (const Observable< PropertyOwnerObserver > &other)
 
 Observable (Observable< PropertyOwnerObserver > &&other) noexcept
 
Observable< PropertyOwnerObserver > & operator= (const Observable< PropertyOwnerObserver > &other)
 
Observable< PropertyOwnerObserver > & operator= (Observable< PropertyOwnerObserver > &&other) noexcept
 
void addObserver (PropertyOwnerObserver *observer)
 
void removeObserver (PropertyOwnerObserver *observer)
 
virtual void startBlockingNotifications () override final
 
virtual void stopBlockingNotifications () override final
 
- Public Member Functions inherited from inviwo::ObservableInterface
- Public Member Functions inherited from inviwo::Serializable
- Public Member Functions inherited from inviwo::EventListener

Protected Member Functions

std::filesystem::path getFileName () const
 
- Protected Member Functions inherited from inviwo::PropertyOwner
 PropertyOwner (const PropertyOwner &rhs)
 
PropertyOwneroperator= (const PropertyOwner &that)=delete
 
void forEachProperty (std::function< void(Property &)> callback, bool recursiveSearch=false) const
 
- Protected Member Functions inherited from inviwo::Observable< PropertyOwnerObserver >
void forEachObserver (C callback)
 
- Protected Member Functions inherited from inviwo::ObservableInterface
void addObservationHelper (Observer *observer)
 
void removeObservationHelper (Observer *observer)
 

Protected Attributes

std::string identifier_
 
bool isDeserializing_
 
InviwoApplicationapp_
 
- Protected Attributes inherited from inviwo::PropertyOwner
std::vector< Property * > properties_
 
std::vector< EventProperty * > eventProperties_
 
std::vector< CompositeProperty * > compositeProperties_
 
std::vector< std::unique_ptr< Property > > ownedProperties_
 

Additional Inherited Members

- Public Types inherited from inviwo::PropertyOwner
using iterator = std::vector<Property*>::iterator
 
using const_iterator = std::vector<Property*>::const_iterator
 

Member Function Documentation

◆ addProperty() [1/2]

virtual void inviwo::Settings::addProperty ( Property & property)
overridevirtual

Reimplemented from inviwo::PropertyOwner.

◆ addProperty() [2/2]

virtual void inviwo::Settings::addProperty ( Property * property,
bool owner = true )
overridevirtual

Reimplemented from inviwo::PropertyOwner.

◆ getIdentifier()

virtual const std::string & inviwo::Settings::getIdentifier ( ) const
overridevirtual

Reimplemented from inviwo::PropertyOwner.

◆ getInviwoApplication()

virtual InviwoApplication * inviwo::Settings::getInviwoApplication ( )
overridevirtual

Implements inviwo::PropertyOwner.

◆ load()

void inviwo::Settings::load ( )

Load setting from disk. Each derived class needs to take care of calling this in the constructor

◆ save()

void inviwo::Settings::save ( )

Save is called automatically whenever a property changes.


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