vsg  1.1.0
VulkanSceneGraph library
Public Member Functions | Public Attributes | List of all members
vsg::ScrollWheelEvent Class Reference

ScrollWheelEvent represents a scroll wheel event. More...

#include <ScrollWheelEvent.h>

Inheritance diagram for vsg::ScrollWheelEvent:
Inheritance graph
[legend]
Collaboration diagram for vsg::ScrollWheelEvent:
Collaboration graph
[legend]

Public Member Functions

 ScrollWheelEvent (Window *in_window, time_point in_time, const vec3 &in_delta)
 
void read (Input &input) override
 
void write (Output &output) const override
 
- Public Member Functions inherited from vsg::Inherit< WindowEvent, ScrollWheelEvent >
 Inherit (Args &&... args)
 
std::size_t sizeofObject () const noexcept override
 
const char * className () const noexcept override
 
const std::type_info & type_info () const noexcept override
 
bool is_compatible (const std::type_info &type) const noexcept override
 
int compare (const Object &rhs) const override
 
void accept (Visitor &visitor) override
 
void accept (ConstVisitor &visitor) const override
 
void accept (RecordTraversal &visitor) const override
 
- Public Member Functions inherited from vsg::WindowEvent
 WindowEvent (Window *in_window, time_point in_time)
 
void read (Input &input) override
 
void write (Output &output) const override
 
- Public Member Functions inherited from vsg::Inherit< UIEvent, WindowEvent >
 Inherit (Args &&... args)
 
- Public Member Functions inherited from vsg::UIEvent
 UIEvent (time_point in_time)
 
- Public Member Functions inherited from vsg::Inherit< Object, UIEvent >
 Inherit (Args &&... args)
 
- Public Member Functions inherited from vsg::Object
 Object (const Object &)
 
Objectoperator= (const Object &)
 
template<class T >
T * cast ()
 
template<class T >
const T * cast () const
 
virtual void traverse (Visitor &)
 
virtual void traverse (ConstVisitor &) const
 
virtual void traverse (RecordTraversal &) const
 
void ref () const noexcept
 
void unref () const noexcept
 
void unref_nodelete () const noexcept
 
unsigned int referenceCount () const noexcept
 
template<typename T >
void setValue (const std::string &key, const T &value)
 
void setValue (const std::string &key, const char *value)
 specialization of setValue to handle passing C strings
 
template<typename T >
bool getValue (const std::string &key, T &value) const
 get specified value type, return false if value associated with key is not assigned or is not the correct type
 
void setObject (const std::string &key, ref_ptr< Object > object)
 assign an Object associated with key
 
ObjectgetObject (const std::string &key)
 get Object pointer associated with key, return nullptr if no object associated with key has been assigned
 
const ObjectgetObject (const std::string &key) const
 get const Object pointer associated with key, return nullptr if no object associated with key has been assigned
 
template<class T >
T * getObject (const std::string &key)
 get object pointer of specified type associated with key, return nullptr if no object associated with key has been assigned
 
template<class T >
const T * getObject (const std::string &key) const
 get const object pointer of specified type associated with key, return nullptr if no object associated with key has been assigned
 
ref_ptr< ObjectgetRefObject (const std::string &key)
 get ref_ptr<Object> associated with key, return nullptr if no object associated with key has been assigned
 
ref_ptr< const ObjectgetRefObject (const std::string &key) const
 get ref_ptr<const Object> pointer associated with key, return nullptr if no object associated with key has been assigned
 
template<class T >
ref_ptr< T > getRefObject (const std::string &key)
 get ref_ptr<T> of specified type associated with key, return nullptr if no object associated with key has been assigned
 
template<class T >
const ref_ptr< const T > getRefObject (const std::string &key) const
 get ref_ptr<const T> of specified type associated with key, return nullptr if no object associated with key has been assigned
 
void removeObject (const std::string &key)
 remove meta object or value associated with key
 
AuxiliarygetOrCreateAuxiliary ()
 
AuxiliarygetAuxiliary ()
 
const AuxiliarygetAuxiliary () const
 

Public Attributes

vec3 delta
 
- Public Attributes inherited from vsg::WindowEvent
observer_ptr< Windowwindow
 
- Public Attributes inherited from vsg::UIEvent
time_point time = {}
 
bool handled = false
 

Additional Inherited Members

- Static Public Member Functions inherited from vsg::Inherit< WindowEvent, ScrollWheelEvent >
static ref_ptr< ScrollWheelEventcreate (Args &&... args)
 
static ref_ptr< ScrollWheelEventcreate_if (bool flag, Args &&... args)
 
- Static Public Member Functions inherited from vsg::Inherit< UIEvent, WindowEvent >
static ref_ptr< WindowEventcreate (Args &&... args)
 
static ref_ptr< WindowEventcreate_if (bool flag, Args &&... args)
 
- Static Public Member Functions inherited from vsg::Inherit< Object, UIEvent >
static ref_ptr< UIEventcreate (Args &&... args)
 
static ref_ptr< UIEventcreate_if (bool flag, Args &&... args)
 
- Static Public Member Functions inherited from vsg::Object
static ref_ptr< Objectcreate ()
 
static ref_ptr< Objectcreate_if (bool flag)
 
static void * operator new (std::size_t count)
 provide new and delete to enable custom memory management via the vsg::Allocator singleton, using the MEMORY_AFFINTY_OBJECTS
 
static void operator delete (void *ptr)
 
- Protected Member Functions inherited from vsg::Object
virtual void _attemptDelete () const
 
void setAuxiliary (Auxiliary *auxiliary)
 

Detailed Description

ScrollWheelEvent represents a scroll wheel event.

Member Data Documentation

◆ delta

vec3 vsg::ScrollWheelEvent::delta

scroll left delta.x < 0.0, scroll right delta.x > 0.0 scroll up delta.y > 0.0, scroll down delta.y < 0.0 scroll out delta.z > 0.0, scroll in delta.z < 0.0


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