blender::bke::greasepencil Namespace Reference

Namespaces
namespace	convert
namespace	tests

Classes
class	DrawingRuntime
class	Drawing
class	DrawingReference
class	TreeNode
class	LayerMask
struct	LayerTransformData
class	LayerRuntime
class	Layer
class	LayerGroupRuntime
class	LayerGroup

Typedefs
using	FramesMapKeyT = int

Functions
void	copy_drawing_array (Span< const GreasePencilDrawingBase * > src_drawings, MutableSpan< GreasePencilDrawingBase * > dst_drawings)
	TREENODE_COMMON_METHODS_FORWARD_IMPL (Layer)
	TREENODE_COMMON_METHODS_FORWARD_IMPL (LayerGroup)
const AttributeAccessorFunctions &	get_attribute_accessor_functions ()
void	ensure_non_empty_layer_names (Main &bmain, GreasePencil &grease_pencil)
static void	update_triangle_cache (const Span< float3 > positions, const Span< float3 > normals, const OffsetIndices< int > points_by_curve, const OffsetIndices< int > triangle_offsets, const IndexMask &curve_mask, MutableSpan< int3 > triangles)
static void	update_curve_plane_normal_cache (const Span< float3 > positions, const OffsetIndices< int > points_by_curve, const IndexMask &curve_mask, MutableSpan< float3 > normals)
static float4x2	get_local_to_stroke_matrix (const Span< float3 > positions, const float3 normal)
static float3x2	get_stroke_to_texture_matrix (const float uv_rotation, const float2 uv_translation, const float2 uv_scale)
static float4x3	expand_4x2_mat (const float4x2 &strokemat)
static const auto &	changed_tags ()
static const auto &	builtin_attributes ()
static int	get_domain_size (const void *owner, const AttrDomain domain)
static AttributeAccessorFunctions	get_grease_pencil_accessor_functions ()
Vertex groups in drawings
void	validate_drawing_vertex_groups (GreasePencil &grease_pencil)
int	ensure_vertex_group (StringRef name, ListBase &vertex_group_names)
void	assign_to_vertex_group (Drawing &drawing, StringRef name, float weight)
void	assign_to_vertex_group_from_mask (CurvesGeometry &curves, const IndexMask &mask, StringRef name, float weight)
bool	remove_from_vertex_group (Drawing &drawing, StringRef name, bool use_selection)
void	clear_vertex_groups (GreasePencil &grease_pencil)

Variables
constexpr float	LEGACY_RADIUS_CONVERSION_FACTOR = 1.0f / 2000.0f
constexpr StringRef	ATTR_RADIUS = "radius"
constexpr StringRef	ATTR_OPACITY = "opacity"
constexpr StringRef	ATTR_VERTEX_COLOR = "vertex_color"
constexpr StringRef	ATTR_FILL_COLOR = "fill_color"

Typedef Documentation

FramesMapKeyT

using blender::bke::greasepencil::FramesMapKeyT = int

Examples

/usr/src/RPM/BUILD/blender5.0-5.0.0/source/blender/blenkernel/BKE_grease_pencil.hh.

Definition at line 390 of file BKE_grease_pencil.hh.

Function Documentation

assign_to_vertex_group()

void blender::bke::greasepencil::assign_to_vertex_group	(	Drawing &	drawing,
		StringRef	name,
		float	weight )

Assign selected vertices to the vertex group.

Definition at line 98 of file grease_pencil_vertex_groups.cc.

References BKE_defgroup_name_index(), BKE_defvert_ensure_index(), BLI_addtail(), BLI_assert, BLI_listbase_count(), i, blender::MutableSpan< T >::index_range(), blender::bke::AttributeAccessor::lookup_or_default(), MEM_callocN(), bDeformGroup::name, name, blender::bke::Point, blender::bke::greasepencil::Drawing::strokes_for_write(), and MDeformWeight::weight.

Referenced by blender::ed::object::vgroup_assign_verts().

assign_to_vertex_group_from_mask()

void blender::bke::greasepencil::assign_to_vertex_group_from_mask	(	bke::CurvesGeometry &	curves,
		const IndexMask &	mask,
		StringRef	name,
		float	weight )

Definition at line 68 of file grease_pencil_vertex_groups.cc.

References BKE_defgroup_name_index(), BKE_defvert_ensure_index(), BLI_addtail(), BLI_assert, BLI_listbase_count(), mask(), MEM_callocN(), bDeformGroup::name, and name.

