tornavis/source/blender/blenkernel/BKE_ipo.h

/* SPDX-FileCopyrightText: 2001-2002 NaN Holding BV. All rights reserved.
 *
 * SPDX-License-Identifier: GPL-2.0-or-later */
#pragma once

/** \file
 * \ingroup bke
 */

#ifdef __cplusplus
extern "C" {
#endif

struct Main;

/**
 * Called from #do_versions() in `readfile.cc` to convert the old 'IPO/adrcode' system
 * to the new 'Animato/RNA' system.
 *
 * The basic method used here, is to loop over data-blocks which have IPO-data,
 * and add those IPO's to new AnimData blocks as Actions.
 * Action/NLA data only works well for Objects, so these only need to be checked for there.
 *
 * Data that has been converted should be freed immediately, which means that it is immediately
 * clear which data-blocks have yet to be converted, and also prevent freeing errors when we exit.
 *
 * \note Currently done after all file reading.
 */
void do_versions_ipos_to_animato(struct Main *main);

/* --------------------- xxx stuff ------------------------ */

#ifdef __cplusplus
};
#endif
Cleanup: Add a copyright notice to files and use SPDX format A lot of files were missing copyright field in the header and the Blender Foundation contributed to them in a sense of bug fixing and general maintenance. This change makes it explicit that those files are at least partially copyrighted by the Blender Foundation. Note that this does not make it so the Blender Foundation is the only holder of the copyright in those files, and developers who do not have a signed contract with the foundation still hold the copyright as well. Another aspect of this change is using SPDX format for the header. We already used it for the license specification, and now we state it for the copyright as well, following the FAQ: https://reuse.software/faq/ 2023-05-31 16:19:06 +02:00			`/* SPDX-FileCopyrightText: 2001-2002 NaN Holding BV. All rights reserved.`
			`*`
			`* SPDX-License-Identifier: GPL-2.0-or-later */`
unify include guard defines, __$FILENAME__ without the underscores these clogged up the namespace for autocompleation which was annoying. 2012-02-17 19:59:41 +01:00			`#pragma once`
Initial revision 2002-10-12 13:37:38 +02:00
doxygen: add newline after \file While \file doesn't need an argument, it can't have another doxy command after it. 2019-02-17 22:08:12 +01:00			`/** \file`
			`* \ingroup bke`
doxygen: blenkernel under core as module. 2011-02-18 14:05:18 +01:00			`*/`

BGE patch: Add automatic support for armature driven shape keys. To take advantage of this feature, you must have a mesh with relative shape keys and shape Ipo curves with drivers referring to bones of the mesh's parent armature. The BGE will automatically detect the dependency between the shape keys and the armature and execute the Ipo drivers during the rendering of the armature actions. This technique is used to make the armature action more natural: the shape keys compensate in places where the armature deformation is uggly and the drivers make sure that the shape correction is synchronized with the bone position. Note: This is not compatible with shape actions; BLender does not allow to have Shape Ipo Curves and Shape actions at the same time. 2008-06-25 00:19:00 +02:00			`#ifdef __cplusplus`
			`extern "C" {`
			`#endif`

Cleanup: sort forward declarations of enum & struct Done using: source/tools/utils_maintenance/c_sort_blocks.py 2019-01-28 11:08:24 +01:00			`struct Main;`
Initial revision 2002-10-12 13:37:38 +02:00
Cleanup: move public doc-strings into headers for 'blenkernel' - Added space below non doc-string comments to make it clear these aren't comments for the symbols directly below them. - Use doxy sections for some headers. - Minor improvements to doc-strings. Ref T92709 2021-12-07 07:19:15 +01:00			`/**`
Cleanup: correct file names in comments after C -> C++ renaming Use back-tick quotes to differentiate these from plain text. 2023-07-31 03:50:54 +02:00			* Called from #do_versions() in `readfile.cc` to convert the old 'IPO/adrcode' system
Cleanup: move public doc-strings into headers for 'blenkernel' - Added space below non doc-string comments to make it clear these aren't comments for the symbols directly below them. - Use doxy sections for some headers. - Minor improvements to doc-strings. Ref T92709 2021-12-07 07:19:15 +01:00			`* to the new 'Animato/RNA' system.`
			`*`
			`* The basic method used here, is to loop over data-blocks which have IPO-data,`
			`* and add those IPO's to new AnimData blocks as Actions.`
			`* Action/NLA data only works well for Objects, so these only need to be checked for there.`
			`*`
			`* Data that has been converted should be freed immediately, which means that it is immediately`
			`* clear which data-blocks have yet to be converted, and also prevent freeing errors when we exit.`
			`*`
			`* \note Currently done after all file reading.`
			`*/`
