Inviwo  0.9.10.1
Inviwo documentation
inviwo::Trackball Class Reference
+ Inheritance diagram for inviwo::Trackball:

Public Member Functions

 Trackball (TrackballObject *object)
 
 Trackball (const Trackball &rhs)
 
virtual Trackballclone () const override
 
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. More...
 
vec3 getWorldSpaceTranslationFromNDCSpace (const vec3 &fromNormalizedDeviceCoord, const vec3 &toNormalizedDeviceCoord)
 
- Public Member Functions inherited from inviwo::CompositeProperty
virtual std::string getClassIdentifier () const override
 
 CompositeProperty (const std::string &identifier, const std::string &displayName, InvalidationLevel invalidationLevel=InvalidationLevel::InvalidResources, PropertySemantics semantics=PropertySemantics::Default)
 
 CompositeProperty (const CompositeProperty &rhs)=default
 
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 void setCollapsed (bool value)
 
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 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 std::vector< std::string > getPath () const override
 
virtual void serialize (Serializer &s) const override
 
virtual void deserialize (Deserializer &d) override
 
- Public Member Functions inherited from inviwo::Property
 Property (const std::string &identifier="", const std::string &displayName="", InvalidationLevel invalidationLevel=InvalidationLevel::InvalidOutput, PropertySemantics semantics=PropertySemantics::Default)
 
virtual ~Property ()
 Removes itself from its PropertyOwner.
 
virtual PropertysetIdentifier (const std::string &identifier)
 
virtual std::string getIdentifier () const
 
virtual PropertysetDisplayName (const std::string &displayName)
 A property's name displayed to the user.
 
virtual 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 ()
 
bool hasWidgets () 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)
 
template<typename T >
const BaseCallBack * onChange (T *object, void(T::*method)())
 
template<typename T >
void removeOnChange (T *object)
 
virtual PropertysetUsageMode (UsageMode usageMode)
 
virtual UsageMode getUsageMode () const
 
virtual void setSerializationMode (PropertySerializationMode mode)
 
virtual PropertySerializationMode getSerializationMode () const
 
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)
 
virtual Document getDescription () const
 
template<typename P >
PropertyautoLinkToProperty (const std::string &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)
 
Observable< PropertyObserver > & operator= (const Observable< PropertyObserver > &other)
 
Observable< PropertyObserver > & operator= (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
 
MetaDataOwneroperator= (const MetaDataOwner &rhs)=default
 
void copyMetaDataFrom (const MetaDataOwner &src)
 
void copyMetaDataTo (MetaDataOwner &dst)
 
template<typename T >
T * createMetaData (const std::string &key)
 
template<typename T , typename U >
void setMetaData (const std::string &key, U value)
 
template<typename T >
bool unsetMetaData (const std::string &key)
 unset, i.e. remove the metadata entry matching the given key and type More...
 
template<typename T , typename U >
getMetaData (const std::string &key, U val) const
 
template<typename T >
T * getMetaData (const std::string &key)
 
template<typename T >
const T * getMetaData (const std::string &key) const
 
MetaDataMapgetMetaDataMap ()
 
const MetaDataMapgetMetaDataMap () const
 
template<typename T >
bool hasMetaData (const std::string &key) const
 
- 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)
 
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. More...
 
virtual void insertProperty (size_t index, Property &property)
 insert property property at position index If index is not valid, the property is appended. More...
 
virtual PropertyremoveProperty (const std::string &identifier)
 
virtual PropertyremoveProperty (Property *property)
 
virtual PropertyremoveProperty (Property &property)
 
virtual PropertyremoveProperty (size_t index)
 remove property referred to by index More...
 
const std::vector< Property * > & getProperties () const
 
const std::vector< CompositeProperty * > & getCompositeProperties () const
 
std::vector< Property * > getPropertiesRecursive () const
 
PropertygetPropertyByIdentifier (const std::string &identifier, bool recursiveSearch=false) const
 
PropertygetPropertyByPath (const std::vector< std::string > &path) const
 
template<class T >
std::vector< T * > getPropertiesByType (bool recursiveSearch=false) const
 
size_t size () const
 
Propertyoperator[] (size_t)
 
const Propertyoperator[] (size_t) const
 
