godotengine
/
godot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
godot/scene/2d/canvas_item.h

283 lines
9.0 KiB
C++
Raw Normal View History

GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
/*************************************************************************/
/* canvas_item.h */
/*************************************************************************/
/* This file is part of: */
/* GODOT ENGINE */
/* http://www.godotengine.org */
/*************************************************************************/
Welcome in 2017, dear changelog reader! That year should bring the long-awaited OpenGL ES 3.0 compatible renderer with state-of-the-art rendering techniques tuned to work as low as middle end handheld devices - without compromising with the possibilities given for higher end desktop games of course. Great times ahead for the Godot community and the gamers that will play our games! (cherry picked from commit c7bc44d5ad9aae4902280012f7654e2318cd910e)
2017-01-01 21:01:57 +00:00
/* Copyright (c) 2007-2017 Juan Linietsky, Ariel Manzur. */
GODOT IS OPEN SOURCE
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 CANVAS_ITEM_H
#define CANVAS_ITEM_H
#include "scene/main/node.h"
#include "scene/resources/texture.h"
#include "scene/main/scene_main_loop.h"
-Initial (untested) implementation of 2D shaders. Probably broken, will be fixed later. -fixed issue of opacity not working
2015-01-11 14:43:31 +00:00
#include "scene/resources/shader.h"
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
class CanvasLayer;
class Viewport;
class Font;
class StyleBox;
support for 2D shadow casters Added support for 2D shadow casters. *DANGER* Shaders in CanvasItem CHANGED, if you are using shader in a CanvasItem and pull this, you will lose them. Shaders now work through a 2D material system similar to 3D. If you don't want to lose the 2D shader code, save the shader as a .shd, then create a material in CanvasItem and re-assign the shader.
2015-03-02 03:54:10 +00:00
class CanvasItemMaterial : public Resource{
OBJ_TYPE(CanvasItemMaterial,Resource);
RID material;
Ref<Shader> shader;
Changes to Light -=-=-=-=-=-=-=-= -Changed material unshaded property for an enum, which supports light-only shading -Added a "Mix" shading mode, useful for using lights as masks -Added energy parameter to Light2D
2015-04-03 04:43:37 +00:00
public:
enum ShadingMode {
SHADING_NORMAL,
SHADING_UNSHADED,
SHADING_ONLY_LIGHT,
};
support for 2D shadow casters Added support for 2D shadow casters. *DANGER* Shaders in CanvasItem CHANGED, if you are using shader in a CanvasItem and pull this, you will lose them. Shaders now work through a 2D material system similar to 3D. If you don't want to lose the 2D shader code, save the shader as a .shd, then create a material in CanvasItem and re-assign the shader.
2015-03-02 03:54:10 +00:00
protected:
Changes to Light -=-=-=-=-=-=-=-= -Changed material unshaded property for an enum, which supports light-only shading -Added a "Mix" shading mode, useful for using lights as masks -Added energy parameter to Light2D
2015-04-03 04:43:37 +00:00
ShadingMode shading_mode;
support for 2D shadow casters Added support for 2D shadow casters. *DANGER* Shaders in CanvasItem CHANGED, if you are using shader in a CanvasItem and pull this, you will lose them. Shaders now work through a 2D material system similar to 3D. If you don't want to lose the 2D shader code, save the shader as a .shd, then create a material in CanvasItem and re-assign the shader.
2015-03-02 03:54:10 +00:00
bool _set(const StringName& p_name, const Variant& p_value);
bool _get(const StringName& p_name,Variant &r_ret) const;
void _get_property_list( List<PropertyInfo> *p_list) const;
static void _bind_methods();
void get_argument_options(const StringName& p_function,int p_idx,List<String>*r_options) const;
public:
void set_shader(const Ref<Shader>& p_shader);
Ref<Shader> get_shader() const;
void set_shader_param(const StringName& p_param,const Variant& p_value);
Variant get_shader_param(const StringName& p_param) const;
Changes to Light -=-=-=-=-=-=-=-= -Changed material unshaded property for an enum, which supports light-only shading -Added a "Mix" shading mode, useful for using lights as masks -Added energy parameter to Light2D
2015-04-03 04:43:37 +00:00
void set_shading_mode(ShadingMode p_mode);
ShadingMode get_shading_mode() const;
support for 2D shadow casters Added support for 2D shadow casters. *DANGER* Shaders in CanvasItem CHANGED, if you are using shader in a CanvasItem and pull this, you will lose them. Shaders now work through a 2D material system similar to 3D. If you don't want to lose the 2D shader code, save the shader as a .shd, then create a material in CanvasItem and re-assign the shader.
2015-03-02 03:54:10 +00:00
virtual RID get_rid() const;
CanvasItemMaterial();
~CanvasItemMaterial();
};
Changes to Light -=-=-=-=-=-=-=-= -Changed material unshaded property for an enum, which supports light-only shading -Added a "Mix" shading mode, useful for using lights as masks -Added energy parameter to Light2D
2015-04-03 04:43:37 +00:00
VARIANT_ENUM_CAST( CanvasItemMaterial::ShadingMode );
support for 2D shadow casters Added support for 2D shadow casters. *DANGER* Shaders in CanvasItem CHANGED, if you are using shader in a CanvasItem and pull this, you will lose them. Shaders now work through a 2D material system similar to 3D. If you don't want to lose the 2D shader code, save the shader as a .shd, then create a material in CanvasItem and re-assign the shader.
2015-03-02 03:54:10 +00:00
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
class CanvasItem : public Node {
OBJ_TYPE( CanvasItem, Node );
public:
enum BlendMode {
BLEND_MODE_MIX, //default
BLEND_MODE_ADD,
BLEND_MODE_SUB,
Making Godot Easier to Use.. -=-=-=-=-=-=-=-=-=-=-=-=-=-= -Auto indenter in code editor, this makes it much easier to paste external code. -Zoom in 2D viewport now uses the mouse pointer as reference. -Obscure hack to see where code/line of GDScript in C++ backtrace. -Fixed a bug where keys would get stuck on X11 if pressed simultaneously -Added Api on IP singleton to request local IPs. -Premultiplied alpha support when importing texture, editing PNGs and as a blend mode.
2014-05-24 04:35:47 +00:00
BLEND_MODE_MUL,
BLEND_MODE_PREMULT_ALPHA
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
};
private:
mutable SelfList<Node> xform_change;
RID canvas_item;
String group;
-Fixed a few bugs in Viewport -Made a few demos using Viewport to show it's true power! -Fixed some start-up error messages.
2014-04-10 03:18:27 +00:00
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
CanvasLayer *canvas_layer;
float opacity;
float self_opacity;
List<CanvasItem*> children_items;
List<CanvasItem*>::Element *C;
BlendMode blend_mode;
support for light and normal mapping in 2D
2015-02-18 22:39:44 +00:00
int light_mask;
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
bool first_draw;
bool hidden;
bool pending_update;
bool toplevel;
bool pending_children_sort;
bool drawing;
bool block_transform_notify;
-Support for changing fonts -Detect when free() might crash the project and throw error -fixed 2D Bounce in physics (3d still broken) -renamed “on_top” property to “behind_parent”, which makes more sense, old on_top remains there for compatibility but is invisible. -large amount of fixes
2014-04-05 15:39:30 +00:00
bool behind;
support for 2D shadow casters Added support for 2D shadow casters. *DANGER* Shaders in CanvasItem CHANGED, if you are using shader in a CanvasItem and pull this, you will lose them. Shaders now work through a 2D material system similar to 3D. If you don't want to lose the 2D shader code, save the shader as a .shd, then create a material in CanvasItem and re-assign the shader.
2015-03-02 03:54:10 +00:00
bool use_parent_material;
Ability to keep collisionshapes and collisionpolygons when running the game. Works for 2D and 3D These are still just helpers in case you want to animate them or access them directly. Modifying the real shapes is still done via CollisionObject and CollisionObject2D APIs But an API was added so you can query which shapes from CollisionObject correspond to which CollisionShape. Have Fun!
2015-09-16 01:07:03 +00:00
bool notify_local_transform;
support for light and normal mapping in 2D
2015-02-18 22:39:44 +00:00
support for 2D shadow casters Added support for 2D shadow casters. *DANGER* Shaders in CanvasItem CHANGED, if you are using shader in a CanvasItem and pull this, you will lose them. Shaders now work through a 2D material system similar to 3D. If you don't want to lose the 2D shader code, save the shader as a .shd, then create a material in CanvasItem and re-assign the shader.
2015-03-02 03:54:10 +00:00
Ref<CanvasItemMaterial> material;
-Initial (untested) implementation of 2D shaders. Probably broken, will be fixed later. -fixed issue of opacity not working
2015-01-11 14:43:31 +00:00
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
mutable Matrix32 global_transform;
mutable bool global_invalid;
void _raise_self();
void _propagate_visibility_changed(bool p_visible);
void _set_visible_(bool p_visible);
bool _is_visible_() const;
void _update_callback();
void _enter_canvas();
void _exit_canvas();
void _queue_sort_children();
void _sort_children();
void _notify_transform(CanvasItem *p_node);
-Support for changing fonts -Detect when free() might crash the project and throw error -fixed 2D Bounce in physics (3d still broken) -renamed “on_top” property to “behind_parent”, which makes more sense, old on_top remains there for compatibility but is invisible. -large amount of fixes
2014-04-05 15:39:30 +00:00
void _set_on_top(bool p_on_top) { set_draw_behind_parent(!p_on_top); }
bool _is_on_top() const { return !is_draw_behind_parent_enabled(); }
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
protected:
Ability to keep collisionshapes and collisionpolygons when running the game. Works for 2D and 3D These are still just helpers in case you want to animate them or access them directly. Modifying the real shapes is still done via CollisionObject and CollisionObject2D APIs But an API was added so you can query which shapes from CollisionObject correspond to which CollisionShape. Have Fun!
2015-09-16 01:07:03 +00:00
_FORCE_INLINE_ void _notify_transform() { if (!is_inside_tree()) return; _notify_transform(this); if (!block_transform_notify && notify_local_transform) notification(NOTIFICATION_LOCAL_TRANSFORM_CHANGED); }
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
void item_rect_changed();
void _notification(int p_what);
static void _bind_methods();
public:
enum {
SceneMainLoop -> SceneTree -=-=-=-=-=-=-=-=-=-=-=-=-=- *YOUR SOURCE MIGHT NOT WORK* For mor information on fix: https://github.com/okamstudio/godot/wiki/devel_scene_tree Other stuff: -Shower of bullets demo -Fixes all around
2014-11-06 00:20:42 +00:00
NOTIFICATION_TRANSFORM_CHANGED=SceneTree::NOTIFICATION_TRANSFORM_CHANGED, //unique
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
NOTIFICATION_DRAW=30,
NOTIFICATION_VISIBILITY_CHANGED=31,
NOTIFICATION_ENTER_CANVAS=32,
NOTIFICATION_EXIT_CANVAS=33,
NOTIFICATION_LOCAL_TRANSFORM_CHANGED=35,
NOTIFICATION_WORLD_2D_CHANGED=36,
};
/* EDITOR */
virtual Variant edit_get_state() const;
virtual void edit_set_state(const Variant& p_state);
virtual void edit_set_rect(const Rect2& p_edit_rect);
virtual void edit_rotate(float p_rot);
virtual Size2 edit_get_minimum_size() const;
/* VISIBILITY */
bool is_visible() const;
bool is_hidden() const;
void show();
void hide();
Added set_hidden method to Spatial and CanvasItem
2015-11-26 21:44:06 +00:00
void set_hidden(bool p_hidden);
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
void update();
void set_blend_mode(BlendMode p_blend_mode);
BlendMode get_blend_mode() const;
-Make tilemap able to change light mask, fixes #2557
2015-12-29 17:47:13 +00:00
virtual void set_light_mask(int p_light_mask);
support for light and normal mapping in 2D
2015-02-18 22:39:44 +00:00
int get_light_mask() const;
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
void set_opacity(float p_opacity);
float get_opacity() const;
void set_self_opacity(float p_self_opacity);
float get_self_opacity() const;
/* DRAWING API */
void draw_line(const Point2& p_from, const Point2& p_to,const Color& p_color,float p_width=1.0);
void draw_rect(const Rect2& p_rect, const Color& p_color);
void draw_circle(const Point2& p_pos, float p_radius, const Color& p_color);
-implement arrows on tabs, when too many tabs are present, fixes #2806
2015-12-14 13:24:28 +00:00
void draw_texture(const Ref<Texture>& p_texture, const Point2& p_pos, const Color &p_modulate=Color(1,1,1,1));
Working TileMap tile transpose transform.
2015-02-02 11:27:48 +00:00
void draw_texture_rect(const Ref<Texture>& p_texture, const Rect2& p_rect, bool p_tile=false,const Color& p_modulate=Color(1,1,1), bool p_transpose=false);
void draw_texture_rect_region(const Ref<Texture>& p_texture,const Rect2& p_rect, const Rect2& p_src_rect,const Color& p_modulate=Color(1,1,1), bool p_transpose=false);
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
void draw_style_box(const Ref<StyleBox>& p_style_box,const Rect2& p_rect);
void draw_primitive(const Vector<Point2>& p_points, const Vector<Color>& p_colors,const Vector<Point2>& p_uvs, Ref<Texture> p_texture=Ref<Texture>(),float p_width=1);
void draw_polygon(const Vector<Point2>& p_points, const Vector<Color>& p_colors,const Vector<Point2>& p_uvs=Vector<Point2>(), Ref<Texture> p_texture=Ref<Texture>());
void draw_colored_polygon(const Vector<Point2>& p_points, const Color& p_color,const Vector<Point2>& p_uvs=Vector<Point2>(), Ref<Texture> p_texture=Ref<Texture>());
void draw_string(const Ref<Font>& p_font, const Point2& p_pos, const String& p_text,const Color& p_modulate=Color(1,1,1),int p_clip_w=-1);
float draw_char(const Ref<Font>& p_font,const Point2& p_pos, const String& p_char,const String& p_next="",const Color& p_modulate=Color(1,1,1));
void draw_set_transform(const Point2& p_offset, float p_rot, const Size2& p_scale);
Ability to set draw transform as a matrix, closes #5428
2016-06-26 16:01:17 +00:00
void draw_set_transform_matrix(const Matrix32& p_matrix);
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
/* RECT / TRANSFORM */
void set_as_toplevel(bool p_toplevel);
bool is_set_as_toplevel() const;
-Support for changing fonts -Detect when free() might crash the project and throw error -fixed 2D Bounce in physics (3d still broken) -renamed “on_top” property to “behind_parent”, which makes more sense, old on_top remains there for compatibility but is invisible. -large amount of fixes
2014-04-05 15:39:30 +00:00
void set_draw_behind_parent(bool p_enable);
bool is_draw_behind_parent_enabled() const;
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
CanvasItem *get_parent_item() const;
virtual Rect2 get_item_rect() const=0;
virtual Matrix32 get_transform() const=0;
virtual Matrix32 get_global_transform() const;
virtual Matrix32 get_global_transform_with_canvas() const;
added a function CanvasItem.get_item_and_children_rect() , fixes #4738
2016-06-14 00:37:04 +00:00
Rect2 get_item_and_children_rect() const;
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
CanvasItem *get_toplevel() const;
_FORCE_INLINE_ RID get_canvas_item() const { return canvas_item; }
void set_block_transform_notify(bool p_enable);
bool is_block_transform_notify_enabled() const;
-Added google play services (needed for some stuff) -Added new screen resizing options, stretch_2d is removed, new much more flexible ones. -Fixed bug in viewport (can create more instances in 3d-in-2d demo now) -Can set android permissions and screen sizes manually in the export settings -Changed export templates extension to .tpz (too many people unzipped the manually..) -File dialog now ensures that the proper extension is used (will not allow to save without it) -Fixed bug that made collision exceptions not work in 2D
2014-04-15 01:43:44 +00:00
Matrix32 get_canvas_transform() const;
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
Matrix32 get_viewport_transform() const;
Rect2 get_viewport_rect() const;
RID get_viewport_rid() const;
RID get_canvas() const;
Ref<World2D> get_world_2d() const;
-Fixed a few bugs in Viewport -Made a few demos using Viewport to show it's true power! -Fixed some start-up error messages.
2014-04-10 03:18:27 +00:00
support for 2D shadow casters Added support for 2D shadow casters. *DANGER* Shaders in CanvasItem CHANGED, if you are using shader in a CanvasItem and pull this, you will lose them. Shaders now work through a 2D material system similar to 3D. If you don't want to lose the 2D shader code, save the shader as a .shd, then create a material in CanvasItem and re-assign the shader.
2015-03-02 03:54:10 +00:00
void set_material(const Ref<CanvasItemMaterial>& p_material);
Ref<CanvasItemMaterial> get_material() const;
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
support for 2D shadow casters Added support for 2D shadow casters. *DANGER* Shaders in CanvasItem CHANGED, if you are using shader in a CanvasItem and pull this, you will lose them. Shaders now work through a 2D material system similar to 3D. If you don't want to lose the 2D shader code, save the shader as a .shd, then create a material in CanvasItem and re-assign the shader.
2015-03-02 03:54:10 +00:00
void set_use_parent_material(bool p_use_parent_material);
bool get_use_parent_material() const;
-fixed issue with shader not being reset on layers, closes #1199 -ability for shader to use parent shader and params, closes #1198
2015-01-12 23:44:02 +00:00
input events on Area2D is now supported also added a demo showing how this works
2015-03-22 04:46:18 +00:00
InputEvent make_input_local(const InputEvent& pevent) const;
Conversion function for screen coords to local Canvas coords - Useful if you need to Convert screen coords to the coordinate space of a CanvasItem, but don't have an associated InputEvent to use in #make_event_local. For example, if you have a particular point on the screen you'd like to project into World Space, for various reasons, you would use this function on the root of the scene. This is analogous to ray casting from screen space in 3D.
2016-05-28 07:31:07 +00:00
Vector2 make_canvas_pos_local(const Vector2& screen_point) const;
added missing set_shader_param functions also added code completion hint for shader params
2015-02-11 09:51:20 +00:00
-Fixed android export options (screen sizes, orientation should work) -added functions to get mouse position in CanvasItem
2015-05-02 00:13:20 +00:00
Vector2 get_global_mouse_pos() const;
Vector2 get_local_mouse_pos() const;
Ability to keep collisionshapes and collisionpolygons when running the game. Works for 2D and 3D These are still just helpers in case you want to animate them or access them directly. Modifying the real shapes is still done via CollisionObject and CollisionObject2D APIs But an API was added so you can query which shapes from CollisionObject correspond to which CollisionShape. Have Fun!
2015-09-16 01:07:03 +00:00
void set_notify_local_transform(bool p_enable);
bool is_local_transform_notification_enabled() const;
-Take in consideration canvas layers for GUI input
2016-01-24 13:57:42 +00:00
int get_canvas_layer() const;
Ability to keep collisionshapes and collisionpolygons when running the game. Works for 2D and 3D These are still just helpers in case you want to animate them or access them directly. Modifying the real shapes is still done via CollisionObject and CollisionObject2D APIs But an API was added so you can query which shapes from CollisionObject correspond to which CollisionShape. Have Fun!
2015-09-16 01:07:03 +00:00
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
CanvasItem();
~CanvasItem();
};
VARIANT_ENUM_CAST( CanvasItem::BlendMode );
#endif // CANVAS_ITEM_H