vsg 1.1.10
VulkanSceneGraph library
Loading...
Searching...
No Matches
vsg::Keyboard Class Reference

Keyboard tracks keyboard events to enable the querying of the key pressed state and how long the key has been held for. More...

#include <Keyboard.h>

Inheritance diagram for vsg::Keyboard:
Collaboration diagram for vsg::Keyboard:

Classes

struct  KeyHistory

Public Member Functions

void apply (KeyPressEvent &keyPress) override
void apply (KeyReleaseEvent &keyRelease) override
void apply (FocusInEvent &focusIn) override
void apply (FocusOutEvent &focusOut) override
bool pressed (KeySymbol key, bool ignore_handled_keys=true) const
 return true if key is currently pressed
std::pair< double, double > times (KeySymbol key, bool ignore_handled_keys=true) const
Public Member Functions inherited from vsg::Inherit< Visitor, Keyboard >
 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
Public Member Functions inherited from vsg::Visitor
 Visitor (const Visitor &rhs, const CopyOp &copyop={})
virtual InstrumentationgetInstrumentation ()
virtual void apply (Object &)
virtual void apply (Objects &)
virtual void apply (External &)
virtual void apply (Data &)
virtual void apply (stringValue &)
virtual void apply (wstringValue &)
virtual void apply (boolValue &)
virtual void apply (intValue &)
virtual void apply (uintValue &)
virtual void apply (floatValue &)
virtual void apply (doubleValue &)
virtual void apply (vec2Value &)
virtual void apply (vec3Value &)
virtual void apply (vec4Value &)
virtual void apply (dvec2Value &)
virtual void apply (dvec3Value &)
virtual void apply (dvec4Value &)
virtual void apply (bvec2Value &)
virtual void apply (bvec3Value &)
virtual void apply (bvec4Value &)
virtual void apply (ubvec2Value &)
virtual void apply (ubvec3Value &)
virtual void apply (ubvec4Value &)
virtual void apply (svec2Value &)
virtual void apply (svec3Value &)
virtual void apply (svec4Value &)
virtual void apply (usvec2Value &)
virtual void apply (usvec3Value &)
virtual void apply (usvec4Value &)
virtual void apply (ivec2Value &)
virtual void apply (ivec3Value &)
virtual void apply (ivec4Value &)
virtual void apply (uivec2Value &)
virtual void apply (uivec3Value &)
virtual void apply (uivec4Value &)
virtual void apply (mat4Value &)
virtual void apply (dmat4Value &)
virtual void apply (byteArray &)
virtual void apply (ubyteArray &)
virtual void apply (shortArray &)
virtual void apply (ushortArray &)
virtual void apply (intArray &)
virtual void apply (uintArray &)
virtual void apply (floatArray &)
virtual void apply (doubleArray &)
virtual void apply (vec2Array &)
virtual void apply (vec3Array &)
virtual void apply (vec4Array &)
virtual void apply (dvec2Array &)
virtual void apply (dvec3Array &)
virtual void apply (dvec4Array &)
virtual void apply (bvec2Array &)
virtual void apply (bvec3Array &)
virtual void apply (bvec4Array &)
virtual void apply (svec2Array &)
virtual void apply (svec3Array &)
virtual void apply (svec4Array &)
virtual void apply (ivec2Array &)
virtual void apply (ivec3Array &)
virtual void apply (ivec4Array &)
virtual void apply (ubvec2Array &)
virtual void apply (ubvec3Array &)
virtual void apply (ubvec4Array &)
virtual void apply (usvec2Array &)
virtual void apply (usvec3Array &)
virtual void apply (usvec4Array &)
virtual void apply (uivec2Array &)
virtual void apply (uivec3Array &)
virtual void apply (uivec4Array &)
virtual void apply (mat4Array &)
virtual void apply (dmat4Array &)
virtual void apply (block64Array &)
virtual void apply (block128Array &)
virtual void apply (byteArray2D &)
virtual void apply (ubyteArray2D &)
virtual void apply (shortArray2D &)
virtual void apply (ushortArray2D &)
virtual void apply (intArray2D &)
virtual void apply (uintArray2D &)
virtual void apply (floatArray2D &)
virtual void apply (doubleArray2D &)
virtual void apply (vec2Array2D &)
virtual void apply (vec3Array2D &)
virtual void apply (vec4Array2D &)
virtual void apply (dvec2Array2D &)
virtual void apply (dvec3Array2D &)
virtual void apply (dvec4Array2D &)
virtual void apply (bvec2Array2D &)
virtual void apply (bvec3Array2D &)
virtual void apply (bvec4Array2D &)
virtual void apply (svec2Array2D &)
virtual void apply (svec3Array2D &)
virtual void apply (svec4Array2D &)
virtual void apply (ivec2Array2D &)
virtual void apply (ivec3Array2D &)
virtual void apply (ivec4Array2D &)
virtual void apply (ubvec2Array2D &)
virtual void apply (ubvec3Array2D &)
virtual void apply (ubvec4Array2D &)
virtual void apply (usvec2Array2D &)
virtual void apply (usvec3Array2D &)
virtual void apply (usvec4Array2D &)
virtual void apply (uivec2Array2D &)
virtual void apply (uivec3Array2D &)
virtual void apply (uivec4Array2D &)
virtual void apply (block64Array2D &)
virtual void apply (block128Array2D &)
virtual void apply (byteArray3D &)
virtual void apply (ubyteArray3D &)
virtual void apply (shortArray3D &)
virtual void apply (ushortArray3D &)
virtual void apply (intArray3D &)
virtual void apply (uintArray3D &)
virtual void apply (floatArray3D &)
virtual void apply (doubleArray3D &)
virtual void apply (vec2Array3D &)
virtual void apply (vec3Array3D &)
virtual void apply (vec4Array3D &)
virtual void apply (dvec2Array3D &)
virtual void apply (dvec3Array3D &)
virtual void apply (dvec4Array3D &)
virtual void apply (ubvec2Array3D &)
virtual void apply (ubvec3Array3D &)
virtual void apply (ubvec4Array3D &)
virtual void apply (block64Array3D &)
virtual void apply (block128Array3D &)
virtual void apply (Node &)
virtual void apply (Compilable &)
virtual void apply (Commands &)
virtual void apply (Group &)
virtual void apply (QuadGroup &)
virtual void apply (LOD &)
virtual void apply (PagedLOD &)
virtual void apply (StateGroup &)
virtual void apply (CullGroup &)
virtual void apply (CullNode &)
virtual void apply (Transform &)
virtual void apply (MatrixTransform &)
virtual void apply (CoordinateFrame &)
virtual void apply (Geometry &)
virtual void apply (VertexDraw &)
virtual void apply (VertexIndexDraw &)
virtual void apply (DepthSorted &)
virtual void apply (Layer &)
virtual void apply (Bin &)
virtual void apply (Switch &)
virtual void apply (Light &)
virtual void apply (AmbientLight &)
virtual void apply (DirectionalLight &)
virtual void apply (PointLight &)
virtual void apply (SpotLight &)
virtual void apply (InstrumentationNode &)
virtual void apply (RegionOfInterest &)
virtual void apply (Text &)
virtual void apply (TextGroup &)
virtual void apply (TextTechnique &)
virtual void apply (TextLayout &)
virtual void apply (Animation &)
virtual void apply (AnimationGroup &)
virtual void apply (AnimationSampler &)
virtual void apply (JointSampler &)
virtual void apply (MorphSampler &)
virtual void apply (TransformSampler &)
virtual void apply (CameraSampler &)
virtual void apply (Joint &)
virtual void apply (BufferInfo &)
virtual void apply (ImageInfo &)
virtual void apply (ImageView &)
virtual void apply (Image &)
virtual void apply (Command &)
virtual void apply (StateCommand &)
virtual void apply (StateSwitch &)
virtual void apply (CommandBuffer &)
virtual void apply (RenderPass &)
virtual void apply (BindDescriptorSet &)
virtual void apply (BindDescriptorSets &)
virtual void apply (BindViewDescriptorSets &)
virtual void apply (Descriptor &)
virtual void apply (DescriptorBuffer &)
virtual void apply (DescriptorImage &)
virtual void apply (DescriptorSet &)
virtual void apply (BindVertexBuffers &)
virtual void apply (BindIndexBuffer &)
virtual void apply (BindComputePipeline &)
virtual void apply (BindGraphicsPipeline &)
virtual void apply (BindRayTracingPipeline &)
virtual void apply (GraphicsPipeline &)
virtual void apply (ComputePipeline &)
virtual void apply (RayTracingPipeline &)
virtual void apply (GraphicsPipelineState &)
virtual void apply (ShaderStage &)
virtual void apply (VertexInputState &)
virtual void apply (InputAssemblyState &)
virtual void apply (TessellationState &)
virtual void apply (ViewportState &)
virtual void apply (RasterizationState &)
virtual void apply (MultisampleState &)
virtual void apply (DepthStencilState &)
virtual void apply (ColorBlendState &)
virtual void apply (DynamicState &)
virtual void apply (ResourceHints &)
virtual void apply (Draw &)
virtual void apply (DrawIndexed &)
virtual void apply (ClearAttachments &)
virtual void apply (ClearColorImage &)
virtual void apply (ClearDepthStencilImage &)
virtual void apply (QueryPool &)
virtual void apply (ResetQueryPool &)
virtual void apply (BeginQuery &)
virtual void apply (EndQuery &)
virtual void apply (WriteTimestamp &)
virtual void apply (CopyQueryPoolResults &)
virtual void apply (DrawMeshTasks &)
virtual void apply (DrawMeshTasksIndirect &)
virtual void apply (DrawMeshTasksIndirectCount &)
virtual void apply (UIEvent &)
virtual void apply (WindowEvent &)
virtual void apply (ExposeWindowEvent &)
virtual void apply (ConfigureWindowEvent &)
virtual void apply (CloseWindowEvent &)
virtual void apply (KeyEvent &)
virtual void apply (PointerEvent &)
virtual void apply (ButtonPressEvent &)
virtual void apply (ButtonReleaseEvent &)
virtual void apply (MoveEvent &)
virtual void apply (TouchEvent &)
virtual void apply (TouchDownEvent &)
virtual void apply (TouchUpEvent &)
virtual void apply (TouchMoveEvent &)
virtual void apply (ScrollWheelEvent &)
virtual void apply (TerminateEvent &)
virtual void apply (FrameEvent &)
virtual void apply (ShaderCompileSettings &)
virtual void apply (Camera &)
virtual void apply (CommandGraph &)
virtual void apply (SecondaryCommandGraph &)
virtual void apply (RenderGraph &)
virtual void apply (View &)
virtual void apply (Viewer &)
virtual void apply (ViewMatrix &)
virtual void apply (LookAt &)
virtual void apply (LookDirection &)
virtual void apply (RelativeViewMatrix &)
virtual void apply (TrackingViewMatrix &)
virtual void apply (ProjectionMatrix &)
virtual void apply (Perspective &)
virtual void apply (Orthographic &)
virtual void apply (RelativeProjection &)
virtual void apply (EllipsoidPerspective &)
virtual void apply (FrameStamp &)
bool is_compatible (const std::type_info &type) const noexcept override
Public Member Functions inherited from vsg::Object
 Object (const Object &object, const CopyOp &copyop={})
