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

Public Member Functions

virtual std::string_view getClassIdentifier () const override
 Trackball (TrackballObject *object)
 Trackball (std::string_view identifier, std::string_view displayName, TrackballObject *object=nullptr)
 Trackball (const Trackball &rhs)
virtual Trackballclone () const override
TrackballObjectgetTrackballObject () const
void setTrackballObject (TrackballObject *obj)
virtual void invokeEvent (Event *event) override
const vec3 getLookTo () const
const vec3 getLookFrom () const
const vec3 getLookUp () const
const vec3 getLookRight () const
const vec3 getLookFromMinValue () const
const vec3 getLookFromMaxValue () const
const vec3 getLookToMinValue () const
const vec3 getLookToMaxValue () const
void setLookTo (vec3 lookTo)
void setLookFrom (vec3 lookFrom)
void setLookUp (vec3 lookUp)
void setLook (vec3 lookFrom, vec3 lookTo, vec3 lookUp)
 Set look from, look to and up vector at the same time. Should be used when more than one parameter will be changed to avoid duplicate evaluations.
vec3 getWorldSpaceTranslationFromNDCSpace (const vec3 &fromNormalizedDeviceCoord, const vec3 &toNormalizedDeviceCoord)
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_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 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< PropertyObserver > & operator= (const Observable< PropertyObserver > &other)
void addObserver (PropertyObserver *observer)
void removeObserver (PropertyObserver *observer)
virtual void startBlockingNotifications () override final
virtual void stopBlockingNotifications () override final
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 ()
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< PropertyOwnerObserver > & operator= (const Observable< PropertyOwnerObserver > &other)
void addObserver (PropertyOwnerObserver *observer)
void removeObserver (PropertyOwnerObserver *observer)
virtual void startBlockingNotifications () override final
virtual void stopBlockingNotifications () override final
Public Member Functions inherited from inviwo::Observable< CompositePropertyObserver >
Observable< CompositePropertyObserver > & operator= (const Observable< CompositePropertyObserver > &other)
void addObserver (CompositePropertyObserver *observer)
void removeObserver (CompositePropertyObserver *observer)
virtual void startBlockingNotifications () override final
virtual void stopBlockingNotifications () override final

Public Attributes

OptionPropertyInt trackballMethod_
FloatProperty sensitivity_
FloatProperty movementSpeed_
 Controls the rotation sensitivity.
BoolProperty fixUp_
OptionPropertyInt worldUp_
 Fixes the up vector to world_up in all rotation methods.
FloatVec3Property customWorldUp_
 Defines which axis is considered up in world space.
FloatProperty verticalAngleLimit_
 The custom world up direction (normalized)
BoolProperty handleInteractionEvents_
BoolProperty allowHorizontalPanning_
 Enable/disable horizontal panning.
BoolProperty allowVerticalPanning_
 Enable/disable vertical panning.
BoolProperty boundedPanning_
BoolProperty allowZooming_
 Enable/disable zooming.
BoolProperty allowWheelZooming_
 Enable/disable zooming using the mouse wheel.
BoolProperty boundedZooming_
BoolProperty mouseCenteredZoom_
BoolProperty allowHorizontalRotation_
 Enable/disable rotation around horizontal axis.
BoolProperty allowVerticalRotation_
 Enable/disable rotation around vertical axis.
BoolProperty allowViewDirectionRotation_
BoolProperty allowRecenterView_
 recenter the camera focus point with a double click
BoolProperty animate_
EventProperty mouseRecenterFocusPoint_
EventProperty wheelZoom_
EventProperty mouseRotate_
EventProperty mouseZoom_
EventProperty mousePan_
EventProperty mouseReset_
EventProperty moveUp_
EventProperty moveDown_
EventProperty moveForward_
EventProperty moveBackward_
EventProperty moveLeft_
EventProperty moveRight_
EventProperty stepRotateUp_
EventProperty stepRotateDown_
EventProperty stepRotateLeft_
EventProperty stepRotateRight_
EventProperty stepZoomIn_
EventProperty stepZoomOut_
EventProperty stepPanUp_
EventProperty stepPanDown_
EventProperty stepPanLeft_
EventProperty stepPanRight_
EventProperty touchGesture_

