SOFA API  ea7f52a9
Open source framework for multi-physics simuation
sofa::core::visual::VisualModel Class Reference

#include <VisualModel.h>

An interface which all VisualModel inherit. More...

Inheritance diagram for sofa::core::visual::VisualModel:

Detailed Description

An interface which all VisualModel inherit.

This Interface is used for the VisualModel, which all visible objects must implement.

VisualModels are drawn by calling their draw method. The method update is used to recompute some internal data (such as normals) after the simulation has computed a new timestep.

Most VisualModel are bound by a Mapping to a BehaviorModel or MechanicalState.

Public Attributes

Data< boold_enable
 Display the object or not. 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 object belongs to More...
 
Data< sofa::type::BoundingBoxf_bbox
 this object bounding box More...
 
Data< sofa::core::objectmodel::ComponentStated_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}
 

Public Member Functions

 SOFA_ABSTRACT_CLASS (VisualModel, objectmodel::BaseObject)
 
virtual void drawVisual (const VisualParams *) final
 Display the VisualModel object. More...
 
void initVisual (const VisualParams *)
 Initialize the textures, or other graphical resources. More...
 
virtual void initVisual () final
 
void updateVisual (const VisualParams *)
 used to update the model if necessary. More...
 
virtual void updateVisual () final
 
virtual void clearVisual ()
 clear some graphical resources (generally called before the deleteVisitor). More...
 
virtual void fwdDraw (VisualParams *)
 Called before objects in the current branch are displayed. More...
 
virtual void bwdDraw (VisualParams *)
 Called after objects in the current branch are displayed. More...
 
virtual void drawTransparent (const VisualParams *)
 Display transparent surfaces. More...
 
virtual void drawShadow (const VisualParams *vparams)
 Display shadow-casting surfaces. More...
 
virtual void parallelUpdateVisual ()
 used to update the model if necessary. More...
 
virtual bool addBBox (SReal *, SReal *)
 used to add the bounding-box of this visual model to the given bounding box in order to compute the scene bounding box or cull hidden objects. More...
 
virtual void applyTranslation (const SReal, const SReal, const SReal)
 
virtual void applyRotation (const SReal, const SReal, const SReal)
 
virtual void applyRotation (const type::Quat< SReal >)
 
virtual void applyScale (const SReal, const SReal, const SReal)
 
virtual void exportOBJ (std::string, std::ostream *, std::ostream *, sofa::Index &, sofa::Index &, sofa::Index &, int &)
 Append this mesh to an OBJ format stream. More...
 
bool insertInNode (objectmodel::BaseNode *node) override
 
bool removeInNode (objectmodel::BaseNode *node) override
 
- Public Member Functions inherited from sofa::core::objectmodel::BaseObject
 SOFA_CLASS (BaseObject, Base)
 
virtual void draw (const core::visual::VisualParams *)
 Render internal data of this object, for debugging purposes. More...
 
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...
 
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 handleEvent (Event *)
 Handle an event. More...
 
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...
 
virtual void init ()
 Initialization method called at graph creation and modification, during top-down traversal. More...
 
virtual void bwdInit ()
 Initialization method called at graph creation and modification, during bottom-up traversal. More...
 
virtual void reinit ()
 Update method called when variables used in precomputation are modified. 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

 VisualModel ()
 
 ~VisualModel () override
 
- 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::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

◆ d_enable

Data<bool> sofa::core::visual::VisualModel::d_enable

Display the object or not.

Constructor details

◆ VisualModel()

sofa::core::visual::VisualModel::VisualModel ( )
protected

◆ ~VisualModel()

sofa::core::visual::VisualModel::~VisualModel ( )
inlineoverrideprotected

Function details

◆ addBBox()

virtual bool sofa::core::visual::VisualModel::addBBox ( SReal *  ,
SReal *   
)
inlinevirtual

used to add the bounding-box of this visual model to the given bounding box in order to compute the scene bounding box or cull hidden objects.

Returns
false if the visual model does not define any bounding box, which should only be the case for "debug" objects, as this lack of information might affect performances and leads to incorrect scene bounding box.

◆ applyRotation() [1/2]

virtual void sofa::core::visual::VisualModel::applyRotation ( const  SReal,
const  SReal,
const  SReal 
)
inlinevirtual

Rotate the positions using Euler Angles in degree

This method is optional, it is used when the user want to interactively change the position of an object

Reimplemented in sofa::component::visual::VisualModelImpl.

