Blender V5.3
DNA_object_types.h File Reference

Object is a sort of wrapper for general info. More...

#include "BLI_enum_flags.hh"
#include "BLI_math_constants.hh"
#include "BLI_math_matrix_types.hh"
#include "DNA_object_enums.h"
#include "DNA_ID.h"
#include "DNA_action_types.h"
#include "DNA_defs.h"
#include "DNA_listBase.h"
#include "DNA_vec_defaults.h"

Go to the source code of this file.

Classes

struct  blender::bDeformGroup
struct  blender::BoundBox
struct  blender::ObjectLineArt
struct  blender::LightLinkingRuntime
struct  blender::LightLinking
struct  blender::Object
struct  blender::ObHook

Namespaces

namespace  blender
 BMesh Iterators.
namespace  blender::bke

Macros

#define MAX_VGROUP_NAME   64
#define SELECT   1
#define OB_TYPE_SUPPORT_MATERIAL(_type)
#define OB_TYPE_IS_GEOMETRY(_type)
#define OB_TYPE_SUPPORT_VGROUP(_type)
#define OB_TYPE_SUPPORT_EDITMODE(_type)
#define OB_TYPE_SUPPORT_PARVERT(_type)
#define OB_DATA_SUPPORT_EDITMODE(_type)
#define OB_DATA_SUPPORT_ID(_id_type)
#define OB_DATA_SUPPORT_ID_CASE

Enumerations

