Blender V5.0
DNA_gpencil_legacy_types.h File Reference
#include "DNA_ID.h"
#include "DNA_curve_types.h"
#include "DNA_listBase.h"

Go to the source code of this file.

Classes

struct  bGPDspoint
struct  bGPDtriangle
struct  bGPDpalettecolor
struct  bGPDpalette
struct  bGPDcurve_point
struct  bGPDcurve
struct  bGPDstroke_Runtime
struct  bGPDstroke
struct  bGPDframe_Runtime
struct  bGPDframe
struct  bGPDlayer_Mask
struct  bGPDlayer_Runtime
struct  bGPDlayer
struct  bGPdata_Runtime
struct  bGPgrid
struct  bGPdata

Macros

#define GP_DEFAULT_PIX_FACTOR   1.0f
#define GP_DEFAULT_GRID_LINES   4
#define GP_MAX_INPUT_SAMPLES   10
#define GP_DEFAULT_CURVE_RESOLUTION   32
#define GP_DEFAULT_CURVE_ERROR   0.1f
#define GP_DEFAULT_CURVE_EDIT_CORNER_ANGLE   M_PI_2
#define GPENCIL_MIN_FILL_FAC   0.05f
#define GPENCIL_MAX_FILL_FAC   8.0f

Typedefs

typedef struct bGPDspoint bGPDspoint
typedef enum eGPDspoint_Flag eGPSPoint_Flag
typedef struct bGPDtriangle bGPDtriangle
typedef struct bGPDpalettecolor bGPDpalettecolor
typedef enum eGPDpalettecolor_Flag eGPDpalettecolor_Flag
typedef struct bGPDpalette bGPDpalette
typedef enum eGPDpalette_Flag eGPDpalette_Flag
typedef struct bGPDcurve_point bGPDcurve_point
typedef enum eGPDcurve_point_Flag eGPDcurve_point_Flag
typedef struct bGPDcurve bGPDcurve
typedef enum bGPDcurve_Flag bGPDcurve_Flag
typedef struct bGPDstroke_Runtime bGPDstroke_Runtime
typedef struct bGPDstroke bGPDstroke
typedef enum eGPDstroke_Flag eGPDstroke_Flag
typedef enum eGPDstroke_Caps GPDstroke_Caps
typedef enum eGPDstroke_Arrowstyle eGPDstroke_Arrowstyle
typedef struct bGPDframe_Runtime bGPDframe_Runtime
typedef struct bGPDframe bGPDframe
typedef enum eGPDframe_Flag eGPDframe_Flag
typedef struct bGPDlayer_Mask bGPDlayer_Mask
typedef enum ebGPDlayer_Mask_Flag ebGPDlayer_Mask_Flag
typedef struct bGPDlayer_Runtime bGPDlayer_Runtime
typedef struct bGPDlayer bGPDlayer
typedef enum eGPDlayer_Flag eGPDlayer_Flag
typedef enum eGPDlayer_OnionFlag eGPDlayer_OnionFlag
typedef enum eGPLayerBlendModes eGPLayerBlendModes
typedef struct bGPdata_Runtime bGPdata_Runtime
typedef struct bGPgrid bGPgrid
typedef struct bGPdata bGPdata
typedef enum eGPdata_Flag eGPdata_Flag
typedef enum eGPD_OnionFlag eGPD_OnionFlag
typedef enum eGP_OnionModes eGP_OnionModes
typedef enum eGP_DepthOrdering eGP_DepthOrdering
typedef enum eGP_DrawMode eGP_DrawMode

Enumerations

