DtLight.h

Go to the documentation of this file.

/******************************************************************************
** Copyright (c) 2020 MAK Technologies, Inc.
** All rights reserved.
******************************************************************************/

#pragma once

#pragma warning( push )
#pragma warning( disable : 4251 )

#include <vrvGraphicsUtils/DtColorValue.h>
#include <vrvGraphicsUtils/DtVectorForwardDeclare.h>
#include <vrvGraphicsUtils/DtAxisAlignedBoundingBox.h>
#include <vrvGraphicsUtils/DtUserObjectBindings.h>
#include <vrvGraphicsUtils/DtMath.h>
#include <vrvGraphicsUtils/DtForwardDeclare.h>

FORWARD_DECLARE_DIFFERENT_SUFFIX(DtLight, Light)

#include <boost/array.hpp> // TODO: replace with std::array when c++11 is available
#include <boost/signals.hpp>

namespace makVrv
{

   class DtLightManager;
   typedef boost::signal< void(const DtLight*) > LightSignal;

   enum LightType
   {
      LT_DIRECTIONAL = 0
      , LT_POINT = 1
      , LT_SPOTLIGHT = 2
   };

   enum LightGroup
   {
      LG_UNKNOWN = 0
      , LG_PROPS = 1
      , LG_TERRAIN = 2
   };

   class DT_DLL_VRVGRAPHICSUTILS DtLight
   {
   public:
      DtLight(DtLightManager * lightManager);

      ~DtLight();

      void setOn(bool bOn);
      bool isOn(void) const { return mybIsOn; }

      void setLightType(LightType lightType);
      LightType lightType(void) const;

      void setAmbientColor(const DtColorValue& color);
      void setDiffuseColor(const DtColorValue& color);
      void setSpecularColor(const DtColorValue& color);

      const DtColorValue& ambientColor(void) const;
      const DtColorValue& diffuseColor(void) const;
      const DtColorValue& specularColor(void) const;

      void setPosition(const Vector3_64& vPosition);
      const Vector3_64& position(void) const;

      void setDirection(const Vector3_64& vDirection);
      const Vector3_64& direction(void) const;

      void setRange(float32 fRange);
      float32 range(void) const;
      float32 squaredRange(void) const;

      void setAttenuation(float32 fConstant, float32 fLinear, float32 fQuadratic);

      float32 constantAttenuation(void) const;
      float32 linearAttenuation(void) const;
      float32 quadraticAttenuation(void) const;

      void getAttenuation(float32 attenuations[3]) const;


      void setSpotLightParameters(const DtDegrees& fInnerAngleDegrees
         , const DtDegrees& fOuterAngleDegrees
         , float32 fFalloff);

      void setSpotLightAngles(const DtDegrees& fInnerAngleDegrees, const DtDegrees& fOuterAngleDegrees);
      void getSpotLightAngles(DtDegrees& fInnerAngleDegrees, DtDegrees& fOuterAngleDegrees);

      DtDegrees innerAngle(void) const;
      DtDegrees outerAngle(void) const;
      float32 falloff(void) const;

      DtUserObjectBindings& getUserObjectBindings(void);
      const DtUserObjectBindings& getUserObjectBindings(void) const;

      void  setOctreeNode(void* pUserData);
      void* octreeNode() const { return myOctreeNode; }

      LightSignal signal_LightUpdated;
      LightSignal signal_LightBoundsUpdated;
      LightSignal signal_LightDestroyed;

      void enableSignals(bool enable);
      bool signalsEnabled(void) const;

      void enableUpdateSignals(bool enable);

      LightGroup lightGroup() const;

      void setLightGroup(LightGroup group);

      const AxisAlignedBoundingBox_64& getWorldAABB(void) const;

      float64 myTempValue;

      static const std::string& getReservedBindingKey(void)
      {
         return mystrReservedBinding;
      }

      DtLight& operator=(const DtLight& rhs);


      bool isInitted() const { return mybIsInitted; }

   private:
      friend class DtLightScreenSpaceData;

      void getArbitraryBasisVectors(Vector3_64& vBasis0, Vector3_64& vBasis1) const;
      void getArbitraryBasisPoints(float distance, boost::array<Vector3_64, 4>& point) const;
      float getAngleFactor() const;

      Vector3_64 getSpotCenter() const;

      LightType myLightType;

      DtColorValue myAmbientColor;
      DtColorValue myDiffuseColor;
      DtColorValue mySpecularColor;

      Vector3_64 myVecPosition;
      Vector3_64 myVecDirection;

      float32 myfRange;
      float32 myfSquaredRange;

      float32 myfConstantAttenuation;
      float32 myfLinearAttenuation;
      float32 myfQuadraticAttenuation;

      DtDegrees myfInnerAngle;
      DtDegrees myfOuterAngle;
      float32 myfFallOff;

      bool mybIsOn;
      bool mybIsInitted;
      DtUserObjectBindings myUserObjectBindings;
      void*                myOctreeNode;

      void UpdateBounds(void);
      AxisAlignedBoundingBox_64 myWorldAABB;

      static const std::string mystrReservedBinding;

      bool mySignalsEnabled;
      bool myUpdateSignalEnabled;

      LightGroup myLightGroup;
      DtLightManager * myLightManager;
   };

} //namespace makVrv

#pragma warning( pop )