Make an actor follow a target entity in the world. More...
#include <gz/sim/systems/FollowActor.hh>
Public Member Functions | |
| FollowActor () | |
| Constructor. More... | |
| ~FollowActor () override | |
| Destructor. More... | |
| void | Configure (const Entity &_entity, const std::shared_ptr< const sdf::Element > &_sdf, EntityComponentManager &_ecm, EventManager &_eventMgr) final |
| Configure the system. More... | |
| void | PreUpdate (const UpdateInfo &_info, EntityComponentManager &_ecm) final |
| Documentation inherited. More... | |
 Public Member Functions inherited from System | |
| System ()=default | |
| Constructor. More... | |
| virtual | ~System ()=default |
| Destructor. More... | |
Detailed Description
Make an actor follow a target entity in the world.
SDF parameters
<target>: Name of entity to follow.
<min_distance>: Distance in meters to keep from target's origin.
<max_distance>: Distance in meters from target's origin when to stop following. When the actor is back within range it starts following again.
<velocity>: Actor's velocity in m/s
<animation>: Actor's animation to play. If empty, the first animation in the model will be used.
<animation_x_vel>: Velocity of the animation on the X axis. Used to coordinate translational motion with the actor's animation.
Constructor & Destructor Documentation
◆ FollowActor()
|
explicit |
Constructor.
◆ ~FollowActor()
|
override |
Destructor.
Member Function Documentation
◆ Configure()
|
finalvirtual |
Configure the system.
- Parameters
-
[in] _entity The entity this plugin is attached to. [in] _sdf The SDF Element associated with this system plugin. [in] _ecm The EntityComponentManager of the given simulation instance. [in] _eventMgr The EventManager of the given simulation instance.
Implements ISystemConfigure.
◆ PreUpdate()
|
finalvirtual |
Documentation inherited.
Implements ISystemPreUpdate.
The documentation for this class was generated from the following file: