Documentation: Changes between Grease Pencil v2 and Grease Pencil v3 #114419

New Issue

Falk David · 2023-11-02T17:46:54+01:00

Falk David commented

2023-11-02 17:46:54 +01:00

This task is meant to give a full list of all the changes (at a user level) between GPv2 and GPv3.

Object-Data Properties

Description	GPv2	GPv3
Default layer name	`GP_Layer`	`Layer`

Draw Mode

TODO:

New drawing operator
New eraser

Description	GPv2	GPv3

Edit Mode

Description	GPv2	GPv3
Normalize stroke operator name	`Stroke > Normalize Thickness`	`Stroke > Set Uniform Thickness`
	`Stroke > Normalize Thickness`	`Stroke > Set Uniform Opacity`
Set Caps Operator		The modes are now: `Round`, `Flat`, `Toggle Start` and `Toggle End`
Subdivide Operator	Will insert `2^n-1` points.	Will insert `number_cuts` points, if the number is 3, then 3 extra points are added to each segment instead of 7. A new extra "Keep Shape" option is available.
Separate Operator		The modes are now: `Selection`, `By Material` and `By Layer`

Modifiers

Description	GPv2	GPv3
Common Influence Filters	`layer`	`layer_filter`
	`layer_pass`	`layer_pass_filter`
	`layer_pass`	`layer_pass_filter`
	`layer_pass < 0` toggles filter	`use_layer_pass_filter`
	`invert_layers`	`invert_layer_filter`
	`invert_layer_pass`	`invert_layer_pass_filter`
	`material`	`material_filter`
	`pass_index`	`material_pass_filter`
	`pass_index < 0` toggles filter	`use_material_pass_filter`
	`invert_materials`	`invert_material_filter`
	`invert_material_pass`	`invert_material_pass_filter`
	`vertex_group`	`vertex_group_name`
	`invert_vertex`	`invert_vertex_group`
	`curve`	`custom_curve`
Smooth Modifier Operator		Does not have UV smoothing yet. A new extra "Keep Shape" option is available. A new extra "Smooth Ends" option is available.
Tint	`tint_type`	`tint_mode`
	`vertex_mode`	`color_mode`
	`use_weight_factor`	`use_weight_as_factor`
	`colors`	`color_ramp`
Line Art	Vertex weight transfer option transfer all weights with the same name prefix.	Vertex weight transfer will only work with the vertex group with the exact given name.

Python API

Description	GPv2	GPv3
Object Type	`GPENCIL`	`GREASEPENCIL`
Calling operators	`bpy.ops.gpencil`	`bpy.ops.grease_pencil`

Assign Material	`stroke_change_color`	`stroke_material_set`
Normalize Thickness	`stroke_normalize`	`set_uniform_thickness`
Normalize Opacity	`stroke_normalize`	`set_uniform_opacity`
Stroke Flip	`stroke_flip`	`stroke_switch_direction`

This task is meant to give a full list of all the changes (at a user level) between GPv2 and GPv3. ## Object-Data Properties | Description | GPv2 | GPv3 | | ------------------ | --------- | -------- | | Default layer name | `GP_Layer` | `Layer` | ## Draw Mode TODO: * New drawing operator * New eraser | Description | GPv2 | GPv3 | | ------------------ | --------- | -------- | ## Edit Mode | Description | GPv2 | GPv3 | | ------------------ | --------- | -------- | | Normalize stroke operator name | `Stroke > Normalize Thickness` | `Stroke > Set Uniform Thickness` | | | `Stroke > Normalize Thickness` | `Stroke > Set Uniform Opacity` | | Set Caps Operator | | The modes are now: `Round`, `Flat`, `Toggle Start` and `Toggle End` | | Subdivide Operator | Will insert `2^n-1` points. | Will insert `number_cuts` points, if the number is 3, then 3 extra points are added to each segment instead of 7. <br />A new extra "Keep Shape" option is available.| | Separate Operator | | The modes are now: `Selection`, `By Material` and `By Layer` | ## Modifiers | Description | GPv2 | GPv3 | | ------------------ | --------- | -------- | | Common Influence Filters | `layer` | `layer_filter` | | | `layer_pass` | `layer_pass_filter` | | | `layer_pass` | `layer_pass_filter` | | | `layer_pass < 0` toggles filter | `use_layer_pass_filter` | | | `invert_layers` | `invert_layer_filter` | | | `invert_layer_pass` | `invert_layer_pass_filter` | | | `material` | `material_filter` | | | `pass_index` | `material_pass_filter` | | | `pass_index < 0` toggles filter | `use_material_pass_filter` | | | `invert_materials` | `invert_material_filter` | | | `invert_material_pass` | `invert_material_pass_filter` | | | `vertex_group` | `vertex_group_name` | | | `invert_vertex` | `invert_vertex_group` | | | `curve` | `custom_curve` | | Smooth Modifier Operator | | Does not have UV smoothing yet.<br /> A new extra "Keep Shape" option is available.<br /> A new extra "Smooth Ends" option is available. | | Tint | `tint_type` | `tint_mode` | | | `vertex_mode` | `color_mode` | | | `use_weight_factor` | `use_weight_as_factor` | | | `colors` | `color_ramp` | | Line Art | Vertex weight transfer option transfer all weights with the same name prefix. | Vertex weight transfer will only work with the vertex group with the exact given name. | ## Python API | Description | GPv2 | GPv3 | | ------------------ | --------- | -------- | | Object Type | `GPENCIL` | `GREASEPENCIL` | | Calling operators | `bpy.ops.gpencil` | `bpy.ops.grease_pencil` | | | | | | Assign Material | `stroke_change_color` | `stroke_material_set` | | Normalize Thickness | `stroke_normalize` | `set_uniform_thickness` | | Normalize Opacity | `stroke_normalize` | `set_uniform_opacity` | | Stroke Flip | `stroke_flip` | `stroke_switch_direction` |

