blender-archive/source/blender/draw/intern/draw_view.c

/*
 * Copyright 2016, Blender Foundation.
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 *
 * Contributor(s): Blender Institute
 *
 */

/** \file blender/draw/intern/draw_view.c
 *  \ingroup draw
 *
 * Contains dynamic drawing using immediate mode
 */

#include "DNA_brush_types.h"
#include "DNA_screen_types.h"
#include "DNA_userdef_types.h"
#include "DNA_world_types.h"
#include "DNA_view3d_types.h"

#include "ED_screen.h"
#include "ED_transform.h"
#include "ED_view3d.h"

#include "GPU_draw.h"
#include "GPU_shader.h"
#include "GPU_immediate.h"
#include "GPU_matrix.h"

#include "UI_resources.h"

#include "WM_api.h"
#include "WM_types.h"

#include "BKE_global.h"
#include "BKE_object.h"
#include "BKE_paint.h"
#include "BKE_unit.h"

#include "DRW_render.h"

#include "view3d_intern.h"

#include "draw_view.h"

/* ******************** region info ***************** */

void DRW_draw_region_info(void)
{
	const DRWContextState *draw_ctx = DRW_context_state_get();
	ARegion *ar = draw_ctx->ar;

	DRW_draw_cursor();

	view3d_draw_region_info(draw_ctx->evil_C, ar);
}

/* ************************* Background ************************** */

void DRW_draw_background(void)
{
	/* Just to make sure */
	glDepthMask(GL_TRUE);
	glColorMask(GL_TRUE, GL_TRUE, GL_TRUE, GL_TRUE);
	glStencilMask(0xFF);

	if (UI_GetThemeValue(TH_SHOW_BACK_GRAD)) {
		float m[4][4];
		unit_m4(m);

		/* Gradient background Color */
		glDisable(GL_DEPTH_TEST);

		GPUVertFormat *format = immVertexFormat();
		uint pos = GPU_vertformat_attr_add(format, "pos", GPU_COMP_F32, 2, GPU_FETCH_FLOAT);
		uint color = GPU_vertformat_attr_add(format, "color", GPU_COMP_U8, 3, GPU_FETCH_INT_TO_FLOAT_UNIT);
		uchar col_hi[3], col_lo[3];

		GPU_matrix_push();
		GPU_matrix_identity_set();
		GPU_matrix_projection_set(m);

		immBindBuiltinProgram(GPU_SHADER_2D_SMOOTH_COLOR_DITHER);

		UI_GetThemeColor3ubv(TH_LOW_GRAD, col_lo);
		UI_GetThemeColor3ubv(TH_HIGH_GRAD, col_hi);

		immBegin(GPU_PRIM_TRI_FAN, 4);
		immAttr3ubv(color, col_lo);
		immVertex2f(pos, -1.0f, -1.0f);
		immVertex2f(pos, 1.0f, -1.0f);

		immAttr3ubv(color, col_hi);
		immVertex2f(pos, 1.0f, 1.0f);
		immVertex2f(pos, -1.0f, 1.0f);
		immEnd();

		immUnbindProgram();

		GPU_matrix_pop();

		glClear(GL_DEPTH_BUFFER_BIT | GL_STENCIL_BUFFER_BIT);

		glEnable(GL_DEPTH_TEST);
	}
	else {
		/* Solid background Color */
		UI_ThemeClearColorAlpha(TH_HIGH_GRAD, 1.0f);
		glClear(GL_COLOR_BUFFER_BIT | GL_DEPTH_BUFFER_BIT | GL_STENCIL_BUFFER_BIT);
	}
}

/* **************************** 3D Cursor ******************************** */

static bool is_cursor_visible(const DRWContextState *draw_ctx, Scene *scene, ViewLayer *view_layer)
{
	View3D *v3d = draw_ctx->v3d;
	if ((v3d->flag2 & V3D_RENDER_OVERRIDE) || (v3d->overlay.flag & V3D_OVERLAY_HIDE_CURSOR)) {
		return false;
	}

	/* don't draw cursor in paint modes, but with a few exceptions */
	if (draw_ctx->object_mode & OB_MODE_ALL_PAINT) {
		/* exception: object is in weight paint and has deforming armature in pose mode */
		if (draw_ctx->object_mode & OB_MODE_WEIGHT_PAINT) {
			if (BKE_object_pose_armature_get(draw_ctx->obact) != NULL) {
				return true;
			}
		}
		/* exception: object in texture paint mode, clone brush, use_clone_layer disabled */
		else if (draw_ctx->object_mode & OB_MODE_TEXTURE_PAINT) {
			const Paint *p = BKE_paint_get_active(scene, view_layer);

			if (p && p->brush && p->brush->imagepaint_tool == PAINT_TOOL_CLONE) {
				if ((scene->toolsettings->imapaint.flag & IMAGEPAINT_PROJECT_LAYER_CLONE) == 0) {
					return true;
				}
			}
		}

		/* no exception met? then don't draw cursor! */
		return false;
	}
	else if (draw_ctx->object_mode & OB_MODE_GPENCIL_WEIGHT) {
		/* grease pencil hide always in some modes */
		return false;
	}

	return true;
}

