SOFA API  651e7a3a
Open source framework for multi-physics simuation
sofa::component::visual::VisualModelImpl Class Reference

#include <VisualModelImpl.h>

Abstract class which implements partially VisualModel. More...

Inheritance diagram for sofa::component::visual::VisualModelImpl:

Detailed Description

Abstract class which implements partially VisualModel.

This class implemented all non-hardware (i.e OpenGL or DirectX) specific functions for rendering. It takes a 3D model (basically a .OBJ model) and apply transformations on it. At the moment, it is only implemented by OglModel for OpenGL systems.

Classes

class  FaceGroup
 

Public Attributes

bool useTopology
 True if list of facets should be taken from the attached topology. More...
 
int lastMeshRev
 Time stamps from the last time the mesh was updated from the topology. More...
 
bool castShadow
 True if object cast shadows. More...
 
sofa::core::topology::BaseMeshTopologym_topology
 
Data< boolm_initRestPositions
 True if rest positions should be initialized with initial positions, False if nothing should be done. More...
 
Data< boolm_useNormals
 True if normals should be read from file. More...
 
Data< boolm_updateNormals
 True if normals should be updated at each iteration. More...
 
Data< boolm_computeTangents
 True if tangents should be computed at startup. More...
 
Data< boolm_updateTangents
 True if tangents should be updated at each iteration. More...
 
Data< boolm_handleDynamicTopology
 True if topological changes should be handled. More...
 
Data< boolm_fixMergedUVSeams
 True if UV seams should be handled even when duplicate UVs are merged. More...
 
Data< boolm_keepLines
 keep and draw lines (false by default) More...
 
Data< VecCoordm_vertices2
 vertices of the model (only if vertices have multiple normals/texcoords, otherwise positions are used) More...
 
core::topology::PointData< VecTexCoordm_vtexcoords
 coordinates of the texture More...
 
core::topology::PointData< VecCoordm_vtangents
 tangents for normal mapping More...
 
core::topology::PointData< VecCoordm_vbitangents
 tangents for normal mapping More...
 
core::topology::EdgeData< VecVisualEdgem_edges
 edges of the model More...
 
core::topology::TriangleData< VecVisualTrianglem_triangles
 triangles of the model More...
 
core::topology::QuadData< VecVisualQuadm_quads
 quads of the model More...
 
bool m_textureChanged {false}
 
Data< type::vector< visual_index_type > > m_vertPosIdx
 
Data< type::vector< visual_index_type > > m_vertNormIdx
 
sofa::core::objectmodel::DataFileName fileMesh
 
sofa::core::objectmodel::DataFileName texturename
 
sofa::type::Vec3f bbox [2]
 
Data< sofa::type::Materialmaterial
 
Data< boolputOnlyTexCoords
 
Data< boolsrgbTexturing
 
Data< type::vector< sofa::type::Material > > materials
 
Data< type::vector< FaceGroup > > groups
 
SingleLink< VisualModelImpl, sofa::core::topology::BaseMeshTopology, BaseLink::FLAG_STOREPATH|BaseLink::FLAG_STRONGLINKl_topology
 Link to be set to the topology container in the component graph. More...
 
sofa::defaulttype::Rigid3fTypes::VecCoord xforms
 Temporary added here from RigidState deprecated inheritance. More...
 
bool xformsModified
 
- Public Attributes inherited from sofa::core::visual::VisualModel
Data< boold_enable
 Display the visual model 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 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 Attributes inherited from sofa::core::visual::VisualState< defaulttype::Vec3Types >
core::topology::PointData< VecCoordm_positions
 Vertices coordinates. More...
 
core::topology::PointData< VecCoordm_restPositions
 Vertices rest coordinates. More...
 
core::topology::PointData< VecDerivm_vnormals
 Normals of the model. More...
 
bool modified
 True if input vertices modified since last rendering. More...
 