2.50: some warning fixes. 2009-03-17 23:27:15 +01:00			`void do_versions_ipos_to_animato(struct Main *main);`
Second try at committing IPO code cleanups... 2008-09-29 01:17:44 +02:00
Animato - Basic version patching support This is work-in-progress patching support for converting animation saved in old system to work in the new one. * Only IPOs/Actions directly attached to Objects + Shapekeys are converted for now. More types will follow... * This is currently done as a step outside of do_versions() due to problems with various pointers not having been resolved yet, but which are necessary for correct resolution of issues such as drivers... However, the current code does illustrate how the data should be converted to give best results/compat between the two systems. * Still need to get the converted data working with depsgraph correctly. Currently, some of my testfiles work, but the BBB files still don't. 2009-01-22 11:53:22 +01:00			`/* --------------------- xxx stuff ------------------------ */`
Version 1.0 of IpoDrivers. First note that this is new functionality, unfinished, and only for testing and feedback purposes. I'll list below what works, and what will need work still. This text is also in cms: http://www.blender.org/cms/Ipo_Drivers.680.0.html An IpoDriver is like an IpoCurve, but instead of a Bezier curve, it allows to connect a property of other Objects as input for the "channel". For example, IpoDrivers can be used to have a Shape Key being "driven" by the rotation of a Bone. Or the RGB colors of a Material get driven by the XYZ location of an Object. Editing of Drivers happens in the IpoWindow. Here you can notice that the channels (right hand window) now have an "active" channel indicator. To add a Driver, you have to use the "Transform Properties" Panel (Nkey). Here you can add or remove a Driver to the active channel, and use the buttons to fill in what kind of relationship you want to establish. Driver Objects Note that any Ipo Channel can become driven now, but that only Object transformation or Pose Bone transformation can be used to become a Driver now. At this moment, only the local transformation is taken into account. For Objects that means the location/rotation/scale value without Parent transform (as shown in "Transform Properties" Panel for Objects). For Pose Bones it means that only the Pose transform (changes of rest position) is Driver information (also as shown in Transform Property Panel in Pose Mode). Mapping of Drivers When an Ipo Channel is "driven", the mapping is by default one-to-one. It is only restricted by already built-in limits for Channels, like for Material the "R" value can only range from 0.0 to 1.0. Also note that when mapping rotations, the actual rotation values in Ipos are scaled down with a factor 10.0. (180 degrees actually has in the Ipo system a value of 18.0). This is an ancient year zero convention in Blender... it is a bit hidden, because the ruler (vertical as well as horizontal) displays the virtual values correctly. Only the Properties panel shows the actual value. When you draw an IpoCurve in a Driven channel, this curve will define the mapping between the Driver output (horizontal) and Driven input (vertical, as usual). A nice new option to use is "Insert one-to-one curve" (press I-key, or in pulldown menu). This will also zoom the display in exactly to fill the window, allowing easy edit. If you use this option with degrees, it will map 180 degree rotation to a range of 1.0 unit. Live updates Since the Drivers are integrated in the Ipo system, they will always be updated whenever an Ipo is evaluated. This happens at least on frame changes. For interactive feedback, updates while transforming objects were added in these cases: - Driven Object Ipos, by other Objects or Pose Bones - Driven Shape Key Ipos, by other Objects or Pose Bones You can also insert Drivers on Action Ipos, but these are only evaluated on frame change now. Todo - Drivers can also get a text button, allowing a 1 line Python script to be executed. - Make UI for it a bit less hidden... maybe with visualization in 3D? - Allowing global transform coordinates as Driver too. Issues - renaming Bones won't rename drivers - (file) appending the Ipo won't append the linked driver Objects 2005-10-02 22:51:35 +02:00
BGE patch: Add automatic support for armature driven shape keys. To take advantage of this feature, you must have a mesh with relative shape keys and shape Ipo curves with drivers referring to bones of the mesh's parent armature. The BGE will automatically detect the dependency between the shape keys and the armature and execute the Ipo drivers during the rendering of the armature actions. This technique is used to make the armature action more natural: the shape keys compensate in places where the armature deformation is uggly and the drivers make sure that the shape correction is synchronized with the bone position. Note: This is not compatible with shape actions; BLender does not allow to have Shape Ipo Curves and Shape actions at the same time. 2008-06-25 00:19:00 +02:00			`#ifdef __cplusplus`
			`};`
			`#endif`