dart
Public Member Functions | Protected Attributes | List of all members
dart::dynamics::PointMassNotifier Class Reference
Inheritance diagram for dart::dynamics::PointMassNotifier:
Inheritance graph
[legend]
Collaboration diagram for dart::dynamics::PointMassNotifier:
Collaboration graph
[legend]

Public Member Functions

 PointMassNotifier (SoftBodyNode *_parentSoftBody, const std::string &_name)
 
bool needsPartialAccelerationUpdate () const
 
void clearTransformNotice ()
 
void clearVelocityNotice ()
 
void clearPartialAccelerationNotice ()
 
void clearAccelerationNotice ()
 
void dirtyTransform () override
 Notify the transformation update of this Entity that its parent Frame's pose is needed.
 
void dirtyVelocity () override
 Notify the velocity update of this Entity that its parent Frame's velocity is needed.
 
void dirtyAcceleration () override
 Notify the acceleration of this Entity that its parent Frame's acceleration is needed.
 
const std::string & setName (const std::string &_name) override
 Set name. More...
 
const std::string & getName () const override
 Return the name of this Entity.
 
- Public Member Functions inherited from dart::dynamics::Entity
 Entity (Frame *_refFrame, bool _quiet)
 Constructor for typical usage.
 
 Entity ()
 Default constructor, delegates to Entity(ConstructAbstract_t)
 
 Entity (const Entity &)=delete
 
virtual ~Entity ()
 Destructor.
 
FramegetParentFrame ()
 Get the parent (reference) frame of this Entity.
 
const FramegetParentFrame () const
 Get the parent (reference) frame of this Entity.
 
bool descendsFrom (const Frame *_someFrame) const
 Returns true if and only if this Entity is itself (i.e. More...
 
bool isFrame () const
 True iff this Entity is also a Frame.
 
bool isQuiet () const
 Returns true if this Entity is set to be quiet. More...
 
virtual void notifyTransformUpdate ()
 Notify the transformation update of this Entity that its parent Frame's pose is needed.
 
bool needsTransformUpdate () const
 Returns true iff a transform update is needed for this Entity.
 
virtual void notifyVelocityUpdate ()
 Notify the velocity update of this Entity that its parent Frame's velocity is needed.
 
bool needsVelocityUpdate () const
 Returns true iff a velocity update is needed for this Entity.
 
virtual void notifyAccelerationUpdate ()
 Notify the acceleration of this Entity that its parent Frame's acceleration is needed.
 
bool needsAccelerationUpdate () const
 Returns true iff an acceleration update is needed for this Entity.
 
- Public Member Functions inherited from dart::common::Subject
virtual ~Subject ()
 Destructor will notify all Observers that it is destructing.
 

Protected Attributes

std::string mName
 
bool mNeedPartialAccelerationUpdate
 
SoftBodyNodemParentSoftBodyNode
 
- Protected Attributes inherited from dart::dynamics::Entity
FramemParentFrame
 Parent frame of this Entity.
 
bool mNeedTransformUpdate
 Does this Entity need a Transform update.
 
bool mNeedVelocityUpdate
 Does this Entity need a Velocity update.
 
bool mNeedAccelerationUpdate
 Does this Entity need an Acceleration update.
 
FrameChangedSignal mFrameChangedSignal
 Frame changed signal.
 
NameChangedSignal mNameChangedSignal
 Name changed signal.
 
EntitySignal mTransformUpdatedSignal
 Transform changed signal.
 
EntitySignal mVelocityChangedSignal
 Velocity changed signal.
 
EntitySignal mAccelerationChangedSignal
 Acceleration changed signal.
 
- Protected Attributes inherited from dart::common::Subject
std::set< Observer * > mObservers
 List of current Observers.
 

Additional Inherited Members

- Public Types inherited from dart::dynamics::Entity
using EntitySignal = common::Signal< void(const Entity *)>
 
using FrameChangedSignal = common::Signal< void(const Entity *, const Frame *_oldFrame, const Frame *_newFrame)>
 
using NameChangedSignal = common::Signal< void(const Entity *, const std::string &_oldName, const std::string &_newName)>
 
- Public Attributes inherited from dart::dynamics::Entity
common::SlotRegister< FrameChangedSignalonFrameChanged
 Slot register for frame changed signal.
 
common::SlotRegister< NameChangedSignalonNameChanged
 Slot register for name changed signal.
 
common::SlotRegister< EntitySignalonTransformUpdated
 Slot register for transform updated signal.
 
common::SlotRegister< EntitySignalonVelocityChanged
 Slot register for velocity updated signal.
 
common::SlotRegister< EntitySignalonAccelerationChanged
 Slot register for acceleration updated signal.
 
- Protected Types inherited from dart::dynamics::Entity
enum  ConstructFrameTag { ConstructFrame }
 Used when constructing a Frame class, because the Frame constructor will take care of setting up the parameters you pass into it.
 
enum  ConstructAbstractTag { ConstructAbstract }
 Used when constructing a pure abstract class, because calling the Entity constructor is just a formality.
 
- Protected Member Functions inherited from dart::dynamics::Entity
 Entity (ConstructFrameTag)
 
 Entity (ConstructAbstractTag)
 
virtual void changeParentFrame (Frame *_newParentFrame)
 Used by derived classes to change their parent frames.
 
- Protected Member Functions inherited from dart::common::Subject
void sendDestructionNotification () const
 Send a destruction notification to all Observers. More...
 
void addObserver (Observer *_observer) const
 Add an Observer to the list of Observers.
 
void removeObserver (Observer *_observer) const
 Remove an Observer from the list of Observers.
 

Member Function Documentation

◆ setName()

const std::string & dart::dynamics::PointMassNotifier::setName ( const std::string &  _name)
overridevirtual

Set name.

Some implementations of Entity may make alterations to the name that gets passed in. The final name that this entity will use gets passed back in the return of this function.

Implements dart::dynamics::Entity.


The documentation for this class was generated from the following files: