SOFA API  59c939c2
Open source framework for multi-physics simuation
sofa::core Namespace Reference

Namespaces

 behavior
 
 collision
 
 loader
 
 objectmodel
 
 topology
 
 visual
 

Classes

class  BaseCollisionElementIterator
 Base class for reference to an collision element defined by its index More...
 
class  BaseMapping
 
class  BaseState
 Component storing position and velocity vectors. More...
 
class  BaseVecId
 
class  BehaviorModel
 Abstract Interface of components defining the behavior of a simulated object. More...
 
class  CallContext
 
class  CategoryLibrary
 An Generic Category of the Sofa Library. More...
 
struct  CleanupCheck
 
class  CollisionElementActiver
 
class  CollisionElementIterator
 Reference to an abstract collision element. More...
 
class  CollisionModel
 Abstract CollisionModel interface. More...
 
class  ComponentLibrary
 An Generic Component of the Sofa Library. More...
 
class  ConstraintParams
 
class  DataEngine
 from a set of Data inputs computes a set of Data outputs More...
 
struct  DataTracker
 
class  DataTrackerCallback
 
class  DataTrackerDDGNode
 A DDGNode with trackable input Data (containing a DataTracker) More...
 
class  DataTrackerEngine
 
class  DataTrackerFunctor
 
class  DevBaseMonitor
 A basic interface to define a Monitor capable to compute metrics. More...
 
class  ExecParams
 Class gathering parameters use by most components methods, and transmitted by all visitors. More...
 
class  Mapping
 Specialized interface to convert a model state of type TIn to a model state of type TOut. This is basically a sofa::core::BaseMapping with given input and output types. More...
 
class  MechanicalParams
 Class gathering parameters use by mechanical components methods, and transmitted by mechanical visitors. More...
 
class  Multi2Mapping
 Specialized interface to describe many to many mapping. The inputs can be of two different types, while all the outputs must be of the same type. More...
 
class  MultiMapping
 Specialized interface to describe many to many mapping. All the input must have the same type, and all the output must have the same type. See also class Multi2Mapping. More...
 
class  ObjectCreator
 Typed Creator class used to create instances of object type RealObject. More...
 
class  ObjectFactory
 
class  ParallelCollisionModel
 
class  Plugin
 
class  PluginManager
 
class  Processor
 
class  RegisterObject
 Helper class used to register a class in the ObjectFactory. More...
 
class  SofaLibrary
 An Generic Library. More...
 
class  State
 Component storing position and velocity vectors. More...
 
struct  StateVecAccessor
 Helper class to access vectors of a given type in a given State. More...
 
struct  StateVecAccessor< DataTypes, V_ALL, V_READ >
 
struct  StateVecAccessor< DataTypes, V_ALL, V_WRITE >
 
struct  StateVecAccessor< DataTypes, V_COORD, V_READ >
 
struct  StateVecAccessor< DataTypes, V_COORD, V_WRITE >
 
struct  StateVecAccessor< DataTypes, V_DERIV, V_READ >
 
struct  StateVecAccessor< DataTypes, V_DERIV, V_WRITE >
 
struct  StateVecAccessor< DataTypes, V_MATDERIV, V_READ >
 
struct  StateVecAccessor< DataTypes, V_MATDERIV, V_WRITE >
 
class  TCollisionElementIterator
 Reference to an collision element defined by its index inside a given collision model. More...
 
class  TMultiVecId
 
class  TMultiVecId< V_ALL, vaccess >
 
class  TStandardVec
 
class  TStandardVec< V_ALL, vaccess >
 
class  TStandardVec< V_COORD, vaccess >
 
class  TStandardVec< V_DERIV, vaccess >
 
class  TStandardVec< V_MATDERIV, vaccess >
 
class  TVecId
 
class  TVecId< V_ALL, vaccess >
 Identify any vector stored in State. More...
 
class  VecIdAlignFix
 

Typedefs

typedef sofa::core::ObjectFactory::Creator Creator
 
typedef sofa::core::ObjectFactory::ClassEntry ClassEntry
 
typedef TMultiVecId< V_COORD, V_READConstMultiVecCoordId
 
typedef TMultiVecId< V_COORD, V_WRITEMultiVecCoordId
 
typedef TMultiVecId< V_DERIV, V_READConstMultiVecDerivId
 
typedef TMultiVecId< V_DERIV, V_WRITEMultiVecDerivId
 
typedef TMultiVecId< V_MATDERIV, V_READConstMultiMatrixDerivId
 
typedef TMultiVecId< V_MATDERIV, V_WRITEMultiMatrixDerivId
 
typedef TMultiVecId< V_ALL, V_READConstMultiVecId
 
typedef TMultiVecId< V_ALL, V_WRITEMultiVecId
 
typedef std::function< void(sofa::core::objectmodel::Base *, sofa::core::objectmodel::BaseObjectDescription *)> OnCreateCallback
 Main class used to register and dynamically create objects. More...
 
template<class T >
using sptr = boost::intrusive_ptr< T >
 
typedef TVecId< V_ALL, V_READConstVecId
 
typedef TVecId< V_ALL, V_WRITEVecId
 
typedef TVecId< V_COORD, V_READConstVecCoordId
 Typedefs for each type of state vectors. More...
 
typedef TVecId< V_COORD, V_WRITEVecCoordId
 
typedef TVecId< V_DERIV, V_READConstVecDerivId
 
typedef TVecId< V_DERIV, V_WRITEVecDerivId
 
