sofa::component::visual::Camera Class Reference

#include <Camera.h>

Inheritance diagram for sofa::component::visual::Camera:

Public Member Functions
	SOFA_CLASS (Camera, BaseCamera)
void	manageEvent (core::objectmodel::Event *e) override
Public Member Functions inherited from sofa::component::visual::BaseCamera
	SOFA_CLASS (BaseCamera, core::objectmodel::BaseObject)
	SOFA_ATTRIBUTE_REPLACED__TYPEMEMBER (Ray, sofa::type::Ray)
	SOFA_ATTRIBUTE_REPLACED__TYPEMEMBER (Vec2, sofa::type::Vec2)
	SOFA_ATTRIBUTE_REPLACED__TYPEMEMBER (Vec3, sofa::type::Vec3)
	SOFA_ATTRIBUTE_REPLACED__TYPEMEMBER (Vec4, sofa::type::Vec4)
	BaseCamera ()
	~BaseCamera () override
void	init () override
	Initialization method called at graph creation and modification, during top-down traversal. More...
void	reinit () override
	Update method called when variables used in precomputation are modified. More...
void	bwdInit () override
	Initialization method called at graph creation and modification, during bottom-up traversal. More...
void	activate ()
void	desactivate ()
bool	isActivated ()
bool	exportParametersInFile (const std::string &viewFilename)
bool	importParametersFromFile (const std::string &viewFilename)
void	translate (const type::Vec3 &t)
void	translateLookAt (const type::Vec3 &t)
void	rotate (const Quat &r)
void	moveCamera (const type::Vec3 &p, const Quat &q)
void	rotateCameraAroundPoint (Quat &rotation, const type::Vec3 &point)
virtual void	rotateWorldAroundPoint (Quat &rotation, const type::Vec3 &point, Quat orientationCam)
type::Vec3	screenToViewportPoint (const type::Vec3 &p) const
type::Vec3	screenToWorldPoint (const type::Vec3 &p)
type::Vec3	viewportToScreenPoint (const type::Vec3 &p) const
type::Vec3	viewportToWorldPoint (const type::Vec3 &p)
type::Vec3	worldToScreenPoint (const type::Vec3 &p)
type::Vec3	worldToViewportPoint (const type::Vec3 &p)
type::Ray	viewportPointToRay (const type::Vec3 &p)
type::Ray	screenPointToRay (const type::Vec3 &p)
type::Ray	toRay () const
type::Vec3	cameraToWorldCoordinates (const type::Vec3 &p)
type::Vec3	worldToCameraCoordinates (const type::Vec3 &p)
type::Vec3	cameraToWorldTransform (const type::Vec3 &v)
type::Vec3	worldToCameraTransform (const type::Vec3 &v)
type::Vec3	screenToWorldCoordinates (int x, int y)
type::Vec2	worldToScreenCoordinates (const type::Vec3 &p)
void	fitSphere (const type::Vec3 &center, SReal radius)
void	fitBoundingBox (const type::Vec3 &min, const type::Vec3 &max)
type::Vec3	getPosition ()
Quat	getOrientation ()
type::Vec3	getLookAt ()
double	getDistance ()
double	getFieldOfView ()
double	getHorizontalFieldOfView ()
unsigned int	getCameraType () const
void	setCameraType (unsigned int type)
void	setBoundingBox (const type::Vec3 &min, const type::Vec3 &max)
void	setViewport (unsigned int w, unsigned int h)
double	getZNear ()
double	getZFar ()
void	setView (const type::Vec3 &position, const Quat &orientation)
void	setDefaultView (const type::Vec3 &gravity=type::Vec3(0, -9.81, 0))
virtual void	getModelViewMatrix (double mat[16])
virtual void	getProjectionMatrix (double mat[16])
void	getOpenGLModelViewMatrix (double mat[16])
void	getOpenGLProjectionMatrix (double mat[16])
Quat	getOrientationFromLookAt (const type::Vec3 &pos, const type::Vec3 &lookat)
type::Vec3	getLookAtFromOrientation (const type::Vec3 &pos, const double &distance, const Quat &orientation)
type::Vec3	getPositionFromOrientation (const type::Vec3 &lookAt, const double &distance, const Quat &orientation)
virtual void	internalUpdate ()
void	handleEvent (sofa::core::objectmodel::Event *event) override
	Handle an event. More...
