1/**************************************************************************/
2/* fog_volume.h */
3/**************************************************************************/
4/* This file is part of: */
5/* GODOT ENGINE */
6/* https://godotengine.org */
7/**************************************************************************/
8/* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */
9/* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur. */
10/* */
11/* Permission is hereby granted, free of charge, to any person obtaining */
12/* a copy of this software and associated documentation files (the */
13/* "Software"), to deal in the Software without restriction, including */
14/* without limitation the rights to use, copy, modify, merge, publish, */
15/* distribute, sublicense, and/or sell copies of the Software, and to */
16/* permit persons to whom the Software is furnished to do so, subject to */
17/* the following conditions: */
18/* */
19/* The above copyright notice and this permission notice shall be */
20/* included in all copies or substantial portions of the Software. */
21/* */
22/* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
23/* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
24/* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. */
25/* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
26/* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
27/* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
28/* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
29/**************************************************************************/
30
31#ifndef FOG_VOLUME_H
32#define FOG_VOLUME_H
33
34#include "core/templates/rid.h"
35#include "scene/3d/visual_instance_3d.h"
36#include "scene/main/node.h"
37#include "scene/main/viewport.h"
38#include "scene/resources/material.h"
39
40class FogVolume : public VisualInstance3D {
41 GDCLASS(FogVolume, VisualInstance3D);
42
43 Vector3 size = Vector3(2, 2, 2);
44 Ref<Material> material;
45 RS::FogVolumeShape shape = RS::FOG_VOLUME_SHAPE_BOX;
46
47 RID volume;
48
49protected:
50 _FORCE_INLINE_ RID _get_volume() { return volume; }
51 static void _bind_methods();
52 void _validate_property(PropertyInfo &p_property) const;
53#ifndef DISABLE_DEPRECATED
54 bool _set(const StringName &p_name, const Variant &p_value);
55 bool _get(const StringName &p_name, Variant &r_property) const;
56#endif // DISABLE_DEPRECATED
57
58public:
59 void set_size(const Vector3 &p_size);
60 Vector3 get_size() const;
61
62 void set_shape(RS::FogVolumeShape p_type);
63 RS::FogVolumeShape get_shape() const;
64
65 void set_material(const Ref<Material> &p_material);
66 Ref<Material> get_material() const;
67
68 virtual AABB get_aabb() const override;
69 PackedStringArray get_configuration_warnings() const override;
70
71 FogVolume();
72 ~FogVolume();
73};
74
75#endif // FOG_VOLUME_H
76