◆ applyRotation() [2/2]

virtual void sofa::core::visual::VisualModel::applyRotation ( const type::Quat< SReal >  )
inlinevirtual

Rotate the positions

This method is optional, it is used when the user want to interactively change the position of an object

Reimplemented in sofa::component::visual::VisualModelImpl.

◆ applyScale()

virtual void sofa::core::visual::VisualModel::applyScale ( const  SReal,
const  SReal,
const  SReal 
)
inlinevirtual

Scale the positions

This method is optional, it is used when the user want to interactively change the position of an object

Reimplemented in sofa::component::visual::VisualModelImpl.

◆ applyTranslation()

virtual void sofa::core::visual::VisualModel::applyTranslation ( const  SReal,
const  SReal,
const  SReal 
)
inlinevirtual

Translate the positions

This method is optional, it is used when the user want to interactively change the position of an object

Reimplemented in sofa::component::visual::VisualModelImpl.

◆ bwdDraw()

virtual void sofa::core::visual::VisualModel::bwdDraw ( VisualParams )
inlinevirtual

Called after objects in the current branch are displayed.

Reimplemented in sofa::component::visual::VisualStyle, sofa::component::visual::VisualTransform, sofa::gl::component::shader::VisualManagerPass, sofa::gl::component::shader::OrderIndependentTransparencyManager, sofa::gl::component::shader::OglTexturePointer, sofa::gl::component::shader::OglTexture, sofa::gl::component::shader::OglShaderVisualModel, sofa::gl::component::shader::OglRenderingSRGB, sofa::gl::component::shader::OglAttribute< size, type, TDataTypes >, sofa::gl::component::shader::OglAttribute< 1, GL_FLOAT, float >, sofa::gl::component::shader::OglAttribute< 3, GL_UNSIGNED_INT, sofa::type::Vec< 3, unsigned int > >, sofa::gl::component::shader::OglAttribute< 2, GL_UNSIGNED_INT, sofa::type::Vec< 2, unsigned int > >, sofa::gl::component::shader::OglAttribute< 4, GL_INT, sofa::type::Vec< 4, int > >, sofa::gl::component::shader::OglAttribute< 3, GL_FLOAT, sofa::type::Vec< 3, float > >, sofa::gl::component::shader::OglAttribute< 4, GL_FLOAT, sofa::type::Vec< 4, float > >, sofa::gl::component::shader::OglAttribute< 2, GL_FLOAT, sofa::type::Vec< 2, float > >, sofa::gl::component::shader::OglAttribute< 3, GL_INT, sofa::type::Vec< 3, int > >, sofa::gl::component::shader::OglAttribute< 2, GL_INT, sofa::type::Vec< 2, int > >, sofa::gl::component::shader::OglAttribute< 1, GL_INT, int >, sofa::gl::component::shader::OglAttribute< 1, GL_UNSIGNED_INT, unsigned int >, sofa::gl::component::shader::OglAttribute< 4, GL_UNSIGNED_INT, sofa::type::Vec< 4, unsigned int > >, sofa::gl::component::shader::LightManager, and sofa::gl::component::rendering3d::ClipPlane.

◆ clearVisual()

virtual void sofa::core::visual::VisualModel::clearVisual ( )
inlinevirtual

clear some graphical resources (generally called before the deleteVisitor).

Note
: for more general usage you can use the cleanup visitor

◆ drawShadow()

virtual void sofa::core::visual::VisualModel::drawShadow ( const VisualParams vparams)
inlinevirtual

Display shadow-casting surfaces.

This method default to calling draw(). Object that do not cast any shadows, or that use a different LOD for them should reimplement it.

Reimplemented in sofa::component::visual::VisualModelImpl.

◆ drawTransparent()

virtual void sofa::core::visual::VisualModel::drawTransparent ( const VisualParams )
inlinevirtual

◆ drawVisual()

void sofa::core::visual::VisualModel::drawVisual ( const VisualParams vparams)
finalvirtual

Display the VisualModel object.

TODO(dmarchal, 2023-06-09): Deprecate VI and use NVI design pattern: In one year, remove the virtual keyword so that everyone will have to override doDrawVisual;

◆ exportOBJ()

virtual void sofa::core::visual::VisualModel::exportOBJ ( std::string  ,
std::ostream *  ,
std::ostream *  ,
sofa::Index &  ,
sofa::Index &  ,
sofa::Index &  ,
int &   
)
inlinevirtual

