#include <inviwo/core/properties/eventproperty.h>

Inheritance diagram for inviwo::EventProperty:

Classes
struct	Action

Public Types
enum class	State : std::uint8_t { Started , Active , Finished }

Public Member Functions
virtual EventProperty *	clone () const override

virtual void	deserialize (Deserializer &d) override

	EventProperty (const EventProperty &rhs)

	EventProperty (std::string_view identifier, std::string_view displayName, Action action, IvwKey key, KeyStates states=KeyState::Press, KeyModifiers modifier=KeyModifiers(flags::none), ModifierMatchingBehavior modifierMatching=ModifierMatchingBehavior::ExactMatch, InvalidationLevel invalidationLevel=InvalidationLevel::InvalidOutput, PropertySemantics semantics=PropertySemantics::Default)

	EventProperty (std::string_view identifier, std::string_view displayName, Action action, MouseButtons buttons, MouseStates states=MouseState::Press, KeyModifiers modifiers=KeyModifiers(flags::none), ModifierMatchingBehavior modifierMatching=ModifierMatchingBehavior::ExactMatch, InvalidationLevel invalidationLevel=InvalidationLevel::InvalidOutput, PropertySemantics semantics=PropertySemantics::Default)

	EventProperty (std::string_view identifier, std::string_view displayName, Action action, std::unique_ptr< EventMatcher > matcher, InvalidationLevel invalidationLevel=InvalidationLevel::InvalidOutput, PropertySemantics semantics=PropertySemantics::Default)
	Constructor used to create a new action-key binding.

	EventProperty (std::string_view identifier, std::string_view displayName, Document help, Action action, IvwKey key, KeyStates states=KeyState::Press, KeyModifiers modifier=KeyModifiers(flags::none), ModifierMatchingBehavior modifierMatching=ModifierMatchingBehavior::ExactMatch, InvalidationLevel invalidationLevel=InvalidationLevel::InvalidOutput, PropertySemantics semantics=PropertySemantics::Default)

	EventProperty (std::string_view identifier, std::string_view displayName, Document help, Action action, MouseButtons buttons, MouseStates states=MouseState::Press, KeyModifiers modifiers=KeyModifiers(flags::none), ModifierMatchingBehavior modifierMatching=ModifierMatchingBehavior::ExactMatch, InvalidationLevel invalidationLevel=InvalidationLevel::InvalidOutput, PropertySemantics semantics=PropertySemantics::Default)

	EventProperty (std::string_view identifier, std::string_view displayName, Document help, Action action, std::unique_ptr< EventMatcher > matcher, InvalidationLevel invalidationLevel=InvalidationLevel::InvalidOutput, PropertySemantics semantics=PropertySemantics::Default)
	Constructor used to create a new action-key binding.

Action	getAction () const

virtual std::string_view	getClassIdentifier () const override

EventMatcher *	getEventMatcher () const

void	invokeEvent (Event *)

virtual bool	isDefaultState () const override

bool	isEnabled () const

virtual EventProperty &	resetToDefaultState () override

virtual void	serialize (Serializer &s) const override

void	setAction (Action action)

virtual EventProperty &	setCurrentStateAsDefault () override

void	setEnabled (bool enabled)

void	setEventMatcher (std::unique_ptr< EventMatcher > matcher)

Public Member Functions inherited from inviwo::Property
virtual void	accept (NetworkVisitor &visitor)
	Accept a NetworkVisitor, the visitor will visit this Property.

template<typename P >
Property &	autoLinkToProperty (std::string_view propertyPath)

void	clearInitiatingWidget ()

void	deregisterWidget (PropertyWidget *propertyWidget)

const std::vector< std::pair< std::string, std::string > > &	getAutoLinkToProperty () const

virtual std::string_view	getClassIdentifierForWidget () const
	Returns which property's widget should be used when the WidgetFactory tries to create a widget. Defaults to getClassIdentifier(), should only be overridden if a subclass want to reuse another property's widget.

virtual Document	getDescription () const

virtual std::string_view	getDisplayName () const

Document &	getHelp ()

const Document &	getHelp () const

virtual std::string_view	getIdentifier () const

virtual InvalidationLevel	getInvalidationLevel () const

PropertyOwner *	getOwner ()

const PropertyOwner *	getOwner () const

std::string_view	getPath () const
	Get the property path as string.

void	getPath (std::pmr::string &out) const

virtual bool	getReadOnly () const

virtual PropertySemantics	getSemantics () const

virtual PropertySerializationMode	getSerializationMode () const

virtual bool	getVisible () const

