#include <cameraproperty.h>

Inheritance diagram for inviwo::CameraProperty:

Public Member Functions
virtual std::string	getClassIdentifier () const override

	CameraProperty (const std::string &identifier, const std::string &displayName, std::function< std::optional< mat4 >()> getBoundingBox, vec3 eye=vec3(0.0f, 0.0f, 2.0f), vec3 center=vec3(0.0f), vec3 lookUp=vec3(0.0f, 1.0f, 0.0f), InvalidationLevel invalidationLevel=InvalidationLevel::InvalidResources, PropertySemantics semantics=PropertySemantics::Default)

	CameraProperty (const std::string &identifier, const std::string &displayName, vec3 eye=vec3(0.0f, 0.0f, 2.0f), vec3 center=vec3(0.0f), vec3 lookUp=vec3(0.0f, 1.0f, 0.0f), Inport *inport=nullptr, InvalidationLevel invalidationLevel=InvalidationLevel::InvalidResources, PropertySemantics semantics=PropertySemantics::Default)

	CameraProperty (const CameraProperty &rhs)

	operator const Camera & () const

virtual CameraProperty *	clone () const override

virtual Camera &	get ()

virtual const Camera &	get () const

virtual void	set (const Property *srcProperty) override

void	resetCamera ()

virtual const vec3 &	getLookFrom () const override

virtual void	setLookFrom (vec3 lookFrom) override

virtual const vec3 &	getLookTo () const override

virtual void	setLookTo (vec3 lookTo) override

virtual const vec3 &	getLookUp () const override

virtual void	setLookUp (vec3 lookUp) override

vec3	getLookRight () const

void	setAspectRatio (float aspectRatio)

float	getAspectRatio () const

virtual void	setLook (vec3 lookFrom, vec3 lookTo, vec3 lookUp) override

virtual float	getNearPlaneDist () const override

virtual float	getFarPlaneDist () const override

void	setNearPlaneDist (float v)

void	setFarPlaneDist (float v)

void	setNearFarPlaneDist (float nearPlaneDist, float farPlaneDist, float minMaxRatio=10.f)

virtual vec3	getLookFromMinValue () const override

virtual vec3	getLookFromMaxValue () const override

virtual vec3	getLookToMinValue () const override

virtual vec3	getLookToMaxValue () const override

virtual vec3	getWorldPosFromNormalizedDeviceCoords (const vec3 &ndcCoords) const override
	Convert from normalized device coordinates (xyz in [-1 1]) to world coordinates. More...

vec4	getClipPosFromNormalizedDeviceCoords (const vec3 &ndcCoords) const
	Convert from normalized device coordinates (xyz in [-1 1]) to clip coordinates. More...

virtual vec3	getNormalizedDeviceFromNormalizedScreenAtFocusPointDepth (const vec2 &normalizedScreenCoord) const override

const mat4 &	viewMatrix () const

const mat4 &	projectionMatrix () const

const mat4 &	inverseViewMatrix () const

const mat4 &	inverseProjectionMatrix () const

void	invokeEvent (Event *event) override

Public Member Functions inherited from inviwo::CompositeProperty
	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

void	set (const CompositeProperty *src)

virtual void	setValid () override

virtual InvalidationLevel	getInvalidationLevel () const override

virtual CompositeProperty &	setCurrentStateAsDefault () override

virtual CompositeProperty &	resetToDefaultState () override

virtual CompositeProperty &	setReadOnly (bool value) override
	Enable or disable editing of property.

virtual void	invalidate (InvalidationLevel invalidationLevel, Property *modifiedProperty=0) override

virtual Processor *	getProcessor () override

virtual const Processor *	getProcessor () 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 Property &	setIdentifier (const std::string &identifier)

virtual std::string	getIdentifier () const

virtual Property &	setDisplayName (const std::string &displayName)
	A property's name displayed to the user.

virtual std::string	getDisplayName () const

virtual Property &	setSemantics (const PropertySemantics &semantics)

virtual PropertySemantics	getSemantics () const

virtual bool	getReadOnly () const

virtual Property &	setInvalidationLevel (InvalidationLevel invalidationLevel)

PropertyOwner *	getOwner ()

const PropertyOwner *	getOwner () 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 Property &	propertyModified ()

virtual Property &	setModified ()

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 Property &	setUsageMode (UsageMode usageMode)

