2014-02-10 02:10:30 +01:00
|
|
|
/*************************************************************************/
|
|
|
|
/* light.h */
|
|
|
|
/*************************************************************************/
|
|
|
|
/* This file is part of: */
|
|
|
|
/* GODOT ENGINE */
|
2017-08-27 14:16:55 +02:00
|
|
|
/* https://godotengine.org */
|
2014-02-10 02:10:30 +01:00
|
|
|
/*************************************************************************/
|
2017-01-01 22:01:57 +01:00
|
|
|
/* Copyright (c) 2007-2017 Juan Linietsky, Ariel Manzur. */
|
2017-04-08 00:11:42 +02:00
|
|
|
/* Copyright (c) 2014-2017 Godot Engine contributors (cf. AUTHORS.md) */
|
2014-02-10 02:10:30 +01:00
|
|
|
/* */
|
|
|
|
/* Permission is hereby granted, free of charge, to any person obtaining */
|
|
|
|
/* a copy of this software and associated documentation files (the */
|
|
|
|
/* "Software"), to deal in the Software without restriction, including */
|
|
|
|
/* without limitation the rights to use, copy, modify, merge, publish, */
|
|
|
|
/* distribute, sublicense, and/or sell copies of the Software, and to */
|
|
|
|
/* permit persons to whom the Software is furnished to do so, subject to */
|
|
|
|
/* the following conditions: */
|
|
|
|
/* */
|
|
|
|
/* The above copyright notice and this permission notice shall be */
|
|
|
|
/* included in all copies or substantial portions of the Software. */
|
|
|
|
/* */
|
|
|
|
/* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
|
|
|
|
/* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
|
|
|
|
/* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.*/
|
|
|
|
/* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
|
|
|
|
/* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
|
|
|
|
/* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
|
|
|
|
/* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
|
|
|
|
/*************************************************************************/
|
|
|
|
#ifndef LIGHT_H
|
|
|
|
#define LIGHT_H
|
|
|
|
|
|
|
|
#include "scene/3d/visual_instance.h"
|
|
|
|
#include "scene/resources/texture.h"
|
|
|
|
#include "servers/visual_server.h"
|
|
|
|
|
|
|
|
/**
|
|
|
|
@author Juan Linietsky <reduzio@gmail.com>
|
|
|
|
*/
|
2016-12-20 04:21:07 +01:00
|
|
|
|
2014-02-10 02:10:30 +01:00
|
|
|
class Light : public VisualInstance {
|
|
|
|
|
2017-03-05 16:44:50 +01:00
|
|
|
GDCLASS(Light, VisualInstance);
|
2014-02-10 02:10:30 +01:00
|
|
|
OBJ_CATEGORY("3D Light Nodes");
|
|
|
|
|
|
|
|
public:
|
2016-10-27 16:50:26 +02:00
|
|
|
enum Param {
|
2016-11-10 03:55:06 +01:00
|
|
|
PARAM_ENERGY = VS::LIGHT_PARAM_ENERGY,
|
|
|
|
PARAM_SPECULAR = VS::LIGHT_PARAM_SPECULAR,
|
|
|
|
PARAM_RANGE = VS::LIGHT_PARAM_RANGE,
|
|
|
|
PARAM_ATTENUATION = VS::LIGHT_PARAM_ATTENUATION,
|
|
|
|
PARAM_SPOT_ANGLE = VS::LIGHT_PARAM_SPOT_ANGLE,
|
|
|
|
PARAM_SPOT_ATTENUATION = VS::LIGHT_PARAM_SPOT_ATTENUATION,
|
2017-03-05 16:44:50 +01:00
|
|
|
PARAM_CONTACT_SHADOW_SIZE = VS::LIGHT_PARAM_CONTACT_SHADOW_SIZE,
|
2016-11-10 03:55:06 +01:00
|
|
|
PARAM_SHADOW_MAX_DISTANCE = VS::LIGHT_PARAM_SHADOW_MAX_DISTANCE,
|
|
|
|
PARAM_SHADOW_SPLIT_1_OFFSET = VS::LIGHT_PARAM_SHADOW_SPLIT_1_OFFSET,
|
|
|
|
PARAM_SHADOW_SPLIT_2_OFFSET = VS::LIGHT_PARAM_SHADOW_SPLIT_2_OFFSET,
|
|
|
|
PARAM_SHADOW_SPLIT_3_OFFSET = VS::LIGHT_PARAM_SHADOW_SPLIT_3_OFFSET,
|
|
|
|
PARAM_SHADOW_NORMAL_BIAS = VS::LIGHT_PARAM_SHADOW_NORMAL_BIAS,
|
|
|
|
PARAM_SHADOW_BIAS = VS::LIGHT_PARAM_SHADOW_BIAS,
|
|
|
|
PARAM_MAX = VS::LIGHT_PARAM_MAX
|
2014-06-11 15:41:03 +02:00
|
|
|
};
|
|
|
|
|
2014-02-10 02:10:30 +01:00
|
|
|
private:
|
2016-10-27 16:50:26 +02:00
|
|
|
Color color;
|
|
|
|
float param[PARAM_MAX];
|
2016-11-11 16:27:52 +01:00
|
|
|
Color shadow_color;
|
2016-10-27 16:50:26 +02:00
|
|
|
bool shadow;
|
|
|
|
bool negative;
|
2017-08-20 01:06:40 +02:00
|
|
|
bool reverse_cull;
|
2016-10-27 16:50:26 +02:00
|
|
|
uint32_t cull_mask;
|
2016-10-03 21:33:42 +02:00
|
|
|
VS::LightType type;
|
2014-10-12 07:13:22 +02:00
|
|
|
bool editor_only;
|
|
|
|
void _update_visibility();
|
2016-12-20 04:21:07 +01:00
|
|
|
|
2017-03-05 16:44:50 +01:00
|
|
|
// bind helpers
|
2014-02-10 02:10:30 +01:00
|
|
|
|
2016-03-09 00:00:52 +01:00
|
|
|
protected:
|
2014-02-10 02:10:30 +01:00
|
|
|
RID light;
|
|
|
|
|
|
|
|
virtual bool _can_gizmo_scale() const;
|
2017-03-05 16:44:50 +01:00
|
|
|
|
2014-02-10 02:10:30 +01:00
|
|
|
static void _bind_methods();
|
2014-10-12 07:13:22 +02:00
|
|
|
void _notification(int p_what);
|
2014-02-10 02:10:30 +01:00
|
|
|
|
2016-03-09 00:00:52 +01:00
|
|
|
Light(VisualServer::LightType p_type);
|
2014-02-10 02:10:30 +01:00
|
|
|
|
2017-03-05 16:44:50 +01:00
|
|
|
public:
|
2014-02-10 02:10:30 +01:00
|
|
|
VS::LightType get_light_type() const { return type; }
|
|
|
|
|
2014-10-12 07:13:22 +02:00
|
|
|
void set_editor_only(bool p_editor_only);
|
|
|
|
bool is_editor_only() const;
|
2014-02-10 02:10:30 +01:00
|
|
|
|
2016-10-27 16:50:26 +02:00
|
|
|
void set_param(Param p_param, float p_value);
|
|
|
|
float get_param(Param p_param) const;
|
2014-02-10 02:10:30 +01:00
|
|
|
|
2016-10-27 16:50:26 +02:00
|
|
|
void set_shadow(bool p_enable);
|
|
|
|
bool has_shadow() const;
|
2014-02-10 02:10:30 +01:00
|
|
|
|
2016-10-27 16:50:26 +02:00
|
|
|
void set_negative(bool p_enable);
|
|
|
|
bool is_negative() const;
|
2014-02-10 02:10:30 +01:00
|
|
|
|
2016-10-27 16:50:26 +02:00
|
|
|
void set_cull_mask(uint32_t p_cull_mask);
|
|
|
|
uint32_t get_cull_mask() const;
|
2014-02-10 02:10:30 +01:00
|
|
|
|
2017-03-05 16:44:50 +01:00
|
|
|
void set_color(const Color &p_color);
|
2016-10-27 16:50:26 +02:00
|
|
|
Color get_color() const;
|
2014-06-11 15:41:03 +02:00
|
|
|
|
2017-03-05 16:44:50 +01:00
|
|
|
void set_shadow_color(const Color &p_shadow_color);
|
2016-11-11 16:27:52 +01:00
|
|
|
Color get_shadow_color() const;
|
2014-06-11 15:41:03 +02:00
|
|
|
|
2017-08-20 01:06:40 +02:00
|
|
|
void set_shadow_reverse_cull_face(bool p_enable);
|
|
|
|
bool get_shadow_reverse_cull_face() const;
|
|
|
|
|
2017-01-11 04:52:51 +01:00
|
|
|
virtual Rect3 get_aabb() const;
|
2017-01-07 22:25:37 +01:00
|
|
|
virtual PoolVector<Face3> get_faces(uint32_t p_usage_flags) const;
|
2014-02-10 02:10:30 +01:00
|
|
|
|
|
|
|
Light();
|
|
|
|
~Light();
|
|
|
|
};
|
|
|
|
|
2016-10-27 16:50:26 +02:00
|
|
|
VARIANT_ENUM_CAST(Light::Param);
|
2014-02-10 02:10:30 +01:00
|
|
|
|
|
|
|
class DirectionalLight : public Light {
|
|
|
|
|
2017-03-05 16:44:50 +01:00
|
|
|
GDCLASS(DirectionalLight, Light);
|
2014-02-10 02:10:30 +01:00
|
|
|
|
|
|
|
public:
|
|
|
|
enum ShadowMode {
|
|
|
|
SHADOW_ORTHOGONAL,
|
2014-05-05 03:50:23 +02:00
|
|
|
SHADOW_PARALLEL_2_SPLITS,
|
|
|
|
SHADOW_PARALLEL_4_SPLITS
|
2014-02-10 02:10:30 +01:00
|
|
|
};
|
|
|
|
|
|
|
|
private:
|
2016-11-10 03:55:06 +01:00
|
|
|
bool blend_splits;
|
2014-02-10 02:10:30 +01:00
|
|
|
ShadowMode shadow_mode;
|
2016-10-03 21:33:42 +02:00
|
|
|
|
2014-02-10 02:10:30 +01:00
|
|
|
protected:
|
|
|
|
static void _bind_methods();
|
|
|
|
|
2017-03-05 16:44:50 +01:00
|
|
|
public:
|
2014-02-10 02:10:30 +01:00
|
|
|
void set_shadow_mode(ShadowMode p_mode);
|
|
|
|
ShadowMode get_shadow_mode() const;
|
|
|
|
|
2016-11-10 03:55:06 +01:00
|
|
|
void set_blend_splits(bool p_enable);
|
|
|
|
bool is_blend_splits_enabled() const;
|
2014-02-10 02:10:30 +01:00
|
|
|
|
|
|
|
DirectionalLight();
|
|
|
|
};
|
|
|
|
|
2016-11-10 03:55:06 +01:00
|
|
|
VARIANT_ENUM_CAST(DirectionalLight::ShadowMode)
|
2014-02-10 02:10:30 +01:00
|
|
|
|
|
|
|
class OmniLight : public Light {
|
|
|
|
|
2017-03-05 16:44:50 +01:00
|
|
|
GDCLASS(OmniLight, Light);
|
|
|
|
|
2016-11-10 03:55:06 +01:00
|
|
|
public:
|
|
|
|
// omni light
|
|
|
|
enum ShadowMode {
|
|
|
|
SHADOW_DUAL_PARABOLOID,
|
|
|
|
SHADOW_CUBE,
|
|
|
|
};
|
|
|
|
|
|
|
|
// omni light
|
|
|
|
enum ShadowDetail {
|
|
|
|
SHADOW_DETAIL_VERTICAL,
|
|
|
|
SHADOW_DETAIL_HORIZONTAL
|
|
|
|
};
|
|
|
|
|
|
|
|
private:
|
|
|
|
ShadowMode shadow_mode;
|
|
|
|
ShadowDetail shadow_detail;
|
2017-03-05 16:44:50 +01:00
|
|
|
|
2014-02-10 02:10:30 +01:00
|
|
|
protected:
|
|
|
|
static void _bind_methods();
|
|
|
|
|
|
|
|
public:
|
2016-11-10 03:55:06 +01:00
|
|
|
void set_shadow_mode(ShadowMode p_mode);
|
|
|
|
ShadowMode get_shadow_mode() const;
|
2014-02-10 02:10:30 +01:00
|
|
|
|
2016-11-10 03:55:06 +01:00
|
|
|
void set_shadow_detail(ShadowDetail p_detail);
|
|
|
|
ShadowDetail get_shadow_detail() const;
|
|
|
|
|
|
|
|
OmniLight();
|
2014-02-10 02:10:30 +01:00
|
|
|
};
|
|
|
|
|
2016-11-10 03:55:06 +01:00
|
|
|
VARIANT_ENUM_CAST(OmniLight::ShadowMode)
|
|
|
|
VARIANT_ENUM_CAST(OmniLight::ShadowDetail)
|
|
|
|
|
2014-02-10 02:10:30 +01:00
|
|
|
class SpotLight : public Light {
|
|
|
|
|
2017-03-05 16:44:50 +01:00
|
|
|
GDCLASS(SpotLight, Light);
|
|
|
|
|
2014-02-10 02:10:30 +01:00
|
|
|
protected:
|
|
|
|
static void _bind_methods();
|
|
|
|
|
2017-03-05 16:44:50 +01:00
|
|
|
public:
|
|
|
|
SpotLight()
|
|
|
|
: Light(VisualServer::LIGHT_SPOT) {}
|
2014-02-10 02:10:30 +01:00
|
|
|
};
|
|
|
|
|
|
|
|
#endif
|