Inviwo 0.9.12-pre
Inviwo documentation
Loading...
Searching...
No Matches
inviwo::plot::PCPAxisSettings Class Reference

#include <pcpaxissettings.h>

+ Inheritance diagram for inviwo::plot::PCPAxisSettings:

Public Member Functions

virtual std::string_view getClassIdentifier () const override
 
 PCPAxisSettings (std::string_view identifier, std::string_view displayName, size_t columnId=0)
 
 PCPAxisSettings (const PCPAxisSettings &rhs)
 
virtual PCPAxisSettingsclone () const override
 
void update (std::shared_ptr< const DataFrame > frame)
 
double getNormalized (double v) const
 
double getNormalizedAt (size_t idx) const
 
double getValue (double normalizedV) const
 
void moveHandle (bool upper, double mouseY)
 
uint32_t columnId () const
 
void setColumnId (uint32_t id)
 
void setParallelCoordinates (ParallelCoordinates *pcp)
 
const std::vector< bool > & getBrushed () const
 
bool isFiltering () const
 
virtual dvec2 getRange () const override
 
virtual bool getAxisVisible () const override
 
virtual bool getMirrored () const override
 
virtual vec4 getColor () const override
 
virtual float getWidth () const override
 
virtual float getScalingFactor () const override
 
virtual Orientation getOrientation () const override
 
virtual const std::string & getCaption () const override
 
virtual const PlotTextSettingsgetCaptionSettings () const override
 
virtual const std::vector< std::string > & getLabels () const override
 
virtual const PlotTextSettingsgetLabelSettings () const override
 
virtual const MajorTickSettingsgetMajorTicks () const override
 
virtual const MinorTickSettingsgetMinorTicks () const override
 
- Public Member Functions inherited from inviwo::plot::AxisSettings
bool isVertical () const
 
- Public Member Functions inherited from inviwo::BoolCompositeProperty
 BoolCompositeProperty (std::string_view identifier, std::string_view displayName, Document help, bool checked=false, InvalidationLevel invalidationLevel=InvalidationLevel::InvalidResources, PropertySemantics semantics=PropertySemantics::Default)
 
 BoolCompositeProperty (std::string_view identifier, std::string_view displayName, bool checked=false, InvalidationLevel invalidationLevel=InvalidationLevel::InvalidResources, PropertySemantics semantics=PropertySemantics::Default)
 
 BoolCompositeProperty (const BoolCompositeProperty &rhs)
 
virtual std::string_view getClassIdentifierForWidget () const override
 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 bool isChecked () const
 
virtual void setChecked (bool checked)
 
virtual operator bool () const
 
virtual BoolPropertygetBoolProperty ()
 
- Public Member Functions inherited from inviwo::CompositeProperty
 CompositeProperty (std::string_view identifier, std::string_view displayName, Document help, InvalidationLevel invalidationLevel=InvalidationLevel::InvalidResources, PropertySemantics semantics=PropertySemantics::Default)
 
 CompositeProperty (std::string_view identifier, std::string_view displayName, InvalidationLevel invalidationLevel=InvalidationLevel::InvalidResources, PropertySemantics semantics=PropertySemantics::Default)
 
 CompositeProperty (const CompositeProperty &rhs)=default
 
virtual const std::string & getIdentifier () const override
 
virtual bool isCollapsed () const
 
virtual CompositePropertysetCollapsed (bool value)
 
CompositePropertysetCollapsed (CollapseAction action, CollapseTarget target)
 
virtual void setOwner (PropertyOwner *owner) override
 
virtual void set (const Property *src) override
 
void set (const CompositeProperty *src)
 
virtual void setValid () override
 
virtual InvalidationLevel getInvalidationLevel () const override
 
virtual CompositePropertysetCurrentStateAsDefault () override
 
virtual CompositePropertyresetToDefaultState () override
 
virtual bool isDefaultState () const override
 
virtual bool needsSerialization () const override
 
virtual CompositePropertysetReadOnly (bool value) override
 Enable or disable editing of property.
 
virtual void invalidate (InvalidationLevel invalidationLevel, Property *modifiedProperty=0) override
 
virtual ProcessorgetProcessor () override
 
virtual const ProcessorgetProcessor () const override
 
virtual const PropertyOwnergetOwner () const override
 
virtual PropertyOwnergetOwner () override
 
virtual InviwoApplicationgetInviwoApplication () override
 
