DtLight.h

Go to the documentation of this file.

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

#pragma once

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

#include <vrvGraphicsUtils/DtColorValue.h>
#include <vrvGraphicsUtils/DtVector3.h>
#include <vrvGraphicsUtils/DtAxisAlignedBoundingBox.h>
#include <vrvGraphicsUtils/DtUserObjectBindings.h>
#include <vrvGraphicsUtils/DtMath.h>
#include <vrvGraphicsUtils/DtForwardDeclare.h>
#include <vrvGraphicsUtils/DtReusableMemoryVector.h>
FORWARD_DECLARE_DIFFERENT_SUFFIX(DtLight, Light)

#include <array>

namespace makVrv
{
   class DtLight;
   class DtLightManager;

   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);

      virtual ~DtLight();

      DtLight& operator=(const DtLight& rhs);
   
   private:
      DtLight() = delete;

      DtLight(const DtLight& rhs) = delete;

   public:
      virtual void setOn(bool bOn);
      virtual bool isOn(void) const;

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

      virtual void setSensorMask(unsigned int sensorMask);
      virtual unsigned int sensorMask() const;
      
      
      virtual void setAmbientColor(const DtColorValue& color);
      virtual void setDiffuseColor(const DtColorValue& color);
      virtual void setSpecularColor(const DtColorValue& color);

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

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

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

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

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

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

      virtual void getAttenuation(float32 attenuations[3]) const;


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

      virtual void setSpotLightAngles(const DtDegrees& fInnerAngleDegrees, const DtDegrees& fOuterAngleDegrees);
      virtual void spotLightAngles(DtDegrees& fInnerAngleDegrees, DtDegrees& fOuterAngleDegrees);

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

      virtual DtUserObjectBindings& userObjectBindings(void);
      virtual const DtUserObjectBindings& userObjectBindings(void) const;

      virtual void  setOctreeNode(void* pUserData);
      virtual void* octreeNode() const;

      virtual LightGroup lightGroup() const;

      virtual void setLightGroup(LightGroup group);

      virtual const AxisAlignedBoundingBox_64& worldAABB(void) const;

      virtual bool isInitted() const;

      virtual void setLightSourceTypeId(unsigned int lightSourceTypeId);

      virtual unsigned int lightSourceTypeId() const;

      virtual void printDetails(void) const;

      virtual void setUserValue(float64 val);

      virtual float64 userValue(void) const;
      
   public:
      static const std::string& reservedBindingKey(void);


   protected:
      friend class DtLightScreenSpaceData;

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

      virtual Vector3_64 getSpotCenter() const;

      virtual void UpdateBounds(void);

   protected:

      LightType myLightType;

      unsigned int mySensorMask; //bit 0 is visual, bit 1 is NVG, bit 2 is MWIR, bit 3 is LWIR

      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;

      AxisAlignedBoundingBox_64 myWorldAABB;

      LightGroup myLightGroup;
      DtLightManager * myLightManager;

      unsigned int myLightSourceTypeId;

      float64 myUserValue;
      
      static const std::string theStrReservedBinding;
   };

   // initializer for a light pointer
   struct DtLightPointerInitializer
   {
   public:
      void operator()(DtLight*& light)
      {
         light = nullptr;
      }
   };

   // a reusable vector of DtLight pointers
   typedef DtReusableMemoryVector<DtLight*, DtLightPointerInitializer> LightReusableVector;

} //namespace makVrv

#pragma warning( pop )