box_entity.h

Go to the documentation of this file.

 
#ifndef BOX_ENTITY_H
#define BOX_ENTITY_H
 
namespace argos {
   class CBoxEntity;
}
 
#include <argos3/core/simulator/entity/embodied_entity.h>
#include <argos3/core/simulator/entity/composable_entity.h>
#include <argos3/plugins/simulator/entities/led_equipped_entity.h>
 
namespace argos {
 
   class CBoxEntity : public CComposableEntity {
 
   public:
 
      ENABLE_VTABLE();
 
      CBoxEntity();
 
      CBoxEntity(const std::string& str_id,
                 const CVector3& c_position,
                 const CQuaternion& c_orientation,
                 bool b_movable,
                 const CVector3& c_size,
                 Real f_mass = 1.0f);
 
      virtual void Init(TConfigurationNode& t_tree);
      virtual void Reset();
 
      /*
       * Enables the LEDs for this entity.
       * Adds the LED equipped entity to the given medium.
       * If you don't call this method, the LEDs added with
       * CBoxEntity::AddLED() won't be updated correctly.
       * @param c_medium The medium to which the LEDs must be associated.
       * @see CBoxEntity::AddLED()
       */
      void EnableLEDs(CLEDMedium& c_medium);
 
      /*
       * Disables the LEDs for this entity.
       */
      void DisableLEDs();
 
      void AddLED(const CVector3& c_offset,
                  const CColor& c_color = CColor::BLACK);
 
      inline CEmbodiedEntity& GetEmbodiedEntity() {
         return *m_pcEmbodiedEntity;
      }
 
      inline const CEmbodiedEntity& GetEmbodiedEntity() const {
         return *m_pcEmbodiedEntity;
      }
 
      inline CLEDEquippedEntity& GetLEDEquippedEntity() {
         return *m_pcLEDEquippedEntity;
      }
 
      inline const CLEDEquippedEntity& GetLEDEquippedEntity() const {
         return *m_pcLEDEquippedEntity;
      }
 
      inline const CVector3& GetSize() const {
         return m_cSize;
      }
 
      void Resize(const CVector3& c_size);
 
      inline Real GetMass() const {
         return m_fMass;
      }
 
      inline void SetMass(Real f_mass) {
         m_fMass = f_mass;
      }
 
      virtual std::string GetTypeDescription() const {
         return "box";
      }
 
   private:
 
      CEmbodiedEntity*    m_pcEmbodiedEntity;
      CLEDEquippedEntity* m_pcLEDEquippedEntity;
      CVector3            m_cSize;
      Real                m_fMass;
      CLEDMedium*         m_pcLEDMedium;
 
   };
 
}
 
#endif