API Documentation
Loading...
Searching...
No Matches
Light.h
Go to the documentation of this file.
1/*--------------------------------------------------------------------------------------------
2Copyright (c) 2019, NDEVR LLC
3tyler.parke@ndevr.org
4 __ __ ____ _____ __ __ _______
5 | \ | | | __ \ | ___|\ \ / / | __ \
6 | \ | | | | \ \ | |___ \ \ / / | |__) |
7 | . \| | | |__/ / | |___ \ V / | _ /
8 | |\ |_|_____/__|_____|___\_/____| | \ \
9 |__| \__________________________________| \__\
10
11Subject to the terms of the Enterprise+ Agreement, NDEVR hereby grants
12Licensee a limited, non-exclusive, non-transferable, royalty-free license
13(without the right to sublicense) to use the API solely for the purpose of
14Licensee's internal development efforts to develop applications for which
15the API was provided.
16
17The above copyright notice and this permission notice shall be included in all
18copies or substantial portions of the Software.
19
20THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
21INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
22PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
23FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
24OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
25DEALINGS IN THE SOFTWARE.
26
27Library: Hardware
28File: Light
29Included in API: True
30Author(s): Tyler Parke
31 *-----------------------------------------------------------------------------------------**/
32#pragma once
33#include <NDEVR/Device.h>
34#include <QObject>
35namespace NDEVR
36{
37 class Log;
38 /**--------------------------------------------------------------------------------------------------
39 \brief A Device responsible for turning on and off a light source. The light could be anything from
40 a laser pointer to a large diffuse light source.
41 **/
42 class HARDWARE_API Light : public Device
43 {
44 Q_OBJECT
45 public:
46 Light(const Model& model, ProgressInfo* log, QObject* parent = nullptr);
47 virtual bool activated() const;
48 virtual void setBrightness(fltp08 brightness);
50 virtual void setActivated(bool activated);
51 signals:
52 void lightActivatedSignal(bool activated);
53 };
54}
#define HARDWARE_API
Definition DLLInfo.h:56
A root class which describes some physical object, such as a Motor, Sensor, or Connection....
Definition Device.h:52
A Device responsible for turning on and off a light source. The light could be anything from a laser ...
Definition Light.h:43
fltp08 brightness() const
virtual bool activated() const
Light(const Model &model, ProgressInfo *log, QObject *parent=nullptr)
virtual void setActivated(bool activated)
void lightActivatedSignal(bool activated)
virtual void setBrightness(fltp08 brightness)
A core class that represents a node on model heirarchy. This node may contain a Geometry or one or mo...
Definition Model.h:58
A light-weight base class for Log that allows processes to update, without the need for additional in...
Definition ProgressInfo.hpp:48
Definition ACIColor.h:37
double fltp08
Defines an alias representing an 8 byte floating-point number.
Definition BaseValues.hpp:149