Yamyam: 1版をインポートしました

2018-06-28T20:50:26Z

1版をインポートしました

2012年8月6日 (月) 02:38にwiki>Apinzonfによる

2012-08-06T02:38:30Z

新規ページ

= Tutorial Adding a New Modifier =

In this tutorial you will learn the steps to create a new modifier in Blender.

This tutorial is focused to people with a medium level of programming in (C, C++, python), and do not know the Blender source code.

The development was done with [http://www.cmake.org CMake], [http://www.microsoft.com/visualstudio/en-us/products/2010-editions/express vs2010] and windows, but should be similar to other systems like SCons and Unix.

You can read an introduction of the topic in [[Dev:Source/Modifiers/Adding]]

== Directory Structure ==

You can read wiki document about file structure [[Dev:2.5/Doc/Blender_Source/Files_structure]]

To build blender need to select a directory we name as <tt>ANY FOLDER</tt> where you'll make the following folders.

<tt>ANY FOLDER/blender</tt>

<tt>ANY FOLDER/lib/windows</tt>

<tt>ANY FOLDER/build</tt>

== Download source code from svn repository==

You can read wiki documentation about set up your local repository in [[Dev:2.5/Doc/Building_Blender/Windows/msvc/CMake]]

For get Blender source code you need a svn client like [http://subversion.tigris.org/ svn command line] or [http://tortoisesvn.tigris.org/ svn graphical client]

* In the command line of windows put this cd ANY FOLDER svn checkout https://svn.blender.org/svnroot/bf-blender/trunk/blender blender svn checkout https://svn.blender.org/svnroot/bf-blender/trunk/lib/windows lib/windows

* In the tortoise:
** Right click in ANY FOLDER/blender and choose SVN Checkout... [[File:Apinzonf_GSOC_2012_Diagram_svn0.png|center|thumb|299px|svn Checkout ]]
** In the URL of repository: put https://svn.blender.org/svnroot/bf-blender/trunk/blender [[File:Apinzonf_GSOC_2012_Diagram_svn1.png|center|thumb|468px|Checkout Dialog]]
** Right click in ANY FOLDER/lib/windows and choose SVN Checkout... in the URL of repository: put https://svn.blender.org/svnroot/bf-blender/trunk/lib/windows

== Manual CMake Setup ==

You can download and install CMake from [http://www.cmake.org www.cmake.org]

You can find CMake in windows Menu: CMake 2.8 -> Cmake (cmake gui)

Your CMake application should look like the picture below

[[File:Apinzonf_GSOC_2012_Diagram_Cmake1.png|center|thumb|662px|CMake gui ]]

* In the field Where is the source code: put the direction of <tt>ANY FOLDER/blender</tt>
* In the field Where is to build the binaries: put the direction of <tt>ANY FOLDER/build</tt>
* Click in Configure button, in the first time appear this dialog, and you choose Visual Studio 2010
[[File:Apinzonf_GSOC_2012_Diagram_Cmake0.png|center|thumb|500px|CMake gui ]]

* Click in Generate button

== Build Blender using visual C++ 2010 ==

After generating project files with Cmake, should appear the file <tt>ANY FOLDER/build/Bender.sln</tt>, open that file, and set Solution Configuration to Release.

[[File:Apinzonf_GSOC_2012_Diagram_vs0.png|center|thumb|827px|Blender - Microsoft Visual Studio ]]

In the Solution Explorer locate the project INSTALL, then right click on the project INSTALL and select the option Generate.

After completion of the compilation, you will find your own version of Blender in <tt>ANY FOLDER/build/bin/Release/blender.exe</tt>

= Adding a New Modifier =

In the previous steps was obtained and compiled the source code, we now need to begin to add the modifier.

This modifier will be very simple but contains all the elements to build something more complex.

In this tutorial we will create a modifier for the scaling of the mesh.

To create a new modifier in Blender, you need to modify a set of files and create several files to place our modifier algorithm.

== Design the new modifier ==

To create a modifier "Scaling" we needs to interact with the GUI (<tt>rna_modifier.c, properties_data_modifier.py</tt>) and be able to call a modifier over a method (<tt>MOD_scaling.c</tt>) that receive the parameters of the modifier in some kind of structure (<tt>RNA_access.h, DNA_modifier_types.h, MOD_util.c</tt>).

This is the list of files to be modified and created

=== properties_data_modifier.py ===
<tt>ANY FOLDER/blender/release/scripts/startup/bl_ui/properties_data_modifier.py</tt>

You must add a new function <tt>SCALING</tt> in the class <tt>DATA_PT_modifiers</tt>. This function sets the layout of the buttons and controls in the GUI.
<source lang="python">class DATA_PT_modifiers(ModifierButtonsPanel, Panel):
...
def SCALING(self, layout, ob, md):
split = layout.split(percentage=0.25)
col = split.column()
col.prop(md, "scaleui")
...
</source>

=== DNA_modifier_types.h ===
<tt>ANY FOLDER/blender/source/blender/makesdna/DNA_modifier_types.h </tt>

Add a new modifier name to the ModifierType list, eModifierType_Scaling. Make sure the new entry comes before NUM_MODIFIER_TYPES, but does not modify the ordinal for any other modifier.
<source lang="c">typedef enum ModifierType {
eModifierType_None = 0,
...
...
eModifierType_Scaling,
NUM_MODIFIER_TYPES
} ModifierType;
</source>

Add a new structure of your new modifier, at end of file of <tt>DNA_modifier_types.h</tt>, and check that the structure meets the alignment requirements [[Dev:Source/Data_Structures/DNAStructs]]
<source lang="c">typedef struct ScalingModifierData {
ModifierData modifier;
float scale;
int pad; /* Variable needed to meet the alignment requirements */
} ScalingModifierData;
</source>

=== RNA_access.h ===
<tt>ANY FOLDER/blender/source/blender/makesrna/RNA_access.h</tt>

Add a new StructRNA declaration.

<source lang="c">extern StructRNA RNA_ScalingModifier;
</source>

=== rna_modifier.c ===
<tt>ANY FOLDER/blender/source/blender/makesrna/intern/rna_modifier.c</tt>

Add the new modifier to the modifier_type_items array. There are currently four categories it can go under: Modify, Generate, Deform, and Simulate. Entries within a category should be in alphabetical order. Add this modifier under <tt>{0, "", 0, N_("Deform"), ""}</tt> block.
<source lang="c">EnumPropertyItem modifier_type_items[] = {
...
{0, "", 0, N_("Deform"), ""},
...
{eModifierType_Scaling, "SCALING", ICON_MAN_SCALE, "Scaling the mesh", ""},
...
};
</source>

In function rna_Modifier_refine, add a new case for the modifier struct:
<source lang="c">
static StructRNA *rna_Modifier_refine(struct PointerRNA *ptr)
{
...
switch (md->type) {
...
case eModifierType_Scaling:
return &RNA_ScalingModifier;
...
}
</source>

Add properties to the blender user interface with base on [[Dev:2.5/Source/Architecture/RNA]]

Add new function rna_def_modifier_scaling
<source lang="c">
static void rna_def_modifier_scaling(BlenderRNA *brna)
{
StructRNA *srna;
PropertyRNA *prop;

srna = RNA_def_struct(brna, "ScalingModifier", "Modifier");
RNA_def_struct_ui_text(srna, "Scaling Modifier", "Scaling effect modifier");
RNA_def_struct_sdna(srna, "ScalingModifierData");
RNA_def_struct_ui_icon(srna, ICON_MAN_SCALE);

/* scaleui: name for "properties_data_modifier.py"*/
prop = RNA_def_property(srna, "scaleui", PROP_FLOAT, PROP_NONE);

/*scale: name for "DNA_modifier_types.h"*/
RNA_def_property_float_sdna(prop, NULL, "scale");

RNA_def_property_range(prop, -FLT_MAX, FLT_MAX);
RNA_def_property_ui_range(prop, -100, 100, 1, 3);
RNA_def_property_ui_text(prop, "Scale", "Scale factor");
RNA_def_property_update(prop, 0, "rna_Modifier_update");

}
</source>

Add line to defines new RNA function, invoke the previous function

<source lang="c">void RNA_def_modifier(BlenderRNA *brna)
{
...
rna_def_modifier_remesh(brna);
rna_def_modifier_skin(brna);
rna_def_modifier_scaling(brna);
}
</source>

=== CMakeLists.txt ===

<tt>ANY FOLDER/blender/source/blender/modifiers/CMakeLists.txt </tt>

Add a file name <tt>MOD_scaling.c</tt> to bf_modifiers project

<source lang="cmake">set(SRC
...
intern/MOD_scaling.c
...
)
</source>

=== MOD_modifiertypes.h ===
<tt>ANY FOLDER/blender/source/blender/modifiers/MOD_modifiertypes.h</tt>

Add a new ModifierTypeInfo declaration.
<source lang="c">extern ModifierTypeInfo modifierType_Scaling;
</source>

=== MOD_util.c ===
<tt>ANY FOLDER/blender/source/blender/modifiers/intern/MOD_util.c</tt>

Add a new INIT_TYPE line.
<source lang="c">#define INIT_TYPE(typeName) (types[eModifierType_##typeName] = &modifierType_##typeName)
...
INIT_TYPE(Scaling);
#undef INIT_TYPE
</source>

=== MOD_scaling.c ===
<tt>ANY FOLDER/blender/source/blender/modifiers/intern/MOD_scaling.c</tt>

Create a new file name as <tt>MOD_scaling.c</tt> in the folder <tt>ANY FOLDER/blender/source/blender/modifiers/intern/</tt>.
<source lang="c">
/*
* ***** BEGIN GPL LICENSE BLOCK *****
*
* 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
* of the License, or (at your option) any later version.
*
* 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,
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*
* The Original Code is Copyright (C) 2005 by the Blender Foundation.
* All rights reserved.
*
* Contributor(s): Your name
*
* ***** END GPL LICENSE BLOCK *****
*
*/

/** \file blender/modifiers/intern/MOD_scaling.c
* \ingroup modifiers
*/

#include "DNA_meshdata_types.h"

#include "BLI_math.h"
#include "BLI_utildefines.h"
#include "BLI_string.h"

#include "MEM_guardedalloc.h"

#include "BKE_cdderivedmesh.h"
#include "BKE_particle.h"
#include "BKE_deform.h"

#include "MOD_modifiertypes.h"
#include "MOD_util.h"

static void initData(ModifierData *md)
{
ScalingModifierData *smd = (ScalingModifierData *) md;
smd->scale = 1.0f;
}

static void copyData(ModifierData *md, ModifierData *target)
{
ScalingModifierData *smd = (ScalingModifierData *) md;
ScalingModifierData *tsmd = (ScalingModifierData *) target;
tsmd->scale = smd->scale;
}

static int isDisabled(ModifierData *md, int UNUSED(useRenderParams))
{
ScalingModifierData *smd = (ScalingModifierData *) md;
/* disable if modifier is 1.0 for scale*/
if (smd->scale == 1.0f) return 1;
return 0;
}

static CustomDataMask requiredDataMask(Object *UNUSED(ob), ModifierData *md)
{
ScalingModifierData *smd = (ScalingModifierData *)md;
CustomDataMask dataMask = 0;
return dataMask;
}

static void ScalingModifier_do(
ScalingModifierData *smd, Object *ob, DerivedMesh *dm,
float (*vertexCos)[3], int numVerts)
{
int i;
float scale;
scale = smd->scale;

for (i = 0; i < numVerts; i++) {
vertexCos[i][0] = vertexCos[i][0] * scale;
vertexCos[i][1] = vertexCos[i][1] * scale;
vertexCos[i][2] = vertexCos[i][2] * scale;
}
}

static void deformVerts(ModifierData *md, Object *ob, DerivedMesh *derivedData,
float (*vertexCos)[3], int numVerts, ModifierApplyFlag UNUSED(flag))
{
DerivedMesh *dm = get_dm(ob, NULL, derivedData, NULL, 0);

ScalingModifier_do((ScalingModifierData *)md, ob, dm,
vertexCos, numVerts);

if (dm != derivedData)
dm->release(dm);
}

static void deformVertsEM(
ModifierData *md, Object *ob, struct BMEditMesh *editData,
DerivedMesh *derivedData, float (*vertexCos)[3], int numVerts)
{
DerivedMesh *dm = get_dm(ob, editData, derivedData, NULL, 0);

ScalingModifier_do((ScalingModifierData *)md, ob, dm,
vertexCos, numVerts);

if (dm != derivedData)
dm->release(dm);
}

ModifierTypeInfo modifierType_Scaling = {
/* name */ "Scaling",
/* structName */ "ScalingModifierData",
/* structSize */ sizeof(ScalingModifierData),
/* type */ eModifierTypeType_OnlyDeform,
/* flags */ eModifierTypeFlag_AcceptsMesh |
eModifierTypeFlag_SupportsEditmode,

/* copyData */ copyData,
/* deformVerts */ deformVerts,
/* deformMatrices */ NULL,
/* deformVertsEM */ deformVertsEM,
/* deformMatricesEM */ NULL,
/* applyModifier */ NULL,
/* applyModifierEM */ NULL,
/* initData */ initData,
/* requiredDataMask */ requiredDataMask,
/* freeData */ NULL,
/* isDisabled */ isDisabled,
/* updateDepgraph */ NULL,
/* dependsOnTime */ NULL,
/* dependsOnNormals */ NULL,
/* foreachObjectLink */ NULL,
/* foreachIDLink */ NULL,
/* foreachTexLink */ NULL,
};
</source>

The most important funcion in the file MOD_scaling.c is
<source lang="c">
static void ScalingModifier_do(
ScalingModifierData *smd, Object *ob, DerivedMesh *dm,
float (*vertexCos)[3], int numVerts)
{
int i;
float scale;
scale = smd->scale;

for (i = 0; i < numVerts; i++) {
vertexCos[i][0] = vertexCos[i][0] * scale;
vertexCos[i][1] = vertexCos[i][1] * scale;
vertexCos[i][2] = vertexCos[i][2] * scale;
}
}
</source>

In that function you scale every vertex in the mesh by the factor scale;

== Configurate and Compile ==

For changes in the CMakeLists.txt file to take effect, you must rerun CMake (cmake-gui) and click on Configure and Generate.

Then you must reopen the file Blender.sln, and Generate the project INSTALL.

← 古い版	2018年6月28日 (木) 20:50時点における版
(相違点なし)

利用者:Apinzonf/Dev:Doc/Tutorial Modifier - 版の履歴

Yamyam: 1版 をインポートしました

2012年8月6日 (月) 02:38にwiki>Apinzonfによる

Yamyam: 1版をインポートしました