SOFA plugin: image  master
Open source framework for multi-physics simuation
sofa::component::container::ImageContainer< _ImageTypes > Class Template Reference

#include <ImageContainer.h>

forward declaration More...

Inheritance diagram for sofa::component::container::ImageContainer< _ImageTypes >:

Detailed Description

template<class _ImageTypes>
class sofa::component::container::ImageContainer< _ImageTypes >

forward declaration

This component is responsible for loading images.

ImageContainer scene options:

template

filename</> - the name of the image file to be loaded. Currently supported filetypes:

Public Attributes

Data< ImageTypesimage
 image More...
 
Data< TransformTypetransform
 12-param vector for trans, rot, scale, ... More...
 
sofa::core::objectmodel::DataFileName m_filename
 
Data< bool > drawBB
 draw bounding box More...
 
Data< bool > sequence
 load a sequence of images More...
 
Data< unsigned int > nFrames
 The number of frames of the sequence to be loaded. Default is the entire sequence. More...
 
bool transformIsSet
 
- Public Attributes inherited from sofa::core::objectmodel::BaseObject
Data< bool > f_listening
 
- Public Attributes inherited from sofa::core::objectmodel::Base
std::vector< lifecycle::DeprecatedData * > m_oldAttributes
 
Data< int > d_messageLogCount
 
Data< std::string > name
 
Data< bool > f_printLog
 
Data< sofa::core::objectmodel::TagSetf_tags
 
Data< sofa::type::BoundingBoxf_bbox
 
Data< sofa::core::objectmodel::ComponentStated_componentState
 
std::string m_definitionSourceFileName
 
int m_definitionSourceFilePos
 
std::string m_instanciationSourceFileName
 
int m_instanciationSourceFilePos
 

Public Member Functions

 SOFA_CLASS (SOFA_TEMPLATE(ImageContainer, _ImageTypes), Inherited)
 
 ImageContainer ()
 
virtual void clear ()
 
 ~ImageContainer () override
 
void parse (sofa::core::objectmodel::BaseObjectDescription *arg) override
 
void init () override
 
- 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)
 
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
 
virtual bool insertInNode (BaseNode *)
 
virtual bool removeInNode (BaseNode *)
 
SReal getTime () const
 
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 handleTopologyChange ()
 
virtual void handleTopologyChange (core::topology::Topology *t)
 
virtual void bwdInit ()
 
virtual void reinit ()
 
void updateInternal ()
 
virtual void storeResetState ()
 
virtual void reset ()
 
virtual void cleanup ()
 
SReal getTime () const
 
- 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
 
void setName (const std::string &n)
 
void setName (const std::string &n, int counter)
 
std::string getTypeName () const
 
virtual std::string getClassName () const
 
virtual std::string getTemplateName () const final
 
std::string getNameSpaceName () const
 
void setDefinitionSourceFileName (const std::string &sourceFileName)
 
const std::string & getDefinitionSourceFileName () const
 
void setDefinitionSourceFilePos (const int)
 
int getDefinitionSourceFilePos () const
 
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
 
bool hasTag (Tag t) const
 
void addTag (Tag t)
 
void removeTag (Tag t)
 
ComponentState getComponentState () const
 
bool isComponentStateValid () const
 
bool isComponentStateInvalid () const
 
 SOFA_ATTRIBUTE_DEPRECATED__TOBASECONSTRAINT () virtual const behavior
 
virtual bool parseField (const std::string &attribute, const std::string &value)
 
virtual bool hasField (const std::string &attribute) const
 
void parseFields (const std::list< std::string > &str)
 
virtual void parseFields (const std::map< std::string, std::string * > &str)
 
void writeDatas (std::map< std::string, std::string * > &str)=delete
 
void writeDatas (std::ostream &out, const std::string &separator=" ")
 
BaseDatafindData (const std::string &name) const
 
std::vector< BaseData * > findGlobalField (const std::string &name) const
 
BaseLinkfindLink (const std::string &name) const
 
std::vector< BaseLink * > findLinks (const std::string &name) const
 
virtual void updateLinks (bool logErrors=true)
 
BaseData::BaseInitData initData (::sofa::core::objectmodel::Data< T > *field, const char *name, const char *help, ::sofa::core::objectmodel::BaseData::DataFlags dataflags)
 
