SOFA API  fdacdac3
Open source framework for multi-physics simuation
sofa::component::io::mesh::MeshSTLLoader Class Reference

#include <MeshSTLLoader.h>

Inheritance diagram for sofa::component::io::mesh::MeshSTLLoader:

Public Attributes

sofa::core::objectmodel::RenamedData< bool_forceBinary
 
sofa::core::objectmodel::RenamedData< unsigned int > _headerSize
 
Data< unsigned int > d_headerSize
 Size of the header binary file (just before the number of facet). More...
 
Data< boold_forceBinary
 Force reading in binary mode. Even in first keyword of the file is solid. More...
 
Data< boold_mergePositionUsingMap
 Since positions are duplicated in a STL, they have to be merged. Using a map to do so will temporarily duplicate memory but should be more efficient. Disable it if memory is really an issue. More...
 
- Public Attributes inherited from sofa::core::loader::MeshLoader
Data< type::vector< Vec3 > > d_positions
 Vertices of the mesh loaded. More...
 
Data< type::vector< Polyline > > d_polylines
 Polylines of the mesh loaded. More...
 
Data< type::vector< Edge > > d_edges
 Edges of the mesh loaded. More...
 
Data< type::vector< Triangle > > d_triangles
 Triangles of the mesh loaded. More...
 
Data< type::vector< Quad > > d_quads
 Quads of the mesh loaded. More...
 
Data< type::vector< type::vector< Topology::ElemID > > > d_polygons
 Polygons of the mesh loaded. More...
 
Data< type::vector< HighOrderEdgePosition > > d_highOrderEdgePositions
 High order edge points of the mesh loaded. More...
 
Data< type::vector< HighOrderTrianglePosition > > d_highOrderTrianglePositions
 High order triangle points of the mesh loaded. More...
 
Data< type::vector< HighOrderQuadPosition > > d_highOrderQuadPositions
 High order quad points of the mesh loaded. More...
 
Data< type::vector< Tetrahedron > > d_tetrahedra
 Tetrahedra of the mesh loaded. More...
 
Data< type::vector< Hexahedron > > d_hexahedra
 Hexahedra of the mesh loaded. More...
 
Data< type::vector< Pentahedron > > d_pentahedra
 Pentahedra of the mesh loaded. More...
 
Data< type::vector< HighOrderTetrahedronPosition > > d_highOrderTetrahedronPositions
 High order tetrahedron points of the mesh loaded. More...
 
Data< type::vector< HighOrderHexahedronPosition > > d_highOrderHexahedronPositions
 High order hexahedron points of the mesh loaded. More...
 
Data< type::vector< Pyramid > > d_pyramids
 Pyramids of the mesh loaded. More...
 
Data< type::vector< sofa::type::Vec3 > > d_normals
 Normals of the mesh loaded. More...
 
Data< type::vector< PrimitiveGroup > > d_edgesGroups
 Groups of Edges. More...
 
Data< type::vector< PrimitiveGroup > > d_trianglesGroups
 Groups of Triangles. More...
 
Data< type::vector< PrimitiveGroup > > d_quadsGroups
 Groups of Quads. More...
 
Data< type::vector< PrimitiveGroup > > d_polygonsGroups
 Groups of Polygons. More...
 
Data< type::vector< PrimitiveGroup > > d_tetrahedraGroups
 Groups of Tetrahedra. More...
 
Data< type::vector< PrimitiveGroup > > d_hexahedraGroups
 Groups of Hexahedra. More...
 
Data< type::vector< PrimitiveGroup > > d_pentahedraGroups
 Groups of Pentahedra. More...
 
Data< type::vector< PrimitiveGroup > > d_pyramidsGroups
 Groups of Pyramids. More...
 
Data< boold_flipNormals
 Flip Normals. More...
 
Data< boold_triangulate
 Divide all polygons into triangles. More...
 
Data< boold_createSubelements
 Divide all n-D elements into their (n-1)-D boundary elements (e.g. tetrahedra to triangles) More...
 
Data< boold_onlyAttachedPoints
 Only keep points attached to elements of the mesh. More...
 
Data< Vec3d_translation
 Translation of the DOFs. More...
 
Data< Vec3d_rotation
 Rotation of the DOFs. More...
 
Data< Vec3d_scale
 Scale of the DOFs in 3 dimensions. More...
 
Data< type::Matrix4d_transformation
 4x4 Homogeneous matrix to transform the DOFs (when present replace any) More...
 
- Public Attributes inherited from sofa::core::loader::BaseLoader
objectmodel::DataFileName d_filename
 
- 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_CLASS (MeshSTLLoader, sofa::core::loader::MeshLoader)
 
- Public Member Functions inherited from sofa::core::loader::MeshLoader
 SOFA_ABSTRACT_CLASS (MeshLoader, BaseLoader)
 
bool canLoad () override
 
void parse (sofa::core::objectmodel::BaseObjectDescription *arg) override
 Parse the given description to assign values to this object's fields and potentially other parameters. More...
 
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...
 
virtual bool load () final
 
virtual void applyTransformation (sofa::type::Matrix4 const &T)
 Apply Homogeneous transformation to the positions. More...
 
virtual void updateMesh ()
 
virtual void updateElements ()
 
virtual void updatePoints ()
 
virtual void updateNormals ()
 
void setTranslation (SReal dx, SReal dy, SReal dz)
 
void setRotation (SReal rx, SReal ry, SReal rz)
 
void setScale (SReal sx, SReal sy, SReal sz)
 
void setTransformation (const sofa::type::Matrix4 &t)
 