void	computeZ ()
virtual bool	isStereo ()
virtual void	setCurrentSide (Side)
virtual Side	getCurrentSide ()
virtual void	setStereoEnabled (bool)
virtual bool	getStereoEnabled ()
virtual void	setStereoMode (StereoMode)
virtual StereoMode	getStereoMode ()
virtual void	setStereoStrategy (StereoStrategy)
virtual StereoStrategy	getStereoStrategy ()
virtual void	setStereoShift (double)
virtual double	getStereoShift ()
void	draw (const core::visual::VisualParams *) override
	Render internal data of this object, for debugging purposes. More...
void	computeClippingPlane (const core::visual::VisualParams *vp, double &zNear, double &zFar)
virtual void	drawCamera (const core::visual::VisualParams *)
Public Member Functions inherited from sofa::core::objectmodel::BaseObject
	SOFA_CLASS (BaseObject, Base)
virtual void	computeBBox (const core::ExecParams *, bool=false)
void	setSrc (const std::string &v, std::vector< std::string > *attributeList=nullptr)
	Sets a source Object and parses it to collect dependent Data. More...
void	setSrc (const std::string &v, const BaseObject *loader, std::vector< std::string > *attributeList=nullptr)
Base *	findLinkDestClass (const BaseClass *destType, const std::string &path, const BaseLink *link) override
virtual std::string	getPathName () const override
	Return the full path name of this object. More...
virtual bool	insertInNode (BaseNode *)
virtual bool	removeInNode (BaseNode *)
SReal	getTime () const
	Current time. More...
const BaseContext *	getContext () const
BaseContext *	getContext ()
const BaseObject *	getMaster () const
BaseObject *	getMaster ()
const VecSlaves &	getSlaves () const
BaseObject *	getSlave (const std::string &name) const
virtual void	addSlave (BaseObject::SPtr s)
virtual void	removeSlave (BaseObject::SPtr s)
virtual void	handleTopologyChange ()
virtual void	handleTopologyChange (core::topology::Topology *t)
void	parse (BaseObjectDescription *arg) override
	Parse the given description to assign values to this object's fields and potentially other parameters. More...
void	updateInternal ()
	Update method called when variables (used to compute other internal variables) are modified. More...
virtual void	storeResetState ()
	Save the initial state for later uses in reset() More...
virtual void	reset ()
	Reset to initial state. More...
virtual void	cleanup ()
Public Member Functions inherited from sofa::core::objectmodel::Base
virtual const BaseClass *	getClass () const
void	addDeprecatedAttribute (lifecycle::DeprecatedData *attribute)
void	addUpdateCallback (const std::string &name, std::initializer_list< BaseData * > inputs, std::function< sofa::core::objectmodel::ComponentState(const DataTracker &)> function, std::initializer_list< BaseData * > outputs)
void	addOutputsToCallback (const std::string &name, std::initializer_list< BaseData * > outputs)
const std::string &	getName () const
	Accessor to the object name. More...
void	setName (const std::string &n)
	Set the name of this object. More...
void	setName (const std::string &n, int counter)
	Set the name of this object, adding an integer counter. More...
std::string	getTypeName () const
	Get the type name of this object (i.e. class and template types) More...
virtual std::string	getClassName () const
	Get the class name of this object. More...
virtual std::string	getTemplateName () const final
	Get the template type names (if any) used to instantiate this object. More...
std::string	getNameSpaceName () const
	Get the template type names (if any) used to instantiate this object. More...
