2011-02-18 14:05:18 +01:00
|
|
|
/*
|
2005-07-19 22:14:17 +02:00
|
|
|
* 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
|
2008-04-17 00:40:48 +02:00
|
|
|
* of the License, or (at your option) any later version.
|
2005-07-19 22:14:17 +02:00
|
|
|
*
|
|
|
|
* 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,
|
2010-02-12 14:34:04 +01:00
|
|
|
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
|
2005-07-19 22:14:17 +02:00
|
|
|
*/
|
2012-02-17 19:59:41 +01:00
|
|
|
#pragma once
|
2005-07-19 22:14:17 +02:00
|
|
|
|
2019-02-17 22:08:12 +01:00
|
|
|
/** \file
|
|
|
|
* \ingroup bke
|
2011-02-18 14:05:18 +01:00
|
|
|
*/
|
|
|
|
|
2006-12-05 18:42:03 +01:00
|
|
|
#include "BKE_customdata.h"
|
2020-03-19 09:33:03 +01:00
|
|
|
#include "BLI_compiler_attrs.h"
|
|
|
|
#include "DNA_modifier_types.h" /* needed for all enum typdefs */
|
2006-12-05 18:42:03 +01:00
|
|
|
|
2020-02-07 17:22:11 +01:00
|
|
|
#ifdef __cplusplus
|
|
|
|
extern "C" {
|
|
|
|
#endif
|
|
|
|
|
2020-06-05 16:41:03 +02:00
|
|
|
struct ARegionType;
|
2019-01-28 11:08:24 +01:00
|
|
|
struct BMEditMesh;
|
2020-09-30 03:51:13 +02:00
|
|
|
struct BlendDataReader;
|
2020-11-06 17:13:04 +01:00
|
|
|
struct BlendLibReader;
|
2020-09-30 03:51:13 +02:00
|
|
|
struct BlendWriter;
|
Refactor CDData masks, to have one mask per mesh elem type.
We already have different storages for cddata of verts, edges etc.,
'simply' do the same for the mask flags we use all around Blender code
to request some data, or limit some operation to some layers, etc.
Reason we need this is that some cddata types (like Normals) are
actually shared between verts/polys/loops, and we don’t want to generate
clnors everytime we request vnors!
As a side note, this also does final fix to T59338, which was the
trigger for this patch (need to request computed loop normals for
another mesh than evaluated one).
Reviewers: brecht, campbellbarton, sergey
Differential Revision: https://developer.blender.org/D4407
2019-03-07 11:13:40 +01:00
|
|
|
struct CustomData_MeshMasks;
|
2019-01-28 11:08:24 +01:00
|
|
|
struct DepsNodeHandle;
|
2018-04-06 12:07:27 +02:00
|
|
|
struct Depsgraph;
|
2020-12-16 06:26:23 +01:00
|
|
|
struct GeometrySet;
|
2019-01-28 11:08:24 +01:00
|
|
|
struct ID;
|
|
|
|
struct ListBase;
|
|
|
|
struct Main;
|
2018-04-18 15:45:54 +02:00
|
|
|
struct Mesh;
|
2019-01-28 11:08:24 +01:00
|
|
|
struct ModifierData;
|
2005-07-19 22:14:17 +02:00
|
|
|
struct Object;
|
2009-01-04 15:14:06 +01:00
|
|
|
struct Scene;
|
2006-06-21 17:14:44 +02:00
|
|
|
struct bArmature;
|
2005-07-19 22:14:17 +02:00
|
|
|
|
|
|
|
typedef enum {
|
2006-08-28 03:12:36 +02:00
|
|
|
/* Should not be used, only for None modifier type */
|
2005-07-19 22:14:17 +02:00
|
|
|
eModifierTypeType_None,
|
2019-04-17 06:17:24 +02:00
|
|
|
|
2020-06-17 06:00:09 +02:00
|
|
|
/**
|
|
|
|
* Modifier only does deformation, implies that modifier
|
2006-08-28 03:12:36 +02:00
|
|
|
* type should have a valid deformVerts function. OnlyDeform
|
|
|
|
* style modifiers implicitly accept either mesh or CV
|
|
|
|
* input but should still declare flags appropriately.
|
|
|
|
*/
|
2005-07-19 22:14:17 +02:00
|
|
|
eModifierTypeType_OnlyDeform,
|
2019-04-17 06:17:24 +02:00
|
|
|
|
2020-06-17 06:00:09 +02:00
|
|
|
/** Modifier adds geometry. */
|
2005-07-19 22:14:17 +02:00
|
|
|
eModifierTypeType_Constructive,
|
2019-10-10 13:25:44 +02:00
|
|
|
/* Modifier can add and remove geometry. */
|
2005-07-19 22:14:17 +02:00
|
|
|
eModifierTypeType_Nonconstructive,
|
2019-04-17 06:17:24 +02:00
|
|
|
|
2020-06-17 06:00:09 +02:00
|
|
|
/**
|
|
|
|
* Both deformVerts & applyModifier are valid calls
|
Particles
=========
Merge of the famous particle patch by Janne Karhu, a full rewrite
of the Blender particle system. This includes:
- Emitter, Hair and Reactor particle types.
- Newtonian, Keyed and Boids physics.
- Various particle visualisation and rendering types.
- Vertex group and texture control for various properties.
- Interpolated child particles from parents.
- Hair editing with combing, growing, cutting, .. .
- Explode modifier.
- Harmonic, Magnetic fields, and multiple falloff types.
.. and lots of other things, some more info is here:
http://wiki.blender.org/index.php/BlenderDev/Particles_Rewrite
http://wiki.blender.org/index.php/BlenderDev/Particles_Rewrite_Doc
The new particle system cannot be backwards compatible. Old particle
systems are being converted to the new system, but will require
tweaking to get them looking the same as before.
Point Cache
===========
The new system to replace manual baking, based on automatic caching
on disk. This is currently used by softbodies and the particle system.
See the Cache API section on:
http://wiki.blender.org/index.php/BlenderDev/PhysicsSprint
Documentation
=============
These new features still need good docs for the release logs, help
for this is appreciated.
2007-11-26 23:09:57 +01:00
|
|
|
* used for particles modifier that doesn't actually modify the object
|
|
|
|
* unless it's a mesh and can be exploded -> curve can also emit particles
|
|
|
|
*/
|
2009-07-02 21:41:31 +02:00
|
|
|
eModifierTypeType_DeformOrConstruct,
|
2019-04-17 06:17:24 +02:00
|
|
|
|
2020-06-17 06:00:09 +02:00
|
|
|
/**
|
|
|
|
* Like eModifierTypeType_Nonconstructive, but does not affect the geometry
|
2011-12-20 15:15:59 +01:00
|
|
|
* of the object, rather some of its CustomData layers.
|
|
|
|
* E.g. UVProject and WeightVG modifiers. */
|
|
|
|
eModifierTypeType_NonGeometrical,
|
2005-07-19 22:14:17 +02:00
|
|
|
} ModifierTypeType;
|
|
|
|
|
|
|
|
typedef enum {
|
2012-05-12 22:39:39 +02:00
|
|
|
eModifierTypeFlag_AcceptsMesh = (1 << 0),
|
|
|
|
eModifierTypeFlag_AcceptsCVs = (1 << 1),
|
|
|
|
eModifierTypeFlag_SupportsMapping = (1 << 2),
|
|
|
|
eModifierTypeFlag_SupportsEditmode = (1 << 3),
|
2019-04-17 06:17:24 +02:00
|
|
|
|
2020-06-17 06:00:09 +02:00
|
|
|
/**
|
|
|
|
* For modifiers that support editmode this determines if the
|
2006-08-28 03:12:36 +02:00
|
|
|
* modifier should be enabled by default in editmode. This should
|
|
|
|
* only be used by modifiers that are relatively speedy and
|
|
|
|
* also generally used in editmode, otherwise let the user enable
|
|
|
|
* it by hand.
|
|
|
|
*/
|
2012-05-12 22:39:39 +02:00
|
|
|
eModifierTypeFlag_EnableInEditmode = (1 << 4),
|
2019-04-17 06:17:24 +02:00
|
|
|
|
2020-06-17 06:00:09 +02:00
|
|
|
/**
|
|
|
|
* For modifiers that require original data and so cannot
|
2006-08-28 03:12:36 +02:00
|
|
|
* be placed after any non-deformative modifier.
|
|
|
|
*/
|
2012-05-12 22:39:39 +02:00
|
|
|
eModifierTypeFlag_RequiresOriginalData = (1 << 5),
|
2019-04-17 06:17:24 +02:00
|
|
|
|
2020-06-17 06:00:09 +02:00
|
|
|
/**
|
|
|
|
* For modifiers that support pointcache,
|
|
|
|
* so we can check to see if it has files we need to deal with.
|
|
|
|
*/
|
2012-05-12 22:39:39 +02:00
|
|
|
eModifierTypeFlag_UsesPointCache = (1 << 6),
|
2019-04-17 06:17:24 +02:00
|
|
|
|
2020-06-17 06:00:09 +02:00
|
|
|
/** For physics modifiers, max one per type */
|
2012-05-12 22:39:39 +02:00
|
|
|
eModifierTypeFlag_Single = (1 << 7),
|
2019-04-17 06:17:24 +02:00
|
|
|
|
2020-06-17 06:00:09 +02:00
|
|
|
/** Some modifier can't be added manually by user */
|
2012-05-12 22:39:39 +02:00
|
|
|
eModifierTypeFlag_NoUserAdd = (1 << 8),
|
2019-04-17 06:17:24 +02:00
|
|
|
|
2020-06-17 06:00:09 +02:00
|
|
|
/** For modifiers that use CD_PREVIEW_MCOL for preview. */
|
2016-05-18 14:21:46 +02:00
|
|
|
eModifierTypeFlag_UsesPreview = (1 << 9),
|
2020-04-21 13:09:41 +02:00
|
|
|
eModifierTypeFlag_AcceptsVertexCosOnly = (1 << 10),
|
2020-05-25 12:16:42 +02:00
|
|
|
|
|
|
|
/** Accepts #BMesh input (without conversion). */
|
|
|
|
eModifierTypeFlag_AcceptsBMesh = (1 << 11),
|
2005-07-19 22:14:17 +02:00
|
|
|
} ModifierTypeFlag;
|
|
|
|
|
2017-01-31 10:41:25 +01:00
|
|
|
typedef void (*IDWalkFunc)(void *userData, struct Object *ob, struct ID **idpoin, int cb_flag);
|
2011-08-12 20:11:22 +02:00
|
|
|
typedef void (*TexWalkFunc)(void *userData,
|
|
|
|
struct Object *ob,
|
|
|
|
struct ModifierData *md,
|
|
|
|
const char *propname);
|
2006-08-28 03:12:36 +02:00
|
|
|
|
2012-05-09 17:00:26 +02:00
|
|
|
typedef enum ModifierApplyFlag {
|
2019-04-18 07:21:26 +02:00
|
|
|
/** Render time. */
|
|
|
|
MOD_APPLY_RENDER = 1 << 0,
|
|
|
|
/** Result of evaluation will be cached, so modifier might
|
|
|
|
* want to cache data for quick updates (used by subsurf) */
|
|
|
|
MOD_APPLY_USECACHE = 1 << 1,
|
|
|
|
/** Modifier evaluated for undeformed texture coordinates */
|
|
|
|
MOD_APPLY_ORCO = 1 << 2,
|
|
|
|
/** Ignore scene simplification flag and use subdivisions
|
|
|
|
* level set in multires modifier. */
|
|
|
|
MOD_APPLY_IGNORE_SIMPLIFY = 1 << 3,
|
2020-03-26 14:36:39 +01:00
|
|
|
/** The effect of this modifier will be applied to the base mesh
|
|
|
|
* The modifier itself will be removed from the modifier stack.
|
|
|
|
* This flag can be checked to ignore rendering display data to the mesh.
|
|
|
|
* See `OBJECT_OT_modifier_apply` operator. */
|
|
|
|
MOD_APPLY_TO_BASE_MESH = 1 << 4,
|
2012-05-09 17:00:26 +02:00
|
|
|
} ModifierApplyFlag;
|
|
|
|
|
2018-02-22 12:54:06 +01:00
|
|
|
typedef struct ModifierUpdateDepsgraphContext {
|
|
|
|
struct Scene *scene;
|
|
|
|
struct Object *object;
|
|
|
|
struct DepsNodeHandle *node;
|
|
|
|
} ModifierUpdateDepsgraphContext;
|
|
|
|
|
2018-05-01 17:33:04 +02:00
|
|
|
/* Contains the information for deformXXX and applyXXX functions below that
|
|
|
|
* doesn't change between consecutive modifiers. */
|
|
|
|
typedef struct ModifierEvalContext {
|
|
|
|
struct Depsgraph *depsgraph;
|
|
|
|
struct Object *object;
|
|
|
|
ModifierApplyFlag flag;
|
|
|
|
} ModifierEvalContext;
|
|
|
|
|
2005-07-19 22:14:17 +02:00
|
|
|
typedef struct ModifierTypeInfo {
|
2006-08-28 03:12:36 +02:00
|
|
|
/* The user visible name for this modifier */
|
- shuffled editmesh derived function name/function
- added ModifierTypeInfo.freeData function
- added modifier_{new,free] utility function
- added ccgSubSurf_getUseAgeCounts to query info
- removed subsurf modifier faking (ME_SUBSURF flag is no
longer valid). subsurf modifier gets converted on file load
although there is obscure linked mesh situation where this
can go wrong, will fix shortly. this also means that some
places in the code that test/copy subsurf settings are broken
for the time being.
- shuffled modifier calculation to be simpler. note that
all modifiers are currently disabled in editmode (including
subsurf). don't worry, will return shortly.
- bug fix, build modifier didn't randomize meshes with only verts
- cleaned up subsurf_ccg and adapted for future editmode modifier
work
- added editmesh.derived{Cage,Final}, not used yet
- added SubsurfModifierData.{mCache,emCache}, will be used to cache
subsurf instead of caching in derivedmesh itself
- removed old subsurf buttons
- added do_modifiers_buttons to handle modifier events
- removed count_object counting of modifier (subsurfed) objects...
this would be nice to add back at some point but requires care.
probably requires rewrite of counting system.
New feature: Incremental Subsurf in Object Mode
The previous release introduce incremental subsurf calculation during
editmode but it was not turned on during object mode. In general it
does not make sense to have it always enabled during object mode because
it requires caching a fair amount of information about the mesh which
is a waste of memory unless the mesh is often recalculated.
However, for mesh's that have subsurfed armatures for example, or that
have other modifiers so that the mesh is essentially changing on every
frame, it makes a lot of sense to keep the subsurf'd object around and
that is what the new incremental subsurf modifier toggle is for. The
intent is that the user will enable this option for (a) a mesh that is
currently under active editing or (b) a mesh that is heavily updated
in the scene, such as a character.
I will try to write more about this feature for release, because it
has advantages and disadvantages that are not immediately obvious (the
first user reaction will be to turn it on for ever object, which is
probably not correct).
2005-07-21 22:30:33 +02:00
|
|
|
char name[32];
|
2019-04-17 06:17:24 +02:00
|
|
|
|
2006-08-28 03:12:36 +02:00
|
|
|
/* The DNA struct name for the modifier data type, used to
|
|
|
|
* write the DNA data out.
|
|
|
|
*/
|
- shuffled editmesh derived function name/function
- added ModifierTypeInfo.freeData function
- added modifier_{new,free] utility function
- added ccgSubSurf_getUseAgeCounts to query info
- removed subsurf modifier faking (ME_SUBSURF flag is no
longer valid). subsurf modifier gets converted on file load
although there is obscure linked mesh situation where this
can go wrong, will fix shortly. this also means that some
places in the code that test/copy subsurf settings are broken
for the time being.
- shuffled modifier calculation to be simpler. note that
all modifiers are currently disabled in editmode (including
subsurf). don't worry, will return shortly.
- bug fix, build modifier didn't randomize meshes with only verts
- cleaned up subsurf_ccg and adapted for future editmode modifier
work
- added editmesh.derived{Cage,Final}, not used yet
- added SubsurfModifierData.{mCache,emCache}, will be used to cache
subsurf instead of caching in derivedmesh itself
- removed old subsurf buttons
- added do_modifiers_buttons to handle modifier events
- removed count_object counting of modifier (subsurfed) objects...
this would be nice to add back at some point but requires care.
probably requires rewrite of counting system.
New feature: Incremental Subsurf in Object Mode
The previous release introduce incremental subsurf calculation during
editmode but it was not turned on during object mode. In general it
does not make sense to have it always enabled during object mode because
it requires caching a fair amount of information about the mesh which
is a waste of memory unless the mesh is often recalculated.
However, for mesh's that have subsurfed armatures for example, or that
have other modifiers so that the mesh is essentially changing on every
frame, it makes a lot of sense to keep the subsurf'd object around and
that is what the new incremental subsurf modifier toggle is for. The
intent is that the user will enable this option for (a) a mesh that is
currently under active editing or (b) a mesh that is heavily updated
in the scene, such as a character.
I will try to write more about this feature for release, because it
has advantages and disadvantages that are not immediately obvious (the
first user reaction will be to turn it on for ever object, which is
probably not correct).
2005-07-21 22:30:33 +02:00
|
|
|
char structName[32];
|
2019-04-17 06:17:24 +02:00
|
|
|
|
2006-08-28 03:12:36 +02:00
|
|
|
/* The size of the modifier data type, used by allocation. */
|
- shuffled editmesh derived function name/function
- added ModifierTypeInfo.freeData function
- added modifier_{new,free] utility function
- added ccgSubSurf_getUseAgeCounts to query info
- removed subsurf modifier faking (ME_SUBSURF flag is no
longer valid). subsurf modifier gets converted on file load
although there is obscure linked mesh situation where this
can go wrong, will fix shortly. this also means that some
places in the code that test/copy subsurf settings are broken
for the time being.
- shuffled modifier calculation to be simpler. note that
all modifiers are currently disabled in editmode (including
subsurf). don't worry, will return shortly.
- bug fix, build modifier didn't randomize meshes with only verts
- cleaned up subsurf_ccg and adapted for future editmode modifier
work
- added editmesh.derived{Cage,Final}, not used yet
- added SubsurfModifierData.{mCache,emCache}, will be used to cache
subsurf instead of caching in derivedmesh itself
- removed old subsurf buttons
- added do_modifiers_buttons to handle modifier events
- removed count_object counting of modifier (subsurfed) objects...
this would be nice to add back at some point but requires care.
probably requires rewrite of counting system.
New feature: Incremental Subsurf in Object Mode
The previous release introduce incremental subsurf calculation during
editmode but it was not turned on during object mode. In general it
does not make sense to have it always enabled during object mode because
it requires caching a fair amount of information about the mesh which
is a waste of memory unless the mesh is often recalculated.
However, for mesh's that have subsurfed armatures for example, or that
have other modifiers so that the mesh is essentially changing on every
frame, it makes a lot of sense to keep the subsurf'd object around and
that is what the new incremental subsurf modifier toggle is for. The
intent is that the user will enable this option for (a) a mesh that is
currently under active editing or (b) a mesh that is heavily updated
in the scene, such as a character.
I will try to write more about this feature for release, because it
has advantages and disadvantages that are not immediately obvious (the
first user reaction will be to turn it on for ever object, which is
probably not correct).
2005-07-21 22:30:33 +02:00
|
|
|
int structSize;
|
2019-04-17 06:17:24 +02:00
|
|
|
|
2020-09-25 12:49:18 +02:00
|
|
|
/* StructRNA of this modifier. This is typically something like RNA_*Modifier. */
|
|
|
|
struct StructRNA *srna;
|
|
|
|
|
2005-07-19 22:14:17 +02:00
|
|
|
ModifierTypeType type;
|
|
|
|
ModifierTypeFlag flags;
|
2019-04-17 06:17:24 +02:00
|
|
|
|
2020-09-25 12:45:30 +02:00
|
|
|
/* Icon of the modifier. Usually something like ICON_MOD_*. */
|
|
|
|
int icon;
|
|
|
|
|
2006-08-28 03:12:36 +02:00
|
|
|
/********************* Non-optional functions *********************/
|
2019-04-17 06:17:24 +02:00
|
|
|
|
2020-06-17 06:00:09 +02:00
|
|
|
/**
|
|
|
|
* Copy instance data for this modifier type. Should copy all user
|
2006-08-28 03:12:36 +02:00
|
|
|
* level settings to the target modifier.
|
2018-07-04 12:45:30 +02:00
|
|
|
*
|
2020-02-10 12:58:59 +01:00
|
|
|
* \param flag: Copying options (see BKE_lib_id.h's LIB_ID_COPY_... flags for more).
|
2006-08-28 03:12:36 +02:00
|
|
|
*/
|
2018-07-04 12:45:30 +02:00
|
|
|
void (*copyData)(const struct ModifierData *md, struct ModifierData *target, const int flag);
|
2019-04-17 06:17:24 +02:00
|
|
|
|
2018-04-18 15:45:54 +02:00
|
|
|
/********************* Deform modifier functions *********************/
|
2019-04-17 06:17:24 +02:00
|
|
|
|
2020-06-17 06:00:09 +02:00
|
|
|
/**
|
|
|
|
* Only for deform types, should apply the deformation
|
2018-04-18 15:45:54 +02:00
|
|
|
* to the given vertex array. If the deformer requires information from
|
|
|
|
* the object it can obtain it from the mesh argument if non-NULL,
|
|
|
|
* and otherwise the ob argument.
|
|
|
|
*/
|
2018-05-01 17:33:04 +02:00
|
|
|
void (*deformVerts)(struct ModifierData *md,
|
|
|
|
const struct ModifierEvalContext *ctx,
|
|
|
|
struct Mesh *mesh,
|
|
|
|
float (*vertexCos)[3],
|
|
|
|
int numVerts);
|
2019-04-17 06:17:24 +02:00
|
|
|
|
2020-06-17 06:00:09 +02:00
|
|
|
/**
|
|
|
|
* Like deformMatricesEM but called from object mode (for supporting modifiers in sculpt mode).
|
|
|
|
*/
|
2018-05-01 17:33:04 +02:00
|
|
|
void (*deformMatrices)(struct ModifierData *md,
|
|
|
|
const struct ModifierEvalContext *ctx,
|
|
|
|
struct Mesh *mesh,
|
|
|
|
float (*vertexCos)[3],
|
|
|
|
float (*defMats)[3][3],
|
|
|
|
int numVerts);
|
2020-06-17 06:00:09 +02:00
|
|
|
/**
|
|
|
|
* Like deformVerts but called during editmode (for supporting modifiers)
|
2018-04-18 15:45:54 +02:00
|
|
|
*/
|
2018-05-01 17:33:04 +02:00
|
|
|
void (*deformVertsEM)(struct ModifierData *md,
|
|
|
|
const struct ModifierEvalContext *ctx,
|
|
|
|
struct BMEditMesh *editData,
|
|
|
|
struct Mesh *mesh,
|
|
|
|
float (*vertexCos)[3],
|
|
|
|
int numVerts);
|
2019-04-17 06:17:24 +02:00
|
|
|
|
2020-07-01 05:12:24 +02:00
|
|
|
/* Set deform matrix per vertex for crazy-space correction */
|
2018-05-01 17:33:04 +02:00
|
|
|
void (*deformMatricesEM)(struct ModifierData *md,
|
|
|
|
const struct ModifierEvalContext *ctx,
|
|
|
|
struct BMEditMesh *editData,
|
|
|
|
struct Mesh *mesh,
|
|
|
|
float (*vertexCos)[3],
|
|
|
|
float (*defMats)[3][3],
|
|
|
|
int numVerts);
|
2019-04-17 06:17:24 +02:00
|
|
|
|
2018-04-18 15:45:54 +02:00
|
|
|
/********************* Non-deform modifier functions *********************/
|
2019-04-17 06:17:24 +02:00
|
|
|
|
2020-06-17 06:00:09 +02:00
|
|
|
/**
|
|
|
|
* For non-deform types: apply the modifier and return a mesh data-block.
|
2018-04-18 15:45:54 +02:00
|
|
|
*
|
2020-04-21 13:09:41 +02:00
|
|
|
* The mesh argument should always be non-NULL; the modifier should use the
|
2020-06-05 06:34:00 +02:00
|
|
|
* passed in mesh data-block rather than object->data, as it contains the mesh
|
2020-04-21 13:09:41 +02:00
|
|
|
* with modifier applied up to this point.
|
2018-04-18 15:45:54 +02:00
|
|
|
*
|
2020-04-21 13:09:41 +02:00
|
|
|
* The modifier may modify and return the mesh argument, but must not free it
|
|
|
|
* and must ensure any referenced data layers are converted to non-referenced
|
|
|
|
* before modification.
|
2018-04-18 15:45:54 +02:00
|
|
|
*/
|
2020-04-21 13:09:41 +02:00
|
|
|
struct Mesh *(*modifyMesh)(struct ModifierData *md,
|
|
|
|
const struct ModifierEvalContext *ctx,
|
|
|
|
struct Mesh *mesh);
|
2020-12-10 14:35:02 +01:00
|
|
|
|
2020-04-21 13:09:41 +02:00
|
|
|
struct Hair *(*modifyHair)(struct ModifierData *md,
|
|
|
|
const struct ModifierEvalContext *ctx,
|
|
|
|
struct Hair *hair);
|
2020-12-10 14:35:02 +01:00
|
|
|
|
|
|
|
/**
|
|
|
|
* The modifier has to change the geometry set in-place. The geometry set can contain zero or
|
|
|
|
* more geometry components. This callback can be used by modifiers that don't work on any
|
|
|
|
* specific type of geometry (e.g. mesh).
|
|
|
|
*/
|
|
|
|
void (*modifyGeometrySet)(struct ModifierData *md,
|
|
|
|
const struct ModifierEvalContext *ctx,
|
|
|
|
struct GeometrySet *geometry_set);
|
|
|
|
|
2006-08-28 03:12:36 +02:00
|
|
|
/********************* Optional functions *********************/
|
2019-04-17 06:17:24 +02:00
|
|
|
|
2020-06-17 06:00:09 +02:00
|
|
|
/**
|
|
|
|
* Initialize new instance data for this modifier type, this function
|
2006-08-28 03:12:36 +02:00
|
|
|
* should set modifier variables to their default values.
|
2018-06-17 17:05:51 +02:00
|
|
|
*
|
2006-08-28 03:12:36 +02:00
|
|
|
* This function is optional.
|
|
|
|
*/
|
2006-12-23 12:56:22 +01:00
|
|
|
void (*initData)(struct ModifierData *md);
|
2019-04-17 06:17:24 +02:00
|
|
|
|
2020-06-17 06:00:09 +02:00
|
|
|
/**
|
|
|
|
* Should add to passed \a r_cddata_masks the data types that this
|
2006-12-05 18:42:03 +01:00
|
|
|
* modifier needs. If (mask & (1 << (layer type))) != 0, this modifier
|
Refactor CDData masks, to have one mask per mesh elem type.
We already have different storages for cddata of verts, edges etc.,
'simply' do the same for the mask flags we use all around Blender code
to request some data, or limit some operation to some layers, etc.
Reason we need this is that some cddata types (like Normals) are
actually shared between verts/polys/loops, and we don’t want to generate
clnors everytime we request vnors!
As a side note, this also does final fix to T59338, which was the
trigger for this patch (need to request computed loop normals for
another mesh than evaluated one).
Reviewers: brecht, campbellbarton, sergey
Differential Revision: https://developer.blender.org/D4407
2019-03-07 11:13:40 +01:00
|
|
|
* needs that custom data layer. It can change required layers
|
2006-12-05 18:42:03 +01:00
|
|
|
* depending on the modifier's settings.
|
|
|
|
*
|
|
|
|
* Note that this means extra data (e.g. vertex groups) - it is assumed
|
|
|
|
* that all modifiers need mesh data and deform modifiers need vertex
|
|
|
|
* coordinates.
|
|
|
|
*
|
Refactor CDData masks, to have one mask per mesh elem type.
We already have different storages for cddata of verts, edges etc.,
'simply' do the same for the mask flags we use all around Blender code
to request some data, or limit some operation to some layers, etc.
Reason we need this is that some cddata types (like Normals) are
actually shared between verts/polys/loops, and we don’t want to generate
clnors everytime we request vnors!
As a side note, this also does final fix to T59338, which was the
trigger for this patch (need to request computed loop normals for
another mesh than evaluated one).
Reviewers: brecht, campbellbarton, sergey
Differential Revision: https://developer.blender.org/D4407
2019-03-07 11:13:40 +01:00
|
|
|
* If this function is not present, it is assumed that no extra data is needed.
|
2006-12-05 18:42:03 +01:00
|
|
|
*
|
|
|
|
* This function is optional.
|
|
|
|
*/
|
Refactor CDData masks, to have one mask per mesh elem type.
We already have different storages for cddata of verts, edges etc.,
'simply' do the same for the mask flags we use all around Blender code
to request some data, or limit some operation to some layers, etc.
Reason we need this is that some cddata types (like Normals) are
actually shared between verts/polys/loops, and we don’t want to generate
clnors everytime we request vnors!
As a side note, this also does final fix to T59338, which was the
trigger for this patch (need to request computed loop normals for
another mesh than evaluated one).
Reviewers: brecht, campbellbarton, sergey
Differential Revision: https://developer.blender.org/D4407
2019-03-07 11:13:40 +01:00
|
|
|
void (*requiredDataMask)(struct Object *ob,
|
|
|
|
struct ModifierData *md,
|
|
|
|
struct CustomData_MeshMasks *r_cddata_masks);
|
2019-04-17 06:17:24 +02:00
|
|
|
|
2020-06-17 06:00:09 +02:00
|
|
|
/**
|
|
|
|
* Free internal modifier data variables, this function should
|
2006-08-28 03:12:36 +02:00
|
|
|
* not free the md variable itself.
|
|
|
|
*
|
2019-03-18 15:56:16 +01:00
|
|
|
* This function is responsible for freeing the runtime data as well.
|
|
|
|
*
|
2006-08-28 03:12:36 +02:00
|
|
|
* This function is optional.
|
|
|
|
*/
|
2006-12-23 12:56:22 +01:00
|
|
|
void (*freeData)(struct ModifierData *md);
|
2019-04-17 06:17:24 +02:00
|
|
|
|
2020-06-17 06:00:09 +02:00
|
|
|
/**
|
|
|
|
* Return a boolean value indicating if this modifier is able to be
|
2006-08-28 03:12:36 +02:00
|
|
|
* calculated based on the modifier data. This is *not* regarding the
|
|
|
|
* md->flag, that is tested by the system, this is just if the data
|
|
|
|
* validates (for example, a lattice will return false if the lattice
|
|
|
|
* object is not defined).
|
|
|
|
*
|
|
|
|
* This function is optional (assumes never disabled if not present).
|
|
|
|
*/
|
2018-07-10 12:14:08 +02:00
|
|
|
bool (*isDisabled)(const struct Scene *scene, struct ModifierData *md, bool userRenderParams);
|
2019-04-17 06:17:24 +02:00
|
|
|
|
2020-06-17 06:00:09 +02:00
|
|
|
/**
|
|
|
|
* Add the appropriate relations to the dependency graph.
|
Depsgraph: New dependency graph integration commit
This commit integrates the work done so far on the new dependency graph system,
where goal was to replace legacy depsgraph with the new one, supporting loads of
neat features like:
- More granular dependency relation nature, which solves issues with fake cycles
in the dependencies.
- Move towards all-animatable, by better integration of drivers into the system.
- Lay down some basis for upcoming copy-on-write, overrides and so on.
The new system is living side-by-side with the previous one and disabled by
default, so nothing will become suddenly broken. The way to enable new depsgraph
is to pass `--new-depsgraph` command line argument.
It's a bit early to consider the system production-ready, there are some TODOs
and issues were discovered during the merge period, they'll be addressed ASAP.
But it's important to merge, because it's the only way to attract artists to
really start testing this system.
There are number of assorted documents related on the design of the new system:
* http://wiki.blender.org/index.php/User:Aligorith/GSoC2013_Depsgraph#Design_Documents
* http://wiki.blender.org/index.php/User:Nazg-gul/DependencyGraph
There are also some user-related information online:
* http://code.blender.org/2015/02/blender-dependency-graph-branch-for-users/
* http://code.blender.org/2015/03/more-dependency-graph-tricks/
Kudos to everyone who was involved into the project:
- Joshua "Aligorith" Leung -- design specification, initial code
- Lukas "lukas_t" Toenne -- integrating code into blender, with further fixes
- Sergey "Sergey" "Sharybin" -- some mocking around, trying to wrap up the
project and so
- Bassam "slikdigit" Kurdali -- stressing the new system, reporting all the
issues and recording/writing documentation.
- Everyone else who i forgot to mention here :)
2015-05-12 12:05:57 +02:00
|
|
|
*
|
|
|
|
* This function is optional.
|
|
|
|
*/
|
|
|
|
void (*updateDepsgraph)(struct ModifierData *md, const ModifierUpdateDepsgraphContext *ctx);
|
2019-04-17 06:17:24 +02:00
|
|
|
|
2020-06-17 06:00:09 +02:00
|
|
|
/**
|
|
|
|
* Should return true if the modifier needs to be recalculated on time
|
2006-08-28 03:12:36 +02:00
|
|
|
* changes.
|
|
|
|
*
|
|
|
|
* This function is optional (assumes false if not present).
|
2021-08-19 14:34:01 +02:00
|
|
|
*
|
|
|
|
* The dag_eval_mode should be of type eEvaluationMode.
|
2006-08-28 03:12:36 +02:00
|
|
|
*/
|
2021-08-19 14:34:01 +02:00
|
|
|
bool (*dependsOnTime)(struct Scene *scene, struct ModifierData *md, const int dag_eval_mode);
|
2019-04-17 06:17:24 +02:00
|
|
|
|
2020-06-17 06:00:09 +02:00
|
|
|
/**
|
|
|
|
* True when a deform modifier uses normals, the requiredDataMask
|
2021-06-22 19:42:32 +02:00
|
|
|
* can't be used here because that refers to a normal layer whereas
|
2010-09-30 12:51:36 +02:00
|
|
|
* in this case we need to know if the deform modifier uses normals.
|
2018-06-17 17:05:51 +02:00
|
|
|
*
|
2010-09-30 12:51:36 +02:00
|
|
|
* this is needed because applying 2 deform modifiers will give the
|
|
|
|
* second modifier bogus normals.
|
2020-06-17 06:00:09 +02:00
|
|
|
*/
|
2013-06-02 05:59:19 +02:00
|
|
|
bool (*dependsOnNormals)(struct ModifierData *md);
|
2019-04-17 06:17:24 +02:00
|
|
|
|
2020-06-17 06:00:09 +02:00
|
|
|
/**
|
|
|
|
* Should call the given walk function with a pointer to each ID
|
2019-06-12 01:04:10 +02:00
|
|
|
* pointer (i.e. each data-block pointer) that the modifier data
|
2006-08-28 03:12:36 +02:00
|
|
|
* stores. This is used for linking on file load and for
|
2019-06-12 01:04:10 +02:00
|
|
|
* unlinking data-blocks or forwarding data-block references.
|
2006-08-28 03:12:36 +02:00
|
|
|
*
|
2020-10-01 18:05:23 +02:00
|
|
|
* This function is optional.
|
- shuffled editmesh derived function name/function
- added ModifierTypeInfo.freeData function
- added modifier_{new,free] utility function
- added ccgSubSurf_getUseAgeCounts to query info
- removed subsurf modifier faking (ME_SUBSURF flag is no
longer valid). subsurf modifier gets converted on file load
although there is obscure linked mesh situation where this
can go wrong, will fix shortly. this also means that some
places in the code that test/copy subsurf settings are broken
for the time being.
- shuffled modifier calculation to be simpler. note that
all modifiers are currently disabled in editmode (including
subsurf). don't worry, will return shortly.
- bug fix, build modifier didn't randomize meshes with only verts
- cleaned up subsurf_ccg and adapted for future editmode modifier
work
- added editmesh.derived{Cage,Final}, not used yet
- added SubsurfModifierData.{mCache,emCache}, will be used to cache
subsurf instead of caching in derivedmesh itself
- removed old subsurf buttons
- added do_modifiers_buttons to handle modifier events
- removed count_object counting of modifier (subsurfed) objects...
this would be nice to add back at some point but requires care.
probably requires rewrite of counting system.
New feature: Incremental Subsurf in Object Mode
The previous release introduce incremental subsurf calculation during
editmode but it was not turned on during object mode. In general it
does not make sense to have it always enabled during object mode because
it requires caching a fair amount of information about the mesh which
is a waste of memory unless the mesh is often recalculated.
However, for mesh's that have subsurfed armatures for example, or that
have other modifiers so that the mesh is essentially changing on every
frame, it makes a lot of sense to keep the subsurf'd object around and
that is what the new incremental subsurf modifier toggle is for. The
intent is that the user will enable this option for (a) a mesh that is
currently under active editing or (b) a mesh that is heavily updated
in the scene, such as a character.
I will try to write more about this feature for release, because it
has advantages and disadvantages that are not immediately obvious (the
first user reaction will be to turn it on for ever object, which is
probably not correct).
2005-07-21 22:30:33 +02:00
|
|
|
*/
|
2006-12-23 12:56:22 +01:00
|
|
|
void (*foreachIDLink)(struct ModifierData *md,
|
|
|
|
struct Object *ob,
|
2012-05-12 22:39:39 +02:00
|
|
|
IDWalkFunc walk,
|
|
|
|
void *userData);
|
2019-04-17 06:17:24 +02:00
|
|
|
|
2020-06-17 06:00:09 +02:00
|
|
|
/**
|
|
|
|
* Should call the given walk function for each texture that the
|
2011-08-12 20:11:22 +02:00
|
|
|
* modifier data stores. This is used for finding all textures in
|
|
|
|
* the context for the UI.
|
|
|
|
*
|
|
|
|
* This function is optional. If it is not present, it will be
|
|
|
|
* assumed the modifier has no textures.
|
|
|
|
*/
|
|
|
|
void (*foreachTexLink)(struct ModifierData *md,
|
|
|
|
struct Object *ob,
|
2012-05-12 22:39:39 +02:00
|
|
|
TexWalkFunc walk,
|
|
|
|
void *userData);
|
2019-04-17 06:17:24 +02:00
|
|
|
|
2020-06-17 06:00:09 +02:00
|
|
|
/**
|
|
|
|
* Free given run-time data.
|
2019-03-18 15:56:16 +01:00
|
|
|
*
|
|
|
|
* This data is coming from a modifier of the corresponding type, but actual
|
|
|
|
* modifier data is not known here.
|
|
|
|
*
|
|
|
|
* Notes:
|
|
|
|
* - The data itself is to be de-allocated as well.
|
2019-06-12 01:04:10 +02:00
|
|
|
* - This callback is allowed to receive NULL pointer as a data, so it's
|
2019-03-18 15:56:16 +01:00
|
|
|
* more like "ensure the data is freed".
|
|
|
|
*/
|
|
|
|
void (*freeRuntimeData)(void *runtime_data);
|
2020-06-05 16:41:03 +02:00
|
|
|
|
2020-06-17 06:00:09 +02:00
|
|
|
/** Register the panel types for the modifier's UI. */
|
2020-06-05 16:41:03 +02:00
|
|
|
void (*panelRegister)(struct ARegionType *region_type);
|
2020-06-15 17:37:07 +02:00
|
|
|
|
2020-06-17 06:00:09 +02:00
|
|
|
/**
|
|
|
|
* Is called when the modifier is written to a file. The modifier data struct itself is written
|
2020-06-15 17:37:07 +02:00
|
|
|
* already.
|
|
|
|
*
|
|
|
|
* This method should write any additional arrays and referenced structs that should be
|
|
|
|
* stored in the file.
|
|
|
|
*/
|
|
|
|
void (*blendWrite)(struct BlendWriter *writer, const struct ModifierData *md);
|
|
|
|
|
2020-06-17 06:00:09 +02:00
|
|
|
/**
|
|
|
|
* Is called when the modifier is read from a file.
|
2020-06-15 17:37:07 +02:00
|
|
|
*
|
|
|
|
* It can be used to update pointers to arrays and other structs. Furthermore, fields that have
|
|
|
|
* not been written (e.g. runtime data) can be reset.
|
|
|
|
*/
|
|
|
|
void (*blendRead)(struct BlendDataReader *reader, struct ModifierData *md);
|
2006-08-28 03:12:36 +02:00
|
|
|
} ModifierTypeInfo;
|
2005-08-11 04:23:52 +02:00
|
|
|
|
2020-06-05 16:41:03 +02:00
|
|
|
/* Used to find a modifier's panel type. */
|
|
|
|
#define MODIFIER_TYPE_PANEL_PREFIX "MOD_PT_"
|
|
|
|
|
2021-02-05 06:23:34 +01:00
|
|
|
/* Initialize modifier's global data (type info and some common global storage). */
|
2013-08-19 11:05:34 +02:00
|
|
|
void BKE_modifier_init(void);
|
|
|
|
|
2020-05-08 10:14:02 +02:00
|
|
|
const ModifierTypeInfo *BKE_modifier_get_info(ModifierType type);
|
2005-08-11 04:23:52 +02:00
|
|
|
|
2020-06-05 16:41:03 +02:00
|
|
|
/* For modifier UI panels. */
|
|
|
|
void BKE_modifier_type_panel_id(ModifierType type, char *r_idname);
|
2020-10-28 18:43:10 +01:00
|
|
|
void BKE_modifier_panel_expand(struct ModifierData *md);
|
2020-06-05 16:41:03 +02:00
|
|
|
|
2006-08-28 03:12:36 +02:00
|
|
|
/* Modifier utility calls, do call through type pointer and return
|
|
|
|
* default values if pointer is optional.
|
|
|
|
*/
|
2020-05-08 10:14:02 +02:00
|
|
|
struct ModifierData *BKE_modifier_new(int type);
|
2020-08-05 11:54:18 +02:00
|
|
|
|
2020-05-08 10:14:02 +02:00
|
|
|
void BKE_modifier_free_ex(struct ModifierData *md, const int flag);
|
|
|
|
void BKE_modifier_free(struct ModifierData *md);
|
2020-12-02 13:35:07 +01:00
|
|
|
void BKE_modifier_remove_from_list(struct Object *ob, struct ModifierData *md);
|
2019-04-17 06:17:24 +02:00
|
|
|
|
2020-08-05 11:54:18 +02:00
|
|
|
/* Generate new UUID for the given modifier. */
|
|
|
|
void BKE_modifier_session_uuid_generate(struct ModifierData *md);
|
|
|
|
|
2020-05-08 10:14:02 +02:00
|
|
|
bool BKE_modifier_unique_name(struct ListBase *modifiers, struct ModifierData *md);
|
2019-04-17 06:17:24 +02:00
|
|
|
|
2020-05-08 10:14:02 +02:00
|
|
|
void BKE_modifier_copydata_generic(const struct ModifierData *md,
|
2020-09-04 20:59:13 +02:00
|
|
|
struct ModifierData *md_dst,
|
2020-05-08 11:02:03 +02:00
|
|
|
const int flag);
|
2020-05-08 10:14:02 +02:00
|
|
|
void BKE_modifier_copydata(struct ModifierData *md, struct ModifierData *target);
|
2020-05-08 11:02:03 +02:00
|
|
|
void BKE_modifier_copydata_ex(struct ModifierData *md,
|
|
|
|
struct ModifierData *target,
|
|
|
|
const int flag);
|
2021-08-19 14:34:01 +02:00
|
|
|
bool BKE_modifier_depends_ontime(struct Scene *scene,
|
|
|
|
struct ModifierData *md,
|
|
|
|
int dag_eval_mode);
|
2020-05-08 10:14:02 +02:00
|
|
|
bool BKE_modifier_supports_mapping(struct ModifierData *md);
|
|
|
|
bool BKE_modifier_supports_cage(struct Scene *scene, struct ModifierData *md);
|
|
|
|
bool BKE_modifier_couldbe_cage(struct Scene *scene, struct ModifierData *md);
|
|
|
|
bool BKE_modifier_is_correctable_deformed(struct ModifierData *md);
|
|
|
|
bool BKE_modifier_is_same_topology(ModifierData *md);
|
|
|
|
bool BKE_modifier_is_non_geometrical(ModifierData *md);
|
2020-05-08 11:02:03 +02:00
|
|
|
bool BKE_modifier_is_enabled(const struct Scene *scene,
|
|
|
|
struct ModifierData *md,
|
|
|
|
int required_mode);
|
2020-12-08 09:40:42 +01:00
|
|
|
bool BKE_modifier_is_nonlocal_in_liboverride(const struct Object *ob,
|
|
|
|
const struct ModifierData *md);
|
2020-10-26 07:07:58 +01:00
|
|
|
void BKE_modifier_set_error(const struct Object *ob,
|
|
|
|
struct ModifierData *md,
|
|
|
|
const char *format,
|
|
|
|
...) ATTR_PRINTF_FORMAT(3, 4);
|
2020-05-08 10:14:02 +02:00
|
|
|
bool BKE_modifier_is_preview(struct ModifierData *md);
|
|
|
|
|
|
|
|
void BKE_modifiers_foreach_ID_link(struct Object *ob, IDWalkFunc walk, void *userData);
|
|
|
|
void BKE_modifiers_foreach_tex_link(struct Object *ob, TexWalkFunc walk, void *userData);
|
|
|
|
|
2021-05-07 02:44:13 +02:00
|
|
|
struct ModifierData *BKE_modifiers_findby_type(const struct Object *ob, ModifierType type);
|
|
|
|
struct ModifierData *BKE_modifiers_findby_name(const struct Object *ob, const char *name);
|
2020-05-08 10:14:02 +02:00
|
|
|
void BKE_modifiers_clear_errors(struct Object *ob);
|
2021-02-17 00:27:50 +01:00
|
|
|
int BKE_modifiers_get_cage_index(const struct Scene *scene,
|
2020-05-08 11:02:03 +02:00
|
|
|
struct Object *ob,
|
|
|
|
int *r_lastPossibleCageIndex,
|
|
|
|
bool is_virtual);
|
2019-04-17 06:17:24 +02:00
|
|
|
|
2020-05-08 10:14:02 +02:00
|
|
|
bool BKE_modifiers_is_modifier_enabled(struct Object *ob, int modifierType);
|
|
|
|
bool BKE_modifiers_is_softbody_enabled(struct Object *ob);
|
|
|
|
bool BKE_modifiers_is_cloth_enabled(struct Object *ob);
|
|
|
|
bool BKE_modifiers_is_particle_enabled(struct Object *ob);
|
|
|
|
|
|
|
|
struct Object *BKE_modifiers_is_deformed_by_armature(struct Object *ob);
|
|
|
|
struct Object *BKE_modifiers_is_deformed_by_meshdeform(struct Object *ob);
|
|
|
|
struct Object *BKE_modifiers_is_deformed_by_lattice(struct Object *ob);
|
|
|
|
struct Object *BKE_modifiers_is_deformed_by_curve(struct Object *ob);
|
|
|
|
bool BKE_modifiers_uses_multires(struct Object *ob);
|
|
|
|
bool BKE_modifiers_uses_armature(struct Object *ob, struct bArmature *arm);
|
2021-02-17 00:27:50 +01:00
|
|
|
bool BKE_modifiers_uses_subsurf_facedots(const struct Scene *scene, struct Object *ob);
|
|
|
|
bool BKE_modifiers_is_correctable_deformed(const struct Scene *scene, struct Object *ob);
|
2020-05-08 10:14:02 +02:00
|
|
|
void BKE_modifier_free_temporary_data(struct ModifierData *md);
|
2005-09-18 15:27:12 +02:00
|
|
|
|
2012-03-26 18:25:21 +02:00
|
|
|
typedef struct CDMaskLink {
|
|
|
|
struct CDMaskLink *next;
|
Refactor CDData masks, to have one mask per mesh elem type.
We already have different storages for cddata of verts, edges etc.,
'simply' do the same for the mask flags we use all around Blender code
to request some data, or limit some operation to some layers, etc.
Reason we need this is that some cddata types (like Normals) are
actually shared between verts/polys/loops, and we don’t want to generate
clnors everytime we request vnors!
As a side note, this also does final fix to T59338, which was the
trigger for this patch (need to request computed loop normals for
another mesh than evaluated one).
Reviewers: brecht, campbellbarton, sergey
Differential Revision: https://developer.blender.org/D4407
2019-03-07 11:13:40 +01:00
|
|
|
struct CustomData_MeshMasks mask;
|
2012-03-26 18:25:21 +02:00
|
|
|
} CDMaskLink;
|
|
|
|
|
2020-06-17 06:00:09 +02:00
|
|
|
/**
|
|
|
|
* Calculates and returns a linked list of CustomData_MeshMasks and modified
|
2019-06-10 15:42:15 +02:00
|
|
|
* final datamask, indicating the data required by each modifier in the stack
|
|
|
|
* pointed to by md for correct evaluation, assuming the data indicated by
|
|
|
|
* final_datamask is required at the end of the stack.
|
2006-12-05 18:42:03 +01:00
|
|
|
*/
|
2021-02-17 00:27:50 +01:00
|
|
|
struct CDMaskLink *BKE_modifier_calc_data_masks(const struct Scene *scene,
|
2020-05-08 11:02:03 +02:00
|
|
|
struct Object *ob,
|
|
|
|
struct ModifierData *md,
|
|
|
|
struct CustomData_MeshMasks *final_datamask,
|
|
|
|
int required_mode,
|
|
|
|
ModifierData *previewmd,
|
|
|
|
const struct CustomData_MeshMasks *previewmask);
|
2021-02-17 00:27:50 +01:00
|
|
|
struct ModifierData *BKE_modifier_get_last_preview(const struct Scene *scene,
|
2020-05-08 11:02:03 +02:00
|
|
|
struct ModifierData *md,
|
|
|
|
int required_mode);
|
2013-08-19 11:05:34 +02:00
|
|
|
|
|
|
|
typedef struct VirtualModifierData {
|
|
|
|
ArmatureModifierData amd;
|
|
|
|
CurveModifierData cmd;
|
|
|
|
LatticeModifierData lmd;
|
|
|
|
ShapeKeyModifierData smd;
|
|
|
|
} VirtualModifierData;
|
|
|
|
|
2020-05-08 10:14:02 +02:00
|
|
|
struct ModifierData *BKE_modifiers_get_virtual_modifierlist(const struct Object *ob,
|
2020-05-08 11:02:03 +02:00
|
|
|
struct VirtualModifierData *data);
|
2005-09-18 15:27:12 +02:00
|
|
|
|
2020-06-17 06:00:09 +02:00
|
|
|
/** Ensure modifier correctness when changing ob->data. */
|
2020-05-08 10:14:02 +02:00
|
|
|
void BKE_modifiers_test_object(struct Object *ob);
|
2010-09-09 02:14:51 +02:00
|
|
|
|
2010-04-23 13:19:06 +02:00
|
|
|
/* here for do_versions */
|
2020-05-08 10:14:02 +02:00
|
|
|
void BKE_modifier_mdef_compact_influences(struct ModifierData *md);
|
2010-04-23 13:19:06 +02:00
|
|
|
|
2020-05-08 10:14:02 +02:00
|
|
|
void BKE_modifier_path_init(char *path, int path_maxlen, const char *name);
|
|
|
|
const char *BKE_modifier_path_relbase(struct Main *bmain, struct Object *ob);
|
|
|
|
const char *BKE_modifier_path_relbase_from_global(struct Object *ob);
|
2013-06-19 10:00:20 +02:00
|
|
|
|
2019-04-04 14:42:33 +02:00
|
|
|
/* Accessors of original/evaluated modifiers. */
|
|
|
|
|
|
|
|
/* For a given modifier data, get corresponding original one.
|
|
|
|
* If the modifier data is already original, return it as-is. */
|
2020-05-08 10:14:02 +02:00
|
|
|
struct ModifierData *BKE_modifier_get_original(struct ModifierData *md);
|
|
|
|
struct ModifierData *BKE_modifier_get_evaluated(struct Depsgraph *depsgraph,
|
2020-05-08 11:02:03 +02:00
|
|
|
struct Object *object,
|
|
|
|
struct ModifierData *md);
|
2019-04-04 14:42:33 +02:00
|
|
|
|
2018-04-18 15:45:54 +02:00
|
|
|
/* wrappers for modifier callbacks that ensure valid normals */
|
2013-06-19 10:00:20 +02:00
|
|
|
|
2020-05-08 10:14:02 +02:00
|
|
|
struct Mesh *BKE_modifier_modify_mesh(ModifierData *md,
|
2020-05-08 11:02:03 +02:00
|
|
|
const struct ModifierEvalContext *ctx,
|
|
|
|
struct Mesh *me);
|
2019-04-17 06:17:24 +02:00
|
|
|
|
2020-05-08 10:14:02 +02:00
|
|
|
void BKE_modifier_deform_verts(ModifierData *md,
|
2020-05-08 11:02:03 +02:00
|
|
|
const struct ModifierEvalContext *ctx,
|
|
|
|
struct Mesh *me,
|
|
|
|
float (*vertexCos)[3],
|
|
|
|
int numVerts);
|
2019-04-17 06:17:24 +02:00
|
|
|
|
2020-05-08 10:14:02 +02:00
|
|
|
void BKE_modifier_deform_vertsEM(ModifierData *md,
|
2020-05-08 11:02:03 +02:00
|
|
|
const struct ModifierEvalContext *ctx,
|
|
|
|
struct BMEditMesh *em,
|
|
|
|
struct Mesh *me,
|
|
|
|
float (*vertexCos)[3],
|
|
|
|
int numVerts);
|
2019-04-17 06:17:24 +02:00
|
|
|
|
2018-05-30 11:34:08 +02:00
|
|
|
struct Mesh *BKE_modifier_get_evaluated_mesh_from_evaluated_object(struct Object *ob_eval,
|
2019-02-11 20:20:12 +01:00
|
|
|
const bool get_cage_mesh);
|
2018-05-09 12:44:22 +02:00
|
|
|
|
2020-08-05 11:54:18 +02:00
|
|
|
void BKE_modifier_check_uuids_unique_and_report(const struct Object *object);
|
|
|
|
|
2020-11-06 17:13:04 +01:00
|
|
|
void BKE_modifier_blend_write(struct BlendWriter *writer, struct ListBase *modbase);
|
|
|
|
void BKE_modifier_blend_read_data(struct BlendDataReader *reader,
|
|
|
|
struct ListBase *lb,
|
|
|
|
struct Object *ob);
|
|
|
|
void BKE_modifier_blend_read_lib(struct BlendLibReader *reader, struct Object *ob);
|
|
|
|
|
2019-11-29 11:42:18 +01:00
|
|
|
#ifdef __cplusplus
|
|
|
|
}
|
|
|
|
#endif
|