virtual Vec3 getTranslation () const
 
virtual Vec3 getRotation () const
 
virtual Vec3 getScale () const
 
virtual sofa::type::Matrix4 getTransformation () const
 
- Public Member Functions inherited from sofa::core::loader::BaseLoader
 SOFA_ABSTRACT_CLASS (BaseLoader, objectmodel::BaseObject)
 
void setFilename (std::string f)
 
const std::string & getFilename ()
 
- 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...
 
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 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...
 
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

 MeshSTLLoader ()
 
bool readSTL (std::ifstream &file)
 
bool readBinarySTL (const char *filename)
 
- Protected Member Functions inherited from sofa::core::loader::MeshLoader
 MeshLoader ()
 
virtual void clearBuffers () final
 
void addPosition (type::vector< sofa::type::Vec3 > &pPositions, const sofa::type::Vec3 &p)
 
void addPosition (type::vector< sofa::type::Vec3 > &pPositions, SReal x, SReal y, SReal z)
 
void addPolyline (type::vector< Polyline > &pPolylines, Polyline p)
 
void addEdge (type::vector< Edge > &pEdges, const Edge &p)
 
void addEdge (type::vector< Edge > &pEdges, Topology::EdgeID p0, Topology::EdgeID p1)
 
void addTriangle (type::vector< Triangle > &pTriangles, const Triangle &p)
 
void addTriangle (type::vector< Triangle > &pTriangles, Topology::TriangleID p0, Topology::TriangleID p1, Topology::TriangleID p2)
 
void addQuad (type::vector< Quad > &pQuads, const Quad &p)
 
void addQuad (type::vector< Quad > &pQuads, Topology::QuadID p0, Topology::QuadID p1, Topology::QuadID p2, Topology::QuadID p3)
 
void addPolygon (type::vector< type::vector< Topology::ElemID > > &pPolygons, const type::vector< Topology::ElemID > &p)
 
void addTetrahedron (type::vector< Tetrahedron > &pTetrahedra, const Tetrahedron &p)
 
void addTetrahedron (type::vector< Tetrahedron > &pTetrahedra, Topology::TetrahedronID p0, Topology::TetrahedronID p1, Topology::TetrahedronID p2, Topology::TetrahedronID p3)
 
void addHexahedron (type::vector< Hexahedron > &pHexahedra, const Hexahedron &p)
 
void addHexahedron (type::vector< Hexahedron > &pHexahedra, Topology::HexahedronID p0, Topology::HexahedronID p1, Topology::HexahedronID p2, Topology::HexahedronID p3, Topology::HexahedronID p4, Topology::HexahedronID p5, Topology::HexahedronID p6, Topology::HexahedronID p7)
 
void addPentahedron (type::vector< Pentahedron > &pPentahedra, const Pentahedron &p)
 
void addPentahedron (type::vector< Pentahedron > &pPentahedra, Topology::ElemID p0, Topology::ElemID p1, Topology::ElemID p2, Topology::ElemID p3, Topology::ElemID p4, Topology::ElemID p5)
 
void addPyramid (type::vector< Pyramid > &pPyramids, const Pyramid &p)
 
void addPyramid (type::vector< Pyramid > &pPyramids, Topology::ElemID p0, Topology::ElemID p1, Topology::ElemID p2, Topology::ElemID p3, Topology::ElemID p4)
 
void copyMeshToData (helper::io::Mesh &_mesh)
 Temporary method that will copy all buffers from a io::Mesh into the corresponding Data. Will be removed as soon as work on unifying meshloader is finished. More...
 
- Protected Member Functions inherited from sofa::core::loader::BaseLoader
 BaseLoader ()
 
 ~BaseLoader () 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::loader::MeshLoader
type::Matrix4 d_previousTransformation
 to be able to call reinit w/o applying several time the same transform 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...
 
- 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)
 
- Static Protected Member Functions inherited from sofa::core::loader::BaseLoader
static void skipToEOL (FILE *f)
 
static bool readLine (char *buf, int size, FILE *f)
 

Attribute details

◆ _forceBinary

sofa::core::objectmodel::RenamedData<bool> sofa::component::io::mesh::MeshSTLLoader::_forceBinary

◆ _headerSize

sofa::core::objectmodel::RenamedData<unsigned int> sofa::component::io::mesh::MeshSTLLoader::_headerSize

◆ d_forceBinary

Data<bool> sofa::component::io::mesh::MeshSTLLoader::d_forceBinary

Force reading in binary mode. Even in first keyword of the file is solid.

◆ d_headerSize

Data<unsigned int> sofa::component::io::mesh::MeshSTLLoader::d_headerSize

Size of the header binary file (just before the number of facet).

◆ d_mergePositionUsingMap

Data<bool> sofa::component::io::mesh::MeshSTLLoader::d_mergePositionUsingMap

Since positions are duplicated in a STL, they have to be merged. Using a map to do so will temporarily duplicate memory but should be more efficient. Disable it if memory is really an issue.

Constructor details

◆ MeshSTLLoader()

sofa::component::io::mesh::MeshSTLLoader::MeshSTLLoader ( )
protected

Function details

◆ readBinarySTL()

bool sofa::component::io::mesh::MeshSTLLoader::readBinarySTL ( const char filename)
protected

◆ readSTL()

bool sofa::component::io::mesh::MeshSTLLoader::readSTL ( std::ifstream &  file)
protected

◆ SOFA_CLASS()

sofa::component::io::mesh::MeshSTLLoader::SOFA_CLASS ( MeshSTLLoader  ,
sofa::core::loader::MeshLoader   
)