enum  blender::ebDeformGroup_Flag : char { blender::DG_LOCK_WEIGHT = 1 }
enum  blender::eObject_Flag : short {
  blender::OB_SELECT = (1 << 0) , blender::BA_WAS_SEL = (1 << 1) , blender::BA_SNAP_FIX_DEPS_FIASCO = (1 << 2) , blender::BA_TEMP_TAG = 1 << 5 ,
  blender::BA_TRANSFORM_LOCKED_IN_PLACE = 1 << 7 , blender::BA_TRANSFORM_CHILD = 1 << 8 , blender::BA_TRANSFORM_PARENT = 1 << 13 , blender::OB_FROMDUPLI = 1 << 9 ,
  blender::OB_DONE = 1 << 10 , blender::OB_FLAG_USE_SIMULATION_CACHE = 1 << 11 , blender::OB_FLAG_ACTIVE_CLIPBOARD = 1 << 12
}
enum  blender::ObjectType : short {
  blender::OB_EMPTY = 0 , blender::OB_MESH = 1 , blender::OB_CURVES_LEGACY = 2 , blender::OB_SURF = 3 ,
  blender::OB_FONT = 4 , blender::OB_MBALL = 5 , blender::OB_LAMP = 10 , blender::OB_CAMERA = 11 ,
  blender::OB_SPEAKER = 12 , blender::OB_LIGHTPROBE = 13 , blender::OB_LATTICE = 22 , blender::OB_ARMATURE = 25 ,
  blender::OB_GPENCIL_LEGACY = 26 , blender::OB_CURVES = 27 , blender::OB_POINTCLOUD = 28 , blender::OB_VOLUME = 29 ,
  blender::OB_GREASE_PENCIL = 30 , blender::OB_TYPE_MAX
}
enum  blender::eObject_Partype : short {
  blender::PAROBJECT = 0 , blender::PARSKEL = 4 , blender::PARVERT1 = 5 , blender::PARVERT3 = 6 ,
  blender::PARBONE = 7 , blender::PARTYPE = (1 << 4) - 1
}
enum  blender::eObject_TransFlag : short {
  blender::OB_TRANSFORM_ADJUST_ROOT_PARENT_FOR_VIEW_LOCK = 1 << 0 , blender::OB_TRANSFLAG_UNUSED_1 = 1 << 1 , blender::OB_NEG_SCALE = 1 << 2 , blender::OB_TRANSFLAG_UNUSED_3 = 1 << 3 ,
  blender::OB_DUPLIVERTS = 1 << 4 , blender::OB_DUPLIROT = 1 << 5 , blender::OB_TRANSFLAG_UNUSED_6 = 1 << 6 , blender::OB_TRANSFLAG_UNUSED_7 = 1 << 7 ,
  blender::OB_DUPLICOLLECTION = 1 << 8 , blender::OB_DUPLIFACES = 1 << 9 , blender::OB_DUPLIFACES_SCALE = 1 << 10 , blender::OB_DUPLIPARTS = 1 << 11 ,
  blender::OB_TRANSFLAG_UNUSED_12 = 1 << 12 , blender::OB_NO_CONSTRAINTS = 1 << 13 , blender::OB_PARENT_USE_FINAL_INDICES = 1 << 14 , blender::OB_DUPLI = OB_DUPLIVERTS | OB_DUPLICOLLECTION | OB_DUPLIFACES | OB_DUPLIPARTS
}
enum  blender::eObject_Axis : short {
  blender::OB_POSX = 0 , blender::OB_POSY = 1 , blender::OB_POSZ = 2 , blender::OB_NEGX = 3 ,
  blender::OB_NEGY = 4 , blender::OB_NEGZ = 5
}
enum  blender::eObject_DrawExtraFlag : short {
  blender::OB_DRAWBOUNDOX = 1 << 0 , blender::OB_AXIS = 1 << 1 , blender::OB_TEXSPACE = 1 << 2 , blender::OB_DRAWNAME = 1 << 3 ,
  blender::OB_DRAWWIRE = 1 << 5 , blender::OB_DRAW_IN_FRONT = 1 << 6 , blender::OB_DRAWTRANSP = 1 << 7 , blender::OB_DRAW_ALL_EDGES = 1 << 8 ,
  blender::OB_DRAW_NO_SHADOW_CAST = 1 << 9 , blender::OB_USE_GPENCIL_LIGHTS = 1 << 10
}
enum  blender::eObject_EmptyDrawType : char {
  blender::OB_ARROWS = 1 , blender::OB_PLAINAXES = 2 , blender::OB_CIRCLE = 3 , blender::OB_SINGLE_ARROW = 4 ,
  blender::OB_CUBE = 5 , blender::OB_EMPTY_SPHERE = 6 , blender::OB_EMPTY_CONE = 7 , blender::OB_EMPTY_IMAGE = 8
}
enum  blender::eGpencil_AddType : int {
  blender::GP_EMPTY = 0 , blender::GP_STROKE = 1 , blender::GP_MONKEY = 2 , blender::GREASE_PENCIL_LINEART_SCENE = 3 ,
  blender::GREASE_PENCIL_LINEART_OBJECT = 4 , blender::GREASE_PENCIL_LINEART_COLLECTION = 5
}
enum  blender::eObject_BoundType : char {
  blender::OB_BOUND_BOX = 0 , blender::OB_BOUND_SPHERE = 1 , blender::OB_BOUND_CYLINDER = 2 , blender::OB_BOUND_CONE = 3 ,
  blender::OB_BOUND_CAPSULE = 7
}
enum  blender::eObject_VisibilityFlag : int {
  blender::OB_HIDE_VIEWPORT = 1 << 0 , blender::OB_HIDE_SELECT = 1 << 1 , blender::OB_HIDE_RENDER = 1 << 2 , blender::OB_HIDE_CAMERA = 1 << 3 ,
  blender::OB_HIDE_DIFFUSE = 1 << 4 , blender::OB_HIDE_GLOSSY = 1 << 5 , blender::OB_HIDE_TRANSMISSION = 1 << 6 , blender::OB_HIDE_VOLUME_SCATTER = 1 << 7 ,
  blender::OB_HIDE_SHADOW = 1 << 8 , blender::OB_HOLDOUT = 1 << 9 , blender::OB_SHADOW_CATCHER = 1 << 10 , blender::OB_HIDE_PROBE_VOLUME = 1 << 11 ,
  blender::OB_HIDE_PROBE_CUBEMAP = 1 << 12 , blender::OB_HIDE_PROBE_PLANAR = 1 << 13 , blender::OB_HIDE_SURFACE_PICK = 1 << 14 , blender::OB_HIDE_RAYCAST = 1 << 15
}
enum  blender::eObject_ShapeFlag : char { blender::OB_SHAPE_LOCK = 1 << 0 , blender::OB_SHAPE_EDIT_MODE = 1 << 2 }
enum  blender::eObject_NlaFlag : short { blender::OB_ADS_UNUSED_1 = 1 << 0 , blender::OB_ADS_UNUSED_2 = 1 << 1 , blender::OB_ADS_COLLAPSED = 1 << 10 }
enum  blender::eObject_ProtectFlag : short {
  blender::OB_LOCK_LOCX = 1 << 0 , blender::OB_LOCK_LOCY = 1 << 1 , blender::OB_LOCK_LOCZ = 1 << 2 , blender::OB_LOCK_LOC = OB_LOCK_LOCX | OB_LOCK_LOCY | OB_LOCK_LOCZ ,
  blender::OB_LOCK_ROTX = 1 << 3 , blender::OB_LOCK_ROTY = 1 << 4 , blender::OB_LOCK_ROTZ = 1 << 5 , blender::OB_LOCK_ROT = OB_LOCK_ROTX | OB_LOCK_ROTY | OB_LOCK_ROTZ ,
  blender::OB_LOCK_SCALEX = 1 << 6 , blender::OB_LOCK_SCALEY = 1 << 7 , blender::OB_LOCK_SCALEZ = 1 << 8 , blender::OB_LOCK_SCALE = OB_LOCK_SCALEX | OB_LOCK_SCALEY | OB_LOCK_SCALEZ ,
  blender::OB_LOCK_ROTW = 1 << 9 , blender::OB_LOCK_ROT4D = 1 << 10
}
enum  blender::eObject_DuplicatorVisibilityFlag : char { blender::OB_DUPLI_FLAG_VIEWPORT = 1 << 0 , blender::OB_DUPLI_FLAG_RENDER = 1 << 1 }
enum  blender::eObject_EmptyImageDepth : char { blender::OB_EMPTY_IMAGE_DEPTH_DEFAULT = 0 , blender::OB_EMPTY_IMAGE_DEPTH_FRONT = 1 , blender::OB_EMPTY_IMAGE_DEPTH_BACK = 2 }
enum  blender::eObject_EmptyImageVisibilityFlag : char {
  blender::OB_EMPTY_IMAGE_HIDE_PERSPECTIVE = 1 << 0 , blender::OB_EMPTY_IMAGE_HIDE_ORTHOGRAPHIC = 1 << 1 , blender::OB_EMPTY_IMAGE_HIDE_BACK = 1 << 2 , blender::OB_EMPTY_IMAGE_HIDE_FRONT = 1 << 3 ,
  blender::OB_EMPTY_IMAGE_HIDE_NON_AXIS_ALIGNED = 1 << 4
}
enum  blender::eObject_EmptyImageFlag : char { blender::OB_EMPTY_IMAGE_USE_ALPHA_BLEND = 1 << 0 }
enum  blender::ObjectModifierFlag : uchar { blender::OB_MODIFIER_FLAG_ADD_REST_POSITION = 1 << 0 }
enum  blender::eObjectLineArt_Usage : short {
  blender::OBJECT_LRT_INHERIT = 0 , blender::OBJECT_LRT_INCLUDE = (1 << 0) , blender::OBJECT_LRT_OCCLUSION_ONLY = (1 << 1) , blender::OBJECT_LRT_EXCLUDE = (1 << 2) ,
  blender::OBJECT_LRT_INTERSECTION_ONLY = (1 << 3) , blender::OBJECT_LRT_NO_INTERSECTION = (1 << 4) , blender::OBJECT_LRT_FORCE_INTERSECTION = (1 << 5)
}
enum  blender::eObjectLineArt_Flags : short { blender::OBJECT_LRT_OWN_CREASE = (1 << 0) , blender::OBJECT_LRT_OWN_INTERSECTION_PRIORITY = (1 << 1) }

