EventListener.h

Go to the documentation of this file.

/*
Copyright 2007-2025. Algoryx Simulation AB.
 
All AGX source code, intellectual property, documentation, sample code,
tutorials, scene files and technical white papers, are copyrighted, proprietary
and confidential material of Algoryx Simulation AB. You may not download, read,
store, distribute, publish, copy or otherwise disseminate, use or expose this
material unless having a written signed agreement with Algoryx Simulation AB, or having been
advised so by Algoryx Simulation AB for a time limited evaluation, or having purchased a
valid commercial license from Algoryx Simulation AB.
 
Algoryx Simulation AB disclaims all responsibilities for loss or damage caused
from using this software, unless otherwise stated in written agreements with
Algoryx Simulation AB.
*/
 
#pragma once
 
#include <agxSDK/agxSDK.h>
#include <agx/Component.h>
 
#include <agxStream/Serializable.h>
#include <agx/SetVector.h>
 
namespace agxSDK
{
 
  class Simulation;
 
  AGX_DECLARE_POINTER_TYPES(EventListener);
  typedef agx::Vector<EventListener*> EventListenerPtrVector;
  typedef agx::SetVector< agx::ref_ptr<agxSDK::EventListener> > EventListenerRefSetVector;
  typedef agx::Vector< agx::ref_ptr<agxSDK::EventListener> > EventListenerRefVector;
 
  class AGXPHYSICS_EXPORT EventListener : public agx::Component, public agxStream::Serializable
  {
    public:
 
      enum Type {
        UNDEFINED_TYPE,         
        STEP_EVENT_LISTENER,    
        CONTACT_EVENT_LISTENER, 
        GUI_EVENT_LISTENER      
      };
 
      virtual void setMask(int f);
 
      int getMask() const;
 
      void setEnable( bool enable );
 
      bool isEnabled( ) const;
 
      Simulation* getSimulation();
 
      const Simulation* getSimulation() const;
 
      virtual void addNotification() {}
 
      virtual void removeNotification() {}
 
      Type getType() const;
 
      agx::UInt32 getPriority() const;
 
#ifndef SWIG
      AGXSTREAM_DECLARE_SERIALIZABLE( agxSDK::EventListener );
#endif
 
  private:
      void setPriority( agx::UInt32 priority );
 
  protected:
      EventListener( Type type = UNDEFINED_TYPE );
 
 
      friend class Simulation;
      friend class EventManager;
 
      void setSimulation( Simulation* simulation );
 
      virtual ~EventListener();
 
      Type m_type;
 
      int m_mask;
      bool m_enabled;
      agx::UInt32 m_priority;
    private:
 
      Simulation* m_simulation;
  };
 
}