enum  eGPDspoint_Flag { GP_SPOINT_SELECT = (1 << 0) , GP_SPOINT_TAG = (1 << 1) }
enum  eGPDpalettecolor_Flag { PC_COLOR_HIDE = (1 << 1) , PC_COLOR_LOCKED = (1 << 2) , PC_COLOR_ONIONSKIN = (1 << 3) , PC_COLOR_VOLUMETRIC = (1 << 4) }
enum  eGPDpalette_Flag { PL_PALETTE_ACTIVE = (1 << 0) }
enum  eGPDcurve_point_Flag { GP_CURVE_POINT_SELECT = (1 << 0) }
enum  bGPDcurve_Flag { GP_CURVE_NEEDS_STROKE_UPDATE = (1 << 0) , GP_CURVE_SELECT = (1 << 1) }
enum  eGPDstroke_Flag {
  GP_STROKE_3DSPACE = (1 << 0) , GP_STROKE_2DSPACE = (1 << 1) , GP_STROKE_2DIMAGE = (1 << 2) , GP_STROKE_SELECT = (1 << 3) ,
  GP_STROKE_CYCLIC = (1 << 7) , GP_STROKE_NOFILL = (1 << 8) , GP_STROKE_NEEDS_CURVE_UPDATE = (1 << 9) , GP_STROKE_HELP = (1 << 10) ,
  GP_STROKE_COLLIDE = (1 << 11) , GP_STROKE_USE_ARROW_START = (1 << 12) , GP_STROKE_USE_ARROW_END = (1 << 13) , GP_STROKE_TAG = (1 << 14) ,
  GP_STROKE_ERASER = (1 << 15)
}
enum  eGPDstroke_Caps { GP_STROKE_CAP_ROUND = 0 , GP_STROKE_CAP_FLAT = 1 , GP_STROKE_CAP_MAX }
enum  eGPDstroke_Arrowstyle {
  GP_STROKE_ARROWSTYLE_NONE = 0 , GP_STROKE_ARROWSTYLE_SEGMENT = 2 , GP_STROKE_ARROWSTYLE_OPEN = 3 , GP_STROKE_ARROWSTYLE_CLOSED = 4 ,
  GP_STROKE_ARROWSTYLE_SQUARE = 6
}
enum  eGPDframe_Flag { GP_FRAME_PAINT = (1 << 0) , GP_FRAME_SELECT = (1 << 1) , GP_FRAME_LRT_CLEARED = (1 << 2) }
enum  ebGPDlayer_Mask_Flag { GP_MASK_HIDE = (1 << 0) , GP_MASK_INVERT = (1 << 1) }
enum  eGPDlayer_Flag {
  GP_LAYER_HIDE = (1 << 0) , GP_LAYER_LOCKED = (1 << 1) , GP_LAYER_ACTIVE = (1 << 2) , GP_LAYER_DRAWDEBUG = (1 << 3) ,
  GP_LAYER_SOLO_MODE = (1 << 4) , GP_LAYER_SELECT = (1 << 5) , GP_LAYER_FRAMELOCK = (1 << 6) , GP_LAYER_NO_XRAY = (1 << 7) ,
  GP_LAYER_VOLUMETRIC = (1 << 10) , GP_LAYER_USE_LIGHTS = (1 << 11) , GP_LAYER_UNLOCK_COLOR = (1 << 12) , GP_LAYER_USE_MASK = (1 << 13) ,
  GP_LAYER_IS_RULER = (1 << 14) , GP_LAYER_DISABLE_MASKS_IN_VIEWLAYER = (1 << 15)
}
enum  eGPDlayer_OnionFlag { GP_LAYER_ONIONSKIN = (1 << 0) , GP_LAYER_ONIONSKIN_CUSTOM_COLOR = (1 << 1) }
enum  eGPLayerBlendModes {
  eGplBlendMode_Regular = 0 , eGplBlendMode_HardLight = 1 , eGplBlendMode_Add = 2 , eGplBlendMode_Subtract = 3 ,
  eGplBlendMode_Multiply = 4 , eGplBlendMode_Divide = 5
}
enum  eGPdata_Flag {
  GP_DATA_ANNOTATIONS = (1 << 0) , GP_DATA_DISPINFO = (1 << 1) , GP_DATA_EXPAND = (1 << 2) , GP_DATA_VIEWALIGN = (1 << 4) ,
  GP_DATA_DEPTH_VIEW = (1 << 5) , GP_DATA_DEPTH_STROKE = (1 << 6) , GP_DATA_DEPTH_STROKE_ENDPOINTS = (1 << 7) , GP_DATA_STROKE_EDITMODE = (1 << 8) ,
  GP_DATA_SHOW_ONIONSKINS = (1 << 9) , GP_DATA_CACHE_IS_DIRTY = (1 << 11) , GP_DATA_STROKE_PAINTMODE = (1 << 12) , GP_DATA_STROKE_SCULPTMODE = (1 << 13) ,
  GP_DATA_STROKE_WEIGHTMODE = (1 << 14) , GP_DATA_STROKE_KEEPTHICKNESS = (1 << 15) , GP_DATA_STROKE_MULTIEDIT = (1 << 16) , GP_DATA_STROKE_VERTEXMODE = (1 << 18) ,
  GP_DATA_AUTOLOCK_LAYERS = (1 << 20) , GP_DATA_CURVE_EDIT_MODE = (1 << 21) , GP_DATA_CURVE_ADAPTIVE_RESOLUTION = (1 << 22)
}
enum  eGPD_OnionFlag {
  GP_ONION_GHOST_PREVCOL = (1 << 0) , GP_ONION_GHOST_NEXTCOL = (1 << 1) , GP_ONION_GHOST_ALWAYS = (1 << 2) , GP_ONION_FADE = (1 << 3) ,
  GP_ONION_LOOP = (1 << 4)
}
enum  eGP_OnionModes { GP_ONION_MODE_ABSOLUTE = 0 , GP_ONION_MODE_RELATIVE = 1 , GP_ONION_MODE_SELECTED = 2 }
enum  eGP_DepthOrdering { GP_XRAY_FRONT = 0 , GP_XRAY_3DSPACE = 1 }
enum  eGP_DrawMode { GP_DRAWMODE_2D = 0 , GP_DRAWMODE_3D = 1 }

