208 lines
7.1 KiB
C
208 lines
7.1 KiB
C
/*
|
|
* 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.
|
|
*/
|
|
|
|
#pragma once
|
|
|
|
/** \file
|
|
* \ingroup bke
|
|
*
|
|
* General operations for brushes.
|
|
*/
|
|
|
|
#include "DNA_object_enums.h"
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
enum eCurveMappingPreset;
|
|
struct Brush;
|
|
struct ImBuf;
|
|
struct ImagePool;
|
|
struct Main;
|
|
struct Scene;
|
|
struct ToolSettings;
|
|
struct UnifiedPaintSettings;
|
|
|
|
// enum eCurveMappingPreset;
|
|
|
|
/* Globals for brush execution. */
|
|
|
|
void BKE_brush_system_init(void);
|
|
void BKE_brush_system_exit(void);
|
|
|
|
/* Data-block functions. */
|
|
|
|
/**
|
|
* \note Resulting brush will have two users: one as a fake user,
|
|
* another is assumed to be used by the caller.
|
|
*/
|
|
struct Brush *BKE_brush_add(struct Main *bmain, const char *name, const eObjectMode ob_mode);
|
|
/**
|
|
* Add a new gp-brush.
|
|
*/
|
|
struct Brush *BKE_brush_add_gpencil(struct Main *bmain,
|
|
struct ToolSettings *ts,
|
|
const char *name,
|
|
eObjectMode mode);
|
|
/**
|
|
* Delete a Brush.
|
|
*/
|
|
bool BKE_brush_delete(struct Main *bmain, struct Brush *brush);
|
|
/**
|
|
* Add grease pencil settings.
|
|
*/
|
|
void BKE_brush_init_gpencil_settings(struct Brush *brush);
|
|
struct Brush *BKE_brush_first_search(struct Main *bmain, const eObjectMode ob_mode);
|
|
|
|
void BKE_brush_sculpt_reset(struct Brush *brush);
|
|
|
|
/**
|
|
* Create a set of grease pencil Drawing presets.
|
|
*/
|
|
void BKE_brush_gpencil_paint_presets(struct Main *bmain,
|
|
struct ToolSettings *ts,
|
|
const bool reset);
|
|
/**
|
|
* Create a set of grease pencil Vertex Paint presets.
|
|
*/
|
|
void BKE_brush_gpencil_vertex_presets(struct Main *bmain,
|
|
struct ToolSettings *ts,
|
|
const bool reset);
|
|
/**
|
|
* Create a set of grease pencil Sculpt Paint presets.
|
|
*/
|
|
void BKE_brush_gpencil_sculpt_presets(struct Main *bmain,
|
|
struct ToolSettings *ts,
|
|
const bool reset);
|
|
/**
|
|
* Create a set of grease pencil Weight Paint presets.
|
|
*/
|
|
void BKE_brush_gpencil_weight_presets(struct Main *bmain,
|
|
struct ToolSettings *ts,
|
|
const bool reset);
|
|
void BKE_gpencil_brush_preset_set(struct Main *bmain, struct Brush *brush, const short type);
|
|
|
|
void BKE_brush_jitter_pos(const struct Scene *scene,
|
|
struct Brush *brush,
|
|
const float pos[2],
|
|
float jitterpos[2]);
|
|
void BKE_brush_randomize_texture_coords(struct UnifiedPaintSettings *ups, bool mask);
|
|
|
|
/* Brush curve. */
|
|
|
|
/**
|
|
* Library Operations
|
|
*/
|
|
void BKE_brush_curve_preset(struct Brush *b, enum eCurveMappingPreset preset);
|
|
/**
|
|
* Uses the brush curve control to find a strength value between 0 and 1.
|
|
*/
|
|
float BKE_brush_curve_strength_clamped(const struct Brush *br, float p, float len);
|
|
/**
|
|
* Uses the brush curve control to find a strength value.
|
|
*/
|
|
float BKE_brush_curve_strength(const struct Brush *br, float p, float len);
|
|
|
|
/* Sampling. */
|
|
|
|
/**
|
|
* Generic texture sampler for 3D painting systems.
|
|
* point has to be either in region space mouse coordinates,
|
|
* or 3d world coordinates for 3D mapping.
|
|
*
|
|
* RGBA outputs straight alpha.
|
|
*/
|
|
float BKE_brush_sample_tex_3d(const struct Scene *scene,
|
|
const struct Brush *br,
|
|
const float point[3],
|
|
float rgba[4],
|
|
const int thread,
|
|
struct ImagePool *pool);
|
|
float BKE_brush_sample_masktex(const struct Scene *scene,
|
|
struct Brush *br,
|
|
const float point[2],
|
|
const int thread,
|
|
struct ImagePool *pool);
|
|
|
|
/* Texture. */
|
|
|
|
unsigned int *BKE_brush_gen_texture_cache(struct Brush *br, int half_side, bool use_secondary);
|
|
|
|
/**
|
|
* Radial control.
|
|
*/
|
|
struct ImBuf *BKE_brush_gen_radial_control_imbuf(struct Brush *br,
|
|
bool secondary,
|
|
bool display_gradient);
|
|
|
|
/* Unified strength size and color. */
|
|
|
|
const float *BKE_brush_color_get(const struct Scene *scene, const struct Brush *brush);
|
|
const float *BKE_brush_secondary_color_get(const struct Scene *scene, const struct Brush *brush);
|
|
void BKE_brush_color_set(struct Scene *scene, struct Brush *brush, const float color[3]);
|
|
|
|
int BKE_brush_size_get(const struct Scene *scene, const struct Brush *brush);
|
|
void BKE_brush_size_set(struct Scene *scene, struct Brush *brush, int size);
|
|
|
|
float BKE_brush_unprojected_radius_get(const struct Scene *scene, const struct Brush *brush);
|
|
void BKE_brush_unprojected_radius_set(struct Scene *scene,
|
|
struct Brush *brush,
|
|
float unprojected_radius);
|
|
|
|
float BKE_brush_alpha_get(const struct Scene *scene, const struct Brush *brush);
|
|
void BKE_brush_alpha_set(struct Scene *scene, struct Brush *brush, float alpha);
|
|
float BKE_brush_weight_get(const struct Scene *scene, const struct Brush *brush);
|
|
void BKE_brush_weight_set(const struct Scene *scene, struct Brush *brush, float value);
|
|
|
|
bool BKE_brush_use_locked_size(const struct Scene *scene, const struct Brush *brush);
|
|
bool BKE_brush_use_alpha_pressure(const struct Brush *brush);
|
|
bool BKE_brush_use_size_pressure(const struct Brush *brush);
|
|
|
|
bool BKE_brush_sculpt_has_secondary_color(const struct Brush *brush);
|
|
|
|
/**
|
|
* Scale unprojected radius to reflect a change in the brush's 2D size.
|
|
*/
|
|
void BKE_brush_scale_unprojected_radius(float *unprojected_radius,
|
|
int new_brush_size,
|
|
int old_brush_size);
|
|
|
|
/**
|
|
* Scale brush size to reflect a change in the brush's unprojected radius.
|
|
*/
|
|
void BKE_brush_scale_size(int *r_brush_size,
|
|
float new_unprojected_radius,
|
|
float old_unprojected_radius);
|
|
|
|
/* Accessors */
|
|
#define BKE_brush_tool_get(brush, p) \
|
|
(CHECK_TYPE_ANY(brush, struct Brush *, const struct Brush *), \
|
|
*(const char *)POINTER_OFFSET(brush, (p)->runtime.tool_offset))
|
|
#define BKE_brush_tool_set(brush, p, tool) \
|
|
{ \
|
|
CHECK_TYPE_ANY(brush, struct Brush *); \
|
|
*(char *)POINTER_OFFSET(brush, (p)->runtime.tool_offset) = tool; \
|
|
} \
|
|
((void)0)
|
|
|
|
/* debugging only */
|
|
void BKE_brush_debug_print_state(struct Brush *br);
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|