SOFA API  cd4ffb93
Open source framework for multi-physics simuation
sofa::component::engine::select::BaseROI< DataTypes > Class Template Referenceabstract

#include <BaseROI.h>

Inheritance diagram for sofa::component::engine::select::BaseROI< DataTypes >:

Detailed Description

template<class DataTypes>
class sofa::component::engine::select::BaseROI< DataTypes >

This interface defines the features for Regions Of Interest (ROI)

Public Attributes

Data< VecCoordd_positions
 
Data< VecEdged_edges
 Edge Topology. More...
 
Data< VecTriangled_triangles
 Triangle Topology. More...
 
Data< VecQuadd_quads
 Quad Topology. More...
 
Data< VecTetrad_tetrahedra
 Tetrahedron Topology. More...
 
Data< VecHexad_hexahedra
 Hexahedron Topology. More...
 
Data< boold_computeEdges
 If true, will compute edge list and index list inside the ROI. (default = true) More...
 
Data< boold_computeTriangles
 If true, will compute triangle list and index list inside the ROI. (default = true) More...
 
Data< boold_computeQuads
 If true, will compute quad list and index list inside the ROI. (default = true) More...
 
Data< boold_computeTetrahedra
 If true, will compute tetrahedra list and index list inside the ROI. (default = true) More...
 
Data< boold_computeHexahedra
 If true, will compute hexahedra list and index list inside the ROI. (default = true) More...
 
Data< boold_strict
 If true, an element is inside the box if all of its nodes are inside. If False, only the center point of the element is checked. (default = true) More...
 
Data< SetIndexd_indices
 Indices of the points contained in the ROI. More...
 
Data< SetIndexd_edgeIndices
 Indices of the edges contained in the ROI. More...
 
Data< SetIndexd_triangleIndices
 Indices of the triangles contained in the ROI. More...
 
Data< SetIndexd_quadIndices
 Indices of the quad contained in the ROI. More...
 
Data< SetIndexd_tetrahedronIndices
 Indices of the tetrahedra contained in the ROI. More...
 
Data< SetIndexd_hexahedronIndices
 Indices of the hexahedra contained in the ROI. More...
 
Data< VecCoordd_pointsInROI
 Points contained in the ROI. More...
 
Data< VecEdged_edgesInROI
 Edges contained in the ROI. More...
 
Data< VecTriangled_trianglesInROI
 Triangles contained in the ROI. More...
 
Data< VecQuadd_quadsInROI
 Quad contained in the ROI. More...
 
Data< VecTetrad_tetrahedraInROI
 Tetrahedra contained in the ROI. More...
 
Data< VecHexad_hexahedraInROI
 Hexahedra contained in the ROI. More...
 
Data< sofa::Size > d_nbIndices
 Number of selected indices. More...
 
Data< VecCoordd_pointsOutROI
 Points not contained in the ROI. More...
 
Data< type::vector< Edge > > d_edgesOutROI
 Edges not contained in the ROI. More...
 
Data< type::vector< Triangle > > d_trianglesOutROI
 Triangles not contained in the ROI. More...
 
Data< type::vector< Quad > > d_quadsOutROI
 Quads not contained in the ROI. More...
 
Data< type::vector< Tetra > > d_tetrahedraOutROI
 Tetrahedra not contained in the ROI. More...
 
Data< type::vector< Hexa > > d_hexahedraOutROI
 Hexahedra not contained in the ROI. More...
 
Data< SetIndexd_indicesOut
 Indices of the points not contained in the ROI. More...
 
Data< SetIndexd_edgeOutIndices
 Indices of the edges not contained in the ROI. More...
 
Data< SetIndexd_triangleOutIndices
 Indices of the triangles not contained in the ROI. More...
 
Data< SetIndexd_quadOutIndices
 Indices of the quads not contained in the ROI. More...
 
