SOFA API  93933a5d
Open source framework for multi-physics simuation
sofa::gl::component::rendering3d::SlicedVolumetricModel Class Reference

#include <SlicedVolumetricModel.h>

Inheritance diagram for sofa::gl::component::rendering3d::SlicedVolumetricModel:

Protected Attributes

Data< floatalpha
 Opacity of the billboards. 1.0 is 100% opaque. More...
 
Data< sofa::type::RGBAColorcolor
 Billboard color.(default=1.0,1.0,1.0,1.0) More...
 
Data< int > _nbPlanes
 Number of billboards. More...
 
int _nbPlanesOld
 
core::topology::BaseMeshTopology_topology
 
core::behavior::BaseMechanicalState_mstate
 
unsigned chartexture_data
 
bool _first
 
GLuint _texname
 
int _width
 
int _height
 
int _depth
 
Coord vRight
 
Coord vUp
 
Coord _planeNormal
 
Real _radius
 
Real _planeSeparations
 
VecCoord _textureCoordinates
 
double _minBBox [3]
 
double _maxBBox [3]
 
- 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_CLASS (SlicedVolumetricModel, core::visual::VisualModel)
 
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 isTransparent ()
 
void drawTransparent (const core::visual::VisualParams *vparams) override
 Display transparent surfaces. More...
 
- 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 initVisual ()
 Initialize the textures, or other graphical resources. 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 drawShadow (const VisualParams *vparams)
 Display shadow-casting surfaces. More...
 
virtual void updateVisual ()
 used to update the model if necessary. More...
 
virtual void parallelUpdateVisual ()
 used to update the model if necessary. More...
 
virtual bool addBBox (SReal *, SReal *)
 used to add the bounding-box of this visual model to the given bounding box in order to compute the scene bounding box or cull hidden objects. More...
 
virtual void applyTranslation (const SReal, const SReal, const SReal)
 
virtual void applyRotation (const SReal, const SReal, const SReal)
 
virtual void applyRotation (const type::Quat< SReal >)
 
virtual void applyScale (const SReal, const SReal, const SReal)
 
virtual void exportOBJ (std::string, std::ostream *, std::ostream *, sofa::Index &, sofa::Index &, sofa::Index &, int &)
 Append this mesh to an OBJ format stream. More...
 
bool insertInNode (objectmodel::BaseNode *node) override
 
bool removeInNode (objectmodel::BaseNode *node) override
 
- Public Member Functions inherited from sofa::core::objectmodel::BaseObject
 SOFA_CLASS (BaseObject, Base)
 
virtual void draw (const core::visual::VisualParams *)
 Render internal data of this object, for debugging purposes. More...
 
virtual void computeBBox (const core::ExecParams *, bool=false)
 
void setSrc (const std::string &v, std::vector< std::string > *attributeList=nullptr)
 Sets a source Object and parses it to collect dependent Data. More...
 
void setSrc (const std::string &v, const BaseObject *loader, std::vector< std::string > *attributeList=nullptr)
 
BasefindLinkDestClass (const BaseClass *destType, const std::string &path, const BaseLink *link) override
 
virtual std::string getPathName () const override
 Return the full path name of this object. More...
 
SReal getTime () const
 Current time. More...
 
const BaseContextgetContext () const
 
BaseContextgetContext ()
 
const BaseObjectgetMaster () const
 
BaseObjectgetMaster ()
 
const VecSlavesgetSlaves () const
 
BaseObjectgetSlave (const std::string &name) const
 
virtual void addSlave (BaseObject::SPtr s)
 
virtual void removeSlave (BaseObject::SPtr s)
 
virtual void handleEvent (Event *)
 Handle an event. More...
 
virtual void handleTopologyChange ()
 
virtual void handleTopologyChange (core::topology::Topology *t)
 
void parse (BaseObjectDescription *arg) override
 Parse the given description to assign values to this object's fields and potentially other parameters. More...
 
virtual void 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

 SlicedVolumetricModel ()
 
 ~SlicedVolumetricModel () override
 
void findAndDrawTriangles ()
 
void computePlaneSeparations ()
 
int intersectionSegmentPlane (const Coord &s0, const Coord &s1, const Coord &segmentDirection, const Coord &planeNormal, const Real &planeConstant, Real &m_fLineT)
 return 0->no intersection, 1->1 intersection, 2->line on plane 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...
 

Additional Inherited Members

- Public Attributes inherited from sofa::core::visual::VisualModel
Data< boold_enable
 Display the object or not. More...
 
- Public Attributes inherited from sofa::core::objectmodel::BaseObject
Data< boolf_listening
 if true, handle the events, otherwise ignore the events More...
 