Falk David added the

Type

To Do

label 2023-11-02 17:46:54 +01:00

Falk David added this to the Grease Pencil project 2023-11-02 17:46:56 +01:00

Falk David changed title from ~~Documentation: Changes between GPv2 and GPv3~~ to Documentation: Changes between Grease Pencil v2 and Grease Pencil v3

2023-11-02 17:54:04 +01:00

Falk David referenced this issue

2023-11-08 15:09:32 +01:00

GPv3: Set selected curve material as active material #114188

Falk David referenced this issue

2023-12-05 11:04:09 +01:00

GPv3: Drawing Placement #115602

Jaime Torres commented

2023-12-09 22:34:46 +01:00

Is there anybody working currently in documentating the Python API for GPENCIL and GREASEPENCIL? as i said over in the grease pencil chat, i was interested on checking out what's happening with MacOS and GPv3, and maybe documenting how the API works could give me a bit more experience with the codebase beforehand and a few pointers. Could i start working on it or help whoever's in charge?

Is there anybody working currently in documentating the Python API for `GPENCIL` and `GREASEPENCIL`? as i said over in the grease pencil chat, i was interested on checking out what's happening with MacOS and GPv3, and maybe documenting how the API works could give me a bit more experience with the codebase beforehand and a few pointers. Could i start working on it or help whoever's in charge?

Falk David commented

2023-12-10 09:37:11 +01:00

Hey @mewslore :) As it stands right now, there isn't muh to document for the Python API, because not much work has been done on it. That being said, I think it could be a good way to learn more about how the code (for GPv2 and GPv3) works. E.g. if you look at rna_gpencil_legacy.cc (python API functions for GPv2) and rna_grease_pencil.cc (same for GPv3), you'll see that most of the functions haven't been ported yet.

If you're interested in looking at this, I can also create a task with some more pointers and a list of what would have to be done.

Hey @mewslore :) As it stands right now, there isn't muh to document for the Python API, because not much work has been done on it. That being said, I think it could be a good way to learn more about how the code (for GPv2 and GPv3) works. E.g. if you look at `rna_gpencil_legacy.cc` (python API functions for GPv2) and `rna_grease_pencil.cc` (same for GPv3), you'll see that most of the functions haven't been ported yet. If you're interested in looking at this, I can also create a task with some more pointers and a list of what would have to be done.

Jaime Torres commented

2023-12-10 19:20:55 +01:00

I'm definitely interested @filedescriptor , let's make that task and i'll start from there ;)

Falk David commented

2023-12-11 16:11:36 +01:00

@mewslore I began working on an overview task: #116043. I'll create a first subtask that might be a good fit for you: data-structure iterators and accessors.

@mewslore I began working on an overview task: https://projects.blender.org/blender/blender/issues/116043. I'll create a first subtask that might be a good fit for you: data-structure iterators and accessors.

Falk David commented

2023-12-11 16:45:11 +01:00

@mewslore #116045: GPv3: Python API: GreasePencilFrame

@mewslore [#116045: GPv3: Python API: GreasePencilFrame](https://projects.blender.org/blender/blender/issues/116045)

Falk David referenced this issue

2024-01-08 17:47:50 +01:00

GPv3: Subdivide operator #116740

Falk David referenced this issue

2024-01-17 16:45:07 +01:00

GPv3: Subdivide modifier #117056

Falk David referenced this issue

2024-01-18 11:36:46 +01:00