Data< SetIndexd_tetrahedronOutIndices
 Indices of the tetrahedra not contained in the ROI. More...
 
Data< SetIndexd_hexahedronOutIndices
 Indices of the hexahedra not contained in the ROI. More...
 
Data< boold_drawROI
 Draw the ROI. (default = false) More...
 
Data< boold_drawPoints
 Draw Points. (default = false) More...
 
Data< boold_drawEdges
 Draw Edges. (default = false) More...
 
Data< boold_drawTriangles
 Draw Triangles. (default = false) More...
 
Data< boold_drawQuads
 Draw Quads. (default = false) More...
 
Data< boold_drawTetrahedra
 Draw Tetrahedra. (default = false) More...
 
Data< boold_drawHexahedra
 Draw Tetrahedra. (default = false) More...
 
Data< floatd_drawSize
 rendering size for ROI and topological elements More...
 
Data< boold_doUpdate
 If true, updates the selection at the beginning of simulation steps. (default = true) More...
 
sofa::core::objectmodel::RenamedData< VecCoordd_X0
 
- 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 (SOFA_TEMPLATE(BaseROI, DataTypes), Inherit)
 
void init () final
 Initialization method called at graph creation and modification, during top-down traversal. More...
 
void doUpdate () override
 Where you put your engine's impl. More...
 
void draw (const core::visual::VisualParams *vparams) final
 Render internal data of this object, for debugging purposes. More...
 
void computeBBox (const core::ExecParams *params, bool onlyVisible) final
 
virtual void roiInit ()
 
virtual bool roiDoUpdate ()
 
virtual void roiDraw (const core::visual::VisualParams *)
 
virtual void roiComputeBBox (const core::ExecParams *, type::BoundingBox &)
 
- Public Member Functions inherited from sofa::core::DataEngine
 SOFA_ABSTRACT_CLASS (DataEngine, core::objectmodel::BaseObject)
 
void update () final
 
void addInput (sofa::core::objectmodel::BaseData *data)
 Add a new input to this engine. More...
 
void addOutput (objectmodel::BaseData *n)
 Add a new output to this engine. More...
 
- Public Member Functions inherited from sofa::core::DataTrackerDDGNode
 DataTrackerDDGNode ()
 
void addInputs (std::initializer_list< sofa::core::objectmodel::BaseData * > datas)
 Create a DataCallback object associated with multiple Data fields. More...
 
void addOutputs (std::initializer_list< sofa::core::objectmodel::BaseData * > datas)
 
virtual void cleanDirty (const core::ExecParams *params=nullptr)
 
void updateAllInputsIfDirty ()
 
- Public Member Functions inherited from sofa::core::objectmodel::DDGNode
 DDGNode ()
 Constructor. More...
 
virtual ~DDGNode ()
 Destructor. Automatically remove remaining links. More...
 
void addInput (DDGNode *n)
 Add a new input to this node. More...
 
void delInput (DDGNode *n)
 Remove an input from this node. More...
 
void addOutput (DDGNode *n)
 Add a new output to this node. More...
 
void delOutput (DDGNode *n)
 Remove an output from this node. More...
 
const DDGLinkContainergetInputs ()
 Get the list of inputs for this DDGNode. More...
 
const DDGLinkContainergetOutputs ()
 Get the list of outputs for this DDGNode. More...
 
bool isDirty () const
 Returns true if the DDGNode needs to be updated. More...
 
virtual void setDirtyValue ()
 Indicate the value needs to be updated. More...
 
virtual void setDirtyOutputs ()
 Indicate the outputs needs to be updated. This method must be called after changing the value of this node. More...
 
void cleanDirty ()
 Set dirty flag to false. More...
 
virtual void notifyEndEdit ()
 Notify links that the DGNode has been modified. More...
 
void updateIfDirty () const
 Utility method to call update if necessary. This method should be called before reading of writing the value of this node. More...
 