- Public Attributes inherited from sofa::core::State< TDataTypes >
AccumulationVecId< TDataTypes, V_DERIV, V_READaccumulatedForces
 Stores all the VecDerivId corresponding to a force. They can then be accumulated. More...
 

Protected Attributes

std::set< sofa::core::topology::BaseMeshTopology::TriangleIDm_dirtyTriangles
 
std::set< sofa::core::topology::BaseMeshTopology::QuadIDm_dirtyQuads
 Internal buffer similar to. More...
 
- 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...
 

Public Member Functions

 SOFA_CLASS2 (VisualModelImpl, core::visual::VisualModel, sofa::core::visual::VisualState< defaulttype::Vec3Types >)
 
 SOFA_ATTRIBUTE_REPLACED__TYPEMEMBER (Index, sofa::Index)
 
virtual void internalDraw (const core::visual::VisualParams *, bool)
 Rendering method. More...
 
void parse (core::objectmodel::BaseObjectDescription *arg) override
 Parse the given description to assign values to this object's fields and potentially other parameters. More...
 
virtual bool hasTransparent ()
 
bool hasOpaque ()
 
void doDrawVisual (const core::visual::VisualParams *vparams) override
 
void drawTransparent (const core::visual::VisualParams *vparams) override
 Display transparent surfaces. More...
 
void drawShadow (const core::visual::VisualParams *vparams) override
 Display shadow-casting surfaces. More...
 
virtual bool loadTextures ()
 
virtual bool loadTexture (const std::string &)
 
bool load (const std::string &filename, const std::string &loader, const std::string &textureName)
 
void flipFaces ()
 
void setFilename (std::string s)
 
std::string getFilename ()
 
void setColor (float r, float g, float b, float a)
 
void setColor (std::string color)
 
void setUseNormals (bool val)
 
bool getUseNormals () const
 
void setCastShadow (bool val)
 
bool getCastShadow () const
 
void setMesh (helper::io::Mesh &m, bool tex=false)
 
bool isUsingTopology () const
 
const VecCoordgetVertices () const
 
const VecDerivgetVnormals () const
 
const VecTexCoordgetVtexcoords () const
 
const VecCoordgetVtangents () const
 
const VecCoordgetVbitangents () const
 
const VecVisualTrianglegetTriangles () const
 
const VecVisualQuadgetQuads () const
 
const VecVisualEdgegetEdges () const
 
void setVertices (VecCoord *x)
 
void setVnormals (VecDeriv *vn)
 
void setVtexcoords (VecTexCoord *vt)
 
void setVtangents (VecCoord *v)
 
void setVbitangents (VecCoord *v)
 
void setTriangles (VecVisualTriangle *t)
 
void setQuads (VecVisualQuad *q)
 
void setEdges (VecVisualEdge *e)
 
virtual void computePositions ()
 
virtual void computeMesh ()
 
virtual void computeNormals ()
 
virtual void computeTangents ()
 
void computeBBox (const core::ExecParams *params, bool=false) override
 
virtual void computeUVSphereProjection ()
 
virtual void updateBuffers ()
 
virtual void deleteBuffers ()
 
virtual void deleteTextures ()
 
void updateVisual () override
 used to update the model if necessary. More...
 
void init () override
 Initialization method called at graph creation and modification, during top-down traversal. More...
 
void initFromTopology ()
 
void initPositionFromVertices ()
 
void initFromFileMesh ()
 
void initVisual () override
 Initialize the textures, or other graphical resources. More...
 
void exportOBJ (std::string name, std::ostream *out, std::ostream *mtl, sofa::Index &vindex, sofa::Index &nindex, sofa::Index &tindex, int &count) override
 
bool insertInNode (core::objectmodel::BaseNode *node) override
 
bool removeInNode (core::objectmodel::BaseNode *node) override
 
- Public Member Functions inherited from sofa::core::visual::VisualModel
 SOFA_ABSTRACT_CLASS (VisualModel, objectmodel::BaseObject)
 