void	setDefinitionSourceFileName (const std::string &sourceFileName)
	Set the source filename (where the component is implemented) More...
const std::string &	getDefinitionSourceFileName () const
	Get the source filename (where the component is implemented) More...
void	setDefinitionSourceFilePos (const int)
	Set the source location (where the component is implemented) More...
int	getDefinitionSourceFilePos () const
	Get the source location (where the component is implemented) More...
void	setInstanciationSourceFileName (const std::string &sourceFileName)
const std::string &	getInstanciationSourceFileName () const
void	setInstanciationSourceFilePos (const int)
int	getInstanciationSourceFilePos () const
void	addMessage (const sofa::helper::logging::Message &m) const
size_t	countLoggedMessages (sofa::helper::logging::Message::TypeSet t=sofa::helper::logging::Message::AnyTypes) const
const std::deque< sofa::helper::logging::Message > &	getLoggedMessages () const
const std::string	getLoggedMessagesAsString (sofa::helper::logging::Message::TypeSet t=sofa::helper::logging::Message::AnyTypes) const
void	clearLoggedMessages () const
bool	notMuted () const
const sofa::core::objectmodel::TagSet &	getTags () const
	Represents the subsets the object belongs to. More...
bool	hasTag (Tag t) const
	Return true if the object belong to the given subset. More...
void	addTag (Tag t)
	Add a subset qualification to the object. More...
void	removeTag (Tag t)
	Remove a subset qualification to the object. More...
ComponentState	getComponentState () const
bool	isComponentStateValid () const
virtual bool	parseField (const std::string &attribute, const std::string &value)
	Assign one field value (Data or Link) More...
virtual bool	hasField (const std::string &attribute) const
	Check if a given Data field or Link exists. More...
void	parseFields (const std::list< std::string > &str)
	Assign the field values stored in the given list of name + value pairs of strings. More...
virtual void	parseFields (const std::map< std::string, std::string * > &str)
	Assign the field values stored in the given map of name -> value pairs. More...
void	writeDatas (std::map< std::string, std::string * > &str)
	Write the current field values to the given map of name -> value pairs. More...
void	writeDatas (std::ostream &out, const std::string &separator=" ")
BaseData *	findData (const std::string &name) const
std::vector< BaseData * >	findGlobalField (const std::string &name) const
	Find data fields given a name: several can be found as we look into the alias map. More...
BaseLink *	findLink (const std::string &name) const
std::vector< BaseLink * >	findLinks (const std::string &name) const
	Find link fields given a name: several can be found as we look into the alias map. More...
virtual void	updateLinks (bool logErrors=true)
	Update pointers in case the pointed-to objects have appeared. More...
template<class T >
BaseData::BaseInitData	initData (::sofa::core::objectmodel::Data< T > *field, const char *name, const char *help, ::sofa::core::objectmodel::BaseData::DataFlags dataflags)
	Helper method used to initialize a data field containing a value of type T. More...
template<class T >
BaseData::BaseInitData	initData (Data< T > *field, const char *name, const char *help, bool isDisplayed=true, bool isReadOnly=false)
	Helper method used to initialize a data field containing a value of type T. More...
template<class T >
Data< T >::InitData	initData (Data< T > *field, const T &value, const char *name, const char *help, bool isDisplayed=true, bool isReadOnly=false)
	Helper method used to initialize a data field containing a value of type T. More...
void	addData (BaseData *f, const std::string &name)
void	addData (BaseData *f)
void	removeData (BaseData *f)
	Remove a data field. More...
void	addAlias (BaseData *field, const char *alias)
	Add an alias to a Data. More...
void	addLink (BaseLink *l)
	Add a link. More...
void	addAlias (BaseLink *link, const char *alias)
	Add an alias to a Link. More...
const VecData &	getDataFields () const
	Accessor to the vector containing all the fields of this object. More...
const MapData &	getDataAliases () const
	Accessor to the map containing all the aliases of this object. More...
