blender-archive/source/blender/blenkernel/BKE_context.h

/**
 * $Id$
 *
 * ***** BEGIN GPL LICENSE BLOCK *****
 *
 * 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., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 *
 * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
 * All rights reserved.
 *
 * Contributor(s): Blender Foundation (2008).
 *
 * ***** END GPL LICENSE BLOCK *****
 */

#ifndef BKE_CONTEXT_H
#define BKE_CONTEXT_H

#ifdef __cplusplus
extern "C" {
#endif

#include "DNA_listBase.h"

struct ARegion;
struct bScreen;
struct EditMesh;
struct ListBase;
struct Main;
struct Object;
struct PointerRNA;
struct ReportList;
struct Scene;
struct ScrArea;
struct SpaceLink;
struct View3D;
struct RegionView3D;
struct StructRNA;
struct ToolSettings;
struct Image;
struct Text;
struct ImBuf;
struct EditBone;
struct bPoseChannel;
struct wmWindow;
struct wmWindowManager;
struct SpaceText;
struct SpaceImage;

/* Structs */

struct bContext;
typedef struct bContext bContext;

struct bContextDataResult;
typedef struct bContextDataResult bContextDataResult;

enum {
	CTX_DATA_MAIN,
	CTX_DATA_SCENE,
	CTX_DATA_TOOL_SETTINGS,

	CTX_DATA_SELECTED_OBJECTS,
	CTX_DATA_SELECTED_BASES,
	CTX_DATA_SELECTED_EDITABLE_OBJECTS,
	CTX_DATA_SELECTED_EDITABLE_BASES,
	CTX_DATA_VISIBLE_OBJECTS,
	CTX_DATA_VISIBLE_BASES,

	CTX_DATA_ACTIVE_OBJECT,
	CTX_DATA_ACTIVE_BASE,
	CTX_DATA_EDIT_OBJECT,

	CTX_DATA_EDIT_IMAGE,
	CTX_DATA_EDIT_IMAGE_BUFFER,

	CTX_DATA_EDIT_TEXT,

	CTX_DATA_SELECTED_NODES,
	
	CTX_DATA_SELECTED_BONES,
	CTX_DATA_SELECTED_EDITABLE_BONES,
	CTX_DATA_SELECTED_PCHANS,
	
	CTX_DATA_ACTIVE_BONE,
	CTX_DATA_ACTIVE_PCHAN,
	
	CTX_DATA_VISIBLE_BONES,
	CTX_DATA_EDITABLE_BONES,
	CTX_DATA_VISIBLE_PCHANS,
};

typedef int bContextDataMember;

typedef int (*bContextDataCallback)(const bContext *C,
	bContextDataMember member, bContextDataResult *result);

/* Context */

bContext *CTX_create(void);
void CTX_free(bContext *C);

bContext *CTX_copy(const bContext *C, int thread);
int CTX_thread(const bContext *C);

/* Context Task and Reports */

typedef enum bContextTask {
	CTX_DRAWING = 0,
	CTX_EDITING = 1,
	CTX_EVALUATING = 2,
	CTX_UNDEFINED = 3
} bContextTask;

bContextTask CTX_task(const bContext *C);
void CTX_task_set(bContext *C, bContextTask task);

struct ReportList *CTX_reports(const bContext *C);
void CTX_reports_set(bContext *C, struct ReportList *reports);

/* Window Manager Context */

struct wmWindowManager *CTX_wm_manager(const bContext *C);
struct wmWindow *CTX_wm_window(const bContext *C);
struct bScreen *CTX_wm_screen(const bContext *C);
struct ScrArea *CTX_wm_area(const bContext *C);
struct SpaceLink *CTX_wm_space_data(const bContext *C);
struct ARegion *CTX_wm_region(const bContext *C);
void *CTX_wm_region_data(const bContext *C);
struct uiBlock *CTX_wm_ui_block(const bContext *C);

struct View3D *CTX_wm_view3d(const bContext *C);
struct RegionView3D *CTX_wm_region_view3d(const bContext *C);
struct SpaceText *CTX_wm_space_text(const bContext *C);
struct SpaceImage *CTX_wm_space_image(const bContext *C);

void CTX_wm_manager_set(bContext *C, struct wmWindowManager *wm);
void CTX_wm_window_set(bContext *C, struct wmWindow *win);
void CTX_wm_screen_set(bContext *C, struct bScreen *screen); /* to be removed */
void CTX_wm_area_set(bContext *C, struct ScrArea *win);
void CTX_wm_region_set(bContext *C, struct ARegion *win);
void CTX_wm_ui_block_set(bContext *C, struct uiBlock *block, bContextDataCallback cb);

/* Data Context

   - note: listbases consist of LinkData items and must be
     freed with BLI_freelistN! */

void CTX_data_pointer_set(bContextDataResult *result, void *data);
void CTX_data_list_add(bContextDataResult *result, void *data);

#define CTX_DATA_BEGIN(C, Type, instance, member) \
	{ \
		ListBase ctx_data_list; \
		LinkData *link; \
		CTX_data_##member(C, &ctx_data_list); \
		for(link=ctx_data_list.first; link; link=link->next) { \
			Type instance= link->data;

#define CTX_DATA_END \
		} \
		BLI_freelistN(&ctx_data_list); \
	}

int ctx_data_list_count(const bContext *C, int (*func)(const bContext*, ListBase*));

#define CTX_DATA_COUNT(C, member) \
	ctx_data_list_count(C, CTX_data_##member)

/* Data Context Members */

struct Main *CTX_data_main(const bContext *C);
struct Scene *CTX_data_scene(const bContext *C);
struct ToolSettings *CTX_data_tool_settings(const bContext *C);

void CTX_data_main_set(bContext *C, struct Main *bmain);
void CTX_data_scene_set(bContext *C, struct Scene *bmain);

int CTX_data_selected_editable_objects(const bContext *C, ListBase *list);
int CTX_data_selected_editable_bases(const bContext *C, ListBase *list);

int CTX_data_selected_objects(const bContext *C, ListBase *list);
int CTX_data_selected_bases(const bContext *C, ListBase *list);

int CTX_data_visible_objects(const bContext *C, ListBase *list);
int CTX_data_visible_bases(const bContext *C, ListBase *list);

struct Object *CTX_data_active_object(const bContext *C);
struct Base *CTX_data_active_base(const bContext *C);
struct Object *CTX_data_edit_object(const bContext *C);

struct Image *CTX_data_edit_image(const bContext *C);
struct ImBuf *CTX_data_edit_image_buffer(const bContext *C);

struct Text *CTX_data_edit_text(const bContext *C);

int CTX_data_selected_nodes(const bContext *C, ListBase *list);

struct EditBone *CTX_data_active_bone(const bContext *C);
int CTX_data_selected_bones(const bContext *C, ListBase *list);
int CTX_data_selected_editable_bones(const bContext *C, ListBase *list);
int CTX_data_visible_bones(const bContext *C, ListBase *list);
int CTX_data_editable_bones(const bContext *C, ListBase *list);

struct bPoseChannel *CTX_data_active_pchan(const bContext *C);
int CTX_data_selected_pchans(const bContext *C, ListBase *list);
int CTX_data_visible_pchans(const bContext *C, ListBase *list);

/* Data Evaluation Context */

float CTX_eval_frame(const bContext *C);

int CTX_eval_render_resolution(const bContext *C);
void CTX_eval_render_resolution_set(bContext *C, int render);

#ifdef __cplusplus
}
#endif
	
#endif