Inviwo 0.9.12-pre
Inviwo documentation
|
#include <optionproperty.h>
Public Member Functions | |
BaseOptionProperty (std::string_view identifier, std::string_view displayName, Document help, InvalidationLevel invalidationLevel=InvalidationLevel::InvalidOutput, PropertySemantics semantics=PropertySemantics::Default) | |
BaseOptionProperty (const BaseOptionProperty &rhs) | |
virtual std::string | getClassIdentifier () const override=0 |
virtual BaseOptionProperty & | clearOptions ()=0 |
virtual size_t | size () const =0 |
virtual size_t | getSelectedIndex () const =0 |
virtual const std::string & | getSelectedIdentifier () const =0 |
virtual const std::string & | getSelectedDisplayName () const =0 |
virtual const std::string & | getOptionIdentifier (size_t index) const =0 |
virtual const std::string & | getOptionDisplayName (size_t index) const =0 |
virtual std::vector< std::string > | getIdentifiers () const =0 |
virtual std::vector< std::string > | getDisplayNames () const =0 |
virtual bool | setSelectedIndex (size_t index)=0 |
virtual bool | setSelectedIdentifier (std::string_view identifier)=0 |
virtual bool | setSelectedDisplayName (std::string_view name)=0 |
virtual bool | isSelectedIndex (size_t index) const =0 |
virtual bool | isSelectedIdentifier (std::string_view identifier) const =0 |
virtual bool | isSelectedDisplayName (std::string_view name) const =0 |
void | set (const BaseOptionProperty *srcProperty) |
virtual void | set (const Property *srcProperty) override |
Public Member Functions inherited from inviwo::Property | |
Property (std::string_view identifier="", std::string_view displayName="", Document help={}, InvalidationLevel invalidationLevel=InvalidationLevel::InvalidOutput, PropertySemantics semantics=PropertySemantics::Default, ReadOnly readOnly=ReadOnly::No) | |
Property (std::string_view identifier, std::string_view displayName, InvalidationLevel invalidationLevel, PropertySemantics semantics=PropertySemantics::Default) | |
virtual Property * | clone () const =0 |
virtual | ~Property () |
Removes itself from its PropertyOwner. | |
virtual Property & | setIdentifier (std::string_view identifier) |
virtual const std::string & | getIdentifier () const |
virtual const std::string & | getPath () const |
Get the property path as string. | |
virtual Property & | setDisplayName (std::string_view displayName) |
A property's name displayed to the user. | |
virtual const std::string & | getDisplayName () const |
virtual std::string | 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 Property & | setSemantics (const PropertySemantics &semantics) |
virtual PropertySemantics | getSemantics () const |
virtual Property & | setReadOnly (bool value) |
Enable or disable editing of property. | |
virtual bool | getReadOnly () const |
virtual Property & | setInvalidationLevel (InvalidationLevel invalidationLevel) |
virtual InvalidationLevel | getInvalidationLevel () const |
virtual void | setOwner (PropertyOwner *owner) |
PropertyOwner * | getOwner () |
const PropertyOwner * | getOwner () const |
void | registerWidget (PropertyWidget *propertyWidget) |
void | deregisterWidget (PropertyWidget *propertyWidget) |
const std::vector< PropertyWidget * > & | getWidgets () const |
void | setInitiatingWidget (PropertyWidget *propertyWidget) |
void | clearInitiatingWidget () |
void | updateWidgets () |
bool | hasWidgets () const |
virtual Property & | setSerializationMode (PropertySerializationMode mode) |
virtual PropertySerializationMode | getSerializationMode () const |
virtual Property & | setCurrentStateAsDefault () |
virtual Property & | resetToDefaultState () |
virtual bool | isDefaultState () const |
virtual bool | needsSerialization () const |
virtual Property & | propertyModified () |
virtual void | setValid () |
virtual Property & | setModified () |
virtual bool | isModified () const |
virtual void | serialize (Serializer &s) const override |
virtual void | deserialize (Deserializer &d) override |
std::shared_ptr< std::function< void()> > | onChangeScoped (std::function< void()> callback) |
const BaseCallBack * | onChange (std::function< void()> callback) |
void | removeOnChange (const BaseCallBack *callback) |
virtual Property & | setVisible (bool val) |
virtual bool | getVisible () const |
template<typename P , typename DecisionFunc > | |
Property & | visibilityDependsOn (P &prop, DecisionFunc callback) |
template<typename P , typename DecisionFunc > | |
Property & | readonlyDependsOn (P &prop, DecisionFunc callback) |
const Document & | getHelp () const |
Document & | getHelp () |
Property & | setHelp (Document help) |
virtual Document | getDescription () const |
template<typename P > | |
Property & | autoLinkToProperty (std::string_view propertyPath) |
const std::vector< std::pair< std::string, std::string > > & | getAutoLinkToProperty () const |
virtual void | accept (NetworkVisitor &visitor) |
Accept a NetworkVisitor, the visitor will visit this Property. | |
Public Member Functions inherited from inviwo::Observable< PropertyObserver > | |
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 | addObserver (PropertyObserver *observer) |
void | removeObserver (PropertyObserver *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::MetaDataOwner | |
MetaDataOwner (const MetaDataOwner &rhs)=default | |
MetaDataOwner (MetaDataOwner &rhs)=default | |
MetaDataOwner & | operator= (const MetaDataOwner &rhs)=default |
MetaDataOwner & | operator= (MetaDataOwner &)=default |
void | copyMetaDataFrom (const MetaDataOwner &src) |
void | copyMetaDataTo (MetaDataOwner &dst) |
template<typename T > requires std::derived_from<T, MetaData> | |
T * | createMetaData (std::string_view key) |
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 | |
template<typename T , typename U > requires std::derived_from<T, MetaData> && Gettable<T, U> | |
U | getMetaData (std::string_view key, U val) const |
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 |
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 |
void | serialize (Serializer &s) const |
void | deserialize (Deserializer &d) |
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 | |
Property (const Property &rhs) | |
Property & | operator= (const Property &that)=delete |
void | notifyAboutChange () |
Protected Member Functions inherited from inviwo::PropertyObservable | |
void | notifyObserversOnSetIdentifier (Property *property, const std::string &identifier) |
void | notifyObserversOnSetDisplayName (Property *property, const std::string &displayName) |
void | notifyObserversOnSetSemantics (Property *property, const PropertySemantics &semantics) |
void | notifyObserversOnSetReadOnly (Property *property, bool readonly) |
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_ |
Base class for the option properties
|
overridepure virtual |
Implements inviwo::Property.
|
overridevirtual |
Set the value of this to that of src. The "value" is in this case considered to be for example the string in a StringProperty or the float value in a FloatProperty. But not things like the identifier of display name.
Reimplemented from inviwo::Property.
Reimplemented in inviwo::ColumnOptionProperty, inviwo::OptionProperty< T >, inviwo::OptionProperty< AngleMeasure >, inviwo::OptionProperty< AxisRangeMode >, inviwo::OptionProperty< AxisSelection >, inviwo::OptionProperty< BackgroundStyle >, inviwo::OptionProperty< BasisPropertyMode >, inviwo::OptionProperty< BasisPropertyReference >, inviwo::OptionProperty< BlendMode >, inviwo::OptionProperty< BoundaryType >, inviwo::OptionProperty< BoxSelectionSettingsInterface::Mode >, inviwo::OptionProperty< BrushBy >, inviwo::OptionProperty< BrushingMode >, inviwo::OptionProperty< BufferTarget >, inviwo::OptionProperty< BufferUsage >, inviwo::OptionProperty< CaptionType >, inviwo::OptionProperty< CartesianCoordinateAxis >, inviwo::OptionProperty< cimgutil::InterpolationType >, inviwo::OptionProperty< Classification >, inviwo::OptionProperty< ClipSide >, inviwo::OptionProperty< colorbrewer::Family >, inviwo::OptionProperty< ColoringGroup >, inviwo::OptionProperty< ColoringMethod >, inviwo::OptionProperty< ColormapType >, inviwo::OptionProperty< ColorSource >, inviwo::OptionProperty< ColumnMatch >, inviwo::OptionProperty< CompositingType >, inviwo::OptionProperty< ConnectivityType >, inviwo::OptionProperty< CoordinateOffset >, inviwo::OptionProperty< CoordinateSpace >, inviwo::OptionProperty< CSVReader::EmptyField >, inviwo::OptionProperty< DataFormatId >, inviwo::OptionProperty< DataRangeMode >, inviwo::OptionProperty< double >, inviwo::OptionProperty< DrawType >, inviwo::OptionProperty< ffmpeg::Recorder::Mode >, inviwo::OptionProperty< Generator >, inviwo::OptionProperty< glui::BoxLayout::LayoutDirection >, inviwo::OptionProperty< GlyphType >, inviwo::OptionProperty< GradientComputation >, inviwo::OptionProperty< HatchingBlendingMode >, inviwo::OptionProperty< HatchingMode >, inviwo::OptionProperty< HistogramMode >, inviwo::OptionProperty< InputType >, inviwo::OptionProperty< int >, inviwo::OptionProperty< IntegralLineProperties::Direction >, inviwo::OptionProperty< IntegralLineProperties::IntegrationScheme >, inviwo::OptionProperty< InterpolationType >, inviwo::OptionProperty< inviwo::ffmpeg::CodecID >, inviwo::OptionProperty< inviwo::FileExtension >, inviwo::OptionProperty< JoinType >, inviwo::OptionProperty< LabelPlacement >, inviwo::OptionProperty< LabelPosition >, inviwo::OptionProperty< LabelType >, inviwo::OptionProperty< LayerType >, inviwo::OptionProperty< Layout >, inviwo::OptionProperty< Location >, inviwo::OptionProperty< luminance::Model >, inviwo::OptionProperty< MeshType >, inviwo::OptionProperty< meshutil::CalculateMeshNormalsMode >, inviwo::OptionProperty< MessageBreakLevel >, inviwo::OptionProperty< Method >, inviwo::OptionProperty< Mode >, inviwo::OptionProperty< NoiseType >, inviwo::OptionProperty< NormalizationMode >, inviwo::OptionProperty< NormalSource >, inviwo::OptionProperty< OffsetScaling >, inviwo::OptionProperty< Operator >, inviwo::OptionProperty< Orientation >, inviwo::OptionProperty< Output >, inviwo::OptionProperty< OutputFormat >, inviwo::OptionProperty< OutputType >, inviwo::OptionProperty< PlaybackMode >, inviwo::OptionProperty< Positioning >, inviwo::OptionProperty< RenderingType >, inviwo::OptionProperty< RenderMode >, inviwo::OptionProperty< SamplingDomain >, inviwo::OptionProperty< ScatterPlotGL::SortingOrder >, inviwo::OptionProperty< SeedingSpace >, inviwo::OptionProperty< Shader::OnError >, inviwo::OptionProperty< Shader::UniformWarning >, inviwo::OptionProperty< ShadingMode >, inviwo::OptionProperty< size_t >, inviwo::OptionProperty< Sizing >, inviwo::OptionProperty< SourceType >, inviwo::OptionProperty< splitter::Direction >, inviwo::OptionProperty< splitter::Style >, inviwo::OptionProperty< std::filesystem::path >, inviwo::OptionProperty< std::string >, inviwo::OptionProperty< StipplingSettingsInterface::Mode >, inviwo::OptionProperty< TickStyle >, inviwo::OptionProperty< Transform >, inviwo::OptionProperty< Type >, inviwo::OptionProperty< Upsampling >, inviwo::OptionProperty< util::VolumeLaplacianPostProcessing >, inviwo::OptionProperty< utilgl::debug::BreakLevel >, inviwo::OptionProperty< utilgl::debug::Mode >, inviwo::OptionProperty< utilgl::debug::Severity >, and inviwo::OptionProperty< Wrapping >.