- Public Member Functions inherited from sofa::core::objectmodel::BaseObject
 SOFA_CLASS (BaseObject, Base)
 
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...
 
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

 BaseROI ()
 
 ~BaseROI () override=default
 
bool isPointIn (const PointID pid) const
 
template<typename Element >
bool isInROI (const Element &e) const
 
template<typename Element >
bool isInStrictROI (const Element &e) const
 
virtual bool isPointInROI (const CPos &p) const =0
 
virtual bool isEdgeInROI (const Edge &e) const
 
virtual bool isEdgeInStrictROI (const Edge &e) const
 
virtual bool isTriangleInROI (const Triangle &t) const
 
virtual bool isTriangleInStrictROI (const Triangle &t) const
 
virtual bool isQuadInROI (const Quad &q) const
 
virtual bool isQuadInStrictROI (const Quad &q) const
 
virtual bool isTetrahedronInROI (const Tetra &t) const
 
virtual bool isTetrahedronInStrictROI (const Tetra &t) const
 
virtual bool isHexahedronInROI (const Hexa &t) const
 
virtual bool isHexahedronInStrictROI (const Hexa &t) const
 
- Protected Member Functions inherited from sofa::core::DataEngine
 DataEngine ()
 Constructor. More...
 
 ~DataEngine () override
 Destructor. Do nothing. More...
 
virtual void doInternalUpdate () final
 Prevent engines to use the internalUpdate mechanism, so that only update/doUpdate is used. More...
 
- Protected Member Functions inherited from sofa::core::objectmodel::DDGNode
virtual void doAddInput (DDGNode *n)
 
virtual void doDelInput (DDGNode *n)
 
virtual void doAddOutput (DDGNode *n)
 
virtual void doDelOutput (DDGNode *n)
 
void cleanDirtyOutputsOfInputs ()
 the dirtyOutputs flags of all the inputs will be set to false More...
 
- 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::DataTrackerDDGNode
DataTracker m_dataTracker
 
- Protected Attributes inherited from sofa::core::objectmodel::DDGNode
DDGLinkContainer inputs
 
DDGLinkContainer outputs
 
- 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_computeEdges

template<class DataTypes >
Data<bool> sofa::component::engine::select::BaseROI< DataTypes >::d_computeEdges

If true, will compute edge list and index list inside the ROI. (default = true)

◆ d_computeHexahedra

template<class DataTypes >
Data<bool> sofa::component::engine::select::BaseROI< DataTypes >::d_computeHexahedra

If true, will compute hexahedra list and index list inside the ROI. (default = true)

◆ d_computeQuads

template<class DataTypes >
Data<bool> sofa::component::engine::select::BaseROI< DataTypes >::d_computeQuads

If true, will compute quad list and index list inside the ROI. (default = true)

◆ d_computeTetrahedra

template<class DataTypes >
Data<bool> sofa::component::engine::select::BaseROI< DataTypes >::d_computeTetrahedra

If true, will compute tetrahedra list and index list inside the ROI. (default = true)

◆ d_computeTriangles

template<class DataTypes >
Data<bool> sofa::component::engine::select::BaseROI< DataTypes >::d_computeTriangles

If true, will compute triangle list and index list inside the ROI. (default = true)

◆ d_doUpdate

template<class DataTypes >
Data<bool> sofa::component::engine::select::BaseROI< DataTypes >::d_doUpdate

If true, updates the selection at the beginning of simulation steps. (default = true)

◆ d_drawEdges

template<class DataTypes >
Data<bool> sofa::component::engine::select::BaseROI< DataTypes >::d_drawEdges

Draw Edges. (default = false)

◆ d_drawHexahedra

template<class DataTypes >
Data<bool> sofa::component::engine::select::BaseROI< DataTypes >::d_drawHexahedra

Draw Tetrahedra. (default = false)

◆ d_drawPoints

