SOFA API  e18b59ce
Open source framework for multi-physics simuation
sofa::core::objectmodel Namespace Reference

Classes

class  AbstractDataLink
 AbstractDataLink is the base class for every link between two data fields The targetted BaseData is called the "target", The base object owning the current "child" object is the "owner" it is possible to store a path in a DataLink, in that case, at each DataLink access the path is resolved to search for a corresponding Data until one is found. Once a Data is set, the path is discarded. More...
 
class  Aspect
 
class  AspectBuffer
 
class  AspectPool
 
class  Base
 Base class for everything. More...
 
class  BaseClass
 Class hierarchy reflection base class. More...
 
class  BaseContext
 Base class for Context classes, storing shared variables and parameters. More...
 
class  BaseData
 Abstract base class for Data. More...
 
class  BaseLink
 Abstract base class for all links in the scene grapn, independently of their type. More...
 
class  BaseNode
 Base class for simulation nodes. More...
 
class  BaseObject
 Base class for simulation components. More...
 
class  BaseObjectDescription
 Base Interface for classes containing the description of an object, used to construct it. More...
 
class  BaseObjectTasks
 
class  ClassInfo
 Meta information class. More...
 
class  ConfigurationSetting
 Base class for all the configuration settings of SOFA. More...
 
class  Context
 Implementation of BaseContext, storing all shared parameters in Datas. More...
 
class  ContextObject
 Base class for simulation objects that modify the shared context (such as gravity, local coordinate system, ...). More...
 
class  Data
 Container that holds a variable for a component. More...
 
class  DataContentValue
 
class  DataContentValue< T, false >
 
class  DataContentValue< T, true >
 
class  DataFileName
 Data specialized to store filenames, potentially relative to the current directory at the time it was specified. More...
 
class  DataFileNameVector
 
class  DataLink
 DataLink stores a connection between two object of type Data<XXX> The class is templated by the Data type to connect. The class implements the AbstractDataLink interface. More...
 
class  DDGNode
 A DDGNode is a vertex in the data dependencies graph. The data dependency graph is used to update the data when some of other changes and it is at the root of the implementation of the data update mecanisme as well as DataEngines. More...
 
class  DeprecatedBaseClass
 
class  DetachNodeEvent
 
class  EmptyData
 
class  Event
 Base class for all events received by the objects. More...
 
class  GUIEvent
 This event notifies about GUI interaction. More...
 
class  HapticDeviceEvent
 This event notifies about haptic device interaction. More...
 
class  IdleEvent
 This event is propagated along the objects hierarchy at regular interval. More...
 
class  JoystickEvent
 JoystickEvent Class. More...
 
class  KeypressedEvent
 This event is propagated along the objects when a key on the keyboard is pressed. More...
 
class  KeyreleasedEvent
 This event is propagated along the objects when a key on the keyboard is released. More...
 
class  LinkTraitsContainer
 
class  LinkTraitsContainer< TDestType, TDestPtr, TValueType, false >
 
class  LinkTraitsContainer< TDestType, TDestPtr, TValueType, true >
 
class  LinkTraitsDestPtr
 
class  LinkTraitsDestPtr< TDestType, false >
 
class  LinkTraitsDestPtr< TDestType, true >
 
class  LinkTraitsValueType
 
class  LinkTraitsValueType< TDestType, TDestPtr, strongLink, false >
 
class  LinkTraitsValueType< TDestType, TDestPtr, strongLink, true >
 
class  MouseEvent
 MouseEvent Class. More...
 
class  MultiLink
 Container of vectors of links in the scenegraph, from a given type of object (Owner) to another (Dest) More...
 
class  New
 new operator for classes with smart pointers (such as all components deriving from Base) More...
 
class  ScriptEvent
 Generic Event class to send a message through the simulation graph. More...
 
class  SingleLink
 Container of single links in the scenegraph, from a given type of object (Owner) to another (Dest) More...
 
class  SinglePtr
 Class to hold 0-or-1 pointer. The interface is similar to std::vector (size/[]/begin/end), plus an automatic convertion to one pointer. More...
 
class  SPtr_const_cast
 const_cast operator for SPtr More...
 
class  SPtr_dynamic_cast
 dynamic_cast operator for SPtr More...
 
class  SPtr_static_cast
 static_cast operator for SPtr More...
 
class  Tag
 A Tag is a string (internally converted to an integer), attached to objects in order to define subsets to process by specific visitors. More...
 
class  TagSet
 
class  TClass
 
class  TClassInfo
 
class  TClassParents
 
class  TClassParents< std::pair< P1, P2 > >
 
class  TClassParents< void >
 
class  TData
 Abstract base class template for Data. More...
 
class  TLink
 Container of all links in the scenegraph, from a given type of object (Owner) to another (Dest) More...
 
class  WriteAccessWithRawPtr
 

Typedefs

using AspectRef = sptr< Aspect >
 

Enumerations

enum  ComponentState {
  ComponentState::Undefined, ComponentState::Loading, ComponentState::Valid, ComponentState::Dirty,
  ComponentState::Busy, ComponentState::Invalid
}
 
enum  PathType { PathType::FILE, PathType::DIRECTORY, PathType::BOTH }
 

Functions

void intrusive_ptr_add_ref (Aspect *a)
 
void intrusive_ptr_release (Aspect *a)
 
std::ostream & operator<< (std::ostream &out, const BaseContext &)
 
template<class T >
const ClassInfoclassidT ()
 
std::ostream & operator<< (std::ostream &o, const ComponentState &s)
 Defining the in/ou operator for use of component status with Data<> More...
 
std::istream & operator>> (std::istream &i, ComponentState &s)
 

Variables

template class SOFA_CORE_API TData< bool >
 
template class SOFA_CORE_API Data< bool >
 

Typedef Documentation

Enumeration Type Documentation

enum class is a C++ x11 feature (http://en.cppreference.com/w/cpp/language/enum), Indicate the state of a sofa object.

Enumerator
Undefined 

component that does not make use of this field have this one

Loading 

the component is loading but never passed successfully its init() function

Valid 

the component has passed successfully its init function

Dirty 

the component is ready to be used but requires a call to reinit

Busy 

the component is doing "something", don't trust its values for doing your computation

Invalid 

the component reached an error and is thus unable to behave normally.

Enumerator
FILE 
DIRECTORY 
BOTH 

Function Documentation

template<class T >
const ClassInfo& sofa::core::objectmodel::classidT ( )
SOFA_CORE_API void sofa::core::objectmodel::intrusive_ptr_add_ref ( Aspect a)
SOFA_CORE_API void sofa::core::objectmodel::intrusive_ptr_release ( Aspect a)
SOFA_CORE_API std::ostream & sofa::core::objectmodel::operator<< ( std::ostream &  o,
const ComponentState s 
)

Defining the in/ou operator for use of component status with Data<>

std::ostream& sofa::core::objectmodel::operator<< ( std::ostream &  out,
const BaseContext  
)
SOFA_CORE_API std::istream & sofa::core::objectmodel::operator>> ( std::istream &  i,
ComponentState s 
)

Variable Documentation

template class SOFA_CORE_API sofa::core::objectmodel::Data< bool >
template class SOFA_CORE_API sofa::core::objectmodel::TData< bool >