kraken/kraken/nodes/KRAmbientZone.h

//
//  KRAmbientZone.h
//  Kraken Engine
//
//  Copyright 2026 Kearwood Gilbert. All rights reserved.
//
//  Redistribution and use in source and binary forms, with or without modification, are
//  permitted provided that the following conditions are met:
//
//  1. Redistributions of source code must retain the above copyright notice, this list of
//  conditions and the following disclaimer.
//
//  2. Redistributions in binary form must reproduce the above copyright notice, this list
//  of conditions and the following disclaimer in the documentation and/or other materials
//  provided with the distribution.
//
//  THIS SOFTWARE IS PROVIDED BY KEARWOOD GILBERT ''AS IS'' AND ANY EXPRESS OR IMPLIED
//  WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
//  FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL KEARWOOD GILBERT OR
//  CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
//  CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
//  SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
//  ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
//  NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
//  ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
//  The views and conclusions contained in the software and documentation are those of the
//  authors and should not be interpreted as representing official policies, either expressed
//  or implied, of Kearwood Gilbert.
//

#pragma once

#include "KREngine-common.h"
#include "resources/KRResource.h"
#include "resources/audio/KRAudioSampleBinding.h"
#include "KRNode.h"

class KRAudioSample;

class KRAmbientZone : public KRNode
{
public:
  static void InitNodeInfo(KrNodeInfo* nodeInfo);

  KRAmbientZone(KRScene& scene, std::string name);
  virtual ~KRAmbientZone();
  virtual std::string getElementName();
  virtual tinyxml2::XMLElement* saveXML(tinyxml2::XMLNode* parent);
  virtual void loadXML(tinyxml2::XMLElement* e);

  void render(RenderInfo& ri) override;

  std::string getZone();
  void setZone(const std::string& zone);

  float getGradientDistance();
  void setGradientDistance(float gradient_distance);

  KRAudioSample* getAmbient();
  void setAmbient(const std::string& ambient);

  float getAmbientGain();
  void setAmbientGain(float ambient_gain);

  virtual hydra::AABB getBounds();

  float getContainment(const hydra::Vector3& pos);

private:
  KRNODE_PROPERTY(std::string, m_zone, "", "zone");
  KRNODE_PROPERTY(float, m_gradient_distance, 0.25f, "gradient");
  KRNODE_PROPERTY(float, m_ambient_gain, 1.f, "gain");
  KRNODE_PROPERTY(KRAudioSampleBinding, m_ambient, "", "sample");
};