Static Public Attributes

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

Protected Types

enum class  Direction { Up = 0 , Down , Left , Right }

Protected Member Functions

vec3 mapNormalizedMousePosToTrackball (const vec2 &mousePos, float radius=1.0f)
void rotateTrackBall (const vec3 &fromTrackballPos, const vec3 &toTrackballPos)
vec3 getBoundedTranslation (const vec3 &lookFrom, const vec3 &lookTo, vec3 translation)
float getBoundedZoom (const vec3 &lookFrom, const vec3 &zoomTo, float zoom)
std::pair< bool, vec3 > getTrackBallIntersection (const vec2 pos) const
void rotate (MouseEvent *event)
void rotateTAV (MouseEvent *event)
void rotateArc (MouseEvent *event, bool followObjectDuringRotation=false)
void rotateFPS (MouseEvent *event)
void zoom (MouseEvent *event)
void pan (MouseEvent *event)
void reset (Event *event)
void moveLeft (Event *event)
void moveRight (Event *event)
void moveUp (Event *event)
void moveDown (Event *event)
void moveForward (Event *event)
void moveBackward (Event *event)
const vec3 getWorldUp () const
mat4 roll (float radians) const
mat4 pitch (float radians) const
mat4 yaw (float radians) const
void stepRotate (Direction dir)
void stepZoom (Direction dir, int numSteps=1)
void stepPan (Direction dir)
void rotateLeft (Event *event)
void rotateRight (Event *event)
void rotateUp (Event *event)
void rotateDown (Event *event)
void panLeft (Event *event)
void panRight (Event *event)
void panUp (Event *event)
void panDown (Event *event)
void zoomWheel (WheelEvent *event)
void zoomIn (Event *event, int numSteps=1)
void zoomOut (Event *event, int numSteps=1)
void recenterFocusPoint (Event *event)
void touchGesture (Event *event)
 Rotates around the direction vector, zooms along the direction vector and translates along up/right vector.
void animate ()
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
virtual void addObserver (Observer *observer)=0
virtual void removeObserver (Observer *observer)=0
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

TrackballObjectobject_
bool isMouseBeingPressedAndHold_
vec3 lastNDC_
vec3 pressNDC_
float trackBallWorldSpaceRadius_
glm::quat lastRot_
std::chrono::system_clock::time_point lastRotTime_
bool evaluated_
Timer timer_
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_

Static Protected Attributes

static constexpr float radius = 0.5f
 Radius in normalized screen space [0 1]^2.
static constexpr float stepSize = 0.05f

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)

Constructor & Destructor Documentation

◆ Trackball()

inviwo::Trackball::Trackball ( TrackballObject * object)

Rotates and moves object around a sphere. The trackball does not take ownership of pointers handed to it.

See also
CameraTrackball

Member Function Documentation

◆ clone()

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

Reimplemented in inviwo::CameraTrackball.

◆ getClassIdentifier()

virtual std::string_view inviwo::Trackball::getClassIdentifier ( ) const
overridevirtual

Reimplemented from inviwo::CompositeProperty.

◆ invokeEvent()

virtual void inviwo::Trackball::invokeEvent ( Event * event)
overridevirtual

Reimplemented from inviwo::PropertyOwner.

◆ setLook()

void inviwo::Trackball::setLook ( vec3 lookFrom,
vec3 lookTo,
vec3 lookUp )

Set look from, look to and up vector at the same time. Should be used when more than one parameter will be changed to avoid duplicate evaluations.

Parameters
lookFrom
lookTo
lookUp

◆ touchGesture()

void inviwo::Trackball::touchGesture ( Event * event)
protected

Rotates around the direction vector, zooms along the direction vector and translates along up/right vector.

Parameters
eventTouchEvent

Member Data Documentation

◆ handleInteractionEvents_

BoolProperty inviwo::Trackball::handleInteractionEvents_

Limits the angle between world up and view direction when fixUp is True

◆ sensitivity_

FloatProperty inviwo::Trackball::sensitivity_

Chooses which trackball method to use (mouse only, touch always follows finger)


The documentation for this class was generated from the following file:
  • trackball.h