SRSDK-Doxygen-Documentation/switchablehint_8h_source.html

#pragma once


#include "sr/management/srcontext.h"


#ifdef WIN32

#   ifdef COMPILING_DLL_SimulatedRealityDisplays

#     define DIMENCOSR_API __declspec(dllexport)

#   else

#     define DIMENCOSR_API __declspec(dllimport)

#   endif

#else

#   define DIMENCOSR_API

#endif


namespace SR {


class DIMENCOSR_API SwitchableLensHint : public Sense {

public:

    static SwitchableLensHint* create(SRContext &context);


    virtual ~SwitchableLensHint() {};


    virtual void enable() = 0;


    virtual void disable() = 0;


    virtual bool isEnabled() = 0;


    virtual bool isEnabledByPreference() = 0;

};


}


#undef DIMENCOSR_API

SR::SRContext
Maintains WorldObject and Sense objects during the application lifetime.
Definition: srcontext.h:75

SR::Sense
Class of objects dealing with Streams  of data.
Definition: sense.h:37

SR::SwitchableLensHint
Pure virtual interface for controlling switchable lenses from applications.
Definition: switchablehint.h:29

SR::SwitchableLensHint::isEnabledByPreference
virtual bool isEnabledByPreference()=0
This function returns true if any of already connected applications enabled the lense,...

SR::SwitchableLensHint::create
static SwitchableLensHint * create(SRContext &context)
Creates a functional SwitchableLensHints instance.

SR::SwitchableLensHint::enable
virtual void enable()=0
Expresses preference to enable the lens such that it affects the light transmitted through it.

SR::SwitchableLensHint::disable
virtual void disable()=0
Expresses preference to disable the lens to minimize the effect on the light transmitted through it.

SR::SwitchableLensHint::isEnabled
virtual bool isEnabled()=0
Checks whether the Lens is currently enabled.

SR::SwitchableLensHint::~SwitchableLensHint
virtual ~SwitchableLensHint()
Virtual destructor.
Definition: switchablehint.h:47

SR
Namespace containing all C++ Simulated Reality classes.
Definition: srconfiguration.h:20

srcontext.h

DIMENCOSR_API
#define DIMENCOSR_API
Definition: switchablehint.h:16