void DRW_draw_cursor(void)
{
	const DRWContextState *draw_ctx = DRW_context_state_get();
	View3D *v3d = draw_ctx->v3d;
	ARegion *ar = draw_ctx->ar;
	Scene *scene = draw_ctx->scene;
	ViewLayer *view_layer = draw_ctx->view_layer;

	glColorMask(GL_TRUE, GL_TRUE, GL_TRUE, GL_TRUE);
	glDepthMask(GL_FALSE);
	glDisable(GL_DEPTH_TEST);

	if (is_cursor_visible(draw_ctx, scene, view_layer)) {
		int co[2];
		const View3DCursor *cursor = ED_view3d_cursor3d_get(scene, v3d);
		if (ED_view3d_project_int_global(
		            ar, cursor->location, co, V3D_PROJ_TEST_NOP | V3D_PROJ_TEST_CLIP_NEAR) == V3D_PROJ_RET_OK)
		{
			RegionView3D *rv3d = ar->regiondata;

			/* Draw nice Anti Aliased cursor. */
			glLineWidth(1.0f);
			glEnable(GL_BLEND);
			glEnable(GL_LINE_SMOOTH);

			float eps = 1e-5f;
			rv3d->viewquat[0] = -rv3d->viewquat[0];
			const bool is_aligned = compare_v4v4(cursor->rotation, rv3d->viewquat, eps);
			rv3d->viewquat[0] = -rv3d->viewquat[0];

			/* Draw lines */
			if  (is_aligned == false) {
				uint pos = GPU_vertformat_attr_add(immVertexFormat(), "pos", GPU_COMP_F32, 3, GPU_FETCH_FLOAT);
				immBindBuiltinProgram(GPU_SHADER_3D_UNIFORM_COLOR);
				immUniformThemeColor3(TH_VIEW_OVERLAY);
				immBegin(GPU_PRIM_LINES, 12);

				const float scale = ED_view3d_pixel_size_no_ui_scale(rv3d, cursor->location) * U.widget_unit;

#define CURSOR_VERT(axis_vec, axis, fac) \
				immVertex3f( \
				        pos, \
				        cursor->location[0] + axis_vec[0] * (fac), \
				        cursor->location[1] + axis_vec[1] * (fac), \
				        cursor->location[2] + axis_vec[2] * (fac))

#define CURSOR_EDGE(axis_vec, axis, sign) { \
					CURSOR_VERT(axis_vec, axis, sign 1.0f); \
					CURSOR_VERT(axis_vec, axis, sign 0.25f); \
				}

				for (int axis = 0; axis < 3; axis++) {
					float axis_vec[3] = {0};
					axis_vec[axis] = scale;
					mul_qt_v3(cursor->rotation, axis_vec);
					CURSOR_EDGE(axis_vec, axis, +);
					CURSOR_EDGE(axis_vec, axis, -);
				}

#undef CURSOR_VERT
#undef CURSOR_EDGE

				immEnd();
				immUnbindProgram();
			}

			ED_region_pixelspace(ar);
			GPU_matrix_translate_2f(co[0] + 0.5f, co[1] + 0.5f);
			GPU_matrix_scale_2f(U.widget_unit, U.widget_unit);

			GPUBatch *cursor_batch = DRW_cache_cursor_get(is_aligned);
			GPUShader *shader = GPU_shader_get_builtin_shader(GPU_SHADER_2D_FLAT_COLOR);
			GPU_batch_program_set(cursor_batch, GPU_shader_get_program(shader), GPU_shader_get_interface(shader));

			GPU_batch_draw(cursor_batch);

			glDisable(GL_BLEND);
			glDisable(GL_LINE_SMOOTH);
		}
	}
}

/* **************************** 3D Gizmo ******************************** */

void DRW_draw_gizmo_3d(void)
{
	const DRWContextState *draw_ctx = DRW_context_state_get();
	ARegion *ar = draw_ctx->ar;

	/* draw depth culled gizmos - gizmos need to be updated *after* view matrix was set up */
	/* TODO depth culling gizmos is not yet supported, just drawing _3D here, should
	 * later become _IN_SCENE (and draw _3D separate) */
	WM_gizmomap_draw(
	        ar->gizmo_map, draw_ctx->evil_C,
	        WM_GIZMOMAP_DRAWSTEP_3D);

}

void DRW_draw_gizmo_2d(void)
{
	const DRWContextState *draw_ctx = DRW_context_state_get();
	ARegion *ar = draw_ctx->ar;

	WM_gizmomap_draw(
	        ar->gizmo_map, draw_ctx->evil_C,
	        WM_GIZMOMAP_DRAWSTEP_2D);

	glDepthMask(GL_TRUE);
}