Objectoperator= (const Object &)
template<class T>
T * cast ()
template<class T>
const T * cast () const
virtual ref_ptr< Objectclone (const CopyOp &copyop={}) const
virtual void traverse (Visitor &)
virtual void accept (ConstVisitor &visitor) const
virtual void traverse (ConstVisitor &) const
virtual void accept (RecordTraversal &visitor) const
virtual void traverse (RecordTraversal &) const
virtual void read (Input &input)
virtual void write (Output &output) 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

std::map< KeySymbol, KeyHistorykeyState
Public Attributes inherited from vsg::Visitor
Mask traversalMask = MASK_ALL
Mask overrideMask = MASK_OFF

Additional Inherited Members

Static Public Member Functions inherited from vsg::Inherit< Visitor, Keyboard >
static ref_ptr< Keyboardcreate (Args &&... args)
static ref_ptr< Keyboardcreate_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

Keyboard tracks keyboard events to enable the querying of the key pressed state and how long the key has been held for.

Member Function Documentation

◆ apply() [1/4]

void vsg::Keyboard::apply ( FocusInEvent & focusIn)
overridevirtual

Reimplemented from vsg::Visitor.

◆ apply() [2/4]

void vsg::Keyboard::apply ( FocusOutEvent & focusOut)
overridevirtual

Reimplemented from vsg::Visitor.

◆ apply() [3/4]

void vsg::Keyboard::apply ( KeyPressEvent & keyPress)
overridevirtual

Reimplemented from vsg::Visitor.

◆ apply() [4/4]

void vsg::Keyboard::apply ( KeyReleaseEvent & keyRelease)
overridevirtual

Reimplemented from vsg::Visitor.

◆ times()

std::pair< double, double > vsg::Keyboard::times ( KeySymbol key,
bool ignore_handled_keys = true ) const

return a pair of times, the first is the time, in seconds, since the key was first pressed and the second is the time, in seconds, since it was released. if the key hasn't been pressed then then the first value will be < 0.0, if the key is still pressed then the second value will be 0.0.


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