iterator begin ()
 
iterator end ()
 
const_iterator cbegin () const
 
const_iterator cend () const
 
virtual bool isValid () const
 
InvalidationLevel getInvalidationLevel () const
 
void setAllPropertiesCurrentStateAsDefault ()
 
void resetAllPoperties ()
 
virtual InviwoApplicationgetInviwoApplication ()
 
- Public Member Functions inherited from inviwo::PropertyOwnerObservable
void notifyObserversWillAddProperty (Property *property, size_t index)
 
void notifyObserversDidAddProperty (Property *property, size_t index)
 
void notifyObserversWillRemoveProperty (Property *property, size_t index)
 
void notifyObserversDidRemoveProperty (Property *property, size_t index)
 
- Public Member Functions inherited from inviwo::Observable< PropertyOwnerObserver >
 Observable (const Observable< PropertyOwnerObserver > &other)
 
 Observable (Observable< PropertyOwnerObserver > &&other)
 
Observable< PropertyOwnerObserver > & operator= (const Observable< PropertyOwnerObserver > &other)
 
Observable< PropertyOwnerObserver > & operator= (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 (const Observable< CompositePropertyObserver > &other)
 
 Observable (Observable< CompositePropertyObserver > &&other)
 
Observable< CompositePropertyObserver > & operator= (const Observable< CompositePropertyObserver > &other)
 
Observable< CompositePropertyObserver > & operator= (Observable< CompositePropertyObserver > &&other)
 
void addObserver (CompositePropertyObserver *observer)
 
void removeObserver (CompositePropertyObserver *observer)
 
virtual void startBlockingNotifications () override final
 
virtual void stopBlockingNotifications () override final
 

Protected Types

enum  Direction { Up = 0, Left, Down, 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 (Event *event)
 
void rotateTAV (Event *event)
 
void rotateArc (Event *event, bool followObjectDuringRotation=false)
 
void rotateFPS (Event *event)
 
void zoom (Event *event)
 
void pan (Event *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 (const float radians) const
 
mat4 pitch (const float radians) const
 
mat4 yaw (const float radians) const
 
void stepRotate (Direction dir)
 
void stepZoom (Direction dir, const 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 (Event *event)
 
void zoomIn (Event *event, const int numSteps=1)
 
void zoomOut (Event *event, const 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. More...
 
void animate ()
 
- Protected Member Functions inherited from inviwo::Property
 Property (const Property &rhs)
 
Propertyoperator= (const Property &that)=delete
 
void updateWidgets ()
 
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)
 
void notifyObserversOnSetUsageMode (Property *property, UsageMode usageMode)
 
- 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
 
- 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_
 
double gestureStartNDCDepth_
 
float trackBallWorldSpaceRadius_
 
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 allowZooming_
 Enable/disable zooming.
 
BoolProperty allowWheelZooming_
 Enable/disable zooming using the mouse wheel.
 
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 mouseRotate_
 
EventProperty mouseZoom_
 
EventProperty wheelZoom_
 
EventProperty mousePan_
 
EventProperty mouseRecenterFocusPoint_
 
EventProperty mouseReset_
 
EventProperty moveUp_
 
EventProperty moveLeft_
 
EventProperty moveDown_
 
EventProperty moveRight_
 
EventProperty moveForward_
 
EventProperty moveBackward_
 
EventProperty stepRotateUp_
 
EventProperty stepRotateLeft_
 
EventProperty stepRotateDown_
 
EventProperty stepRotateRight_
 
EventProperty stepZoomIn_
 
EventProperty stepZoomOut_
 
EventProperty stepPanUp_
 
EventProperty stepPanLeft_
 
EventProperty stepPanDown_
 
EventProperty stepPanRight_
 
EventProperty touchGesture_
 
const float radius = 0.5f
 Radius in normalized screen space [0 1]^2.
 
const float stepsize = 0.05f
 
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_
 

Additional Inherited Members

- 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)
 
- Static Public Attributes inherited from inviwo::CompositeProperty
static const std::string classIdentifier = "org.inviwo.CompositeProperty"
 

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()

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.

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

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

◆ sensitivity_

FloatProperty inviwo::Trackball::sensitivity_
protected

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


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