Referenced by blender::ed::sculpt_paint::greasepencil::process_stroke_weights().

builtin_attributes()

const auto & blender::bke::greasepencil::builtin_attributes ( )

static

Definition at line 21 of file grease_pencil_attributes.cc.

Referenced by get_grease_pencil_accessor_functions().

changed_tags()

const auto & blender::bke::greasepencil::changed_tags ( )

static

Definition at line 15 of file grease_pencil_attributes.cc.

Referenced by get_grease_pencil_accessor_functions().

clear_vertex_groups()

void blender::bke::greasepencil::clear_vertex_groups

(

GreasePencil &

grease_pencil

)

Remove vertices from all vertex groups.

Definition at line 159 of file grease_pencil_vertex_groups.cc.

References BKE_defvert_clear(), GP_DRAWING, blender::bke::greasepencil::Drawing::strokes_for_write(), and wrap().

Referenced by BKE_object_defgroup_remove_all_ex(), and object_defgroup_remove_common().

copy_drawing_array()

void blender::bke::greasepencil::copy_drawing_array	(	Span< const GreasePencilDrawingBase * >	src_drawings,
		MutableSpan< GreasePencilDrawingBase * >	dst_drawings )

Copies the drawings from one array to another. Assumes that dst_drawings is allocated but not initialized, e.g. it will allocate new drawings and store the pointers.

Examples

/usr/src/RPM/BUILD/blender5.0-5.0.0/source/blender/blenkernel/BKE_grease_pencil.hh.

Definition at line 1008 of file grease_pencil.cc.

References BLI_assert, copy_drawing_array(), GP_DRAWING, GP_DRAWING_REFERENCE, i, blender::Span< T >::index_range(), blender::MutableSpan< T >::size(), blender::Span< T >::size(), and GreasePencilDrawingBase::type.

Referenced by BKE_grease_pencil_duplicate_drawing_array(), copy_drawing_array(), and blender::ed::greasepencil::join_object_with_active().

ensure_non_empty_layer_names()

void blender::bke::greasepencil::ensure_non_empty_layer_names	(	Main &	bmain,
		GreasePencil &	grease_pencil )

Renames layers with empty names to "Layer".

Note

While original data should not have layers with empty names, we allow layer names to be empty in evaluated geometry.

Examples

/usr/src/RPM/BUILD/blender5.0-5.0.0/source/blender/blenkernel/BKE_grease_pencil.hh.

Definition at line 1969 of file grease_pencil.cc.

References DATA_.

Referenced by blender::ed::object::apply_grease_pencil_for_modifier(), blender::ed::object::apply_grease_pencil_for_modifier_all_keyframes(), and blender::ed::geometry::store_result_geometry().

ensure_vertex_group()

int blender::bke::greasepencil::ensure_vertex_group	(	StringRef	name,
		ListBase &	vertex_group_names )

Find or create a vertex group in a drawing.

Definition at line 55 of file grease_pencil_vertex_groups.cc.

References BKE_defgroup_name_index(), BLI_addtail(), BLI_assert, BLI_listbase_count(), MEM_callocN(), bDeformGroup::name, and name.

Referenced by blender::write_weights_for_drawing().

expand_4x2_mat()

float4x3 blender::bke::greasepencil::expand_4x2_mat ( const float4x2 & strokemat )

static

Definition at line 660 of file grease_pencil.cc.

Referenced by blender::bke::greasepencil::Drawing::set_texture_matrices().

get_attribute_accessor_functions()

const AttributeAccessorFunctions & blender::bke::greasepencil::get_attribute_accessor_functions

(

)

Examples

/usr/src/RPM/BUILD/blender5.0-5.0.0/source/blender/blenkernel/BKE_grease_pencil.hh.

Definition at line 148 of file grease_pencil_attributes.cc.

References get_grease_pencil_accessor_functions().

Referenced by blender::bke::GreasePencilComponent::attributes(), and blender::bke::GreasePencilComponent::attributes_for_write().

get_domain_size()

int blender::bke::greasepencil::get_domain_size ( const void * owner, const AttrDomain domain )

static

Definition at line 30 of file grease_pencil_attributes.cc.

References blender::bke::Layer.

Referenced by get_grease_pencil_accessor_functions().

