SOFA API  99934cbc
Open source framework for multi-physics simuation
sofa::component::visualmodel::Camera Class Reference

#include <Camera.h>

Inheritance diagram for sofa::component::visualmodel::Camera:

Public Member Functions

 SOFA_CLASS (Camera, BaseCamera)
 
void manageEvent (core::objectmodel::Event *e) override
 
- Public Member Functions inherited from sofa::component::visualmodel::BaseCamera
 SOFA_CLASS (BaseCamera, core::objectmodel::BaseObject)
 
 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 Vec3 &t)
 
void translateLookAt (const Vec3 &t)
 
void rotate (const Quat &r)
 
void moveCamera (const Vec3 &p, const Quat &q)
 
void rotateCameraAroundPoint (Quat &rotation, const Vec3 &point)
 
virtual void rotateWorldAroundPoint (Quat &rotation, const Vec3 &point, Quat orientationCam)
 
Vec3 screenToViewportPoint (const Vec3 &p) const
 
Vec3 screenToWorldPoint (const Vec3 &p)
 
Vec3 viewportToScreenPoint (const Vec3 &p) const
 
Vec3 viewportToWorldPoint (const Vec3 &p)
 
Vec3 worldToScreenPoint (const Vec3 &p)
 
Vec3 worldToViewportPoint (const Vec3 &p)
 
Ray viewportPointToRay (const Vec3 &p)
 
Ray screenPointToRay (const Vec3 &p)
 
Ray toRay () const
 
Vec3 cameraToWorldCoordinates (const Vec3 &p)
 
Vec3 worldToCameraCoordinates (const Vec3 &p)
 
Vec3 cameraToWorldTransform (const Vec3 &v)
 
Vec3 worldToCameraTransform (const Vec3 &v)
 
Vec3 screenToWorldCoordinates (int x, int y)
 
Vec2 worldToScreenCoordinates (const Vec3 &p)
 
void fitSphere (const Vec3 &center, SReal radius)
 
void fitBoundingBox (const Vec3 &min, const Vec3 &max)
 
Vec3 getPosition ()
 
Quat getOrientation ()
 
Vec3 getLookAt ()
 
double getDistance ()
 
double getFieldOfView ()
 
double getHorizontalFieldOfView ()
 
unsigned int getCameraType () const
 
void setCameraType (unsigned int type)
 
void setBoundingBox (const Vec3 &min, const Vec3 &max)
 
void setViewport (unsigned int w, unsigned int h)
 
double getZNear ()
 
double getZFar ()
 
void setView (const Vec3 &position, const Quat &orientation)
 
void setDefaultView (const Vec3 &gravity=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 Vec3 &pos, const Vec3 &lookat)
 
Vec3 getLookAtFromOrientation (const Vec3 &pos, const double &distance, const Quat &orientation)
 
Vec3 getPositionFromOrientation (const 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)
 
void * 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 *)
 
template<class T >
T::SPtr searchLocal () const
 Local search of an object of the given type. More...
 
template<class T >
T::SPtr searchUp () const
 Upward search of an object of the given type, starting from the local context. More...
 
template<class T >
T::SPtr searchDown () const
 Downward search of an object of the given type, starting from the local context. More...
 
template<class T >
T::SPtr searchFromRoot () const
 
template<class T >
T::SPtr searchInParents () const
 
template<class T >
helper::vector< typename T::SPtr > searchAllLocal () const
 Local search of all objects of the given type. More...
 
template<class T >
helper::vector< typename T::SPtr > searchAllUp () const
 Upward search of all objects of the given type, starting from the local context. More...
 
template<class T >
helper::vector< typename T::SPtr > searchAllDown () const
 Downward search of all objects of the given type, starting from the local context. More...
 
template<class T >
helper::vector< typename T::SPtr > searchAllFromRoot () const
 Search of all objects of the given type, starting from the root. More...
 
template<class T >
helper::vector< typename T::SPtr > searchAllInParents () const
 
template<class T >
helper::vector< typename T::SPtr > searchAllLocal (const Tag &t) const
 Local search of all objects of the given type with a given Tag. More...
 
template<class T >
helper::vector< typename T::SPtr > searchAllUp (const Tag &t) const
 Upward search of all objects of the given type with a given Tag, starting from the local context. More...
 
template<class T >
helper::vector< typename T::SPtr > searchAllDown (const Tag &t) const
 Downward search of all objects of the given typee with a given Tag, starting from the local context. More...
 
template<class T >
helper::vector< typename T::SPtr > searchAllFromRoot (const Tag &t) const
 Search of all objects of the given typee with a given Tag, starting from the root. More...
 
template<class T >
helper::vector< typename T::SPtr > searchAllInParents (const Tag &t) const
 
template<class T >
helper::vector< typename T::SPtr > searchAllLocal (const TagSet &t) const
 Local search of all objects of the given type with a given TagSet. More...
 
template<class T >
helper::vector< typename T::SPtr > searchAllUp (const TagSet &t) const
 Upward search of all objects of the given type with a given TagSet, starting from the local context. More...
 
template<class T >
helper::vector< typename T::SPtr > searchAllDown (const TagSet &t) const
 Downward search of all objects of the given typee with a given TagSet, starting from the local context. More...
 
template<class T >
helper::vector< typename T::SPtr > searchAllFromRoot (const TagSet &t) const
 Search of all objects of the given typee with a given TagSet, starting from the root. More...
 
template<class T >
helper::vector< typename T::SPtr > searchAllInParents (const TagSet &t) const
 
SReal getTime () const
 Current time. More...
 
const BaseContextgetContext () const
 
