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

Public Member Functions

virtual std::string getClassIdentifier () const override
 
 LineSettingsProperty (std::string_view identifier, std::string_view displayName, InvalidationLevel invalidationLevel=InvalidationLevel::InvalidResources, PropertySemantics semantics=PropertySemantics::Default)
 
 LineSettingsProperty (const LineSettingsProperty &rhs)
 
virtual LineSettingsPropertyclone () const override
 
virtual float getWidth () const override
 
virtual float getAntialiasingWidth () const override
 
virtual float getMiterLimit () const override
 
virtual bool getRoundCaps () const override
 
virtual bool getPseudoLighting () const override
 
virtual bool getRoundDepthProfile () const override
 
virtual vec4 getDefaultColor () const override
 
virtual const StipplingSettingsInterfacegetStippling () const override
 
virtual bool getOverrideColor () const override
 
virtual vec3 getOverrideColorValue () const override
 
virtual bool getOverrideAlpha () const override
 
virtual float getOverrideAlphaValue () const override
 
virtual bool getUseMetaColor () const override
 
virtual const TransferFunctiongetMetaColor () const override
 
- Public Member Functions inherited from inviwo::LineSettingsInterface
- 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 std::string 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 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)
 
virtual const std::string & getPath () const
 Get the property path as string.
 
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

FloatProperty lineWidth
 
FloatProperty antialiasing
 
FloatProperty miterLimit
 
BoolProperty roundCaps
 
BoolProperty pseudoLighting
 
BoolProperty roundDepthProfile
 
FloatVec4Property defaultColor
 
BoolCompositeProperty overrideColor
 
FloatVec3Property color
 
BoolCompositeProperty overrideAlpha
 
FloatProperty alpha
 
BoolCompositeProperty useMetaColor
 
TransferFunctionProperty metaColor
 
StipplingProperty stippling
 

Static Public Attributes

static const std::string classIdentifier
 
- Static Public Attributes inherited from inviwo::CompositeProperty
static const std::string classIdentifier
 

Additional Inherited Members

- 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_
 

Member Function Documentation

◆ clone()

virtual LineSettingsProperty * inviwo::LineSettingsProperty::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::CompositeProperty.

◆ getAntialiasingWidth()

virtual float inviwo::LineSettingsProperty::getAntialiasingWidth ( ) const
overridevirtual

Returns
Width of antialiasing (in pixels)

Implements inviwo::LineSettingsInterface.

◆ getClassIdentifier()

virtual std::string inviwo::LineSettingsProperty::getClassIdentifier ( ) const
overridevirtual

Reimplemented from inviwo::CompositeProperty.

◆ getDefaultColor()

virtual vec4 inviwo::LineSettingsProperty::getDefaultColor ( ) const
overridevirtual

Default color used when the mesh doesn't have a color attribute.

Implements inviwo::LineSettingsInterface.

◆ getMetaColor()

virtual const TransferFunction & inviwo::LineSettingsProperty::getMetaColor ( ) const
overridevirtual

◆ getMiterLimit()

virtual float inviwo::LineSettingsProperty::getMiterLimit ( ) const
overridevirtual

Where to crop of sharp corners. Occurs when two lines meeting at low angles.

Returns
distance (in pixels)

Implements inviwo::LineSettingsInterface.

◆ getOverrideAlpha()

virtual bool inviwo::LineSettingsProperty::getOverrideAlpha ( ) const
overridevirtual

◆ getOverrideAlphaValue()

virtual float inviwo::LineSettingsProperty::getOverrideAlphaValue ( ) const
overridevirtual

◆ getOverrideColor()

virtual bool inviwo::LineSettingsProperty::getOverrideColor ( ) const
overridevirtual

◆ getOverrideColorValue()

virtual vec3 inviwo::LineSettingsProperty::getOverrideColorValue ( ) const
overridevirtual

◆ getPseudoLighting()

virtual bool inviwo::LineSettingsProperty::getPseudoLighting ( ) const
overridevirtual

Make lines appear cylinder shaped?

Implements inviwo::LineSettingsInterface.

◆ getRoundCaps()

virtual bool inviwo::LineSettingsProperty::getRoundCaps ( ) const
overridevirtual

Should line end points be round?

Implements inviwo::LineSettingsInterface.

◆ getRoundDepthProfile()

virtual bool inviwo::LineSettingsProperty::getRoundDepthProfile ( ) const
overridevirtual

Depth values according to cylinder shape?

Implements inviwo::LineSettingsInterface.

◆ getStippling()

virtual const StipplingSettingsInterface & inviwo::LineSettingsProperty::getStippling ( ) const
overridevirtual

Dashed line settings, e.g., - - -

Implements inviwo::LineSettingsInterface.

◆ getUseMetaColor()

virtual bool inviwo::LineSettingsProperty::getUseMetaColor ( ) const
overridevirtual

◆ getWidth()

virtual float inviwo::LineSettingsProperty::getWidth ( ) const
overridevirtual

Returns
Line width (in pixels)

Implements inviwo::LineSettingsInterface.


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