BaseData::BaseInitData initData (Data< T > *field, const char *name, const char *help, bool isDisplayed=true, bool isReadOnly=false)
 
Data< T >::InitData initData (Data< T > *field, const T &value, const char *name, const char *help, bool isDisplayed=true, bool isReadOnly=false)
 
void addData (BaseData *f, const std::string &name)
 
void addData (BaseData *f)
 
void removeData (BaseData *f)
 
void addAlias (BaseData *field, const char *alias)
 
void addLink (BaseLink *l)
 
void addAlias (BaseLink *link, const char *alias)
 
const VecDatagetDataFields () const
 
const MapDatagetDataAliases () const
 
const VecLinkgetLinks () const
 
const MapLinkgetLinkAliases () const
 
virtual bool findDataLinkDest (BaseData *&ptr, const std::string &path, const BaseLink *link)
 
bool findLinkDest (T *&ptr, const std::string &path, const BaseLink *link)
 
const sofa::core::objectmodel::TagSetgetTags () const
 
bool hasTag (Tag t) const
 
void addTag (Tag t)
 
void removeTag (Tag t)
 
ComponentState getComponentState () const
 
bool isComponentStateValid () const
 
bool isComponentStateInvalid () const
 
 SOFA_ATTRIBUTE_DEPRECATED__TOBASECONSTRAINT () virtual const behavior
 

Protected Member Functions

type::Mat< 3, 3, RealRotVec3DToRotMat3D (float *rotVec)
 
bool load ()
 
bool load (std::string fname)
 
bool loadCamera ()
 
void handleEvent (sofa::core::objectmodel::Event *event) override
 
void getCorners (type::Vec< 8, type::Vec3 > &c)
 
void computeBBox (const core::ExecParams *params, bool onlyVisible=false) override
 
void draw (const core::visual::VisualParams *vparams) override
 
bool loadSequence (std::string fname)
 
std::string getNextFname (std::string currentFname)
 
- Protected Member Functions inherited from sofa::core::objectmodel::BaseObject
 BaseObject ()
 
 ~BaseObject () override
 
virtual void doUpdateInternal ()
 
void changeContextLink (BaseContext *before, BaseContext *&after)
 
void changeSlavesLink (BaseObject::SPtr ptr, std::size_t, bool add)
 
void trackInternalData (const BaseData &data)
 
void cleanTracker ()
 
bool hasDataChanged (const BaseData &data)
 
- 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)
 
void initData0 (BaseData *field, BaseData::BaseInitData &res, const char *name, const char *help, BaseData::DataFlags dataFlags)
 
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)
 
- Protected Member Functions inherited from sofa::core::IntrusiveObject
virtual ~IntrusiveObject ()=default
 

Friends

struct ImageContainerSpecialization< _ImageTypes >
 

Additional Inherited Members

- Protected Attributes inherited from sofa::core::objectmodel::BaseObject
SingleLink< BaseObject, BaseContext, BaseLink::FLAG_DOUBLELINK > l_context
 
LinkSlaves l_slaves
 
SingleLink< BaseObject, BaseObject, BaseLink::FLAG_DOUBLELINK > l_master
 
- Protected Attributes inherited from sofa::core::objectmodel::Base
std::map< std::string, sofa::core::DataTrackerCallbackm_internalEngine
 
VecData m_vecData
 
MapData m_aliasData
 
VecLink m_vecLink
 
MapLink m_aliasLink
 
- Static Public Member Functions inherited from sofa::core::objectmodel::BaseObject
static bool canCreate (T *, BaseContext *, BaseObjectDescription *)
 
static T::SPtr create (T *, BaseContext *context, BaseObjectDescription *arg)
 
- Static Public Member Functions inherited from sofa::core::objectmodel::Base
static const BaseClassGetClass ()
 
static std::string shortName (const T *ptr=nullptr, BaseObjectDescription *=nullptr)
 

Attribute details

◆ drawBB

template<class _ImageTypes >
Data<bool> sofa::component::container::ImageContainer< _ImageTypes >::drawBB

draw bounding box

◆ image

template<class _ImageTypes >
Data< ImageTypes > sofa::component::container::ImageContainer< _ImageTypes >::image

image

◆ m_filename