Functions

 blender::ENUM_OPERATORS (eObjectLineArt_Usage)

Detailed Description

Object is a sort of wrapper for general info.

Definition in file DNA_object_types.h.

Macro Definition Documentation

◆ MAX_VGROUP_NAME

◆ OB_DATA_SUPPORT_EDITMODE

#define OB_DATA_SUPPORT_EDITMODE ( _type)
Value:
(ELEM(_type, ID_ME, ID_CU_LEGACY, ID_MB, ID_LT, ID_AR, ID_CV, ID_GP))
#define ELEM(...)

Matches OB_TYPE_SUPPORT_EDITMODE.

Definition at line 753 of file DNA_object_types.h.

Referenced by blender::BKE_object_data_is_in_editmode(), blender::deg::deg_update_eval_copy_datablock(), blender::ed_undo_push_check_id_changes_fn(), and blender::ed::outliner::is_object_data_in_editmode().

◆ OB_DATA_SUPPORT_ID

◆ OB_DATA_SUPPORT_ID_CASE

#define OB_DATA_SUPPORT_ID_CASE
Value:
ID_ME: \
case ID_CU_LEGACY: \
case ID_MB: \
case ID_LA: \
case ID_SPK: \
case ID_LP: \
case ID_CA: \
case ID_LT: \
case ID_GD_LEGACY: \
case ID_AR: \
case ID_CV: \
case ID_PT: \
case ID_VO: \
case ID_GP

