inviwo::Trackball Class Reference

Inheritance diagram for inviwo::Trackball:

Public Member Functions
virtual Trackball *	clone () const override
virtual std::string_view	getClassIdentifier () const override
const vec3	getLookFrom () const
const vec3	getLookFromMaxValue () const
const vec3	getLookFromMinValue () const
const vec3	getLookRight () const
const vec3	getLookTo () const
const vec3	getLookToMaxValue () const
const vec3	getLookToMinValue () const
const vec3	getLookUp () const
TrackballObject *	getTrackballObject () const
vec3	getWorldSpaceTranslationFromNDCSpace (const vec3 &fromNormalizedDeviceCoord, const vec3 &toNormalizedDeviceCoord)
virtual void	invokeEvent (Event *event) override
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.
void	setLookFrom (vec3 lookFrom)
void	setLookTo (vec3 lookTo)
void	setLookUp (vec3 lookUp)
void	setTrackballObject (TrackballObject *obj)
	Trackball (const Trackball &rhs)
	Trackball (std::string_view identifier, std::string_view displayName, TrackballObject *object=nullptr)
	Trackball (TrackballObject *object)
Public Member Functions inherited from inviwo::CompositeProperty
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.
	CompositeProperty (CompositeProperty &&rhs)=default
	CompositeProperty (const CompositeProperty &rhs)=default
	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)
virtual void	deserialize (Deserializer &d) 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 const std::string &	getIdentifier () const override
virtual InvalidationLevel	getInvalidationLevel () const override
virtual InviwoApplication *	getInviwoApplication () override
virtual const PropertyOwner *	getOwner () const override
virtual PropertyOwner *	getOwner () override
virtual const Processor *	getProcessor () const override
virtual Processor *	getProcessor () override
virtual void	invalidate (InvalidationLevel invalidationLevel, Property *modifiedProperty=0) override
virtual bool	isCollapsed () const
virtual bool	isDefaultState () const override
virtual bool	needsSerialization () const override
CompositeProperty &	operator= (CompositeProperty &&rhs)=default
CompositeProperty &	operator= (const CompositeProperty &rhs)=delete
virtual CompositeProperty &	resetToDefaultState () override
virtual void	serialize (Serializer &s) const override
void	set (const CompositeProperty *src)
virtual void	set (const Property *src) override
virtual CompositeProperty &	setCollapsed (bool value)
CompositeProperty &	setCollapsed (CollapseAction action, CollapseTarget target)
virtual CompositeProperty &	setCurrentStateAsDefault () override
virtual void	setOwner (PropertyOwner *owner) override
virtual CompositeProperty &	setReadOnly (bool value) override
	Enable or disable editing of property.
virtual void	setValid () override
Public Member Functions inherited from inviwo::Property
template<typename P>
Property &	autoLinkToProperty (std::string_view propertyPath)
void	clearInitiatingWidget ()
void	deregisterWidget (PropertyWidget *propertyWidget)
const std::vector< std::pair< std::string, std::string > > &	getAutoLinkToProperty () const
virtual Document	getDescription () const
virtual const std::string &	getDisplayName () const
Document &	getHelp ()
const Document &	getHelp () const
PropertyOwner *	getOwner ()
const PropertyOwner *	getOwner () const
const std::string &	getPath () const
	Get the property path as string.
void	getPath (std::pmr::string &out) const
virtual bool	getReadOnly () const
virtual PropertySemantics	getSemantics () const
virtual PropertySerializationMode	getSerializationMode () const
virtual bool	getVisible () const
const std::vector< PropertyWidget * > &	getWidgets () const
bool	hasWidgets () const
virtual bool	isModified () const
const BaseCallBack *	onChange (std::function< void()> callback)
std::shared_ptr< std::function< void()> >	onChangeScoped (std::function< void()> callback)
	Property (std::string_view identifier, std::string_view displayName, InvalidationLevel invalidationLevel, PropertySemantics semantics=PropertySemantics::Default)
	Property (std::string_view identifier="", std::string_view displayName="", Document help={}, InvalidationLevel invalidationLevel=InvalidationLevel::InvalidOutput, PropertySemantics semantics=PropertySemantics::Default, ReadOnly readOnly=ReadOnly::No)
virtual Property &	propertyModified ()
template<typename P, typename DecisionFunc>
Property &	readonlyDependsOn (P &prop, DecisionFunc callback)
void	registerWidget (PropertyWidget *propertyWidget)
void	removeOnChange (const BaseCallBack *callback)
virtual Property &	setDisplayName (std::string_view displayName)
	A property's name displayed to the user.