Macro Definition Documentation

◆ GP_DEFAULT_CURVE_EDIT_CORNER_ANGLE

#define GP_DEFAULT_CURVE_EDIT_CORNER_ANGLE   M_PI_2

Definition at line 24 of file DNA_gpencil_legacy_types.h.

Referenced by BKE_gpencil_data_addnew(), and blo_do_versions_290().

◆ GP_DEFAULT_CURVE_ERROR

#define GP_DEFAULT_CURVE_ERROR   0.1f

Definition at line 23 of file DNA_gpencil_legacy_types.h.

Referenced by BKE_gpencil_data_addnew(), and blo_do_versions_290().

◆ GP_DEFAULT_CURVE_RESOLUTION

#define GP_DEFAULT_CURVE_RESOLUTION   32

Definition at line 22 of file DNA_gpencil_legacy_types.h.

Referenced by BKE_gpencil_data_addnew(), and blo_do_versions_290().

◆ GP_DEFAULT_GRID_LINES

#define GP_DEFAULT_GRID_LINES   4

Definition at line 19 of file DNA_gpencil_legacy_types.h.

Referenced by BKE_gpencil_data_addnew(), and blo_do_versions_280().

◆ GP_DEFAULT_PIX_FACTOR

#define GP_DEFAULT_PIX_FACTOR   1.0f

Definition at line 18 of file DNA_gpencil_legacy_types.h.

Referenced by BKE_gpencil_data_addnew(), and blo_do_versions_280().

◆ GP_MAX_INPUT_SAMPLES

#define GP_MAX_INPUT_SAMPLES   10

Definition at line 20 of file DNA_gpencil_legacy_types.h.

Referenced by rna_def_gpencil_options().

◆ GPENCIL_MAX_FILL_FAC

#define GPENCIL_MAX_FILL_FAC   8.0f

Definition at line 27 of file DNA_gpencil_legacy_types.h.

Referenced by rna_def_gpencil_options().

◆ GPENCIL_MIN_FILL_FAC

#define GPENCIL_MIN_FILL_FAC   0.05f

Definition at line 26 of file DNA_gpencil_legacy_types.h.

Referenced by rna_def_gpencil_options().

Typedef Documentation

◆ bGPdata

typedef struct bGPdata bGPdata

Grease-Pencil Annotations - 'DataBlock'.

◆ bGPdata_Runtime

typedef struct bGPdata_Runtime bGPdata_Runtime

◆ bGPDcurve

typedef struct bGPDcurve bGPDcurve

◆ bGPDcurve_Flag

◆ bGPDcurve_point

typedef struct bGPDcurve_point bGPDcurve_point

◆ bGPDframe

typedef struct bGPDframe bGPDframe

Grease-Pencil Annotations - 'Frame' -> Acts as storage for the 'image' formed by strokes

◆ bGPDframe_Runtime

typedef struct bGPDframe_Runtime bGPDframe_Runtime

◆ bGPDlayer

typedef struct bGPDlayer bGPDlayer

Grease-Pencil Annotations - 'Layer'.

◆ bGPDlayer_Mask

typedef struct bGPDlayer_Mask bGPDlayer_Mask

◆ bGPDlayer_Runtime