template<class DataTypes >
Data<bool> sofa::component::engine::select::BaseROI< DataTypes >::d_drawPoints

Draw Points. (default = false)

◆ d_drawQuads

template<class DataTypes >
Data<bool> sofa::component::engine::select::BaseROI< DataTypes >::d_drawQuads

Draw Quads. (default = false)

◆ d_drawROI

template<class DataTypes >
Data<bool> sofa::component::engine::select::BaseROI< DataTypes >::d_drawROI

Draw the ROI. (default = false)

◆ d_drawSize

template<class DataTypes >
Data<float> sofa::component::engine::select::BaseROI< DataTypes >::d_drawSize

rendering size for ROI and topological elements

◆ d_drawTetrahedra

template<class DataTypes >
Data<bool> sofa::component::engine::select::BaseROI< DataTypes >::d_drawTetrahedra

Draw Tetrahedra. (default = false)

◆ d_drawTriangles

template<class DataTypes >
Data<bool> sofa::component::engine::select::BaseROI< DataTypes >::d_drawTriangles

Draw Triangles. (default = false)

◆ d_edgeIndices

template<class DataTypes >
Data<SetIndex> sofa::component::engine::select::BaseROI< DataTypes >::d_edgeIndices

Indices of the edges contained in the ROI.

◆ d_edgeOutIndices

template<class DataTypes >
Data<SetIndex> sofa::component::engine::select::BaseROI< DataTypes >::d_edgeOutIndices

Indices of the edges not contained in the ROI.

◆ d_edges

template<class DataTypes >
Data<VecEdge > sofa::component::engine::select::BaseROI< DataTypes >::d_edges

Edge Topology.

◆ d_edgesInROI

template<class DataTypes >
Data<VecEdge> sofa::component::engine::select::BaseROI< DataTypes >::d_edgesInROI

Edges contained in the ROI.

◆ d_edgesOutROI

template<class DataTypes >
Data<type::vector<Edge> > sofa::component::engine::select::BaseROI< DataTypes >::d_edgesOutROI

Edges not contained in the ROI.

◆ d_hexahedra

template<class DataTypes >
Data<VecHexa > sofa::component::engine::select::BaseROI< DataTypes >::d_hexahedra

Hexahedron Topology.

◆ d_hexahedraInROI

template<class DataTypes >
Data<VecHexa> sofa::component::engine::select::BaseROI< DataTypes >::d_hexahedraInROI

Hexahedra contained in the ROI.

◆ d_hexahedraOutROI

template<class DataTypes >
Data<type::vector<Hexa> > sofa::component::engine::select::BaseROI< DataTypes >::d_hexahedraOutROI

Hexahedra not contained in the ROI.

◆ d_hexahedronIndices

template<class DataTypes >
Data<SetIndex> sofa::component::engine::select::BaseROI< DataTypes >::d_hexahedronIndices

Indices of the hexahedra contained in the ROI.

◆ d_hexahedronOutIndices

template<class DataTypes >
Data<SetIndex> sofa::component::engine::select::BaseROI< DataTypes >::d_hexahedronOutIndices

Indices of the hexahedra not contained in the ROI.

◆ d_indices

template<class DataTypes >
Data<SetIndex> sofa::component::engine::select::BaseROI< DataTypes >::d_indices

Indices of the points contained in the ROI.

◆ d_indicesOut

template<class DataTypes >
Data<SetIndex> sofa::component::engine::select::BaseROI< DataTypes >::d_indicesOut

Indices of the points not contained in the ROI.

◆ d_nbIndices

template<class DataTypes >
Data< sofa::Size > sofa::component::engine::select::BaseROI< DataTypes >::d_nbIndices

Number of selected indices.

◆ d_pointsInROI

template<class DataTypes >
Data<VecCoord> sofa::component::engine::select::BaseROI< DataTypes >::d_pointsInROI

Points contained in the ROI.

◆ d_pointsOutROI

