/*************************************************************************/ /* viewport.cpp */ /*************************************************************************/ /* This file is part of: */ /* GODOT ENGINE */ /* http://www.godotengine.org */ /*************************************************************************/ /* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur. */ /* */ /* 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. */ /*************************************************************************/ #include "viewport.h" #include "os/os.h" #include "scene/3d/spatial.h" //#include "scene/3d/camera.h" #include "servers/spatial_sound_server.h" #include "servers/spatial_sound_2d_server.h" #include "scene/gui/control.h" #include "scene/3d/camera.h" #include "scene/3d/spatial_indexer.h" int RenderTargetTexture::get_width() const { ERR_FAIL_COND_V(!vp,0); return vp->rect.size.width; } int RenderTargetTexture::get_height() const{ ERR_FAIL_COND_V(!vp,0); return vp->rect.size.height; } Size2 RenderTargetTexture::get_size() const{ ERR_FAIL_COND_V(!vp,Size2()); return vp->rect.size; } RID RenderTargetTexture::get_rid() const{ ERR_FAIL_COND_V(!vp,RID()); return vp->render_target_texture_rid; } bool RenderTargetTexture::has_alpha() const{ return false; } void RenderTargetTexture::set_flags(uint32_t p_flags){ } uint32_t RenderTargetTexture::get_flags() const{ return 0; } RenderTargetTexture::RenderTargetTexture(Viewport *p_vp){ vp=p_vp; } void Viewport::_update_stretch_transform() { if (size_override_stretch && size_override) { stretch_transform=Matrix32(); stretch_transform.scale(rect.size/(size_override_size+size_override_margin*2)); stretch_transform.elements[2]=size_override_margin; } else { stretch_transform=Matrix32(); } _update_global_transform(); } void Viewport::_update_rect() { if (!is_inside_scene()) return; Node *parent = get_parent(); if (!render_target && parent && parent->cast_to()) { Control *c = parent->cast_to(); rect.pos=Point2(); rect.size=c->get_size(); } VisualServer::ViewportRect vr; vr.x=rect.pos.x; vr.y=rect.pos.y; if (render_target) { vr.x=0; vr.y=0; } vr.width=rect.size.width; vr.height=rect.size.height; VisualServer::get_singleton()->viewport_set_rect(viewport,vr); if (canvas_item.is_valid()) { VisualServer::get_singleton()->canvas_item_set_custom_rect(canvas_item,true,rect); } emit_signal("size_changed"); } void Viewport::_parent_resized() { _update_rect(); } void Viewport::_parent_draw() { } void Viewport::_parent_visibility_changed() { Node *parent = get_parent(); if (parent && parent->cast_to()) { Control *c = parent->cast_to(); VisualServer::get_singleton()->canvas_item_set_visible(canvas_item,c->is_visible()); } } void Viewport::_vp_enter_scene() { Node *parent = get_parent(); //none? if (parent && parent->cast_to()) { Control *cparent=parent->cast_to(); RID parent_ci = cparent->get_canvas_item(); ERR_FAIL_COND(!parent_ci.is_valid()); canvas_item = VisualServer::get_singleton()->canvas_item_create(); VisualServer::get_singleton()->canvas_item_set_parent(canvas_item,parent_ci); VisualServer::get_singleton()->canvas_item_set_visible(canvas_item,false); VisualServer::get_singleton()->canvas_item_attach_viewport(canvas_item,viewport); parent->connect("resized",this,"_parent_resized"); parent->connect("visibility_changed",this,"_parent_visibility_changed"); } else if (!parent){ VisualServer::get_singleton()->viewport_attach_to_screen(viewport,0); } } void Viewport::_vp_exit_scene() { Node *parent = get_parent(); if (parent && parent->cast_to()) { parent->disconnect("resized",this,"_parent_resized"); } if (parent && parent->cast_to()) { parent->disconnect("visibility_changed",this,"_parent_visibility_changed"); } if (canvas_item.is_valid()) { VisualServer::get_singleton()->free(canvas_item); canvas_item=RID(); } if (!parent) { VisualServer::get_singleton()->viewport_detach(viewport); } } void Viewport::update_worlds() { if (!is_inside_scene()) return; Rect2 xformed_rect = (global_canvas_transform * canvas_transform).affine_inverse().xform(get_visible_rect()); find_world_2d()->_update_viewport(this,xformed_rect); find_world_2d()->_update(); find_world()->_update(get_scene()->get_frame()); } void Viewport::_notification(int p_what) { switch( p_what ) { case NOTIFICATION_ENTER_SCENE: { if (!render_target) _vp_enter_scene(); this->parent=NULL; Node *parent=get_parent(); if (parent) { while(parent && !(this->parent=parent->cast_to())) { parent=parent->get_parent(); } } current_canvas=find_world_2d()->get_canvas(); VisualServer::get_singleton()->viewport_set_scenario(viewport,find_world()->get_scenario()); VisualServer::get_singleton()->viewport_attach_canvas(viewport,current_canvas); _update_listener(); _update_listener_2d(); _update_rect(); if (world_2d.is_valid()) { find_world_2d()->_register_viewport(this,Rect2()); //best to defer this and not do it here, as it can annoy a lot of setup logic if user //adds a node and then moves it, will get enter/exit screen/viewport notifications //unnecesarily // update_worlds(); } add_to_group("_viewports"); } break; case NOTIFICATION_READY: { if (cameras.size() && !camera) { //there are cameras but no current camera, pick first in tree and make it current Camera *first=NULL; for(Set::Element *E=cameras.front();E;E=E->next()) { if (first==NULL || first->is_greater_than(E->get())) { first=E->get(); } } if (first) first->make_current(); } } break; case NOTIFICATION_EXIT_SCENE: { if (world_2d.is_valid()) world_2d->_remove_viewport(this); if (!render_target) _vp_exit_scene(); VisualServer::get_singleton()->viewport_set_scenario(viewport,RID()); SpatialSoundServer::get_singleton()->listener_set_space(listener,RID()); VisualServer::get_singleton()->viewport_remove_canvas(viewport,current_canvas); remove_from_group("_viewports"); } break; } } RID Viewport::get_viewport() const { return viewport; } void Viewport::set_rect(const Rect2& p_rect) { if (rect==p_rect) return; rect=p_rect; _update_rect(); _update_stretch_transform(); } Rect2 Viewport::get_visible_rect() const { Rect2 r; if (rect.pos==Vector2() && rect.size==Size2()) { r=Rect2( Point2(), Size2( OS::get_singleton()->get_video_mode().width, OS::get_singleton()->get_video_mode().height ) ); } else { r=Rect2( rect.pos , rect.size ); } if (size_override) { r.size=size_override_size; } return r; } Rect2 Viewport::get_rect() const { return rect; } void Viewport::_update_listener() { if (is_inside_scene() && audio_listener && camera) { SpatialSoundServer::get_singleton()->listener_set_space(listener,find_world()->get_sound_space()); } else { SpatialSoundServer::get_singleton()->listener_set_space(listener,RID()); } } void Viewport::_update_listener_2d() { if (is_inside_scene() && audio_listener_2d) SpatialSound2DServer::get_singleton()->listener_set_space(listener_2d,find_world_2d()->get_sound_space()); else SpatialSound2DServer::get_singleton()->listener_set_space(listener_2d,RID()); } void Viewport::set_as_audio_listener(bool p_enable) { if (p_enable==audio_listener) return; audio_listener=p_enable; _update_listener(); } bool Viewport::is_audio_listener() const { return audio_listener; } void Viewport::set_as_audio_listener_2d(bool p_enable) { if (p_enable==audio_listener_2d) return; audio_listener_2d=p_enable; _update_listener_2d(); } bool Viewport::is_audio_listener_2d() const { return audio_listener_2d; } void Viewport::set_canvas_transform(const Matrix32& p_transform) { canvas_transform=p_transform; VisualServer::get_singleton()->viewport_set_canvas_transform(viewport,find_world_2d()->get_canvas(),canvas_transform); Matrix32 xform = (global_canvas_transform * canvas_transform).affine_inverse(); Size2 ss = get_visible_rect().size; SpatialSound2DServer::get_singleton()->listener_set_transform(listener_2d,Matrix32(0,xform.xform(ss*0.5))); Vector2 ss2 = ss*xform.get_scale(); float panrange = MAX(ss2.x,ss2.y); SpatialSound2DServer::get_singleton()->listener_set_param(listener_2d,SpatialSound2DServer::LISTENER_PARAM_PAN_RANGE,panrange); } Matrix32 Viewport::get_canvas_transform() const{ return canvas_transform; } void Viewport::_update_global_transform() { Matrix32 sxform = stretch_transform * global_canvas_transform; VisualServer::get_singleton()->viewport_set_global_canvas_transform(viewport,sxform); Matrix32 xform = (sxform * canvas_transform).affine_inverse(); Size2 ss = get_visible_rect().size; SpatialSound2DServer::get_singleton()->listener_set_transform(listener_2d,Matrix32(0,xform.xform(ss*0.5))); Vector2 ss2 = ss*xform.get_scale(); float panrange = MAX(ss2.x,ss2.y); SpatialSound2DServer::get_singleton()->listener_set_param(listener_2d,SpatialSound2DServer::LISTENER_PARAM_PAN_RANGE,panrange); } void Viewport::set_global_canvas_transform(const Matrix32& p_transform) { global_canvas_transform=p_transform; _update_global_transform(); } Matrix32 Viewport::get_global_canvas_transform() const{ return global_canvas_transform; } void Viewport::_camera_transform_changed_notify() { #ifndef _3D_DISABLED if (camera) SpatialSoundServer::get_singleton()->listener_set_transform(listener,camera->get_camera_transform()); #endif } void Viewport::_set_camera(Camera* p_camera) { #ifndef _3D_DISABLED if (camera==p_camera) return; if (camera && find_world().is_valid()) { camera->notification(Camera::NOTIFICATION_LOST_CURRENT); } camera=p_camera; if (camera) VisualServer::get_singleton()->viewport_attach_camera(viewport,camera->get_camera()); else VisualServer::get_singleton()->viewport_attach_camera(viewport,RID()); if (camera && find_world().is_valid()) { camera->notification(Camera::NOTIFICATION_BECAME_CURRENT); } _update_listener(); _camera_transform_changed_notify(); #endif } void Viewport::set_transparent_background(bool p_enable) { transparent_bg=p_enable; VS::get_singleton()->viewport_set_transparent_background(viewport,p_enable); } bool Viewport::has_transparent_background() const { return transparent_bg; } #if 0 void Viewport::set_world_2d(const Ref& p_world_2d) { world_2d=p_world_2d; _update_listener_2d(); if (is_inside_scene()) { if (current_canvas.is_valid()) VisualServer::get_singleton()->viewport_remove_canvas(viewport,current_canvas); current_canvas=find_world_2d()->get_canvas(); VisualServer::get_singleton()->viewport_attach_canvas(viewport,current_canvas); } } Ref Viewport::find_world_2d() const{ if (world_2d.is_valid()) return world_2d; else if (parent) return parent->find_world_2d(); else return Ref(); } #endif Ref Viewport::find_world_2d() const{ return world_2d; } void Viewport::_propagate_enter_world(Node *p_node) { if (p_node!=this) { if (!p_node->is_inside_scene()) //may not have entered scene yet return; Spatial *s = p_node->cast_to(); if (s) { s->notification(Spatial::NOTIFICATION_ENTER_WORLD); } else { Viewport *v = p_node->cast_to(); if (v) { if (v->world.is_valid()) return; } } } for(int i=0;iget_child_count();i++) { _propagate_enter_world(p_node->get_child(i)); } } void Viewport::_propagate_exit_world(Node *p_node) { if (p_node!=this) { if (!p_node->is_inside_scene()) //may have exited scene already return; Spatial *s = p_node->cast_to(); if (s) { s->notification(Spatial::NOTIFICATION_EXIT_WORLD,false); } else { Viewport *v = p_node->cast_to(); if (v) { if (v->world.is_valid()) return; } } } for(int i=0;iget_child_count();i++) { _propagate_exit_world(p_node->get_child(i)); } } void Viewport::set_world(const Ref& p_world) { if (world==p_world) return; if (is_inside_scene()) _propagate_exit_world(this); #ifndef _3D_DISABLED if (find_world().is_valid() && camera) camera->notification(Camera::NOTIFICATION_LOST_CURRENT); #endif world=p_world; if (is_inside_scene()) _propagate_enter_world(this); #ifndef _3D_DISABLED if (find_world().is_valid() && camera) camera->notification(Camera::NOTIFICATION_BECAME_CURRENT); #endif //propagate exit if (is_inside_scene()) { VisualServer::get_singleton()->viewport_set_scenario(viewport,find_world()->get_scenario()); } _update_listener(); } Ref Viewport::get_world() const{ return world; } Ref Viewport::find_world() const{ if (world.is_valid()) return world; else if (parent) return parent->find_world(); else return Ref(); } Camera* Viewport::get_camera() const { return camera; } Matrix32 Viewport::get_final_transform() const { return stretch_transform * global_canvas_transform; } void Viewport::set_size_override(bool p_enable, const Size2& p_size, const Vector2 &p_margin) { if (size_override==p_enable && p_size==size_override_size) return; size_override=p_enable; if (p_size.x>=0 || p_size.y>=0) { size_override_size=p_size; } size_override_margin=p_margin; _update_rect(); _update_stretch_transform(); } Size2 Viewport::get_size_override() const { return size_override_size; } bool Viewport::is_size_override_enabled() const { return size_override; } void Viewport::set_size_override_stretch(bool p_enable) { if (p_enable==size_override_stretch) return; size_override_stretch=p_enable; if (size_override) { _update_rect(); } _update_stretch_transform(); } bool Viewport::is_size_override_stretch_enabled() const { return size_override; } void Viewport::set_as_render_target(bool p_enable){ if (render_target==p_enable) return; render_target=p_enable; VS::get_singleton()->viewport_set_as_render_target(viewport,p_enable); if (is_inside_scene()) { if (p_enable) _vp_exit_scene(); else _vp_enter_scene(); } if (p_enable) { render_target_texture_rid = VS::get_singleton()->viewport_get_render_target_texture(viewport); } else { render_target_texture_rid=RID(); } } bool Viewport::is_set_as_render_target() const{ return render_target; } void Viewport::set_render_target_update_mode(RenderTargetUpdateMode p_mode){ render_target_update_mode=p_mode; VS::get_singleton()->viewport_set_render_target_update_mode(viewport,VS::RenderTargetUpdateMode(p_mode)); } Viewport::RenderTargetUpdateMode Viewport::get_render_target_update_mode() const{ return render_target_update_mode; } //RID get_render_target_texture() const; void Viewport::queue_screen_capture(){ VS::get_singleton()->viewport_queue_screen_capture(viewport); } Image Viewport::get_screen_capture() const { return VS::get_singleton()->viewport_get_screen_capture(viewport); } Ref Viewport::get_render_target_texture() const { return render_target_texture; } void Viewport::_bind_methods() { ObjectTypeDB::bind_method(_MD("set_rect","rect"), &Viewport::set_rect); ObjectTypeDB::bind_method(_MD("get_rect"), &Viewport::get_rect); //ObjectTypeDB::bind_method(_MD("set_world_2d","world_2d:World2D"), &Viewport::set_world_2d); //ObjectTypeDB::bind_method(_MD("get_world_2d:World2D"), &Viewport::get_world_2d); ObjectTypeDB::bind_method(_MD("find_world_2d:World2D"), &Viewport::find_world_2d); ObjectTypeDB::bind_method(_MD("set_world","world:World"), &Viewport::set_world); ObjectTypeDB::bind_method(_MD("get_world:World"), &Viewport::get_world); ObjectTypeDB::bind_method(_MD("find_world:World"), &Viewport::find_world); ObjectTypeDB::bind_method(_MD("set_canvas_transform","xform"), &Viewport::set_canvas_transform); ObjectTypeDB::bind_method(_MD("get_canvas_transform"), &Viewport::get_canvas_transform); ObjectTypeDB::bind_method(_MD("set_global_canvas_transform","xform"), &Viewport::set_global_canvas_transform); ObjectTypeDB::bind_method(_MD("get_global_canvas_transform"), &Viewport::get_global_canvas_transform); ObjectTypeDB::bind_method(_MD("get_final_transform"), &Viewport::get_final_transform); ObjectTypeDB::bind_method(_MD("get_visible_rect"), &Viewport::get_visible_rect); ObjectTypeDB::bind_method(_MD("set_transparent_background","enable"), &Viewport::set_transparent_background); ObjectTypeDB::bind_method(_MD("has_transparent_background"), &Viewport::has_transparent_background); ObjectTypeDB::bind_method(_MD("_parent_visibility_changed"), &Viewport::_parent_visibility_changed); ObjectTypeDB::bind_method(_MD("_parent_resized"), &Viewport::_parent_resized); ObjectTypeDB::bind_method(_MD("set_size_override","enable","size","margin"), &Viewport::set_size_override,DEFVAL(Size2(-1,-1)),DEFVAL(Size2(0,0))); ObjectTypeDB::bind_method(_MD("get_size_override"), &Viewport::get_size_override); ObjectTypeDB::bind_method(_MD("is_size_override_enabled"), &Viewport::is_size_override_enabled); ObjectTypeDB::bind_method(_MD("set_size_override_stretch","enabled"), &Viewport::set_size_override_stretch); ObjectTypeDB::bind_method(_MD("is_size_override_stretch_enabled"), &Viewport::is_size_override_stretch_enabled); ObjectTypeDB::bind_method(_MD("queue_screen_capture"), &Viewport::queue_screen_capture); ObjectTypeDB::bind_method(_MD("get_screen_capture"), &Viewport::get_screen_capture); ObjectTypeDB::bind_method(_MD("set_as_render_target","enable"), &Viewport::set_as_render_target); ObjectTypeDB::bind_method(_MD("is_set_as_render_target"), &Viewport::is_set_as_render_target); ObjectTypeDB::bind_method(_MD("set_render_target_update_mode","mode"), &Viewport::set_render_target_update_mode); ObjectTypeDB::bind_method(_MD("get_render_target_update_mode"), &Viewport::get_render_target_update_mode); ObjectTypeDB::bind_method(_MD("get_render_target_texture:RenderTargetTexture"), &Viewport::get_render_target_texture); ObjectTypeDB::bind_method(_MD("get_viewport"), &Viewport::get_viewport); ObjectTypeDB::bind_method(_MD("update_worlds"), &Viewport::update_worlds); ObjectTypeDB::bind_method(_MD("set_as_audio_listener","enable"), &Viewport::set_as_audio_listener); ObjectTypeDB::bind_method(_MD("is_audio_listener","enable"), &Viewport::is_audio_listener); ObjectTypeDB::bind_method(_MD("set_as_audio_listener_2d","enable"), &Viewport::set_as_audio_listener_2d); ObjectTypeDB::bind_method(_MD("is_audio_listener_2d","enable"), &Viewport::is_audio_listener_2d); ADD_PROPERTY( PropertyInfo(Variant::RECT2,"rect"), _SCS("set_rect"), _SCS("get_rect") ); ADD_PROPERTY( PropertyInfo(Variant::OBJECT,"world",PROPERTY_HINT_RESOURCE_TYPE,"World"), _SCS("set_world"), _SCS("get_world") ); // ADD_PROPERTY( PropertyInfo(Variant::OBJECT,"world_2d",PROPERTY_HINT_RESOURCE_TYPE,"World2D"), _SCS("set_world_2d"), _SCS("get_world_2d") ); ADD_PROPERTY( PropertyInfo(Variant::BOOL,"transparent_bg"), _SCS("set_transparent_background"), _SCS("has_transparent_background") ); ADD_PROPERTY( PropertyInfo(Variant::BOOL,"render_target/enabled"), _SCS("set_as_render_target"), _SCS("is_set_as_render_target") ); ADD_PROPERTY( PropertyInfo(Variant::INT,"render_target/update_mode",PROPERTY_HINT_ENUM,"Disabled,Once,When Visible,Always"), _SCS("set_render_target_update_mode"), _SCS("get_render_target_update_mode") ); ADD_PROPERTY( PropertyInfo(Variant::BOOL,"audio_listener/enable_2d"), _SCS("set_as_audio_listener_2d"), _SCS("is_audio_listener_2d") ); ADD_PROPERTY( PropertyInfo(Variant::BOOL,"audio_listener/enable_3d"), _SCS("set_as_audio_listener"), _SCS("is_audio_listener") ); ADD_SIGNAL(MethodInfo("size_changed")); BIND_CONSTANT( RENDER_TARGET_UPDATE_DISABLED ); BIND_CONSTANT( RENDER_TARGET_UPDATE_ONCE ); BIND_CONSTANT( RENDER_TARGET_UPDATE_WHEN_VISIBLE ); BIND_CONSTANT( RENDER_TARGET_UPDATE_ALWAYS ); } Viewport::Viewport() { world_2d = Ref( memnew( World2D )); viewport = VisualServer::get_singleton()->viewport_create(); listener=SpatialSoundServer::get_singleton()->listener_create(); audio_listener=false; listener_2d=SpatialSound2DServer::get_singleton()->listener_create(); audio_listener_2d=false; transparent_bg=false; parent=NULL; camera=NULL; size_override=false; size_override_stretch=false; size_override_size=Size2(1,1); render_target=false; render_target_update_mode=RENDER_TARGET_UPDATE_WHEN_VISIBLE; render_target_texture = Ref( memnew( RenderTargetTexture(this) ) ); } Viewport::~Viewport() { VisualServer::get_singleton()->free( viewport ); SpatialSoundServer::get_singleton()->free(listener); if (render_target_texture.is_valid()) render_target_texture->vp=NULL; //so if used, will crash }