diff options
author | Keränen Pasi <pasi.keranen@digia.com> | 2013-09-13 11:13:16 +0300 |
---|---|---|
committer | Pasi Keränen <pasi.keranen@digia.com> | 2013-09-19 12:11:33 +0300 |
commit | 802681d854d93a50547585570da3bcf7b6c41636 (patch) | |
tree | 2818f239df688f6ad5b91b2ac9d638ffae34e24a /src/datavisualization/engine/q3dlight.cpp | |
parent | 35a5a5302fdcf43bc571f51f03512e3df9d2c58c (diff) |
Qdoc documentation for new scene and input classes.
Change-Id: I5d9680fcf2e49655c1b9bcdf961bbda02bf31968
Reviewed-by: Miikka Heikkinen <miikka.heikkinen@digia.com>
Reviewed-by: Tomi Korpipää <tomi.korpipaa@digia.com>
Diffstat (limited to 'src/datavisualization/engine/q3dlight.cpp')
-rw-r--r-- | src/datavisualization/engine/q3dlight.cpp | 23 |
1 files changed, 21 insertions, 2 deletions
diff --git a/src/datavisualization/engine/q3dlight.cpp b/src/datavisualization/engine/q3dlight.cpp index 214efa5d..c482e62a 100644 --- a/src/datavisualization/engine/q3dlight.cpp +++ b/src/datavisualization/engine/q3dlight.cpp @@ -22,17 +22,36 @@ QT_DATAVISUALIZATION_BEGIN_NAMESPACE +/*! + \class Q3DLight + \inmodule QtDataVisualization + \brief Representation of a light source in 3D space. + \since 1.0.0 + + Q3DLight represents a monochrome non variable light source in 3D space. +*/ + +/*! + * Constructs a new 3D light located at origo. An optional \a parent parameter can be given + * and is then passed to QObject constructor. + */ Q3DLight::Q3DLight(QObject *parent) : Q3DObject(parent), d_ptr(new Q3DLightPrivate(this)) { } +/*! + * Copies the properties of the 3D light from the given source \a source light to this light instance. + */ void Q3DLight::copyValuesFrom(const Q3DLight &source) { Q3DObject::copyValuesFrom(source); } +/*! + * Destroys the light object. + */ Q3DLight::~Q3DLight() { } @@ -46,10 +65,10 @@ Q3DLightPrivate::~Q3DLightPrivate() { } -// Copies changed values from this light to the other light. If the other light had same changes, -// those changes are discarded. void Q3DLightPrivate::sync(Q3DLight &other) { + // Copies changed values from this light to the other light. If the other light had same changes, + // those changes are discarded. if (q_ptr->isDirty()) { other.copyValuesFrom(*q_ptr); q_ptr->setDirty(false); |