const std::vector< PropertyWidget * > &	getWidgets () const

bool	hasWidgets () const

virtual bool	isModified () const

virtual bool	needsSerialization () const

const BaseCallBack *	onChange (std::function< void()> callback)

std::shared_ptr< std::function< void()> >	onChangeScoped (std::function< void()> callback)

	Property (std::string_view identifier, std::string_view displayName, InvalidationLevel invalidationLevel, PropertySemantics semantics=PropertySemantics::Default)

	Property (std::string_view identifier="", std::string_view displayName="", Document help={}, InvalidationLevel invalidationLevel=InvalidationLevel::InvalidOutput, PropertySemantics semantics=PropertySemantics::Default, ReadOnly readOnly=ReadOnly::No)

virtual Property &	propertyModified ()

template<typename P , typename DecisionFunc >
Property &	readonlyDependsOn (P &prop, DecisionFunc callback)

void	registerWidget (PropertyWidget *propertyWidget)

void	removeOnChange (const BaseCallBack *callback)

virtual void	set (const Property *src)

virtual Property &	setDisplayName (std::string_view displayName)
	A property's name displayed to the user.

Property &	setHelp (Document help)

virtual Property &	setIdentifier (std::string_view identifier)

void	setInitiatingWidget (PropertyWidget *propertyWidget)

virtual Property &	setInvalidationLevel (InvalidationLevel invalidationLevel)

virtual Property &	setModified ()

virtual void	setOwner (PropertyOwner *owner)

virtual Property &	setReadOnly (bool value)
	Enable or disable editing of property.

virtual Property &	setSemantics (const PropertySemantics &semantics)

virtual Property &	setSerializationMode (PropertySerializationMode mode)

virtual void	setValid ()

virtual Property &	setVisible (bool val)

void	updateWidgets ()

template<typename P , typename DecisionFunc >
Property &	visibilityDependsOn (P &prop, DecisionFunc callback)

virtual	~Property ()
	Removes itself from its PropertyOwner.

Public Member Functions inherited from inviwo::Observable< PropertyObserver >
void	addObserver (PropertyObserver *observer)

bool	isObservedBy (PropertyObserver *observer) const

	Observable (const Observable< PropertyObserver > &other)

	Observable (Observable< PropertyObserver > &&other) noexcept

Observable< PropertyObserver > &	operator= (const Observable< PropertyObserver > &other)

Observable< PropertyObserver > &	operator= (Observable< PropertyObserver > &&other) noexcept

void	removeObserver (PropertyObserver *observer)

virtual void	startBlockingNotifications () override final

virtual void	stopBlockingNotifications () override final

Public Member Functions inherited from inviwo::MetaDataOwner
void	copyMetaDataFrom (const MetaDataOwner &src)

void	copyMetaDataTo (MetaDataOwner &dst)

template<typename T > requires std::derived_from<T, MetaData>
T *	createMetaData (std::string_view key)

void	deserialize (Deserializer &d)

template<typename T > requires std::derived_from<T, MetaData>
T *	getMetaData (std::string_view key)

template<typename T > requires std::derived_from<T, MetaData>
const T *	getMetaData (std::string_view key) const

template<typename T , typename U > requires std::derived_from<T, MetaData> && Gettable<T, U>
U	getMetaData (std::string_view key, U val) const

MetaDataMap *	getMetaDataMap ()

const MetaDataMap *	getMetaDataMap () const

bool	hasMetaData (std::string_view key) const

template<typename T > requires std::derived_from<T, MetaData>
bool	hasMetaData (std::string_view key) const

	MetaDataOwner (const MetaDataOwner &rhs)=default

	MetaDataOwner (MetaDataOwner &rhs)=default

MetaDataOwner &	operator= (const MetaDataOwner &rhs)=default

MetaDataOwner &	operator= (MetaDataOwner &)=default

void	serialize (Serializer &s) const

template<typename T , typename U > requires std::derived_from<T, MetaData> && Settable<T, U>
void	setMetaData (std::string_view key, U value)

template<typename T > requires std::derived_from<T, MetaData>
bool	unsetMetaData (std::string_view key)
	unset, i.e. remove the metadata entry matching the given key and type

Static Public Attributes
static constexpr std::string_view	classIdentifier {"org.inviwo.EventProperty"}

Additional Inherited Members
Static Public Member Functions inherited from inviwo::Property
template<typename T , typename U >
static void	setStateAsDefault (T &property, const U &state)

Protected Member Functions inherited from inviwo::Property
void	notifyAboutChange ()

Property &	operator= (const Property &that)=delete