virtual UsageMode	getUsageMode () const

virtual void	setSerializationMode (PropertySerializationMode mode)

virtual PropertySerializationMode	getSerializationMode () const

virtual Property &	setVisible (bool val)

virtual bool	getVisible () const

template<typename P , typename DecisionFunc >
Property &	visibilityDependsOn (P &prop, DecisionFunc callback)

template<typename P , typename DecisionFunc >
Property &	readonlyDependsOn (P &prop, DecisionFunc callback)

virtual Document	getDescription () const

template<typename P >
Property &	autoLinkToProperty (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

MetaDataOwner &	operator= (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 >
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

MetaDataMap *	getMetaDataMap ()

const MetaDataMap *	getMetaDataMap () 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 Property *	removeProperty (const std::string &identifier)

virtual Property *	removeProperty (Property *property)

virtual Property *	removeProperty (Property &property)

virtual Property *	removeProperty (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

Property *	getPropertyByIdentifier (const std::string &identifier, bool recursiveSearch=false) const

Property *	getPropertyByPath (const std::vector< std::string > &path) const

template<class T >
std::vector< T * >	getPropertiesByType (bool recursiveSearch=false) const

size_t	size () const

Property *	operator[] (size_t)

const Property *	operator[] (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 InviwoApplication *	getInviwoApplication ()

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

Public Attributes
OptionPropertyString	cameraType_

ButtonGroupProperty	cameraActions_

FloatVec3Property	lookFrom_

FloatVec3Property	lookTo_

FloatVec3Property	lookUp_

FloatProperty	aspectRatio_

FloatProperty	nearPlane_

FloatProperty	farPlane_

Static Public Attributes
static const std::string	classIdentifier = "org.inviwo.CameraProperty"

Static Public Attributes inherited from inviwo::CompositeProperty
static const std::string	classIdentifier = "org.inviwo.CompositeProperty"

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)

Protected Member Functions inherited from inviwo::Property
	Property (const Property &rhs)

Property &	operator= (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)

PropertyOwner &	operator= (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 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

A property wrapping the Camera data structure

See also: Camera

Member Function Documentation

◆ clone()

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

◆ getClipPosFromNormalizedDeviceCoords()

vec4 inviwo::CameraProperty::getClipPosFromNormalizedDeviceCoords ( const vec3 & ndcCoords ) const

Convert from normalized device coordinates (xyz in [-1 1]) to clip coordinates.

Parameters

ndcCoords xyz clip-coordinates in [-1 1]^3, and the clip w-coordinate used for perspective division.

Returns: Clip space position

◆ getWorldPosFromNormalizedDeviceCoords()

vec3 inviwo::CameraProperty::getWorldPosFromNormalizedDeviceCoords ( const vec3 & ndcCoords ) const

overridevirtual

Convert from normalized device coordinates (xyz in [-1 1]) to world coordinates.

Parameters

ndcCoords Coordinates in [-1 1]

Returns: World space position

Implements inviwo::TrackballObject.

◆ resetCamera()

void inviwo::CameraProperty::resetCamera ( )

Reset camera position, direction to default state.

◆ set()

void inviwo::CameraProperty::set ( const Property * src )

overridevirtual

Set the value of this to that of src. The "value" is in this case considered to be for example the string in a StringProperty or the float value in a FloatProperty. But not things like the identifier of display name.

Reimplemented from inviwo::CompositeProperty.

◆ setLook()

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

overridevirtual

Sets given camera properties while respecting their min/max ranges. Locks and unlocks processor network before and after changing property values.

Note: Parameters will be capped by their min/max.

Implements inviwo::TrackballObject.

◆ setNearFarPlaneDist()

void inviwo::CameraProperty::setNearFarPlaneDist	(	float	nearPlaneDist,
		float	farPlaneDist,
		float	minMaxRatio = `10.f`
	)

Set near and far plane distance values and adjust their min/max ranges. Adjusts the min/max ranges of the properties to e.g. 0.1/10 times the given value. Locks and unlocks processor network before and after changing property values.

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

cameraproperty.h
cameraproperty.cpp

Public Member Functions

Public Attributes

Static Public Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ clone()

◆ getClipPosFromNormalizedDeviceCoords()

◆ getWorldPosFromNormalizedDeviceCoords()

◆ resetCamera()

◆ set()

◆ setLook()

◆ setNearFarPlaneDist()