SCENE C++ API  2.0.27
Public Member Functions | List of all members
LSEvent Class Reference

The base class for all API events. More...

#include <lsevent.h>

+ Inheritance diagram for LSEvent:

Public Member Functions

 LSEvent ()
 Constructor. More...
 
virtual ~LSEvent ()
 Destructor. More...
 
bool isConsumed () const
 Query whether this event has been consumed. More...
 
void consume ()
 Consumes this event if the event can be consumed. More...
 

Additional Inherited Members

- Protected Member Functions inherited from LSRefType
void ref () const
 Increments the internal reference counter. More...
 
void unref () const
 Decrements the internal reference counter. More...
 

Detailed Description

The base class for all API events.

Version
SCENE API Version 2.0.0.

Constructor & Destructor Documentation

◆ LSEvent()

LSEvent ( )

Constructor.

Version
SCENE API Version 2.0.0.

◆ ~LSEvent()

virtual ~LSEvent ( )
virtual

Destructor.

Version
SCENE API Version 2.0.0.

Member Function Documentation

◆ isConsumed()

bool isConsumed ( ) const

Query whether this event has been consumed.

Returns
true if the event has been consumed, false otherwise.
Version
SCENE API Version 2.0.0.

◆ consume()

void consume ( )

Consumes this event if the event can be consumed.

This will prevent the event from being processed in the default manner.

Version
SCENE API Version 2.0.0.