const VecLink &	getLinks () const
	Accessor to the vector containing all the fields of this object. More...
const MapLink &	getLinkAliases () const
	Accessor to the map containing all the aliases of this object. More...
virtual bool	findDataLinkDest (BaseData *&ptr, const std::string &path, const BaseLink *link)
template<class T >
bool	findLinkDest (T *&ptr, const std::string &path, const BaseLink *link)

Protected Member Functions
	Camera ()
	~Camera () override
Protected Member Functions inherited from sofa::component::visual::BaseCamera
void	updateOutputData ()
Protected Member Functions inherited from sofa::core::objectmodel::BaseObject
	BaseObject ()
	~BaseObject () override
virtual void	doUpdateInternal ()
	Implementation of the internal update. More...
void	changeContextLink (BaseContext *before, BaseContext *&after)
void	changeSlavesLink (BaseObject::SPtr ptr, std::size_t, bool add)
	This method insures that slaves objects have master and context links set correctly. More...
void	trackInternalData (const BaseData &data)
	Method called to add the Data to the DataTracker (listing the Data to track) More...
void	cleanTracker ()
bool	hasDataChanged (const BaseData &data)
	Method called to know if a tracked Data has changed. More...
Protected Member Functions inherited from sofa::core::objectmodel::Base
	Base ()
virtual	~Base ()
void	initData0 (BaseData *field, BaseData::BaseInitData &res, const char *name, const char *help, bool isDisplayed=true, bool isReadOnly=false)
	Helper method used by initData() More...
void	initData0 (BaseData *field, BaseData::BaseInitData &res, const char *name, const char *help, BaseData::DataFlags dataFlags)
	Helper method used by initData() More...
template<class T >
void	initData0 (Data< T > *field, typename Data< T >::InitData &res, const T &value, const char *name, const char *help, bool isDisplayed=true, bool isReadOnly=false)
	Helper method used by initData() More...

Additional Inherited Members
Public Attributes inherited from sofa::component::visual::BaseCamera
sofa::core::objectmodel::RenamedData< type::Vec3 >	p_position
sofa::core::objectmodel::RenamedData< Quat >	p_orientation
sofa::core::objectmodel::RenamedData< type::Vec3 >	p_lookAt
sofa::core::objectmodel::RenamedData< double >	p_distance
sofa::core::objectmodel::RenamedData< double >	p_fieldOfView
sofa::core::objectmodel::RenamedData< double >	p_zNear
sofa::core::objectmodel::RenamedData< double >	p_zFar
sofa::core::objectmodel::RenamedData< bool >	p_computeZClip
sofa::core::objectmodel::RenamedData< type::Vec3 >	p_minBBox
sofa::core::objectmodel::RenamedData< type::Vec3 >	p_maxBBox
sofa::core::objectmodel::RenamedData< unsigned int >	p_widthViewport
sofa::core::objectmodel::RenamedData< unsigned int >	p_heightViewport
sofa::core::objectmodel::RenamedData< sofa::helper::OptionsGroup >	p_type
sofa::core::objectmodel::RenamedData< bool >	p_activated
sofa::core::objectmodel::RenamedData< bool >	p_fixedLookAtPoint
sofa::core::objectmodel::RenamedData< type::vector< SReal > >	p_modelViewMatrix
sofa::core::objectmodel::RenamedData< type::vector< SReal > >	p_projectionMatrix
Data< type::Vec3 >	d_position
	Camera's position. More...
Data< Quat >	d_orientation
	Camera's orientation. More...
Data< type::Vec3 >	d_lookAt
	Camera's look at. More...
Data< double >	d_distance
	Distance between camera and look at. More...
Data< double >	d_fieldOfView
	Camera's FOV. More...
Data< double >	d_zNear
	Camera's zNear. More...
Data< double >	d_zFar
	Camera's zFar. More...
Data< bool >	d_computeZClip
	Compute Z clip planes (Near and Far) according to the bounding box. More...