virtual void drawVisual (const VisualParams *) final
 Display the VisualModel object. More...
 
virtual void clearVisual ()
 clear some graphical resources (generaly 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 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...
 
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...
 
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 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)
 
- Public Member Functions inherited from sofa::core::visual::VisualState< defaulttype::Vec3Types >
 SOFA_CLASS (VisualState, SOFA_TEMPLATE(core::State, defaulttype::Vec3Types))
 
 VisualState ()
 
virtual void resize (Size vsize) override
 Resize all stored vector. More...
 
virtual Size getSize () const override
 Current size of all stored vectors. More...
 
virtual Data< VecCoord > * write (core::VecCoordId v) override
 
virtual Data< VecDeriv > * write (core::VecDerivId v) override
 
virtual Data< MatrixDeriv > * write (core::MatrixDerivId) override
 
virtual const Data< VecCoord > * read (core::ConstVecCoordId v) const override
 
virtual const Data< VecDeriv > * read (core::ConstVecDerivId v) const override
 
virtual const Data< MatrixDeriv > * read (core::ConstMatrixDerivId) const override
 
- Public Member Functions inherited from sofa::core::State< TDataTypes >
 SOFA_CLASS (SOFA_TEMPLATE(State, TDataTypes), BaseState)
 
sofa::type::TBoundingBox< RealcomputeBBox () const
 Compute the bounding box independently from the visibility parameters. More...
 
void computeBBox (const core::ExecParams *params, bool onlyVisible=false) override
 
objectmodel::BaseDatabaseWrite (VecId v) override
 
const objectmodel::BaseDatabaseRead (ConstVecId v) const override
 
ReadVecCoord readPositions () const
 
WriteVecCoord writePositions ()
 
WriteOnlyVecCoord writeOnlyPositions ()
 
ReadVecCoord readRestPositions () const
 
WriteVecCoord writeRestPositions ()
 
WriteOnlyVecCoord writeOnlyRestPositions ()
 
ReadVecDeriv readVelocities () const
 
WriteVecDeriv writeVelocities ()
 
WriteOnlyVecDeriv writeOnlyVelocities ()
 
ReadVecDeriv readForces () const
 
WriteVecDeriv writeForces ()
 
WriteOnlyVecDeriv writeOnlyForces ()
 
ReadVecDeriv readDx () const
 
WriteVecDeriv writeDx ()
 
WriteOnlyVecDeriv writeOnlyDx ()
 
ReadVecDeriv readNormals () const
 
const AccumulationVecId< TDataTypes, V_DERIV, V_READ > & readTotalForces () const
 Returns a proxy objects offering simplified access to elements of the cumulative sum of all force containers. More...
 
void addToTotalForces (core::ConstVecDerivId forceId) override
 The provided VecDerivId will contribute to the sum of all force containers. More...
 
void removeFromTotalForces (core::ConstVecDerivId forceId) override
 
- Public Member Functions inherited from sofa::core::BaseState
 SOFA_ABSTRACT_CLASS (BaseState, objectmodel::BaseObject)
 
bool insertInNode (objectmodel::BaseNode *node) override
 
bool removeInNode (objectmodel::BaseNode *node) override
 

Static Public Member Functions

static std::string GetCustomTemplateName ()
 
static Coord computeTangent (const Coord &v1, const Coord &v2, const Coord &v3, const TexCoord &t1, const TexCoord &t2, const TexCoord &t3)
 Utility method to compute tangent from vertices and texture coordinates. More...
 
static Coord computeBitangent (const Coord &v1, const Coord &v2, const Coord &v3, const TexCoord &t1, const TexCoord &t2, const TexCoord &t3)
 Utility method to compute bitangent from vertices and texture coordinates. 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)
 

Protected Member Functions

 VisualModelImpl ()
 Default constructor. More...
 
 ~VisualModelImpl () override
 Default destructor. More...
 