Definition at line 774 of file DNA_object_types.h.

Referenced by blender::wm_context_member_from_ptr().

◆ OB_TYPE_IS_GEOMETRY

#define OB_TYPE_IS_GEOMETRY ( _type)
Value:
(ELEM(_type, \
OB_MESH, \
OB_SURF, \
OB_FONT, \
OB_MBALL, \
OB_CURVES_LEGACY, \
OB_CURVES, \
OB_POINTCLOUD, \
OB_VOLUME, \
OB_GREASE_PENCIL))

Does the object have some render-able geometry (unlike empties, cameras, etc.). True for #OB_CURVES_LEGACY, since these often evaluate to objects with geometry.

Definition at line 722 of file DNA_object_types.h.

Referenced by blender::deg::DepsgraphRelationBuilder::build_driver_variables(), blender::object_preview_is_type_supported(), and blender::ed::outliner::outliner_draw_restrictbuts().

◆ OB_TYPE_SUPPORT_EDITMODE

#define OB_TYPE_SUPPORT_EDITMODE ( _type)
Value:
(ELEM(_type, \
OB_MESH, \
OB_FONT, \
OB_CURVES_LEGACY, \
OB_SURF, \
OB_MBALL, \
OB_LATTICE, \
OB_ARMATURE, \
OB_CURVES, \
OB_POINTCLOUD, \
OB_GREASE_PENCIL))

Definition at line 736 of file DNA_object_types.h.

Referenced by blender::ed::object::editmode_toggle_poll(), blender::ed::outliner::outliner_item_mode_toggle(), and blender::view3d_panel_transform().

◆ OB_TYPE_SUPPORT_MATERIAL

#define OB_TYPE_SUPPORT_MATERIAL ( _type)
Value:
(((_type) >= OB_MESH && (_type) <= OB_MBALL) || \
((_type) >= OB_CURVES && (_type) <= OB_GREASE_PENCIL))

Definition at line 714 of file DNA_object_types.h.

Referenced by blender::ed::object::allow_make_links_data(), blender::buttons_context(), blender::buttons_context_path_material(), blender::object_materials_supported_poll_ex(), blender::ed::space_node::preview_prepare_scene(), and blender::preview_prepare_scene().

◆ OB_TYPE_SUPPORT_PARVERT

#define OB_TYPE_SUPPORT_PARVERT ( _type)
Value:
(ELEM(_type, OB_MESH, OB_SURF, OB_CURVES_LEGACY, OB_LATTICE))

Definition at line 749 of file DNA_object_types.h.

Referenced by blender::ob_parvert3(), and blender::ed::object::parent_set_invoke_menu().

◆ OB_TYPE_SUPPORT_VGROUP

◆ SELECT

#define SELECT   1

This is used as a flag for many kinds of data that use selections, examples include:

  • #BezTriple.f1, #BezTriple.f2, #BezTriple.f3
  • #bNode.flag
  • #MovieTrackingTrack.flag And more, ideally this would have a generic location.

Definition at line 711 of file DNA_object_types.h.