typedef struct bGPDlayer_Runtime bGPDlayer_Runtime

Runtime temp data for bGPDlayer.

◆ bGPDpalette

typedef struct bGPDpalette bGPDpalette

◆ bGPDpalettecolor

typedef struct bGPDpalettecolor bGPDpalettecolor

◆ bGPDspoint

typedef struct bGPDspoint bGPDspoint

Grease-Pencil Annotations - 'Stroke Point' -> Coordinates may either be 2d or 3d depending on settings at the time -> Coordinates of point on stroke, in proportions of window size This assumes that the bottom-left corner is (0,0)

◆ bGPDstroke

typedef struct bGPDstroke bGPDstroke

Grease-Pencil Annotations - 'Stroke' -> A stroke represents a (simplified version) of the curve drawn by the user in one 'mouse-down'->'mouse-up' operation

◆ bGPDstroke_Runtime

typedef struct bGPDstroke_Runtime bGPDstroke_Runtime

◆ bGPDtriangle

typedef struct bGPDtriangle bGPDtriangle

◆ bGPgrid

typedef struct bGPgrid bGPgrid

◆ ebGPDlayer_Mask_Flag

◆ eGP_DepthOrdering

◆ eGP_DrawMode

◆ eGP_OnionModes

◆ eGPD_OnionFlag

◆ eGPdata_Flag

bGPdata.flag

NOTE: A few flags have been deprecated since early 2.5, since they have been made redundant by interaction changes made during the porting process.

◆ eGPDcurve_point_Flag

◆ eGPDframe_Flag

◆ eGPDlayer_Flag

◆ eGPDlayer_OnionFlag

◆ eGPDpalette_Flag

◆ eGPDpalettecolor_Flag

◆ eGPDstroke_Arrowstyle

#bGPDataRuntime.arrowstyle

◆ eGPDstroke_Flag

◆ eGPLayerBlendModes

◆ eGPSPoint_Flag

◆ GPDstroke_Caps

Enumeration Type Documentation

◆ bGPDcurve_Flag

Enumerator
GP_CURVE_NEEDS_STROKE_UPDATE 
GP_CURVE_SELECT 

Definition at line 190 of file DNA_gpencil_legacy_types.h.

◆ ebGPDlayer_Mask_Flag

Enumerator
GP_MASK_HIDE 
GP_MASK_INVERT 

Definition at line 407 of file DNA_gpencil_legacy_types.h.

◆ eGP_DepthOrdering

Enumerator
GP_XRAY_FRONT 
GP_XRAY_3DSPACE 

Definition at line 793 of file DNA_gpencil_legacy_types.h.

◆ eGP_DrawMode

Enumerator
GP_DRAWMODE_2D 
GP_DRAWMODE_3D 

Definition at line 799 of file DNA_gpencil_legacy_types.h.

◆ eGP_OnionModes

Enumerator
GP_ONION_MODE_ABSOLUTE 
GP_ONION_MODE_RELATIVE 
GP_ONION_MODE_SELECTED 

Definition at line 786 of file DNA_gpencil_legacy_types.h.

◆ eGPD_OnionFlag

Enumerator
GP_ONION_GHOST_PREVCOL 
GP_ONION_GHOST_NEXTCOL 
GP_ONION_GHOST_ALWAYS 
GP_ONION_FADE 
GP_ONION_LOOP 

Definition at line 772 of file DNA_gpencil_legacy_types.h.

◆ eGPdata_Flag

bGPdata.flag

NOTE: A few flags have been deprecated since early 2.5, since they have been made redundant by interaction changes made during the porting process.

Enumerator
GP_DATA_ANNOTATIONS 
GP_DATA_DISPINFO 
GP_DATA_EXPAND 
GP_DATA_VIEWALIGN 
GP_DATA_DEPTH_VIEW 
GP_DATA_DEPTH_STROKE 
GP_DATA_DEPTH_STROKE_ENDPOINTS 
GP_DATA_STROKE_EDITMODE 
GP_DATA_SHOW_ONIONSKINS 
GP_DATA_CACHE_IS_DIRTY 
GP_DATA_STROKE_PAINTMODE 
GP_DATA_STROKE_SCULPTMODE 
GP_DATA_STROKE_WEIGHTMODE 
GP_DATA_STROKE_KEEPTHICKNESS 
GP_DATA_STROKE_MULTIEDIT 
GP_DATA_STROKE_VERTEXMODE 
GP_DATA_AUTOLOCK_LAYERS 
GP_DATA_CURVE_EDIT_MODE 
GP_DATA_CURVE_ADAPTIVE_RESOLUTION 