- Public Attributes inherited from sofa::core::objectmodel::Base
std::vector< lifecycle::DeprecatedData * > m_oldAttributes
 
Data< int > d_messageLogCount
 
Data< std::string > name
 Name of the object. More...
 
Data< boolf_printLog
 if true, emits extra messages at runtime. More...
 
Data< sofa::core::objectmodel::TagSetf_tags
 list of the subsets the objet 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}
 
- 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

◆ _depth

int sofa::gl::component::rendering3d::SlicedVolumetricModel::_depth
protected

◆ _first

bool sofa::gl::component::rendering3d::SlicedVolumetricModel::_first
protected

◆ _height

int sofa::gl::component::rendering3d::SlicedVolumetricModel::_height
protected

◆ _maxBBox

double sofa::gl::component::rendering3d::SlicedVolumetricModel::_maxBBox[3]
protected

◆ _minBBox

double sofa::gl::component::rendering3d::SlicedVolumetricModel::_minBBox[3]
protected

◆ _mstate

core::behavior::BaseMechanicalState* sofa::gl::component::rendering3d::SlicedVolumetricModel::_mstate
protected

◆ _nbPlanes

Data<int> sofa::gl::component::rendering3d::SlicedVolumetricModel::_nbPlanes
protected

Number of billboards.

◆ _nbPlanesOld

int sofa::gl::component::rendering3d::SlicedVolumetricModel::_nbPlanesOld
protected

◆ _planeNormal

Coord sofa::gl::component::rendering3d::SlicedVolumetricModel::_planeNormal
protected

◆ _planeSeparations

Real sofa::gl::component::rendering3d::SlicedVolumetricModel::_planeSeparations
protected

◆ _radius

Real sofa::gl::component::rendering3d::SlicedVolumetricModel::_radius
protected

◆ _texname

GLuint sofa::gl::component::rendering3d::SlicedVolumetricModel::_texname
protected

◆ _textureCoordinates

VecCoord sofa::gl::component::rendering3d::SlicedVolumetricModel::_textureCoordinates
protected

◆ _topology

core::topology::BaseMeshTopology* sofa::gl::component::rendering3d::SlicedVolumetricModel::_topology
protected

◆ _width

int sofa::gl::component::rendering3d::SlicedVolumetricModel::_width
protected

◆ alpha

Data<float> sofa::gl::component::rendering3d::SlicedVolumetricModel::alpha
protected

Opacity of the billboards. 1.0 is 100% opaque.

◆ color

Data<sofa::type::RGBAColor> sofa::gl::component::rendering3d::SlicedVolumetricModel::color
protected

Billboard color.(default=1.0,1.0,1.0,1.0)

◆ texture_data

unsigned char* sofa::gl::component::rendering3d::SlicedVolumetricModel::texture_data
protected

◆ vRight

Coord sofa::gl::component::rendering3d::SlicedVolumetricModel::vRight
protected

◆ vUp

Coord sofa::gl::component::rendering3d::SlicedVolumetricModel::vUp
protected

Constructor details

◆ SlicedVolumetricModel()

sofa::gl::component::rendering3d::SlicedVolumetricModel::SlicedVolumetricModel ( )
protected

◆ ~SlicedVolumetricModel()

sofa::gl::component::rendering3d::SlicedVolumetricModel::~SlicedVolumetricModel ( )
overrideprotected

Function details

◆ computePlaneSeparations()

void sofa::gl::component::rendering3d::SlicedVolumetricModel::computePlaneSeparations ( )
protected

◆ drawTransparent()

void sofa::gl::component::rendering3d::SlicedVolumetricModel::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.

◆ findAndDrawTriangles()

void sofa::gl::component::rendering3d::SlicedVolumetricModel::findAndDrawTriangles ( )
protected

◆ init()

void sofa::gl::component::rendering3d::SlicedVolumetricModel::init ( void  )
overridevirtual

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

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

◆ intersectionSegmentPlane()

int sofa::gl::component::rendering3d::SlicedVolumetricModel::intersectionSegmentPlane ( const Coord s0,
const Coord s1,
const Coord segmentDirection,
const Coord planeNormal,
const Real planeConstant,
Real m_fLineT 
)
protected

return 0->no intersection, 1->1 intersection, 2->line on plane

◆ isTransparent()

virtual bool sofa::gl::component::rendering3d::SlicedVolumetricModel::isTransparent ( )
inlinevirtual

◆ reinit()

void sofa::gl::component::rendering3d::SlicedVolumetricModel::reinit ( )
overridevirtual

Update method called when variables used in precomputation are modified.

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

◆ SOFA_CLASS()

sofa::gl::component::rendering3d::SlicedVolumetricModel::SOFA_CLASS ( SlicedVolumetricModel  ,
core::visual::VisualModel   
)