Data< type::Vec3 >	d_minBBox
	minBBox More...
Data< type::Vec3 >	d_maxBBox
	maxBBox More...
Data< unsigned int >	d_widthViewport
	widthViewport More...
Data< unsigned int >	d_heightViewport
	heightViewport More...
Data< sofa::helper::OptionsGroup >	d_type
	Camera Type (0 = Perspective, 1 = Orthographic) More...
Data< bool >	d_activated
	Camera activated ? More...
Data< bool >	d_fixedLookAtPoint
	keep the lookAt point always fixed More...
Data< type::vector< SReal > >	d_modelViewMatrix
	ModelView Matrix. More...
Data< type::vector< SReal > >	d_projectionMatrix
	Projection Matrix. More...
Public Attributes inherited from sofa::core::objectmodel::BaseObject
Data< bool >	f_listening
	if true, handle the events, otherwise ignore the events More...
Public Attributes inherited from sofa::core::objectmodel::Base
std::vector< lifecycle::DeprecatedData * >	m_oldAttributes
Data< int >	d_messageLogCount
Data< std::string >	name
	Name of the object. More...
Data< bool >	f_printLog
	if true, emits extra messages at runtime. More...
Data< sofa::core::objectmodel::TagSet >	f_tags
	list of the subsets the object belongs to More...
Data< sofa::type::BoundingBox >	f_bbox
	this object bounding box More...
Data< sofa::core::objectmodel::ComponentState >	d_componentState
	The state of the component among (Dirty, Valid, Undefined, Loading, Invalid). More...
std::string	m_definitionSourceFileName {""}
int	m_definitionSourceFilePos {-1}
std::string	m_instanciationSourceFileName {""}
int	m_instanciationSourceFilePos {-1}
Protected Attributes inherited from sofa::component::visual::BaseCamera
type::Vec3	sceneCenter
SReal	sceneRadius
bool	b_setDefaultParameters
type::Vec3	currentLookAt
double	currentDistance
double	currentZNear
double	currentZFar
Protected Attributes inherited from sofa::core::objectmodel::BaseObject
SingleLink< BaseObject, BaseContext, BaseLink::FLAG_DOUBLELINK >	l_context
LinkSlaves	l_slaves
SingleLink< BaseObject, BaseObject, BaseLink::FLAG_DOUBLELINK >	l_master
Protected Attributes inherited from sofa::core::objectmodel::Base
std::map< std::string, sofa::core::DataTrackerCallback >	m_internalEngine
VecData	m_vecData
	List of fields (Data instances) More...
MapData	m_aliasData
	name -> Data multi-map (includes names and aliases) More...
VecLink	m_vecLink
	List of links. More...
MapLink	m_aliasLink
	name -> Link multi-map (includes names and aliases) More...
Static Public Member Functions inherited from sofa::core::objectmodel::BaseObject
template<class T >
static bool	canCreate (T *, BaseContext *, BaseObjectDescription *)
	Pre-construction check method called by ObjectFactory. More...
template<class T >
static T::SPtr	create (T *, BaseContext *context, BaseObjectDescription *arg)
	Construction method called by ObjectFactory. More...
Static Public Member Functions inherited from sofa::core::objectmodel::Base
static const BaseClass *	GetClass ()
template<class T >
static std::string	shortName (const T *ptr=nullptr, BaseObjectDescription *=nullptr)

Constructor details

Camera()

sofa::component::visual::Camera::Camera ( )

protected

~Camera()

sofa::component::visual::Camera::~Camera ( )

overrideprotected

Function details

manageEvent()

void sofa::component::visual::Camera::manageEvent ( core::objectmodel::Event *  e )

inlineoverridevirtual

Implements sofa::component::visual::BaseCamera.

SOFA_CLASS()

sofa::component::visual::Camera::SOFA_CLASS	(	Camera	,
		BaseCamera
	)