template<class DataTypes >
Data<VecCoord > sofa::component::engine::select::BaseROI< DataTypes >::d_pointsOutROI

Points not contained in the ROI.

◆ d_positions

template<class DataTypes >
Data<VecCoord> sofa::component::engine::select::BaseROI< DataTypes >::d_positions

◆ d_quadIndices

template<class DataTypes >
Data<SetIndex> sofa::component::engine::select::BaseROI< DataTypes >::d_quadIndices

Indices of the quad contained in the ROI.

◆ d_quadOutIndices

template<class DataTypes >
Data<SetIndex> sofa::component::engine::select::BaseROI< DataTypes >::d_quadOutIndices

Indices of the quads not contained in the ROI.

◆ d_quads

template<class DataTypes >
Data<VecQuad > sofa::component::engine::select::BaseROI< DataTypes >::d_quads

Quad Topology.

◆ d_quadsInROI

template<class DataTypes >
Data<VecQuad> sofa::component::engine::select::BaseROI< DataTypes >::d_quadsInROI

Quad contained in the ROI.

◆ d_quadsOutROI

template<class DataTypes >
Data<type::vector<Quad> > sofa::component::engine::select::BaseROI< DataTypes >::d_quadsOutROI

Quads not contained in the ROI.

◆ d_strict

template<class DataTypes >
Data<bool> sofa::component::engine::select::BaseROI< DataTypes >::d_strict

If true, an element is inside the box if all of its nodes are inside. If False, only the center point of the element is checked. (default = true)

◆ d_tetrahedra

template<class DataTypes >
Data<VecTetra > sofa::component::engine::select::BaseROI< DataTypes >::d_tetrahedra

Tetrahedron Topology.

◆ d_tetrahedraInROI

template<class DataTypes >
Data<VecTetra> sofa::component::engine::select::BaseROI< DataTypes >::d_tetrahedraInROI

Tetrahedra contained in the ROI.

◆ d_tetrahedraOutROI

template<class DataTypes >
Data<type::vector<Tetra> > sofa::component::engine::select::BaseROI< DataTypes >::d_tetrahedraOutROI

Tetrahedra not contained in the ROI.

◆ d_tetrahedronIndices

template<class DataTypes >
Data<SetIndex> sofa::component::engine::select::BaseROI< DataTypes >::d_tetrahedronIndices

Indices of the tetrahedra contained in the ROI.

◆ d_tetrahedronOutIndices

template<class DataTypes >
Data<SetIndex> sofa::component::engine::select::BaseROI< DataTypes >::d_tetrahedronOutIndices

Indices of the tetrahedra not contained in the ROI.

◆ d_triangleIndices

template<class DataTypes >
Data<SetIndex> sofa::component::engine::select::BaseROI< DataTypes >::d_triangleIndices

Indices of the triangles contained in the ROI.

◆ d_triangleOutIndices

template<class DataTypes >
Data<SetIndex> sofa::component::engine::select::BaseROI< DataTypes >::d_triangleOutIndices

Indices of the triangles not contained in the ROI.

◆ d_triangles

template<class DataTypes >
Data<VecTriangle > sofa::component::engine::select::BaseROI< DataTypes >::d_triangles

Triangle Topology.

◆ d_trianglesInROI

template<class DataTypes >
Data<VecTriangle> sofa::component::engine::select::BaseROI< DataTypes >::d_trianglesInROI

Triangles contained in the ROI.

◆ d_trianglesOutROI

template<class DataTypes >
Data<type::vector<Triangle> > sofa::component::engine::select::BaseROI< DataTypes >::d_trianglesOutROI

Triangles not contained in the ROI.

◆ d_X0

Constructor details

◆ BaseROI()

template<class DataTypes >
sofa::component::engine::select::BaseROI< DataTypes >::BaseROI
protected

◆ ~BaseROI()

