SOFA API  9e8e531f
Open source framework for multi-physics simuation
sofa::component::visual::InteractiveCamera Class Reference

#include <InteractiveCamera.h>

Inheritance diagram for sofa::component::visual::InteractiveCamera:

Public Attributes

Data< double > p_zoomSpeed
 Zoom Speed. More...
 
Data< double > p_panSpeed
 Pan Speed. More...
 
Data< int > p_pivot
 Pivot (0 => Camera lookAt, 1 => Camera position, 2 => Scene center, 3 => World center. More...
 
- Public Attributes inherited from sofa::component::visual::BaseCamera
Data< type::Vec3p_position
 Camera's position. More...
 
Data< Quatp_orientation
 Camera's orientation. More...
 
Data< type::Vec3p_lookAt
 Camera's look at. More...
 
Data< double > p_distance
 Distance between camera and look at. More...
 
Data< double > p_fieldOfView
 Camera's FOV. More...
 
Data< double > p_zNear
 Camera's zNear. More...
 
Data< double > p_zFar
 Camera's zFar. More...
 
Data< boolp_computeZClip
 Compute Z clip planes (Near and Far) according to the bounding box. More...
 
Data< type::Vec3p_minBBox
 minBBox More...
 
Data< type::Vec3p_maxBBox
 maxBBox More...
 
Data< unsigned int > p_widthViewport
 widthViewport More...
 
Data< unsigned int > p_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< type::vector< SReal > > p_modelViewMatrix
 ModelView Matrix. More...
 
Data< type::vector< SReal > > p_projectionMatrix
 Projection Matrix. More...
 
- 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
std::vector< lifecycle::DeprecatedData * > m_oldAttributes
 
Data< int > d_messageLogCount
 
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::type::BoundingBoxf_bbox
 this object bounding box More...
 
Data< sofa::core::objectmodel::ComponentStated_componentState
 the object state More...
 
std::string m_definitionSourceFileName {""}
 
int m_definitionSourceFilePos {-1}
 
std::string m_instanciationSourceFileName {""}
 
int m_instanciationSourceFilePos {-1}
 

Public Member Functions

 SOFA_CLASS (InteractiveCamera, BaseCamera)
 
- 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)
 
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)
 
BasefindLinkDestClass (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 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 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::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 (::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 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

 InteractiveCamera ()
 
 ~InteractiveCamera () override
 
void moveCamera (int x, int y)
 
void manageEvent (core::objectmodel::Event *e) override
 
void processMouseEvent (core::objectmodel::MouseEvent *me)
 
void processKeyPressedEvent (core::objectmodel::KeypressedEvent *kpe)
 
void processKeyReleasedEvent (core::objectmodel::KeyreleasedEvent *kre)
 
- 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

- 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_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 std::string shortName (const T *ptr=nullptr, BaseObjectDescription *=nullptr)
 

Attribute details

◆ p_panSpeed

Data<double> sofa::component::visual::InteractiveCamera::p_panSpeed

Pan Speed.

◆ p_pivot

Data<int> sofa::component::visual::InteractiveCamera::p_pivot

Pivot (0 => Camera lookAt, 1 => Camera position, 2 => Scene center, 3 => World center.

◆ p_zoomSpeed

Data<double> sofa::component::visual::InteractiveCamera::p_zoomSpeed

Zoom Speed.

Constructor details

◆ InteractiveCamera()

sofa::component::visual::InteractiveCamera::InteractiveCamera ( )
protected

◆ ~InteractiveCamera()

sofa::component::visual::InteractiveCamera::~InteractiveCamera ( )
overrideprotected

Function details

◆ manageEvent()

void sofa::component::visual::InteractiveCamera::manageEvent ( core::objectmodel::Event e)
overrideprotectedvirtual

◆ moveCamera()

void sofa::component::visual::InteractiveCamera::moveCamera ( int  x,
int  y 
)
protected

◆ processKeyPressedEvent()

void sofa::component::visual::InteractiveCamera::processKeyPressedEvent ( core::objectmodel::KeypressedEvent kpe)
protected

◆ processKeyReleasedEvent()

void sofa::component::visual::InteractiveCamera::processKeyReleasedEvent ( core::objectmodel::KeyreleasedEvent kre)
protected

◆ processMouseEvent()

void sofa::component::visual::InteractiveCamera::processMouseEvent ( core::objectmodel::MouseEvent me)
protected

◆ SOFA_CLASS()

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

Enum details

◆ anonymous enum

anonymous enum
Enumerator
TRACKBALL_MODE 
PAN_MODE 
ZOOM_MODE 
WHEEL_ZOOM_MODE 
NONE_MODE 

◆ anonymous enum

anonymous enum
Enumerator
CAMERA_LOOKAT_PIVOT 
CAMERA_POSITION_PIVOT 
SCENE_CENTER_PIVOT 
WORLD_CENTER_PIVOT