typedef TVecId< V_MATDERIV, V_READConstMatrixDerivId
 
typedef TVecId< V_MATDERIV, V_WRITEMatrixDerivId
 

Enumerations

enum  { SOFA_DATA_MAX_ASPECTS = 1 }
 
enum  VecType { V_ALL = 0, V_COORD, V_DERIV, V_MATDERIV }
 Types of vectors that can be stored in State. More...
 
enum  VecAccess { V_READ =0, V_WRITE }
 Types of vectors that can be stored in State. More...
 

Functions

std::string caseInsensitive (const std::string &text)
 
SOFA_CORE_API void init ()
 Initialize the SofaCore library, as well as its dependencies: SofaDefaultType, SofaHelper. More...
 
SOFA_CORE_API bool isInitialized ()
 Return true if and only if the SofaCore library has been initialized. More...
 
SOFA_CORE_API void cleanup ()
 Clean up the resources used by the SofaCore library, as well as its dependencies: SofaDefaultType, SofaHelper. More...
 
SOFA_CORE_API bool isCleanedUp ()
 Return true if and only if the SofaCore library has been cleaned up. More...
 

Variables

template class SOFA_CORE_API Multi2Mapping< Vec1Types, Rigid3Types, Rigid3Types >
 
template class SOFA_CORE_API Multi2Mapping< Vec3Types, Rigid3Types, Vec3Types >
 
template class SOFA_CORE_API Multi2Mapping< Vec3Types, Rigid3Types, Rigid3Types >
 
template class SOFA_CORE_API Multi2Mapping< Vec3Types, Vec3Types, Vec3Types >
 
template class SOFA_CORE_API Multi2Mapping< Vec1Types, Vec3Types, Rigid3Types >
 
template class SOFA_CORE_API Multi2Mapping< Vec1Types, Rigid3Types, Vec3Types >
 
template class SOFA_CORE_API Multi2Mapping< Vec1Types, Vec1Types, Rigid3Types >
 
class SOFA_CORE_API BaseState
 
template class SOFA_CORE_API State< Vec3dTypes >
 
template class SOFA_CORE_API State< Vec2Types >
 
template class SOFA_CORE_API State< Vec1Types >
 
template class SOFA_CORE_API State< Vec6Types >
 
template class SOFA_CORE_API State< Rigid3Types >
 
template class SOFA_CORE_API State< Rigid2Types >
 
template class SOFA_CORE_API State< Vec3fTypes >
 

Typedef Documentation

Typedefs for each type of state vectors.

Identify one vector stored in State A ConstVecId only provides a read-only access to the underlying vector.

Main class used to register and dynamically create objects.

It uses the Factory design pattern, where each class is registered in a map, and dynamically retrieved given the type name.

It also stores metainformation on each classes, such as description, authors, license, and available template types.

See also
RegisterObject for how new classes should be registered.
template<class T >
using sofa::core::sptr = typedef boost::intrusive_ptr<T>

Identify one vector stored in State A VecId provides a read-write access to the underlying vector.

Enumeration Type Documentation

anonymous enum
Enumerator
SOFA_DATA_MAX_ASPECTS 

Types of vectors that can be stored in State.

Enumerator
V_READ 
V_WRITE 

Types of vectors that can be stored in State.

Enumerator
V_ALL 
V_COORD 
V_DERIV 
V_MATDERIV 

Function Documentation

std::string sofa::core::caseInsensitive ( const std::string &  text)
SOFA_CORE_API void sofa::core::cleanup ( )

Clean up the resources used by the SofaCore library, as well as its dependencies: SofaDefaultType, SofaHelper.

SOFA_CORE_API void sofa::core::init ( )

Initialize the SofaCore library, as well as its dependencies: SofaDefaultType, SofaHelper.

SOFA_CORE_API bool sofa::core::isCleanedUp ( )

Return true if and only if the SofaCore library has been cleaned up.

SOFA_CORE_API bool sofa::core::isInitialized ( )

Return true if and only if the SofaCore library has been initialized.

Variable Documentation

class SOFA_CORE_API sofa::core::BaseState
template class SOFA_CORE_API sofa::core::Multi2Mapping< Vec1Types, Rigid3Types, Rigid3Types >
template class SOFA_CORE_API sofa::core::Multi2Mapping< Vec1Types, Rigid3Types, Vec3Types >
template class SOFA_CORE_API sofa::core::Multi2Mapping< Vec1Types, Vec1Types, Rigid3Types >
template class SOFA_CORE_API sofa::core::Multi2Mapping< Vec1Types, Vec3Types, Rigid3Types >
template class SOFA_CORE_API sofa::core::Multi2Mapping< Vec3Types, Rigid3Types, Rigid3Types >
template class SOFA_CORE_API sofa::core::Multi2Mapping< Vec3Types, Rigid3Types, Vec3Types >
template class SOFA_CORE_API sofa::core::Multi2Mapping< Vec3Types, Vec3Types, Vec3Types >
template class SOFA_CORE_API sofa::core::State< Rigid2Types >
template class SOFA_CORE_API sofa::core::State< Rigid3Types >
template class SOFA_CORE_API sofa::core::State< Vec1Types >
template class SOFA_CORE_API sofa::core::State< Vec2Types >
template class SOFA_CORE_API sofa::core::State< Vec3dTypes >
template class SOFA_CORE_API sofa::core::State< Vec3fTypes >
template class SOFA_CORE_API sofa::core::State< Vec6Types >