virtual void accept (NetworkVisitor &visitor) override
 Accept a NetworkVisitor, the visitor will visit this and then each Property of the CompositeProperty in an undefined order. The Visitor will then visit each Properties's properties and so on.
 
virtual void serialize (Serializer &s) const override
 
virtual void deserialize (Deserializer &d) 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 ()
 Removes itself from its PropertyOwner.
 
virtual PropertysetIdentifier (std::string_view identifier)
 
const std::string & getPath () const
 Get the property path as string.
 
void getPath (std::pmr::string &out) const
 
virtual PropertysetDisplayName (std::string_view displayName)
 A property's name displayed to the user.
 
virtual const std::string & getDisplayName () const
 
virtual PropertysetSemantics (const PropertySemantics &semantics)
 
virtual PropertySemantics getSemantics () const
 
virtual bool getReadOnly () const
 
virtual PropertysetInvalidationLevel (InvalidationLevel invalidationLevel)
 
PropertyOwnergetOwner ()
 
const PropertyOwnergetOwner () 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 PropertysetSerializationMode (PropertySerializationMode mode)
 
virtual PropertySerializationMode getSerializationMode () const
 
virtual PropertypropertyModified ()
 
virtual PropertysetModified ()
 
virtual bool isModified () const
 
std::shared_ptr< std::function< void()> > onChangeScoped (std::function< void()> callback)
 
const BaseCallBack * onChange (std::function< void()> callback)
 
void removeOnChange (const BaseCallBack *callback)
 
virtual PropertysetVisible (bool val)
 
virtual bool getVisible () const
 
template<typename P , typename DecisionFunc >
PropertyvisibilityDependsOn (P &prop, DecisionFunc callback)
 
template<typename P , typename DecisionFunc >
PropertyreadonlyDependsOn (P &prop, DecisionFunc callback)
 
const DocumentgetHelp () const
 
DocumentgetHelp ()
 
PropertysetHelp (Document help)
 
virtual Document getDescription () const
 
template<typename P >
PropertyautoLinkToProperty (std::string_view propertyPath)
 
const std::vector< std::pair< std::string, std::string > > & getAutoLinkToProperty () const
 
- 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
 
MetaDataOwneroperator= (const MetaDataOwner &rhs)=default
 
MetaDataOwneroperator= (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>
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
 
MetaDataMapgetMetaDataMap ()
 
const MetaDataMapgetMetaDataMap () 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)
 
- Public Member Functions inherited from inviwo::PropertyOwner
virtual ~PropertyOwner ()
 Removes all properties and notifies its observers of the removal.
 
virtual void addProperty (Property *property, bool owner=true)
 
virtual void addProperty (Property &property)
 
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
 
InvalidationLevel getInvalidationLevel () const
 
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::EventListener
- Public Member Functions inherited from inviwo::Observable< CompositePropertyObserver >
 Observable (const Observable< CompositePropertyObserver > &other)
 
 Observable (Observable< CompositePropertyObserver > &&other) noexcept
 
Observable< CompositePropertyObserver > & operator= (const Observable< CompositePropertyObserver > &other)
 
Observable< CompositePropertyObserver > & operator= (Observable< CompositePropertyObserver > &&other) noexcept
 
void addObserver (CompositePropertyObserver *observer)
 
void removeObserver (CompositePropertyObserver *observer)
 
virtual void startBlockingNotifications () override final
 
virtual void stopBlockingNotifications () override final
 

Public Attributes

std::function< double(size_t)> at = [](size_t) { return 0.0; }
 
DoubleMinMaxProperty range
 
BoolProperty invertRange
 
ParallelCoordinatespcp_ = nullptr
 
std::shared_ptr< const Columncol_
 
const CategoricalColumncatCol_ = nullptr
 

Static Public Attributes

static constexpr std::string_view classIdentifier
 
- Static Public Attributes inherited from inviwo::BoolCompositeProperty
static constexpr std::string_view classIdentifier {"org.inviwo.BoolCompositeProperty"}
 
- Static Public Attributes inherited from inviwo::CompositeProperty
static constexpr std::string_view classIdentifier {"org.inviwo.CompositeProperty"}
 

Additional Inherited Members

- Public Types inherited from inviwo::plot::AxisSettings
enum class  Orientation { Horizontal , Vertical }
 
- Public Types inherited from inviwo::CompositeProperty
enum class  CollapseAction { Collapse , Expand }
 
enum class  CollapseTarget { Current , Recursive , Children , Siblings }
 