- Protected Member Functions inherited from sofa::core::visual::VisualModel
 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...
 
- Protected Member Functions inherited from sofa::core::State< TDataTypes >
 State ()
 
 ~State () override
 
- Protected Member Functions inherited from sofa::core::BaseState
 BaseState ()
 
 ~BaseState () override
 

Initial transformation attributes

typedef sofa::type::Vec< 3, RealVec3Real
 
Data< Vec3Realm_translation
 Initial Translation of the object. More...
 
Data< Vec3Realm_rotation
 Initial Rotation of the object. More...
 
Data< Vec3Realm_scale
 Initial Scale of the object. More...
 
Data< TexCoordm_scaleTex
 Scale of the texture. More...
 
Data< TexCoordm_translationTex
 Translation of the texture. More...
 
void applyTranslation (const SReal dx, const SReal dy, const SReal dz) override
 
void applyRotation (const SReal rx, const SReal ry, const SReal rz) override
 Apply Rotation from Euler angles (in degree!) More...
 
void applyRotation (const sofa::type::Quat< SReal > q) override
 
void applyScale (const SReal sx, const SReal sy, const SReal sz) override
 
virtual void applyUVTransformation ()
 
void applyUVTranslation (const Real dU, const Real dV)
 
void applyUVScale (const Real su, const Real sv)
 
void setTranslation (SReal dx, SReal dy, SReal dz)
 
void setRotation (SReal rx, SReal ry, SReal rz)
 
void setScale (SReal sx, SReal sy, SReal sz)
 

Attribute details

◆ bbox

sofa::type::Vec3f sofa::component::visual::VisualModelImpl::bbox[2]

◆ castShadow

bool sofa::component::visual::VisualModelImpl::castShadow

True if object cast shadows.

◆ fileMesh

sofa::core::objectmodel::DataFileName sofa::component::visual::VisualModelImpl::fileMesh

◆ groups

Data< type::vector<FaceGroup> > sofa::component::visual::VisualModelImpl::groups

◆ l_topology

Link to be set to the topology container in the component graph.

◆ lastMeshRev

int sofa::component::visual::VisualModelImpl::lastMeshRev

Time stamps from the last time the mesh was updated from the topology.

◆ m_computeTangents

Data<bool> sofa::component::visual::VisualModelImpl::m_computeTangents

True if tangents should be computed at startup.

◆ m_dirtyQuads

std::set< sofa::core::topology::BaseMeshTopology::QuadID> sofa::component::visual::VisualModelImpl::m_dirtyQuads
protected

Internal buffer similar to.

See also
m_dirtyTriangles but to be used by topolgy Data
m_quads callback when points are removed.

◆ m_dirtyTriangles

std::set< sofa::core::topology::BaseMeshTopology::TriangleID> sofa::component::visual::VisualModelImpl::m_dirtyTriangles
protected

Internal buffer to be filled by topology Data

See also
m_triangles callback when points are removed. Those dirty triangles will be updated at next updateVisual This avoid to update the whole mesh.

◆ m_edges

core::topology::EdgeData< VecVisualEdge > sofa::component::visual::VisualModelImpl::m_edges

edges of the model

◆ m_fixMergedUVSeams

Data<bool> sofa::component::visual::VisualModelImpl::m_fixMergedUVSeams

True if UV seams should be handled even when duplicate UVs are merged.

◆ m_handleDynamicTopology

Data<bool> sofa::component::visual::VisualModelImpl::m_handleDynamicTopology

True if topological changes should be handled.

◆ m_initRestPositions

Data<bool> sofa::component::visual::VisualModelImpl::m_initRestPositions

True if rest positions should be initialized with initial positions, False if nothing should be done.

◆ m_keepLines

Data<bool> sofa::component::visual::VisualModelImpl::m_keepLines

keep and draw lines (false by default)

◆ m_quads

core::topology::QuadData< VecVisualQuad > sofa::component::visual::VisualModelImpl::m_quads

