inviwo::CameraProperty Class Reference

#include <cameraproperty.h>

Inheritance diagram for inviwo::CameraProperty:

Public Types
using	value_type = Camera
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

Public Member Functions
virtual std::string_view	getClassIdentifier () const override
	CameraProperty (std::string_view identifier, std::string_view displayName, Document help, 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 (std::string_view identifier, std::string_view 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 (std::string_view identifier, std::string_view 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
CameraProperty &	setCamera (std::string_view cameraIdentifier)
CameraProperty &	setCamera (std::unique_ptr< Camera > camera)
virtual vec3	getLookFrom () const override
virtual TrackballObject &	setLookFrom (vec3 lookFrom) override
virtual vec3	getLookTo () const override
virtual TrackballObject &	setLookTo (vec3 lookTo) override
virtual vec3	getLookUp () const override
virtual TrackballObject &	setLookUp (vec3 lookUp) override
vec3	getLookRight () const
CameraProperty &	setAspectRatio (float aspectRatio)
float	getAspectRatio () const
virtual TrackballObject &	setLook (vec3 lookFrom, vec3 lookTo, vec3 lookUp) override
virtual float	getNearPlaneDist () const override
virtual float	getFarPlaneDist () const override
CameraProperty &	setNearPlaneDist (float v)
CameraProperty &	setFarPlaneDist (float v)
CameraProperty &	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 void	zoom (const ZoomOptions &opts) override
virtual vec3	getWorldPosFromNormalizedDeviceCoords (const vec3 &ndcCoords) const override
	Convert from normalized device coordinates (xyz in [-1 1]) to world coordinates.
vec4	getClipPosFromNormalizedDeviceCoords (const vec3 &ndcCoords) const
	Convert from normalized device coordinates (xyz in [-1 1]) to clip coordinates.
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
Property *	getCameraProperty (const std::string &identifier) const
void	addCamerapProperty (std::unique_ptr< Property > camprop)
virtual CameraProperty &	setCurrentStateAsDefault () override
virtual CameraProperty &	resetToDefaultState () override
virtual bool	isDefaultState () const override
virtual bool	needsSerialization () const override
virtual void	serialize (Serializer &s) const override
virtual void	deserialize (Deserializer &d) override
void	fitData ()
void	setView (camerautil::Side side)
void	flipUp ()
void	setNearFar ()
void	setLookRange ()
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 CompositeProperty &	setCollapsed (bool value)
CompositeProperty &	setCollapsed (CollapseAction action, CollapseTarget target)
virtual void	setOwner (PropertyOwner *owner) override
void	set (const CompositeProperty *src)
virtual void	setValid () override
virtual InvalidationLevel	getInvalidationLevel () const 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 const PropertyOwner *	getOwner () const override
virtual PropertyOwner *	getOwner () override
virtual InviwoApplication *	getInviwoApplication () 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.
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 Property &	setIdentifier (std::string_view identifier)
const std::string &	getPath () const
	Get the property path as string.
void	getPath (std::pmr::string &out) const
virtual Property &	setDisplayName (std::string_view displayName)
	A property's name displayed to the user.
virtual const 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 ()
void	updateWidgets ()
bool	hasWidgets () const
virtual Property &	setSerializationMode (PropertySerializationMode mode)
virtual PropertySerializationMode	getSerializationMode () 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)
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)
const Document &	getHelp () const
Document &	getHelp ()
Property &	setHelp (Document help)
virtual Document	getDescription () const
template<typename P>
Property &	autoLinkToProperty (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
MetaDataOwner &	operator= (const MetaDataOwner &rhs)=default
MetaDataOwner &	operator= (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>
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
MetaDataMap *	getMetaDataMap ()
const MetaDataMap *	getMetaDataMap () 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 Property *	addProperty (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 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 Property *	removeProperty (std::string_view identifier)
virtual Property *	removeProperty (Property *property)
virtual Property *	removeProperty (Property &property)
virtual Property *	removeProperty (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
Property *	getPropertyByIdentifier (std::string_view identifier, bool recursiveSearch=false) const
Property *	getPropertyByPath (std::string_view path) const
template<class T>
std::vector< T * >	getPropertiesByType (bool recursiveSearch=false) const
bool	empty () const
size_t	size () const
Property *	operator[] (size_t)
const Property *	operator[] (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
FloatVec3RefProperty	lookFrom_
FloatVec3RefProperty	lookTo_
FloatVec3RefProperty	lookUp_
FloatRefProperty	aspectRatio_
FloatRefProperty	nearPlane_
FloatRefProperty	farPlane_

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

Additional Inherited Members
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	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)
PropertyOwner &	operator= (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_

Detailed Description

A property wrapping the Camera data structure

See also

Camera

Member Function Documentation

clone()

virtual 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.

deserialize()

virtual void inviwo::CameraProperty::deserialize ( Deserializer & d )

overridevirtual

Reimplemented from inviwo::CompositeProperty.

fitData()

void inviwo::CameraProperty::fitData

(

)

Fit the current bounding box into view, keeping the view direction If updateNearFar is set it will also adjust near and far. If updateLookRanges is set it will also adjust the range of look from

See also

camerautil::setCameraView

Precondition

There must be a bounding box set

flipUp()

void inviwo::CameraProperty::flipUp

(

)

Flip the direction of the up vector

getClassIdentifier()

virtual std::string_view inviwo::CameraProperty::getClassIdentifier ( ) const

overridevirtual

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

getFarPlaneDist()

virtual float inviwo::CameraProperty::getFarPlaneDist ( ) const

overridevirtual

Implements inviwo::TrackballObject.

getLookFrom()

virtual vec3 inviwo::CameraProperty::getLookFrom ( ) const

overridevirtual

Implements inviwo::TrackballObject.

getLookFromMaxValue()

virtual vec3 inviwo::CameraProperty::getLookFromMaxValue ( ) const

overridevirtual

Implements inviwo::TrackballObject.

getLookFromMinValue()

virtual vec3 inviwo::CameraProperty::getLookFromMinValue ( ) const

overridevirtual

Implements inviwo::TrackballObject.

getLookTo()

virtual vec3 inviwo::CameraProperty::getLookTo ( ) const

overridevirtual

Implements inviwo::TrackballObject.

getLookToMaxValue()

virtual vec3 inviwo::CameraProperty::getLookToMaxValue ( ) const

overridevirtual

Implements inviwo::TrackballObject.

getLookToMinValue()

virtual vec3 inviwo::CameraProperty::getLookToMinValue ( ) const

overridevirtual

Implements inviwo::TrackballObject.

getLookUp()

virtual vec3 inviwo::CameraProperty::getLookUp ( ) const

overridevirtual

Implements inviwo::TrackballObject.

getNearPlaneDist()

virtual float inviwo::CameraProperty::getNearPlaneDist ( ) const

overridevirtual

Implements inviwo::TrackballObject.

getNormalizedDeviceFromNormalizedScreenAtFocusPointDepth()

virtual vec3 inviwo::CameraProperty::getNormalizedDeviceFromNormalizedScreenAtFocusPointDepth ( const vec2 & normalizedScreenCoord ) const

overridevirtual

Implements inviwo::TrackballObject.

getWorldPosFromNormalizedDeviceCoords()

virtual 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.

invokeEvent()

void inviwo::CameraProperty::invokeEvent ( Event * event )

overridevirtual

Reimplemented from inviwo::PropertyOwner.

isDefaultState()

virtual bool inviwo::CameraProperty::isDefaultState ( ) const

overridevirtual

Check if the property is in it's default state, i.e. resetToDefaultState would do nothing

See also

setCurrentStateAsDefault

resetToDefaultState

Reimplemented from inviwo::CompositeProperty.

needsSerialization()

virtual bool inviwo::CameraProperty::needsSerialization ( ) const

overridevirtual

Determinate if the property should be included in the serialization Depends on the PropertySerializationMode and if the property is in the default state. If the mode is All it always return true, None always returns false, and default delegates to isDefaultState()

Reimplemented from inviwo::CompositeProperty.

resetToDefaultState()

virtual CameraProperty & inviwo::CameraProperty::resetToDefaultState ( )

overridevirtual

Reset the state of the property back to it's default value. It is important that all overriding properties make sure to call the base class implementation.

Reimplemented from inviwo::CompositeProperty.

serialize()

virtual void inviwo::CameraProperty::serialize ( Serializer & s ) const

overridevirtual

Reimplemented from inviwo::CompositeProperty.

set()

virtual 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.

setCurrentStateAsDefault()

virtual CameraProperty & inviwo::CameraProperty::setCurrentStateAsDefault ( )

overridevirtual

Save the current state of the property as the default. This state will then be used as a reference when serializing, only state different from the default will be serialized. This method should usually only be called once directly after construction in the processor constructor after setting property specific state. It is important that all overriding properties make sure to call the base class implementation.

Reimplemented from inviwo::CompositeProperty.

setLook()

virtual TrackballObject & 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.

setLookFrom()

virtual TrackballObject & inviwo::CameraProperty::setLookFrom ( vec3 lookFrom )

overridevirtual

Implements inviwo::TrackballObject.

setLookRange()

void inviwo::CameraProperty::setLookRange

(

)

Adjust the look from ranges for the current bounding box

Precondition

There must be a bounding box set

setLookTo()

virtual TrackballObject & inviwo::CameraProperty::setLookTo ( vec3 lookTo )

overridevirtual

Implements inviwo::TrackballObject.

setLookUp()

virtual TrackballObject & inviwo::CameraProperty::setLookUp ( vec3 lookUp )

overridevirtual

Implements inviwo::TrackballObject.

setNearFar()

void inviwo::CameraProperty::setNearFar

(

)

Adjust the near and far values for the current bounding box

Precondition

There must be a bounding box set

setNearFarPlaneDist()

CameraProperty & 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.

setView()

void inviwo::CameraProperty::setView

(

camerautil::Side

side

)

Fit the current bounding box into view and set the view direction to the specified side If updateNearFar is set it will also adjust near and far. If updateLookRanges is set it will also adjust the range of look from

See also

camerautil::setCameraView

Precondition

There must be a bounding box set

zoom()

virtual void inviwo::CameraProperty::zoom ( const ZoomOptions & opts )

overridevirtual

Implements inviwo::TrackballObject.

---

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

• cameraproperty.h