Append this mesh to an OBJ format stream.

The number of vertices position, normal, and texture coordinates already written is given as parameters. This method should update them.

Reimplemented in sofa::gl::component::rendering3d::OglCylinderModel, and sofa::component::visual::VisualModelImpl.

◆ fwdDraw()

virtual void sofa::core::visual::VisualModel::fwdDraw ( VisualParams )
inlinevirtual

Called before objects in the current branch are displayed.

Reimplemented in sofa::component::visual::VisualStyle, sofa::component::visual::VisualTransform, sofa::gl::component::shader::VisualManagerPass, sofa::gl::component::shader::OrderIndependentTransparencyManager, sofa::gl::component::shader::OglTexturePointer, sofa::gl::component::shader::OglTexture, sofa::gl::component::shader::OglShaderVisualModel, sofa::gl::component::shader::OglRenderingSRGB, sofa::gl::component::shader::OglAttribute< size, type, TDataTypes >, sofa::gl::component::shader::OglAttribute< 1, GL_FLOAT, float >, sofa::gl::component::shader::OglAttribute< 3, GL_UNSIGNED_INT, sofa::type::Vec< 3, unsigned int > >, sofa::gl::component::shader::OglAttribute< 2, GL_UNSIGNED_INT, sofa::type::Vec< 2, unsigned int > >, sofa::gl::component::shader::OglAttribute< 4, GL_INT, sofa::type::Vec< 4, int > >, sofa::gl::component::shader::OglAttribute< 3, GL_FLOAT, sofa::type::Vec< 3, float > >, sofa::gl::component::shader::OglAttribute< 4, GL_FLOAT, sofa::type::Vec< 4, float > >, sofa::gl::component::shader::OglAttribute< 2, GL_FLOAT, sofa::type::Vec< 2, float > >, sofa::gl::component::shader::OglAttribute< 3, GL_INT, sofa::type::Vec< 3, int > >, sofa::gl::component::shader::OglAttribute< 2, GL_INT, sofa::type::Vec< 2, int > >, sofa::gl::component::shader::OglAttribute< 1, GL_INT, int >, sofa::gl::component::shader::OglAttribute< 1, GL_UNSIGNED_INT, unsigned int >, sofa::gl::component::shader::OglAttribute< 4, GL_UNSIGNED_INT, sofa::type::Vec< 4, unsigned int > >, sofa::gl::component::shader::LightManager, and sofa::gl::component::rendering3d::ClipPlane.

◆ initVisual() [1/2]

void sofa::core::visual::VisualModel::initVisual ( )
finalvirtual

◆ initVisual() [2/2]

void sofa::core::visual::VisualModel::initVisual ( const VisualParams vparams)

Initialize the textures, or other graphical resources.

Called once before the first frame is drawn, and if the graphical context has been recreated.

◆ insertInNode()

bool sofa::core::visual::VisualModel::insertInNode ( objectmodel::BaseNode )
overridevirtual

the component can insert itself directly in the right sequence in the Node so the Node does not have to test its type against all known types

Returns
true if the component was inserted

Reimplemented from sofa::core::objectmodel::BaseObject.

Reimplemented in sofa::gl::component::shader::OglShader, sofa::gl::component::rendering3d::OglCylinderModel, and sofa::gl::component::rendering3d::DataDisplay.

◆ parallelUpdateVisual()

virtual void sofa::core::visual::VisualModel::parallelUpdateVisual ( )
inlinevirtual

used to update the model if necessary.

◆ removeInNode()

bool sofa::core::visual::VisualModel::removeInNode ( objectmodel::BaseNode )
overridevirtual

the component can remove itself directly in the right sequence in the Node so the Node does not have to test its type against all known types

Returns
true if the component was removed

Reimplemented from sofa::core::objectmodel::BaseObject.

Reimplemented in sofa::gl::component::shader::OglShader, sofa::gl::component::rendering3d::OglCylinderModel, and sofa::gl::component::rendering3d::DataDisplay.

◆ SOFA_ABSTRACT_CLASS()

sofa::core::visual::VisualModel::SOFA_ABSTRACT_CLASS ( VisualModel  ,
objectmodel::BaseObject   
)

◆ updateVisual() [1/2]

void sofa::core::visual::VisualModel::updateVisual ( )
finalvirtual

◆ updateVisual() [2/2]

void sofa::core::visual::VisualModel::updateVisual ( const VisualParams vparams)

used to update the model if necessary.