get_grease_pencil_accessor_functions()

AttributeAccessorFunctions blender::bke::greasepencil::get_grease_pencil_accessor_functions ( )

static

Definition at line 36 of file grease_pencil_attributes.cc.

References blender::bke::AttributeIter::accessor, blender::bke::AttributeStorage::add(), blender::bke::attribute_init_to_data(), GreasePencil::attribute_storage, blender::bke::attribute_to_reader(), blender::bke::attribute_to_writer(), builtin_attributes(), changed_tags(), blender::bke::AttributeInit::Construct, blender::bke::Attribute::data_type(), blender::bke::AttrBuiltinInfo::default_value, blender::bke::Attribute::domain(), blender::bke::AttributeStorage::foreach_with_stop(), get_domain_size(), blender::bke::AttributeIter::is_builtin, blender::bke::AttributeIter::is_stopped(), blender::bke::Layer, blender::bke::AttributeStorage::lookup(), blender::bke::Attribute::name(), name, blender::bke::AttributeStorage::remove(), and blender::bke::AttrBuiltinInfo::validator.

Referenced by get_attribute_accessor_functions().

get_local_to_stroke_matrix()

float4x2 blender::bke::greasepencil::get_local_to_stroke_matrix ( const Span< float3 > positions, const float3 normal )

static

Definition at line 593 of file grease_pencil.cc.

References cross, dot(), blender::MatBase< float, 4, 2 >::identity(), blender::math::length_squared(), normalize, blender::Span< T >::size(), and transpose.

Referenced by blender::bke::greasepencil::Drawing::set_texture_matrices().

get_stroke_to_texture_matrix()

float3x2 blender::bke::greasepencil::get_stroke_to_texture_matrix ( const float uv_rotation, const float2 uv_translation, const float2 uv_scale )

static

Definition at line 624 of file grease_pencil.cc.

References cos, blender::math::from_scale(), blender::MatBase< float, 3, 2 >::identity(), rot, blender::math::safe_rcp(), and sin.

remove_from_vertex_group()

bool blender::bke::greasepencil::remove_from_vertex_group	(	Drawing &	drawing,
		StringRef	name,
		bool	use_selection )

Remove selected vertices from the vertex group.

Returns

True if at least one vertex was removed from the group.

Definition at line 132 of file grease_pencil_vertex_groups.cc.

References BKE_defgroup_name_index(), BKE_defvert_find_index(), BKE_defvert_remove_group(), i, blender::MutableSpan< T >::index_range(), blender::bke::AttributeAccessor::lookup_or_default(), name, blender::bke::Point, and blender::bke::greasepencil::Drawing::strokes_for_write().

Referenced by blender::ed::object::grease_pencil_clear_from_vgroup().

TREENODE_COMMON_METHODS_FORWARD_IMPL() [1/2]

blender::bke::greasepencil::TREENODE_COMMON_METHODS_FORWARD_IMPL

(

Layer

)

TREENODE_COMMON_METHODS_FORWARD_IMPL() [2/2]

blender::bke::greasepencil::TREENODE_COMMON_METHODS_FORWARD_IMPL

(

LayerGroup

)

update_curve_plane_normal_cache()

void blender::bke::greasepencil::update_curve_plane_normal_cache ( const Span< float3 > positions, const OffsetIndices< int > points_by_curve, const IndexMask & curve_mask, MutableSpan< float3 > normals )

static

Definition at line 538 of file grease_pencil.cc.

References add_newell_cross_v3_v3v3(), blender::IndexRange::drop_back(), blender::index_mask::IndexMask::foreach_index(), blender::math::is_zero(), blender::IndexRange::last(), length(), blender::math::length_squared(), blender::math::normalize(), blender::math::normalize_and_get_length(), normals, and blender::IndexRange::size().

Referenced by blender::bke::greasepencil::Drawing::curve_plane_normals(), blender::bke::greasepencil::Drawing::tag_positions_changed(), and blender::bke::greasepencil::Drawing::tag_topology_changed().

update_triangle_cache()

void blender::bke::greasepencil::update_triangle_cache ( const Span< float3 > positions, const Span< float3 > normals, const OffsetIndices< int > points_by_curve, const OffsetIndices< int > triangle_offsets, const IndexMask & curve_mask, MutableSpan< int3 > triangles )

static

Definition at line 474 of file grease_pencil.cc.