quads of the model

◆ m_rotation

Data< Vec3Real > sofa::component::visual::VisualModelImpl::m_rotation

Initial Rotation of the object.

◆ m_scale

Data< Vec3Real > sofa::component::visual::VisualModelImpl::m_scale

Initial Scale of the object.

◆ m_scaleTex

Data< TexCoord > sofa::component::visual::VisualModelImpl::m_scaleTex

Scale of the texture.

◆ m_textureChanged

bool sofa::component::visual::VisualModelImpl::m_textureChanged {false}

◆ m_topology

sofa::core::topology::BaseMeshTopology* sofa::component::visual::VisualModelImpl::m_topology

◆ m_translation

Data< Vec3Real > sofa::component::visual::VisualModelImpl::m_translation

Initial Translation of the object.

◆ m_translationTex

Data< TexCoord > sofa::component::visual::VisualModelImpl::m_translationTex

Translation of the texture.

◆ m_triangles

core::topology::TriangleData< VecVisualTriangle > sofa::component::visual::VisualModelImpl::m_triangles

triangles of the model

◆ m_updateNormals

Data<bool> sofa::component::visual::VisualModelImpl::m_updateNormals

True if normals should be updated at each iteration.

◆ m_updateTangents

Data<bool> sofa::component::visual::VisualModelImpl::m_updateTangents

True if tangents should be updated at each iteration.

◆ m_useNormals

Data<bool> sofa::component::visual::VisualModelImpl::m_useNormals

True if normals should be read from file.

◆ m_vbitangents

core::topology::PointData< VecCoord > sofa::component::visual::VisualModelImpl::m_vbitangents

tangents for normal mapping

◆ m_vertices2

Data< VecCoord > sofa::component::visual::VisualModelImpl::m_vertices2

vertices of the model (only if vertices have multiple normals/texcoords, otherwise positions are used)

◆ m_vertNormIdx

Data< type::vector<visual_index_type> > sofa::component::visual::VisualModelImpl::m_vertNormIdx

Similarly this vector store which input normal is used for each vertex If it is empty then each vertex correspond to one normal

◆ m_vertPosIdx

Data< type::vector<visual_index_type> > sofa::component::visual::VisualModelImpl::m_vertPosIdx

If vertices have multiple normals/texcoords, then we need to separate them This vector store which input position is used for each vertex If it is empty then each vertex correspond to one position

◆ m_vtangents

core::topology::PointData< VecCoord > sofa::component::visual::VisualModelImpl::m_vtangents

tangents for normal mapping

◆ m_vtexcoords

core::topology::PointData< VecTexCoord > sofa::component::visual::VisualModelImpl::m_vtexcoords

coordinates of the texture

◆ material

Data< sofa::type::Material > sofa::component::visual::VisualModelImpl::material

◆ materials

Data< type::vector<sofa::type::Material> > sofa::component::visual::VisualModelImpl::materials

◆ putOnlyTexCoords

Data< bool > sofa::component::visual::VisualModelImpl::putOnlyTexCoords

◆ srgbTexturing

Data< bool > sofa::component::visual::VisualModelImpl::srgbTexturing

◆ texturename

sofa::core::objectmodel::DataFileName sofa::component::visual::VisualModelImpl::texturename

◆ useTopology

bool sofa::component::visual::VisualModelImpl::useTopology

True if list of facets should be taken from the attached topology.

◆ xforms

sofa::defaulttype::Rigid3fTypes::VecCoord sofa::component::visual::VisualModelImpl::xforms

Temporary added here from RigidState deprecated inheritance.

◆ xformsModified

bool sofa::component::visual::VisualModelImpl::xformsModified

Constructor details

◆ VisualModelImpl()

sofa::component::visual::VisualModelImpl::VisualModelImpl ( )
protected

Default constructor.

◆ ~VisualModelImpl()

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

Default destructor.

Function details

◆ applyRotation() [1/2]

