The Detachable class is a special case of the Entity base class.
More...
#include <Entity.hpp>
The Detachable class is a special case of the Entity base class.
Detachable allows the Entity's reference Frame to be changed arbitrarily by the user.
◆ EntitySignal
◆ FrameChangedSignal
◆ NameChangedSignal
◆ ConstructAbstractTag
Used when constructing a pure abstract class, because calling the Entity constructor is just a formality.
Enumerator |
---|
ConstructAbstract | |
◆ ConstructFrameTag
Used when constructing a Frame class, because the Frame constructor will take care of setting up the parameters you pass into it.
◆ Detachable() [1/2]
dart::dynamics::Detachable::Detachable |
( |
Frame * |
_refFrame, |
|
|
bool |
_quiet |
|
) |
| |
|
explicit |
◆ Detachable() [2/2]
dart::dynamics::Detachable::Detachable |
( |
| ) |
|
|
protected |
Constructor for inheriting classes, so they do not need to fill in the arguments.
◆ addObserver()
void dart::common::Subject::addObserver |
( |
Observer * |
_observer | ) |
const |
|
protectedinherited |
Add an Observer to the list of Observers.
◆ changeParentFrame()
void dart::dynamics::Entity::changeParentFrame |
( |
Frame * |
_newParentFrame | ) |
|
|
protectedvirtualinherited |
◆ descendsFrom()
bool dart::dynamics::Entity::descendsFrom |
( |
const Frame * |
_someFrame | ) |
const |
|
inherited |
Returns true if and only if this Entity is itself (i.e.
this == _someFrame) or depends on (i.e. kinematically descends from) _someFrame.
If _someFrame is nullptr, this returns true in order to accommodate BodyNodes which always have a nullptr BodyNode as the parent of a root BodyNode.
◆ dirtyAcceleration()
void dart::dynamics::Entity::dirtyAcceleration |
( |
| ) |
|
|
virtualinherited |
◆ dirtyTransform()
void dart::dynamics::Entity::dirtyTransform |
( |
| ) |
|
|
virtualinherited |
◆ dirtyVelocity()
void dart::dynamics::Entity::dirtyVelocity |
( |
| ) |
|
|
virtualinherited |
◆ getName()
virtual const std::string& dart::dynamics::Entity::getName |
( |
| ) |
const |
|
pure virtualinherited |
◆ getParentFrame() [1/2]
Frame * dart::dynamics::Entity::getParentFrame |
( |
| ) |
|
|
inherited |
Get the parent (reference) frame of this Entity.
◆ getParentFrame() [2/2]
const Frame * dart::dynamics::Entity::getParentFrame |
( |
| ) |
const |
|
inherited |
Get the parent (reference) frame of this Entity.
◆ isFrame()
bool dart::dynamics::Entity::isFrame |
( |
| ) |
const |
|
inherited |
◆ isQuiet()
bool dart::dynamics::Entity::isQuiet |
( |
| ) |
const |
|
inherited |
Returns true if this Entity is set to be quiet.
A quiet entity is unknown to its parent Frame. It will not be tracked by its parent; it will not receive notifications from its parent, and it will not be rendered. The advantage to a quiet Entity is that it has less overhead when constructing and deconstructing, which makes it more suitable for temporary objects.
◆ needsAccelerationUpdate()
bool dart::dynamics::Entity::needsAccelerationUpdate |
( |
| ) |
const |
|
inherited |
Returns true iff an acceleration update is needed for this Entity.
◆ needsTransformUpdate()
bool dart::dynamics::Entity::needsTransformUpdate |
( |
| ) |
const |
|
inherited |
Returns true iff a transform update is needed for this Entity.
◆ needsVelocityUpdate()
bool dart::dynamics::Entity::needsVelocityUpdate |
( |
| ) |
const |
|
inherited |
Returns true iff a velocity update is needed for this Entity.
◆ notifyAccelerationUpdate()
void dart::dynamics::Entity::notifyAccelerationUpdate |
( |
| ) |
|
|
virtualinherited |
Notify the acceleration of this Entity that its parent Frame's acceleration is needed.
◆ notifyTransformUpdate()
void dart::dynamics::Entity::notifyTransformUpdate |
( |
| ) |
|
|
virtualinherited |
Notify the transformation update of this Entity that its parent Frame's pose is needed.
◆ notifyVelocityUpdate()
void dart::dynamics::Entity::notifyVelocityUpdate |
( |
| ) |
|
|
virtualinherited |
Notify the velocity update of this Entity that its parent Frame's velocity is needed.
◆ removeObserver()
void dart::common::Subject::removeObserver |
( |
Observer * |
_observer | ) |
const |
|
protectedinherited |
Remove an Observer from the list of Observers.
◆ sendDestructionNotification()
void dart::common::Subject::sendDestructionNotification |
( |
| ) |
const |
|
protectedinherited |
Send a destruction notification to all Observers.
This will cause all Observers to behave as if this Subject has been permanently deleted, so it should only be called when that behavior is desired.
◆ setName()
virtual const std::string& dart::dynamics::Entity::setName |
( |
const std::string & |
_name | ) |
|
|
pure virtualinherited |
◆ setParentFrame()
void dart::dynamics::Detachable::setParentFrame |
( |
Frame * |
_newParentFrame | ) |
|
|
virtual |
Allows the user to change the parent Frame of this Entity.
◆ mAccelerationChangedSignal
EntitySignal dart::dynamics::Entity::mAccelerationChangedSignal |
|
protectedinherited |
Acceleration changed signal.
◆ mAmFrame
bool dart::dynamics::Entity::mAmFrame |
|
privateinherited |
◆ mAmQuiet
const bool dart::dynamics::Entity::mAmQuiet |
|
privateinherited |
Whether or not this Entity is set to be quiet.
◆ mFrameChangedSignal
◆ mNameChangedSignal
◆ mNeedAccelerationUpdate
bool dart::dynamics::Entity::mNeedAccelerationUpdate |
|
mutableprotectedinherited |
Does this Entity need an Acceleration update.
◆ mNeedTransformUpdate
bool dart::dynamics::Entity::mNeedTransformUpdate |
|
mutableprotectedinherited |
Does this Entity need a Transform update.
◆ mNeedVelocityUpdate
bool dart::dynamics::Entity::mNeedVelocityUpdate |
|
mutableprotectedinherited |
Does this Entity need a Velocity update.
◆ mObservers
std::set<Observer*> dart::common::Subject::mObservers |
|
mutableprotectedinherited |
List of current Observers.
◆ mParentFrame
Frame* dart::dynamics::Entity::mParentFrame |
|
protectedinherited |
◆ mTransformUpdatedSignal
EntitySignal dart::dynamics::Entity::mTransformUpdatedSignal |
|
protectedinherited |
Transform changed signal.
◆ mVelocityChangedSignal
◆ onAccelerationChanged
Slot register for acceleration updated signal.
◆ onFrameChanged
Slot register for frame changed signal.
◆ onNameChanged
Slot register for name changed signal.
◆ onTransformUpdated
Slot register for transform updated signal.
◆ onVelocityChanged
Slot register for velocity updated signal.