godot/scene/2d/particles_2d.h

135 lines
4.6 KiB
C++
Raw Normal View History

2014-02-10 01:10:30 +00:00
/*************************************************************************/
/* particles_2d.h */
/*************************************************************************/
/* This file is part of: */
/* GODOT ENGINE */
/* https://godotengine.org */
2014-02-10 01:10:30 +00:00
/*************************************************************************/
/* Copyright (c) 2007-2017 Juan Linietsky, Ariel Manzur. */
/* Copyright (c) 2014-2017 Godot Engine contributors (cf. AUTHORS.md) */
2014-02-10 01:10:30 +00: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 PARTICLES_FRAME_H
#define PARTICLES_FRAME_H
#include "scene/2d/node_2d.h"
#include "scene/resources/color_ramp.h"
#include "scene/resources/texture.h"
2014-02-10 01:10:30 +00:00
class Particles2D : public Node2D {
2017-06-21 19:25:45 +00:00
private:
GDCLASS(Particles2D, Node2D)
2014-02-10 01:10:30 +00:00
public:
2017-06-21 19:25:45 +00:00
enum DrawOrder {
DRAW_ORDER_INDEX,
DRAW_ORDER_LIFETIME,
2017-02-27 09:47:28 +00:00
};
2014-02-10 01:10:30 +00:00
private:
2017-06-21 19:25:45 +00:00
RID particles;
2014-02-10 01:10:30 +00:00
bool one_shot;
2017-06-21 19:25:45 +00:00
int amount;
float lifetime;
float pre_process_time;
float explosiveness_ratio;
float randomness_ratio;
float speed_scale;
Rect2 visibility_rect;
bool local_coords;
int fixed_fps;
bool fractional_delta;
int v_frames;
2017-06-21 19:25:45 +00:00
int h_frames;
2014-02-10 01:10:30 +00:00
2017-06-21 19:25:45 +00:00
Ref<Material> process_material;
2017-02-27 09:47:28 +00:00
2017-06-21 19:25:45 +00:00
DrawOrder draw_order;
2014-02-10 01:10:30 +00:00
Ref<Texture> texture;
2017-06-21 19:25:45 +00:00
Ref<Texture> normal_map;
2014-02-10 01:10:30 +00:00
2017-06-21 19:25:45 +00:00
void _update_particle_emission_transform();
2014-02-10 01:10:30 +00:00
protected:
static void _bind_methods();
2017-06-21 19:25:45 +00:00
virtual void _validate_property(PropertyInfo &property) const;
void _notification(int p_what);
2014-02-10 01:10:30 +00:00
public:
void set_emitting(bool p_emitting);
void set_amount(int p_amount);
void set_lifetime(float p_lifetime);
void set_one_shot(bool p_enable);
2017-06-21 19:25:45 +00:00
void set_pre_process_time(float p_time);
void set_explosiveness_ratio(float p_ratio);
void set_randomness_ratio(float p_ratio);
void set_visibility_rect(const Rect2 &p_aabb);
void set_use_local_coordinates(bool p_enable);
void set_process_material(const Ref<Material> &p_material);
void set_speed_scale(float p_scale);
2014-02-10 01:10:30 +00:00
2017-06-21 19:25:45 +00:00
bool is_emitting() const;
int get_amount() const;
float get_lifetime() const;
bool get_one_shot() const;
2014-02-10 01:10:30 +00:00
float get_pre_process_time() const;
2017-06-21 19:25:45 +00:00
float get_explosiveness_ratio() const;
float get_randomness_ratio() const;
Rect2 get_visibility_rect() const;
bool get_use_local_coordinates() const;
Ref<Material> get_process_material() const;
float get_speed_scale() const;
2014-02-10 01:10:30 +00:00
2017-06-21 19:25:45 +00:00
void set_fixed_fps(int p_count);
int get_fixed_fps() const;
2014-02-10 01:10:30 +00:00
2017-06-21 19:25:45 +00:00
void set_fractional_delta(bool p_enable);
bool get_fractional_delta() const;
2014-02-10 01:10:30 +00:00
2017-06-21 19:25:45 +00:00
void set_draw_order(DrawOrder p_order);
DrawOrder get_draw_order() const;
2014-02-10 01:10:30 +00:00
void set_texture(const Ref<Texture> &p_texture);
2014-02-10 01:10:30 +00:00
Ref<Texture> get_texture() const;
2017-06-21 19:25:45 +00:00
void set_normal_map(const Ref<Texture> &p_normal_map);
Ref<Texture> get_normal_map() const;
2014-02-10 01:10:30 +00:00
2017-06-21 19:25:45 +00:00
virtual String get_configuration_warning() const;
2014-02-10 01:10:30 +00:00
2017-06-21 19:25:45 +00:00
void set_v_frames(int p_count);
int get_v_frames() const;
2014-02-10 01:10:30 +00:00
2017-06-21 19:25:45 +00:00
void set_h_frames(int p_count);
int get_h_frames() const;
2014-02-10 01:10:30 +00:00
void restart();
2017-06-21 19:25:45 +00:00
Rect2 capture_rect() const;
2014-02-10 01:10:30 +00:00
Particles2D();
2017-06-21 19:25:45 +00:00
~Particles2D();
2014-02-10 01:10:30 +00:00
};
2017-06-21 19:25:45 +00:00
VARIANT_ENUM_CAST(Particles2D::DrawOrder)
2014-02-10 01:10:30 +00:00
#endif // PARTICLES_FRAME_H