void sofa::component::visual::VisualModelImpl::applyRotation ( const sofa::type::Quat< SReal >  )
overridevirtual

Rotate the positions

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

Reimplemented from sofa::core::visual::VisualModel.

◆ applyRotation() [2/2]

void sofa::component::visual::VisualModelImpl::applyRotation ( const SReal  rx,
const SReal  ry,
const SReal  rz 
)
overridevirtual

Apply Rotation from Euler angles (in degree!)

Reimplemented from sofa::core::visual::VisualModel.

◆ applyScale()

void sofa::component::visual::VisualModelImpl::applyScale ( const SReal  SReal,
const SReal  SReal,
const SReal  SReal 
)
overridevirtual

Scale the positions

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

Reimplemented from sofa::core::visual::VisualModel.

◆ applyTranslation()

void sofa::component::visual::VisualModelImpl::applyTranslation ( const SReal  SReal,
const SReal  SReal,
const SReal  SReal 
)
overridevirtual

Translate the positions

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

Reimplemented from sofa::core::visual::VisualModel.

◆ applyUVScale()

void sofa::component::visual::VisualModelImpl::applyUVScale ( const Real  su,
const Real  sv 
)

◆ applyUVTransformation()

void sofa::component::visual::VisualModelImpl::applyUVTransformation ( )
virtual

◆ applyUVTranslation()

void sofa::component::visual::VisualModelImpl::applyUVTranslation ( const Real  dU,
const Real  dV 
)

◆ computeBBox()

void sofa::component::visual::VisualModelImpl::computeBBox ( const core::ExecParams ,
bool  = false 
)
overridevirtual

Bounding Box computation method. Default to empty method.

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

◆ computeBitangent()

VisualModelImpl::Coord sofa::component::visual::VisualModelImpl::computeBitangent ( const Coord v1,
const Coord v2,
const Coord v3,
const TexCoord t1,
const TexCoord t2,
const TexCoord t3 
)
static

Utility method to compute bitangent from vertices and texture coordinates.

◆ computeMesh()

void sofa::component::visual::VisualModelImpl::computeMesh ( )
virtual

◆ computeNormals()

void sofa::component::visual::VisualModelImpl::computeNormals ( )
virtual

◆ computePositions()

void sofa::component::visual::VisualModelImpl::computePositions ( )
virtual

◆ computeTangent()

VisualModelImpl::Coord sofa::component::visual::VisualModelImpl::computeTangent ( const Coord v1,
const Coord v2,
const Coord v3,
const TexCoord t1,
const TexCoord t2,
const TexCoord t3 
)
static

Utility method to compute tangent from vertices and texture coordinates.

◆ computeTangents()

void sofa::component::visual::VisualModelImpl::computeTangents ( )
virtual

◆ computeUVSphereProjection()

void sofa::component::visual::VisualModelImpl::computeUVSphereProjection ( )
virtual

◆ deleteBuffers()

virtual void sofa::component::visual::VisualModelImpl::deleteBuffers ( )
inlinevirtual

◆ deleteTextures()

virtual void sofa::component::visual::VisualModelImpl::deleteTextures ( )
inlinevirtual

◆ doDrawVisual()

void sofa::component::visual::VisualModelImpl::doDrawVisual ( const core::visual::VisualParams vparams)
overridevirtual

Reimplemented from sofa::core::visual::VisualModel.

◆ drawShadow()

void sofa::component::visual::VisualModelImpl::drawShadow ( const core::visual::VisualParams vparams)
overridevirtual

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 from sofa::core::visual::VisualModel.

◆ drawTransparent()

void sofa::component::visual::VisualModelImpl::drawTransparent ( const core::visual::VisualParams )
overridevirtual

Display transparent surfaces.

Transparent objects should use this method to get a correct display order.

Reimplemented from sofa::core::visual::VisualModel.

◆ exportOBJ()