Property &	operator= (Property &&that)

	Property (const Property &rhs)

	Property (Property &&rhs)

Protected Member Functions inherited from inviwo::PropertyObservable
void	notifyObserversOnSetDisplayName (Property *property, const std::string &displayName)

void	notifyObserversOnSetIdentifier (Property *property, const std::string &identifier)

void	notifyObserversOnSetReadOnly (Property *property, bool readonly)

void	notifyObserversOnSetSemantics (Property *property, const PropertySemantics &semantics)

void	notifyObserversOnSetVisible (Property *property, bool visible)

Protected Member Functions inherited from inviwo::Observable< PropertyObserver >
void	forEachObserver (C callback)

Protected Member Functions inherited from inviwo::ObservableInterface
void	addObservationHelper (Observer *observer)

void	removeObservationHelper (Observer *observer)

Protected Attributes inherited from inviwo::Property
CallBackList	onChangeCallback_

PropertySerializationMode	serializationMode_

Protected Attributes inherited from inviwo::MetaDataOwner
MetaDataMap	metaData_

Detailed Description

Property which contains one event matcher and one action to represent the current key binding for the contained action.

See also: EventPropertyWidgetQt

Constructor & Destructor Documentation

◆ EventProperty() [1/2]

inviwo::EventProperty::EventProperty	(	std::string_view	identifier,
		std::string_view	displayName,
		Document	help,
		Action	action,
		std::unique_ptr< EventMatcher >	matcher,
		InvalidationLevel	invalidationLevel = InvalidationLevel::InvalidOutput,
		PropertySemantics	semantics = PropertySemantics::Default )

Constructor used to create a new action-key binding.

The constructor creates a new binding between a specified action and event.

Parameters

identifier
displayName
help
matcher	The selection of events to bind to an action
action	The action to executed upon the event.
invalidationLevel
semantics

◆ EventProperty() [2/2]

inviwo::EventProperty::EventProperty	(	std::string_view	identifier,
		std::string_view	displayName,
		Action	action,
		std::unique_ptr< EventMatcher >	matcher,
		InvalidationLevel	invalidationLevel = InvalidationLevel::InvalidOutput,
		PropertySemantics	semantics = PropertySemantics::Default )

Constructor used to create a new action-key binding.

The constructor creates a new binding between a specified action and event.

Parameters

identifier
displayName
matcher	The selection of events to bind to an action
action	The action to executed upon the event.
invalidationLevel
semantics

Member Function Documentation

◆ clone()

virtual EventProperty * inviwo::EventProperty::clone ( ) const

overridevirtual

Creates a clone of this property. The clone will have the same identifier, hence the identifier must be changed if the clone should be added to the same owner as this. The new clone does not have any owner set.

Implements inviwo::Property.

◆ deserialize()

virtual void inviwo::EventProperty::deserialize ( Deserializer & d )

overridevirtual

Reimplemented from inviwo::Property.

◆ getClassIdentifier()

virtual std::string_view inviwo::EventProperty::getClassIdentifier ( ) const

overridevirtual

Implements inviwo::Property.

◆ isDefaultState()

virtual bool inviwo::EventProperty::isDefaultState ( ) const

overridevirtual

Check if the property is in it's default state, i.e. resetToDefaultState would do nothing

See also: setCurrentStateAsDefault; resetToDefaultState

Reimplemented from inviwo::Property.

◆ resetToDefaultState()

virtual EventProperty & inviwo::EventProperty::resetToDefaultState ( )

overridevirtual

Reset the state of the property back to it's default value. It is important that all overriding properties make sure to call the base class implementation.

Reimplemented from inviwo::Property.

◆ serialize()

virtual void inviwo::EventProperty::serialize ( Serializer & s ) const

overridevirtual

Reimplemented from inviwo::Property.

◆ setCurrentStateAsDefault()

virtual EventProperty & inviwo::EventProperty::setCurrentStateAsDefault ( )

overridevirtual

Save the current state of the property as the default. This state will then be used as a reference when serializing, only state different from the default will be serialized. This method should usually only be called once directly after construction in the processor constructor after setting property specific state. It is important that all overriding properties make sure to call the base class implementation.

Reimplemented from inviwo::Property.

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

include/inviwo/core/properties/eventproperty.h

Classes

Public Types

Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ EventProperty() [1/2]

◆ EventProperty() [2/2]

Member Function Documentation

◆ clone()

◆ deserialize()

◆ getClassIdentifier()

◆ isDefaultState()

◆ resetToDefaultState()

◆ serialize()

◆ setCurrentStateAsDefault()