template<class _ImageTypes >
sofa::core::objectmodel::DataFileName sofa::component::container::ImageContainer< _ImageTypes >::m_filename

◆ nFrames

template<class _ImageTypes >
Data<unsigned int> sofa::component::container::ImageContainer< _ImageTypes >::nFrames

The number of frames of the sequence to be loaded. Default is the entire sequence.

The number of frames of the sequence to be loaded.

◆ sequence

template<class _ImageTypes >
Data<bool> sofa::component::container::ImageContainer< _ImageTypes >::sequence

load a sequence of images

If true, the container will attempt to load a sequence of images starting from the file given by filename

◆ transform

template<class _ImageTypes >
Data< TransformType > sofa::component::container::ImageContainer< _ImageTypes >::transform

12-param vector for trans, rot, scale, ...

◆ transformIsSet

template<class _ImageTypes >
bool sofa::component::container::ImageContainer< _ImageTypes >::transformIsSet

Constructor details

◆ ImageContainer()

template<class _ImageTypes >
sofa::component::container::ImageContainer< _ImageTypes >::ImageContainer ( )
inline

◆ ~ImageContainer()

template<class _ImageTypes >
sofa::component::container::ImageContainer< _ImageTypes >::~ImageContainer ( )
inlineoverride

Function details

◆ clear()

template<class _ImageTypes >
virtual void sofa::component::container::ImageContainer< _ImageTypes >::clear ( )
inlinevirtual

◆ computeBBox()

template<class _ImageTypes >
void sofa::component::container::ImageContainer< _ImageTypes >::computeBBox ( const core::ExecParams params,
bool  onlyVisible = false 
)
inlineoverrideprotectedvirtual

◆ draw()

template<class _ImageTypes >
void sofa::component::container::ImageContainer< _ImageTypes >::draw ( const core::visual::VisualParams vparams)
inlineoverrideprotectedvirtual

◆ getCorners()

template<class _ImageTypes >
void sofa::component::container::ImageContainer< _ImageTypes >::getCorners ( type::Vec< 8, type::Vec3 > &  c)
inlineprotected

◆ getNextFname()

template<class _ImageTypes >
std::string sofa::component::container::ImageContainer< _ImageTypes >::getNextFname ( std::string  currentFname)
inlineprotected

When loading a sequence of images, determines the filename of the next image in the sequence based on the current image's filename.

◆ handleEvent()

template<class _ImageTypes >
void sofa::component::container::ImageContainer< _ImageTypes >::handleEvent ( sofa::core::objectmodel::Event event)
inlineoverrideprotectedvirtual

◆ init()

template<class _ImageTypes >
void sofa::component::container::ImageContainer< _ImageTypes >::init ( void  )
inlineoverridevirtual

◆ load() [1/2]

template<class _ImageTypes >
bool sofa::component::container::ImageContainer< _ImageTypes >::load ( )
inlineprotected

◆ load() [2/2]

template<class _ImageTypes >
bool sofa::component::container::ImageContainer< _ImageTypes >::load ( std::string  fname)
inlineprotected

◆ loadCamera()

template<class _ImageTypes >
bool sofa::component::container::ImageContainer< _ImageTypes >::loadCamera ( )
inlineprotected

◆ loadSequence()

template<class _ImageTypes >
bool sofa::component::container::ImageContainer< _ImageTypes >::loadSequence ( std::string  fname)
inlineprotected

◆ parse()

template<class _ImageTypes >
void sofa::component::container::ImageContainer< _ImageTypes >::parse ( sofa::core::objectmodel::BaseObjectDescription arg)
inlineoverridevirtual

◆ RotVec3DToRotMat3D()

template<class _ImageTypes >
type::Mat<3,3,Real> sofa::component::container::ImageContainer< _ImageTypes >::RotVec3DToRotMat3D ( float *  rotVec)
inlineprotected

◆ SOFA_CLASS()

template<class _ImageTypes >
sofa::component::container::ImageContainer< _ImageTypes >::SOFA_CLASS ( SOFA_TEMPLATE(ImageContainer< _ImageTypes >, _ImageTypes)  ,
Inherited   
)

Related details

◆ ImageContainerSpecialization< _ImageTypes >

template<class _ImageTypes >
friend struct ImageContainerSpecialization< _ImageTypes >
friend