Property &	setHelp (Document help)
virtual Property &	setIdentifier (std::string_view identifier)
void	setInitiatingWidget (PropertyWidget *propertyWidget)
virtual Property &	setInvalidationLevel (InvalidationLevel invalidationLevel)
virtual Property &	setModified ()
virtual Property &	setSemantics (const PropertySemantics &semantics)
virtual Property &	setSerializationMode (PropertySerializationMode mode)
virtual Property &	setVisible (bool val)
void	updateWidgets ()
template<typename P, typename DecisionFunc>
Property &	visibilityDependsOn (P &prop, DecisionFunc callback)
virtual	~Property ()
	Removes itself from its PropertyOwner.
Public Member Functions inherited from inviwo::Observable< PropertyObserver >
void	addObserver (PropertyObserver *observer)
bool	isObservedBy (PropertyObserver *observer) const
Observable< PropertyObserver > &	operator= (const Observable< PropertyObserver > &other)
void	removeObserver (PropertyObserver *observer)
virtual void	startBlockingNotifications () override final
virtual void	stopBlockingNotifications () override final
Public Member Functions inherited from inviwo::MetaDataOwner
void	copyMetaDataFrom (const MetaDataOwner &src)
void	copyMetaDataTo (MetaDataOwner &dst)
template<typename T> requires std::derived_from<T, MetaData>
T *	createMetaData (std::string_view key)
void	deserialize (Deserializer &d)
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
template<typename T, typename U> requires std::derived_from<T, MetaData> && Gettable<T, U>
U	getMetaData (std::string_view key, U val) const
MetaDataMap *	getMetaDataMap ()
const MetaDataMap *	getMetaDataMap () const
template<typename T> requires std::derived_from<T, MetaData>
bool	hasMetaData (std::string_view key) const
bool	hasMetaData (std::string_view key) const
	MetaDataOwner (const MetaDataOwner &rhs)=default
	MetaDataOwner (MetaDataOwner &rhs)=default
MetaDataOwner &	operator= (const MetaDataOwner &rhs)=default
MetaDataOwner &	operator= (MetaDataOwner &)=default
void	serialize (Serializer &s) const
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
Public Member Functions inherited from inviwo::PropertyOwner
template<typename... Ts>
void	addProperties (Ts &... properties)
void	addProperty (Property &property)
void	addProperty (Property *property, bool owner=true)
Property *	addProperty (std::unique_ptr< Property > property)
iterator	begin ()
const_iterator	begin () const
const_iterator	cbegin () const
const_iterator	cend () const
virtual void	clear ()
	Remove all properties; Owned properties will be deleted.
bool	empty () const
iterator	end ()
const_iterator	end () const
const_iterator	find (Property *property) const
const std::vector< CompositeProperty * > &	getCompositeProperties () const
InvalidationLevel	getInvalidationLevel () const
const std::vector< Property * > &	getProperties () const
template<class T>
std::vector< T * >	getPropertiesByType (bool recursiveSearch=false) const
std::vector< Property * >	getPropertiesRecursive () const
std::vector< Property * > &	getPropertiesRecursive (std::vector< Property * > &destination) const
template<std::derived_from< Property > T = Property>
T *	getProperty (std::string_view identifier)
Property *	getPropertyByIdentifier (std::string_view identifier, bool recursiveSearch=false) const
Property *	getPropertyByPath (std::string_view path) const
void	insertProperty (size_t index, Property &property)
	insert property property at position index If index is not valid, the property is appended.
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.
Property *	insertProperty (size_t index, std::unique_ptr< Property > property)
	insert property property at position index If index is not valid, the property is appended.
virtual bool	isValid () const
virtual bool	move (Property *property, size_t newIndex)
PropertyOwner &	operator= (const PropertyOwner &that)=delete
Property *	operator[] (size_t)
const Property *	operator[] (size_t) const
virtual Property *	removeProperty (iterator it)
Property *	removeProperty (Property &property)
Property *	removeProperty (Property *property)
Property *	removeProperty (size_t index)
	remove property referred to by index
Property *	removeProperty (std::string_view identifier)
virtual void	resetAllProperties ()
virtual void	setAllPropertiesCurrentStateAsDefault ()
size_t	size () const
virtual	~PropertyOwner ()
	Removes all properties and notifies its observers of the removal.