- Public Types inherited from inviwo::PropertyOwner
using iterator = std::vector<Property*>::iterator
 
using const_iterator = std::vector<Property*>::const_iterator
 
- 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)
 
Propertyoperator= (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 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::CompositePropertyObservable
void notifyObserversOnSetCollapsed (bool collapsed)
 
- Protected Member Functions inherited from inviwo::Observable< CompositePropertyObserver >
void forEachObserver (C callback)
 
- Protected Attributes inherited from inviwo::Property
CallBackList onChangeCallback_
 
PropertySerializationMode serializationMode_
 
- Protected Attributes inherited from inviwo::MetaDataOwner
MetaDataMap metaData_
 
- 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_
 

Detailed Description

Helper class for handling axis specific tasks for the parallel coordinates plot

Member Function Documentation

◆ clone()

virtual PCPAxisSettings * inviwo::plot::PCPAxisSettings::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.

Reimplemented from inviwo::BoolCompositeProperty.

◆ getAxisVisible()

virtual bool inviwo::plot::PCPAxisSettings::getAxisVisible ( ) const
overridevirtual

◆ getCaption()

virtual const std::string & inviwo::plot::PCPAxisSettings::getCaption ( ) const
overridevirtual

◆ getCaptionSettings()

virtual const PlotTextSettings & inviwo::plot::PCPAxisSettings::getCaptionSettings ( ) const
overridevirtual

◆ getClassIdentifier()

virtual std::string_view inviwo::plot::PCPAxisSettings::getClassIdentifier ( ) const
overridevirtual

Reimplemented from inviwo::BoolCompositeProperty.

◆ getColor()

virtual vec4 inviwo::plot::PCPAxisSettings::getColor ( ) const
overridevirtual

◆ getLabels()

virtual const std::vector< std::string > & inviwo::plot::PCPAxisSettings::getLabels ( ) const
overridevirtual

◆ getLabelSettings()

virtual const PlotTextSettings & inviwo::plot::PCPAxisSettings::getLabelSettings ( ) const
overridevirtual

◆ getMajorTicks()

virtual const MajorTickSettings & inviwo::plot::PCPAxisSettings::getMajorTicks ( ) const
overridevirtual

◆ getMinorTicks()

virtual const MinorTickSettings & inviwo::plot::PCPAxisSettings::getMinorTicks ( ) const
overridevirtual

◆ getMirrored()

virtual bool inviwo::plot::PCPAxisSettings::getMirrored ( ) const
overridevirtual

◆ getNormalized()

double inviwo::plot::PCPAxisSettings::getNormalized ( double v) const

Normalizes the value v from the range of the parameter to zero and one. Clamps out-of-bounds values to zero and one. Using inverse linear interpolation between min and max unless usePercentiles is checked. If usePercentiles is checked linear interpolation is used within three percentile ranges (0-25, 25-75, 75-100).

◆ getNormalizedAt()

double inviwo::plot::PCPAxisSettings::getNormalizedAt ( size_t idx) const

Samples the column at the given index and returned the normalized value.

See also
getNormalized(double)

◆ getOrientation()

virtual Orientation inviwo::plot::PCPAxisSettings::getOrientation ( ) const
overridevirtual

◆ getRange()

virtual dvec2 inviwo::plot::PCPAxisSettings::getRange ( ) const
overridevirtual

◆ getScalingFactor()

virtual float inviwo::plot::PCPAxisSettings::getScalingFactor ( ) const
overridevirtual

◆ getValue()

double inviwo::plot::PCPAxisSettings::getValue ( double normalizedV) const

Get data-range value from a normalized value. This the inverse function of getNormalized, ie x = getValue(getNormalized(x)).

See also
getNormalized(double)

◆ getWidth()

virtual float inviwo::plot::PCPAxisSettings::getWidth ( ) const
overridevirtual

◆ moveHandle()

void inviwo::plot::PCPAxisSettings::moveHandle ( bool upper,
double mouseY )

Helper function for ParallelCoordinates::handlePicked

◆ update()

void inviwo::plot::PCPAxisSettings::update ( std::shared_ptr< const DataFrame > frame)

Update the range of the axis based on the given column.

Member Data Documentation

◆ classIdentifier

std::string_view inviwo::plot::PCPAxisSettings::classIdentifier
staticconstexpr
Initial value:
{
"org.inviwo.parallelcoordinates.axissettingsproperty"}

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