SilverLining
Public Member Functions | List of all members
SilverLining::LightningListener Class Referenceabstract

Extend this class in order to receive notifications of lightning strike events from cumulonimbus cloud layers. More...

#include <LightningListener.h>

Public Member Functions

virtual ~LightningListener ()
 Virtual destructor.
 
virtual void SILVERLINING_API LightningStartedEvent (double lightningPosX, double lightningPosY, double lightningPosZ)=0
 This pure virtual method will be called any time a lightning strike begins within a CloudLayer.
 

Detailed Description

Extend this class in order to receive notifications of lightning strike events from cumulonimbus cloud layers.

Constructor & Destructor Documentation

◆ ~LightningListener()

virtual SilverLining::LightningListener::~LightningListener ( )
inlinevirtual

Virtual destructor.

Member Function Documentation

◆ LightningStartedEvent()

virtual void SILVERLINING_API SilverLining::LightningListener::LightningStartedEvent ( double  lightningPosX,
double  lightningPosY,
double  lightningPosZ 
)
pure virtual

This pure virtual method will be called any time a lightning strike begins within a CloudLayer.

You must pass your LightningListener object's pointer into CloudLayer::AddLightningListener() in order to receive lightning events from a given CloudLayer. Presently, only CumulonimbusCloudLayer objects will fire these events. The position returned is the location of the lightning strike's origin, in world units.


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