Public Member Functions inherited from inviwo::PropertyOwnerObservable
void	notifyObserversDidAddProperty (Property *property, size_t index)
void	notifyObserversDidRemoveProperty (PropertyOwner *owner, Property *property, size_t index)
void	notifyObserversWillAddProperty (PropertyOwner *owner, Property *property, size_t index)
void	notifyObserversWillRemoveProperty (Property *property, size_t index)
Public Member Functions inherited from inviwo::Observable< PropertyOwnerObserver >
void	addObserver (PropertyOwnerObserver *observer)
bool	isObservedBy (PropertyOwnerObserver *observer) const
Observable< PropertyOwnerObserver > &	operator= (const Observable< PropertyOwnerObserver > &other)
void	removeObserver (PropertyOwnerObserver *observer)
virtual void	startBlockingNotifications () override final
virtual void	stopBlockingNotifications () override final
Public Member Functions inherited from inviwo::Observable< CompositePropertyObserver >
void	addObserver (CompositePropertyObserver *observer)
bool	isObservedBy (CompositePropertyObserver *observer) const
Observable< CompositePropertyObserver > &	operator= (const Observable< CompositePropertyObserver > &other)
void	removeObserver (CompositePropertyObserver *observer)
virtual void	startBlockingNotifications () override final
virtual void	stopBlockingNotifications () override final

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

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
void	animate ()
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
const vec3	getWorldUp () const
vec3	mapNormalizedMousePosToTrackball (const vec2 &mousePos, float radius=1.0f)
void	moveBackward (Event *event)
void	moveDown (Event *event)
void	moveForward (Event *event)
void	moveLeft (Event *event)
void	moveRight (Event *event)
void	moveUp (Event *event)
void	pan (MouseEvent *event)
void	panDown (Event *event)
void	panLeft (Event *event)
void	panRight (Event *event)
void	panUp (Event *event)
mat4	pitch (float radians) const
void	recenterFocusPoint (Event *event)
void	reset (Event *event)
mat4	roll (float radians) const
void	rotate (MouseEvent *event)
void	rotateArc (MouseEvent *event, bool followObjectDuringRotation=false)
void	rotateDown (Event *event)
void	rotateFPS (MouseEvent *event)
void	rotateLeft (Event *event)
void	rotateRight (Event *event)
void	rotateTAV (MouseEvent *event)
void	rotateTrackBall (const vec3 &fromTrackballPos, const vec3 &toTrackballPos)
void	rotateUp (Event *event)
void	stepPan (Direction dir)
void	stepRotate (Direction dir)
void	stepZoom (Direction dir, int numSteps=1)
void	touchGesture (Event *event)
	Rotates around the direction vector, zooms along the direction vector and translates along up/right vector.
mat4	yaw (float radians) const
void	zoom (MouseEvent *event)
void	zoomIn (Event *event, int numSteps=1)
void	zoomOut (Event *event, int numSteps=1)
void	zoomWheel (WheelEvent *event)
Protected Member Functions inherited from inviwo::Property
void	notifyAboutChange ()
Property &	operator= (const Property &that)=delete
Property &	operator= (Property &&that)
	Property (const Property &rhs)
	Property (Property &&rhs)
Protected Member Functions inherited from inviwo::PropertyObservable
void	notifyObserversOnSetDisplayName (Property *property, const std::string &displayName)
void	notifyObserversOnSetIdentifier (Property *property, const std::string &identifier)
void	notifyObserversOnSetReadOnly (Property *property, bool readonly)
void	notifyObserversOnSetSemantics (Property *property, const PropertySemantics &semantics)
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)
virtual void	addObserver (Observer *observer)=0
void	removeObservationHelper (Observer *observer)
virtual void	removeObserver (Observer *observer)=0
Protected Member Functions inherited from inviwo::PropertyOwner
void	forEachProperty (std::function< void(Property &)> callback, bool recursiveSearch=false) const
PropertyOwner &	operator= (PropertyOwner &&that)
	PropertyOwner (const PropertyOwner &rhs)
	PropertyOwner (PropertyOwner &&rhs)
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
bool	evaluated_
bool	isMouseBeingPressedAndHold_
vec3	lastNDC_
glm::quat	lastRot_
std::chrono::system_clock::time_point	lastRotTime_
TrackballObject *	object_
vec3	pressNDC_
Timer	timer_
float	trackBallWorldSpaceRadius_
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< CompositeProperty * >	compositeProperties_
std::vector< EventProperty * >	eventProperties_
std::vector< std::unique_ptr< Property > >	ownedProperties_
std::vector< Property * >	properties_

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	const_iterator = std::vector<Property*>::const_iterator
using	iterator = std::vector<Property*>::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

event

TouchEvent

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:

• include/inviwo/core/interaction/trackball.h