template<class DataTypes >
sofa::component::engine::select::BaseROI< DataTypes >::~BaseROI ( )
overrideprotecteddefault

Function details

◆ computeBBox()

template<typename DataTypes >
void sofa::component::engine::select::BaseROI< DataTypes >::computeBBox ( const core::ExecParams ,
bool   
)
finalvirtual

Bounding Box computation method. Default to empty method.

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

◆ doUpdate()

template<class DataTypes >
void sofa::component::engine::select::BaseROI< DataTypes >::doUpdate ( )
overridevirtual

Where you put your engine's impl.

Implements sofa::core::DataEngine.

◆ draw()

template<class DataTypes >
void sofa::component::engine::select::BaseROI< DataTypes >::draw ( const core::visual::VisualParams )
finalvirtual

Render internal data of this object, for debugging purposes.

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

◆ init()

template<class DataTypes >
void sofa::component::engine::select::BaseROI< DataTypes >::init ( void  )
finalvirtual

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

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

◆ isEdgeInROI()

template<class DataTypes >
bool sofa::component::engine::select::BaseROI< DataTypes >::isEdgeInROI ( const Edge e) const
protectedvirtual

◆ isEdgeInStrictROI()

template<class DataTypes >
bool sofa::component::engine::select::BaseROI< DataTypes >::isEdgeInStrictROI ( const Edge e) const
protectedvirtual

◆ isHexahedronInROI()

template<class DataTypes >
bool sofa::component::engine::select::BaseROI< DataTypes >::isHexahedronInROI ( const Hexa t) const
protectedvirtual

◆ isHexahedronInStrictROI()

template<class DataTypes >
bool sofa::component::engine::select::BaseROI< DataTypes >::isHexahedronInStrictROI ( const Hexa t) const
protectedvirtual

◆ isInROI()

template<class DataTypes >
template<typename Element >
bool sofa::component::engine::select::BaseROI< DataTypes >::isInROI ( const Element &  e) const
protected

◆ isInStrictROI()

template<class DataTypes >
template<typename Element >
bool sofa::component::engine::select::BaseROI< DataTypes >::isInStrictROI ( const Element &  e) const
protected

◆ isPointIn()

template<class DataTypes >
bool sofa::component::engine::select::BaseROI< DataTypes >::isPointIn ( const PointID  pid) const
protected

◆ isPointInROI()

◆ isQuadInROI()

template<class DataTypes >
bool sofa::component::engine::select::BaseROI< DataTypes >::isQuadInROI ( const Quad q) const
protectedvirtual

◆ isQuadInStrictROI()

template<class DataTypes >
bool sofa::component::engine::select::BaseROI< DataTypes >::isQuadInStrictROI ( const Quad q) const
protectedvirtual

◆ isTetrahedronInROI()

template<class DataTypes >
bool sofa::component::engine::select::BaseROI< DataTypes >::isTetrahedronInROI ( const Tetra t) const
protectedvirtual

◆ isTetrahedronInStrictROI()

template<class DataTypes >
bool sofa::component::engine::select::BaseROI< DataTypes >::isTetrahedronInStrictROI ( const Tetra t) const
protectedvirtual

◆ isTriangleInROI()

template<class DataTypes >
bool sofa::component::engine::select::BaseROI< DataTypes >::isTriangleInROI ( const Triangle t) const
protectedvirtual

◆ isTriangleInStrictROI()

template<class DataTypes >
bool sofa::component::engine::select::BaseROI< DataTypes >::isTriangleInStrictROI ( const Triangle t) const
protectedvirtual

◆ roiComputeBBox()

◆ roiDoUpdate()

◆ roiDraw()

◆ roiInit()

◆ SOFA_CLASS()

template<class DataTypes >
sofa::component::engine::select::BaseROI< DataTypes >::SOFA_CLASS ( SOFA_TEMPLATE(BaseROI< DataTypes >, DataTypes ,
Inherit   
)