void sofa::component::visual::VisualModelImpl::exportOBJ ( std::string  name,
std::ostream *  out,
std::ostream *  mtl,
sofa::Index &  vindex,
sofa::Index &  nindex,
sofa::Index &  tindex,
int &  count 
)
overridevirtual

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 from sofa::core::visual::VisualModel.

◆ flipFaces()

void sofa::component::visual::VisualModelImpl::flipFaces ( )

◆ getCastShadow()

bool sofa::component::visual::VisualModelImpl::getCastShadow ( ) const
inline

◆ GetCustomTemplateName()

static std::string sofa::component::visual::VisualModelImpl::GetCustomTemplateName ( )
inlinestatic

Returns the sofa class name. By default the name of the c++ class is exposed... More details on the name customization infrastructure is in NameDecoder.h

◆ getEdges()

const VecVisualEdge& sofa::component::visual::VisualModelImpl::getEdges ( ) const
inline

◆ getFilename()

std::string sofa::component::visual::VisualModelImpl::getFilename ( )
inline

◆ getQuads()

const VecVisualQuad& sofa::component::visual::VisualModelImpl::getQuads ( ) const
inline

◆ getTriangles()

const VecVisualTriangle& sofa::component::visual::VisualModelImpl::getTriangles ( ) const
inline

◆ getUseNormals()

bool sofa::component::visual::VisualModelImpl::getUseNormals ( ) const
inline

◆ getVbitangents()

const VecCoord& sofa::component::visual::VisualModelImpl::getVbitangents ( ) const
inline

◆ getVertices()

const VecCoord& sofa::component::visual::VisualModelImpl::getVertices ( ) const
inline

◆ getVnormals()

const VecDeriv& sofa::component::visual::VisualModelImpl::getVnormals ( ) const
inline

◆ getVtangents()

const VecCoord& sofa::component::visual::VisualModelImpl::getVtangents ( ) const
inline

◆ getVtexcoords()

const VecTexCoord& sofa::component::visual::VisualModelImpl::getVtexcoords ( ) const
inline

◆ hasOpaque()

bool sofa::component::visual::VisualModelImpl::hasOpaque ( )

◆ hasTransparent()

bool sofa::component::visual::VisualModelImpl::hasTransparent ( )
virtual

◆ init()

void sofa::component::visual::VisualModelImpl::init ( void  )
overridevirtual

Initialization method called at graph creation and modification, during top-down traversal.

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

Reimplemented in sofa::gl::component::shader::OglShaderVisualModel, sofa::gl::component::rendering3d::OglModel, and sofa::gl::component::rendering3d::MergeVisualModels.

◆ initFromFileMesh()

void sofa::component::visual::VisualModelImpl::initFromFileMesh ( )

◆ initFromTopology()

void sofa::component::visual::VisualModelImpl::initFromTopology ( )

◆ initPositionFromVertices()

void sofa::component::visual::VisualModelImpl::initPositionFromVertices ( )

◆ initVisual()

void sofa::component::visual::VisualModelImpl::initVisual ( )
overridevirtual

Initialize the textures, or other graphical resources.

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

Reimplemented from sofa::core::visual::VisualModel.

Reimplemented in sofa::gl::component::shader::OglShaderVisualModel, and sofa::gl::component::rendering3d::OglModel.

◆ insertInNode()

bool sofa::component::visual::VisualModelImpl::insertInNode ( core::objectmodel::BaseNode )
inlineoverridevirtual

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.

◆ internalDraw()

virtual void sofa::component::visual::VisualModelImpl::internalDraw ( const core::visual::VisualParams ,
bool   
)
inlinevirtual

Rendering method.

Reimplemented in sofa::gl::component::rendering3d::OglModel.

◆ isUsingTopology()

bool sofa::component::visual::VisualModelImpl::isUsingTopology ( ) const
inline

◆ load()

bool sofa::component::visual::VisualModelImpl::load ( const std::string &  filename,
const std::string &  loader,
const std::string &  textureName 
)