References axis_dominant_v3_to_m3(), BLI_memarena_alloc(), BLI_memarena_clear(), BLI_memarena_free(), BLI_memarena_new(), BLI_MEMARENA_STD_BUFSIZE, BLI_polyfill_calc_arena(), blender::MutableSpan< T >::data(), float, blender::index_mask::IndexMask::foreach_segment(), i, blender::threading::EnumerableThreadSpecific< T >::local(), mul_v2_m3v3(), normals, blender::MatBase< T, NumCol, NumRow, Alignment >::ptr(), blender::IndexRange::size(), and blender::MutableSpan< T >::slice().

Referenced by blender::bke::greasepencil::Drawing::tag_positions_changed(), blender::bke::greasepencil::Drawing::tag_topology_changed(), and blender::bke::greasepencil::Drawing::triangles().

validate_drawing_vertex_groups()

void blender::bke::greasepencil::validate_drawing_vertex_groups

(

GreasePencil &

grease_pencil

)

Make sure drawings only contain vertex groups of the GreasePencil.

Definition at line 26 of file grease_pencil_vertex_groups.cc.

References blender::Set< Key, InlineBufferCapacity, ProbingStrategy, Hash, IsEqual, Slot, Allocator >::add_new(), BLI_remlink(), blender::Set< Key, InlineBufferCapacity, ProbingStrategy, Hash, IsEqual, Slot, Allocator >::contains(), GP_DRAWING, LISTBASE_FOREACH, LISTBASE_FOREACH_MUTABLE, MEM_SAFE_FREE, blender::bke::remove_defgroup_index(), blender::bke::greasepencil::Drawing::strokes_for_write(), GreasePencil::vertex_group_names, and wrap().

Referenced by BKE_object_defgroup_new(), and BKE_object_defgroup_remove().

Variable Documentation

ATTR_FILL_COLOR

StringRef blender::bke::greasepencil::ATTR_FILL_COLOR = "fill_color"

constexpr

Definition at line 389 of file grease_pencil.cc.

Referenced by blender::bke::greasepencil::Drawing::fill_colors(), and blender::bke::greasepencil::Drawing::fill_colors_for_write().

ATTR_OPACITY

StringRef blender::bke::greasepencil::ATTR_OPACITY = "opacity"

constexpr

Definition at line 387 of file grease_pencil.cc.

Referenced by blender::bke::greasepencil::Drawing::opacities(), and blender::bke::greasepencil::Drawing::opacities_for_write().

ATTR_RADIUS

StringRef blender::bke::greasepencil::ATTR_RADIUS = "radius"

constexpr

Definition at line 386 of file grease_pencil.cc.

Referenced by blender::bke::greasepencil::Drawing::radii(), and blender::bke::greasepencil::Drawing::radii_for_write().

ATTR_VERTEX_COLOR

StringRef blender::bke::greasepencil::ATTR_VERTEX_COLOR = "vertex_color"

constexpr

Definition at line 388 of file grease_pencil.cc.

Referenced by blender::bke::greasepencil::Drawing::vertex_colors(), and blender::bke::greasepencil::Drawing::vertex_colors_for_write().

LEGACY_RADIUS_CONVERSION_FACTOR

float blender::bke::greasepencil::LEGACY_RADIUS_CONVERSION_FACTOR = 1.0f / 2000.0f

constexpr

Examples

/usr/src/RPM/BUILD/blender5.0-5.0.0/source/blender/blenkernel/BKE_grease_pencil.hh.

Definition at line 49 of file BKE_grease_pencil.hh.

Referenced by blo_do_versions_420(), blo_do_versions_430(), blender::ed::object::convert_mesh_to_grease_pencil(), blender::ed::greasepencil::image_render::draw_dots(), blender::ed::greasepencil::image_render::draw_grease_pencil_stroke(), blender::bke::greasepencil::convert::fcurve_convert_thickness_cb(), blender::ed::sculpt_paint::GreasePencilFillOpData::from_context(), blender::ed::sculpt_paint::grease_pencil_apply_fill(), blender::bke::greasepencil::convert::legacy_gpencil_frame_to_grease_pencil_drawing(), blender::bke::greasepencil::convert::legacy_object_modifier_thickness(), blender::bke::greasepencil::convert::lineart_unwrap_v3(), blender::bke::greasepencil::convert::lineart_wrap_v3(), and blender::modify_drawing().