Definition at line 709 of file DNA_gpencil_legacy_types.h.

◆ eGPDcurve_point_Flag

Enumerator
GP_CURVE_POINT_SELECT 

Definition at line 169 of file DNA_gpencil_legacy_types.h.

◆ eGPDframe_Flag

Enumerator
GP_FRAME_PAINT 
GP_FRAME_SELECT 
GP_FRAME_LRT_CLEARED 

Definition at line 382 of file DNA_gpencil_legacy_types.h.

◆ eGPDlayer_Flag

Enumerator
GP_LAYER_HIDE 
GP_LAYER_LOCKED 
GP_LAYER_ACTIVE 
GP_LAYER_DRAWDEBUG 
GP_LAYER_SOLO_MODE 
GP_LAYER_SELECT 
GP_LAYER_FRAMELOCK 
GP_LAYER_NO_XRAY 
GP_LAYER_VOLUMETRIC 
GP_LAYER_USE_LIGHTS 
GP_LAYER_UNLOCK_COLOR 
GP_LAYER_USE_MASK 
GP_LAYER_IS_RULER 
GP_LAYER_DISABLE_MASKS_IN_VIEWLAYER 

Definition at line 509 of file DNA_gpencil_legacy_types.h.

◆ eGPDlayer_OnionFlag

bGPDlayer.onion_flag

Enumerator
GP_LAYER_ONIONSKIN 
GP_LAYER_ONIONSKIN_CUSTOM_COLOR 

Definition at line 541 of file DNA_gpencil_legacy_types.h.

◆ eGPDpalette_Flag

bGPDpalette.flag

Enumerator
PL_PALETTE_ACTIVE 

Definition at line 135 of file DNA_gpencil_legacy_types.h.

◆ eGPDpalettecolor_Flag

bGPDpalettecolor.flag

Enumerator
PC_COLOR_HIDE 
PC_COLOR_LOCKED 
PC_COLOR_ONIONSKIN 
PC_COLOR_VOLUMETRIC 

Definition at line 106 of file DNA_gpencil_legacy_types.h.

◆ eGPDspoint_Flag

bGPDspoint.flag

Enumerator
GP_SPOINT_SELECT 
GP_SPOINT_TAG 

Definition at line 64 of file DNA_gpencil_legacy_types.h.

◆ eGPDstroke_Arrowstyle

#bGPDataRuntime.arrowstyle

Enumerator
GP_STROKE_ARROWSTYLE_NONE 
GP_STROKE_ARROWSTYLE_SEGMENT 
GP_STROKE_ARROWSTYLE_OPEN 
GP_STROKE_ARROWSTYLE_CLOSED 
GP_STROKE_ARROWSTYLE_SQUARE 

Definition at line 337 of file DNA_gpencil_legacy_types.h.

◆ eGPDstroke_Caps

bGPDstroke.caps

Enumerator
GP_STROKE_CAP_ROUND 
GP_STROKE_CAP_FLAT 
GP_STROKE_CAP_MAX 

Definition at line 325 of file DNA_gpencil_legacy_types.h.

◆ eGPDstroke_Flag

bGPDstroke.flag

Enumerator
GP_STROKE_3DSPACE 
GP_STROKE_2DSPACE 
GP_STROKE_2DIMAGE 
GP_STROKE_SELECT 
GP_STROKE_CYCLIC 
GP_STROKE_NOFILL 
GP_STROKE_NEEDS_CURVE_UPDATE 
GP_STROKE_HELP 
GP_STROKE_COLLIDE 
GP_STROKE_USE_ARROW_START 
GP_STROKE_USE_ARROW_END 
GP_STROKE_TAG 
GP_STROKE_ERASER 

Definition at line 293 of file DNA_gpencil_legacy_types.h.

◆ eGPLayerBlendModes

bGPDlayer.blend_mode

Enumerator
eGplBlendMode_Regular 
eGplBlendMode_HardLight 
eGplBlendMode_Add 
eGplBlendMode_Subtract 
eGplBlendMode_Multiply 
eGplBlendMode_Divide 

Definition at line 548 of file DNA_gpencil_legacy_types.h.