◆ loadTexture()

virtual bool sofa::component::visual::VisualModelImpl::loadTexture ( const std::string &  )
inlinevirtual

◆ loadTextures()

virtual bool sofa::component::visual::VisualModelImpl::loadTextures ( )
inlinevirtual

◆ parse()

void sofa::component::visual::VisualModelImpl::parse ( core::objectmodel::BaseObjectDescription arg)
overridevirtual

Parse the given description to assign values to this object's fields and potentially other parameters.

Reimplemented from sofa::core::objectmodel::Base.

Reimplemented in sofa::gl::component::rendering3d::MergeVisualModels.

◆ removeInNode()

bool sofa::component::visual::VisualModelImpl::removeInNode ( core::objectmodel::BaseNode )
inlineoverridevirtual

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.

◆ setCastShadow()

void sofa::component::visual::VisualModelImpl::setCastShadow ( bool  val)
inline

◆ setColor() [1/2]

void sofa::component::visual::VisualModelImpl::setColor ( float  r,
float  g,
float  b,
float  a 
)

◆ setColor() [2/2]

void sofa::component::visual::VisualModelImpl::setColor ( std::string  color)

◆ setEdges()

void sofa::component::visual::VisualModelImpl::setEdges ( VecVisualEdge e)
inline

◆ setFilename()

void sofa::component::visual::VisualModelImpl::setFilename ( std::string  s)
inline

◆ setMesh()

void sofa::component::visual::VisualModelImpl::setMesh ( helper::io::Mesh m,
bool  tex = false 
)

◆ setQuads()

void sofa::component::visual::VisualModelImpl::setQuads ( VecVisualQuad q)
inline

◆ setRotation()

void sofa::component::visual::VisualModelImpl::setRotation ( SReal  rx,
SReal  ry,
SReal  rz 
)
inline

◆ setScale()

void sofa::component::visual::VisualModelImpl::setScale ( SReal  sx,
SReal  sy,
SReal  sz 
)
inline

◆ setTranslation()

void sofa::component::visual::VisualModelImpl::setTranslation ( SReal  dx,
SReal  dy,
SReal  dz 
)
inline

◆ setTriangles()

void sofa::component::visual::VisualModelImpl::setTriangles ( VecVisualTriangle t)
inline

◆ setUseNormals()

void sofa::component::visual::VisualModelImpl::setUseNormals ( bool  val)
inline

◆ setVbitangents()

void sofa::component::visual::VisualModelImpl::setVbitangents ( VecCoord v)
inline

◆ setVertices()

void sofa::component::visual::VisualModelImpl::setVertices ( VecCoord x)
inline

◆ setVnormals()

void sofa::component::visual::VisualModelImpl::setVnormals ( VecDeriv vn)
inline

◆ setVtangents()

void sofa::component::visual::VisualModelImpl::setVtangents ( VecCoord v)
inline

◆ setVtexcoords()

void sofa::component::visual::VisualModelImpl::setVtexcoords ( VecTexCoord vt)
inline

◆ SOFA_ATTRIBUTE_REPLACED__TYPEMEMBER()

sofa::component::visual::VisualModelImpl::SOFA_ATTRIBUTE_REPLACED__TYPEMEMBER ( Index  ,
sofa::Index   
)

◆ SOFA_CLASS2()

sofa::component::visual::VisualModelImpl::SOFA_CLASS2 ( VisualModelImpl  ,
core::visual::VisualModel  ,
sofa::core::visual::VisualState< defaulttype::Vec3Types  
)

◆ updateBuffers()

virtual void sofa::component::visual::VisualModelImpl::updateBuffers ( )
inlinevirtual

◆ updateVisual()

void sofa::component::visual::VisualModelImpl::updateVisual ( )
overridevirtual

used to update the model if necessary.

Reimplemented from sofa::core::visual::VisualModel.

Reimplemented in sofa::gl::component::shader::OglShaderVisualModel.