BaseContextgetContext ()
 
const BaseObjectgetMaster () const
 
BaseObjectgetMaster ()
 
const VecSlavesgetSlaves () const
 
BaseObjectgetSlave (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 BaseClassgetClass () const
 
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...
 
virtual 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
 Get the template type names (if any) used to instantiate this object. More...
 
virtual 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
 
const std::string getWarnings () const
 
const std::string getOutputs () const
 use getLoggedMessageAsString() or getLoggedMessage instead. More...
 
void clearWarnings ()
 use getLoggedMessageAsString() or getLoggedMessage instead. More...
 
void clearOutputs ()
 use clearLoggedMessages() instead More...
 
void processStream (std::ostream &out)
 use clearLoggedMessages() instead More...
 
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
 
bool IsInheritingFromBase ()
 
const sofa::core::objectmodel::TagSetgetTags () 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=" ")
 
BaseDatafindData (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...
 
BaseLinkfindLink (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 (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 VecDatagetDataFields () const
 Accessor to the vector containing all the fields of this object. More...
 
const MapDatagetDataAliases () const
 Accessor to the map containing all the aliases of this object. More...
 
const VecLinkgetLinks () const
 Accessor to the vector containing all the fields of this object. More...
 
const MapLinkgetLinkAliases () 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::visualmodel::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::visualmodel::BaseCamera
Data< Vec3p_position
 Camera's position. More...
 
Data< Quatp_orientation
 Camera's orientation. More...
 
Data< Vec3p_lookAt
 Camera's look at. More...
 
Data< doublep_distance
 Distance between camera and look at. More...
 
Data< doublep_fieldOfView
 Camera's FOV. More...
 
Data< doublep_zNear
 Camera's zNear. More...
 
Data< doublep_zFar
 Camera's zFar. More...
 
Data< boolp_computeZClip
 Compute Z clip planes (Near and Far) according to the bounding box. More...
 
Data< Vec3p_minBBox
 minBBox More...
 
Data< Vec3p_maxBBox
 maxBBox More...
 
Data< unsigned intp_widthViewport
 widthViewport More...
 
Data< unsigned intp_heightViewport
 heightViewport More...
 
Data< sofa::helper::OptionsGroupp_type
 Camera Type (0 = Perspective, 1 = Orthographic) More...
 
Data< boolp_activated
 Camera activated ? More...
 
Data< boolp_fixedLookAtPoint
 keep the lookAt point always fixed More...
 
Data< helper::vector< SReal > > p_modelViewMatrix
 ModelView Matrix. More...
 
Data< helper::vector< SReal > > p_projectionMatrix
 Projection Matrix. More...
 
SingleLink< BaseCamera, sofa::component::configurationsetting::BackgroundSetting, BaseLink::FLAG_STOREPATHl_background
 
- Public Attributes inherited from sofa::core::objectmodel::BaseObject
Data< boolf_listening
 if true, handle the events, otherwise ignore the events More...
 
- Public Attributes inherited from sofa::core::objectmodel::Base
helper::system::SofaOStream< helper::logging::Message::Warningserr
 
helper::system::SofaOStream< helper::logging::Message::Infosout
 
helper::system::SofaEndl< Basesendl
 runs the stream processing More...
 
Data< std::string > name
 Name of the object. More...
 
Data< boolf_printLog
 if true, emits extra messages at runtime. More...
 
Data< sofa::core::objectmodel::TagSetf_tags
 list of the subsets the objet belongs to More...
 
Data< sofa::defaulttype::BoundingBoxf_bbox
 this object bounding box More...
 
Data< sofa::core::objectmodel::ComponentStated_componentState
 the object state More...
 
DeprecatedAndRemoved m_componentstate
 
DeprecatedAndRemoved d_componentstate
 
std::string m_definitionSourceFileName {""}
 
int m_definitionSourceFilePos {-1}
 
std::string m_instanciationSourceFileName {""}
 
int m_instanciationSourceFilePos {-1}
 
- Protected Attributes inherited from sofa::component::visualmodel::BaseCamera
Vec3 sceneCenter
 
SReal sceneRadius
 
bool b_setDefaultParameters
 
Vec3 currentLookAt
 
double currentDistance
 
double currentZNear
 
double currentZFar
 
- Protected Attributes inherited from sofa::core::objectmodel::BaseObject
SingleLink< BaseObject, BaseContext, BaseLink::FLAG_DOUBLELINKl_context
 
LinkSlaves l_slaves
 
SingleLink< BaseObject, BaseObject, BaseLink::FLAG_DOUBLELINKl_master
 
- Protected Attributes inherited from sofa::core::objectmodel::Base
std::map< std::string, sofa::core::DataTrackerCallbackm_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 BaseClassGetClass ()
 
template<class T >
static void dynamicCast (T *&ptr, Base *b)
 
template<class T >
static std::string typeName (const T *ptr=nullptr)
 
template<class T >
static std::string className (const T *ptr=nullptr)
 
template<class T >
static std::string namespaceName (const T *ptr=nullptr)
 
template<class T >
static std::string templateName (const T *ptr=nullptr)
 
template<class T >
static std::string shortName (const T *ptr=nullptr, BaseObjectDescription *=nullptr)
 

Constructor details

sofa::component::visualmodel::Camera::Camera ( )
protected
sofa::component::visualmodel::Camera::~Camera ( )
overrideprotected

Function details

void sofa::component::visualmodel::Camera::manageEvent ( core::objectmodel::Event e)
inlineoverridevirtual
sofa::component::visualmodel::Camera::SOFA_CLASS ( Camera  ,
BaseCamera   
)