2011-02-18 14:05:18 +01:00
|
|
|
/*
|
2008-04-17 00:40:48 +02:00
|
|
|
* ***** BEGIN GPL LICENSE BLOCK *****
|
2002-10-12 13:37:38 +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.
|
2002-10-12 13:37:38 +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.
|
2002-10-12 13:37:38 +02:00
|
|
|
*
|
|
|
|
* The Original Code is: all of this file.
|
|
|
|
*
|
|
|
|
* Contributor(s): none yet.
|
|
|
|
*
|
2008-04-17 00:40:48 +02:00
|
|
|
* ***** END GPL LICENSE BLOCK *****
|
2002-10-12 13:37:38 +02:00
|
|
|
*/
|
|
|
|
|
2012-02-17 19:59:41 +01:00
|
|
|
#ifndef __BKE_OBJECT_H__
|
|
|
|
#define __BKE_OBJECT_H__
|
2002-10-12 13:37:38 +02:00
|
|
|
|
2011-02-18 14:05:18 +01:00
|
|
|
/** \file BKE_object.h
|
|
|
|
* \ingroup bke
|
|
|
|
* \brief General operations, lookup, etc. for blender objects.
|
|
|
|
*/
|
2002-10-12 13:37:38 +02:00
|
|
|
#ifdef __cplusplus
|
|
|
|
extern "C" {
|
|
|
|
#endif
|
|
|
|
|
|
|
|
struct Base;
|
2013-12-26 12:24:42 +01:00
|
|
|
struct EvaluationContext;
|
2009-01-04 15:14:06 +01:00
|
|
|
struct Scene;
|
2002-10-12 13:37:38 +02:00
|
|
|
struct Object;
|
|
|
|
struct Camera;
|
|
|
|
struct BoundBox;
|
|
|
|
struct View3D;
|
2005-04-16 17:06:02 +02:00
|
|
|
struct SoftBody;
|
2008-09-27 23:52:20 +02:00
|
|
|
struct BulletSoftBody;
|
2006-11-14 16:27:43 +01:00
|
|
|
struct Group;
|
2007-10-22 04:43:07 +02:00
|
|
|
struct bAction;
|
2010-03-05 15:06:39 +01:00
|
|
|
struct RenderData;
|
2010-04-12 02:36:50 +02:00
|
|
|
struct rctf;
|
2011-11-07 13:55:18 +01:00
|
|
|
struct MovieClip;
|
2013-02-05 13:46:15 +01:00
|
|
|
struct Main;
|
2013-02-16 17:17:45 +01:00
|
|
|
struct RigidBodyWorld;
|
2013-10-15 22:15:45 +02:00
|
|
|
struct HookModifierData;
|
2002-10-12 13:37:38 +02:00
|
|
|
|
2012-05-05 16:03:12 +02:00
|
|
|
void BKE_object_workob_clear(struct Object *workob);
|
|
|
|
void BKE_object_workob_calc_parent(struct Scene *scene, struct Object *ob, struct Object *workob);
|
2008-12-24 12:08:15 +01:00
|
|
|
|
2012-05-22 17:29:57 +02:00
|
|
|
void BKE_object_transform_copy(struct Object *ob_tar, const struct Object *ob_src);
|
2014-03-31 14:39:08 +02:00
|
|
|
struct SoftBody *copy_softbody(struct SoftBody *sb, bool copy_caches);
|
2008-09-27 23:52:20 +02:00
|
|
|
struct BulletSoftBody *copy_bulletsoftbody(struct BulletSoftBody *sb);
|
2012-05-05 16:03:12 +02:00
|
|
|
void BKE_object_copy_particlesystems(struct Object *obn, struct Object *ob);
|
|
|
|
void BKE_object_copy_softbody(struct Object *obn, struct Object *ob);
|
|
|
|
void BKE_object_free_particlesystems(struct Object *ob);
|
|
|
|
void BKE_object_free_softbody(struct Object *ob);
|
|
|
|
void BKE_object_free_bulletsoftbody(struct Object *ob);
|
2013-08-19 11:25:24 +02:00
|
|
|
void BKE_object_free_curve_cache(struct Object *ob);
|
2012-05-05 16:03:12 +02:00
|
|
|
void BKE_object_update_base_layer(struct Scene *scene, struct Object *ob);
|
2005-11-27 21:49:25 +01:00
|
|
|
|
2012-05-05 16:03:12 +02:00
|
|
|
void BKE_object_free(struct Object *ob);
|
2013-12-25 11:43:26 +01:00
|
|
|
void BKE_object_free_ex(struct Object *ob, bool do_id_user);
|
2013-05-18 12:24:34 +02:00
|
|
|
void BKE_object_free_derived_caches(struct Object *ob);
|
2010-01-04 17:26:07 +01:00
|
|
|
|
2013-10-15 22:15:45 +02:00
|
|
|
void BKE_object_modifier_hook_reset(struct Object *ob, struct HookModifierData *hmd);
|
|
|
|
|
2013-03-09 06:35:49 +01:00
|
|
|
bool BKE_object_support_modifier_type_check(struct Object *ob, int modifier_type);
|
2012-03-12 15:35:07 +01:00
|
|
|
|
2012-05-05 16:03:12 +02:00
|
|
|
void BKE_object_link_modifiers(struct Object *ob, struct Object *from);
|
|
|
|
void BKE_object_free_modifiers(struct Object *ob);
|
2005-11-27 21:49:25 +01:00
|
|
|
|
2012-05-05 16:03:12 +02:00
|
|
|
void BKE_object_make_proxy(struct Object *ob, struct Object *target, struct Object *gob);
|
|
|
|
void BKE_object_copy_proxy_drivers(struct Object *ob, struct Object *target);
|
2006-11-11 17:45:17 +01:00
|
|
|
|
2012-05-05 16:03:12 +02:00
|
|
|
void BKE_object_unlink(struct Object *ob);
|
2013-03-09 06:35:49 +01:00
|
|
|
bool BKE_object_exists_check(struct Object *obtest);
|
|
|
|
bool BKE_object_is_in_editmode(struct Object *ob);
|
2013-07-01 22:27:03 +02:00
|
|
|
bool BKE_object_is_in_editmode_vgroup(struct Object *ob);
|
|
|
|
bool BKE_object_is_in_wpaint_select_vert(struct Object *ob);
|
2012-12-17 15:51:06 +01:00
|
|
|
|
2013-02-05 13:46:15 +01:00
|
|
|
struct Object *BKE_object_add_only_object(struct Main *bmain, int type, const char *name);
|
2013-04-18 10:58:21 +02:00
|
|
|
struct Object *BKE_object_add(struct Main *bmain, struct Scene *scene, int type);
|
|
|
|
void *BKE_object_obdata_add_from_type(struct Main *bmain, int type);
|
2012-05-05 16:03:12 +02:00
|
|
|
|
2013-12-17 23:42:47 +01:00
|
|
|
void BKE_object_lod_add(struct Object *ob);
|
|
|
|
void BKE_object_lod_sort(struct Object *ob);
|
|
|
|
bool BKE_object_lod_remove(struct Object *ob, int level);
|
2014-04-09 03:48:04 +02:00
|
|
|
void BKE_object_lod_update(struct Object *ob, const float camera_position[3]);
|
2013-12-17 23:42:47 +01:00
|
|
|
bool BKE_object_lod_is_usable(struct Object *ob, struct Scene *scene);
|
|
|
|
struct Object *BKE_object_lod_meshob_get(struct Object *ob, struct Scene *scene);
|
|
|
|
struct Object *BKE_object_lod_matob_get(struct Object *ob, struct Scene *scene);
|
|
|
|
|
2014-04-01 02:34:00 +02:00
|
|
|
struct Object *BKE_object_copy_ex(struct Main *bmain, struct Object *ob, bool copy_caches);
|
2012-05-05 16:03:12 +02:00
|
|
|
struct Object *BKE_object_copy(struct Object *ob);
|
|
|
|
void BKE_object_make_local(struct Object *ob);
|
2013-03-09 06:35:49 +01:00
|
|
|
bool BKE_object_is_libdata(struct Object *ob);
|
|
|
|
bool BKE_object_obdata_is_libdata(struct Object *ob);
|
2012-05-05 16:03:12 +02:00
|
|
|
|
2012-12-11 15:29:01 +01:00
|
|
|
void BKE_object_scale_to_mat3(struct Object *ob, float mat[3][3]);
|
2013-03-21 00:14:18 +01:00
|
|
|
void BKE_object_rot_to_mat3(struct Object *ob, float mat[3][3], bool use_drot);
|
|
|
|
void BKE_object_mat3_to_rot(struct Object *ob, float mat[3][3], bool use_compat);
|
2012-12-11 15:29:01 +01:00
|
|
|
void BKE_object_to_mat3(struct Object *ob, float mat[3][3]);
|
|
|
|
void BKE_object_to_mat4(struct Object *ob, float mat[4][4]);
|
2013-03-21 00:14:18 +01:00
|
|
|
void BKE_object_apply_mat4(struct Object *ob, float mat[4][4], const bool use_compat, const bool use_parent);
|
2013-07-12 14:58:01 +02:00
|
|
|
void BKE_object_matrix_local_get(struct Object *ob, float mat[4][4]);
|
2012-05-05 16:03:12 +02:00
|
|
|
|
2013-06-09 23:25:27 +02:00
|
|
|
bool BKE_object_pose_context_check(struct Object *ob);
|
2012-05-05 16:03:12 +02:00
|
|
|
struct Object *BKE_object_pose_armature_get(struct Object *ob);
|
|
|
|
|
|
|
|
void BKE_object_where_is_calc(struct Scene *scene, struct Object *ob);
|
2013-07-12 13:18:34 +02:00
|
|
|
void BKE_object_where_is_calc_ex(struct Scene *scene, struct RigidBodyWorld *rbw, struct Object *ob, float r_originmat[3][3]);
|
2012-05-05 16:03:12 +02:00
|
|
|
void BKE_object_where_is_calc_time(struct Scene *scene, struct Object *ob, float ctime);
|
2013-02-17 04:57:20 +01:00
|
|
|
void BKE_object_where_is_calc_time_ex(struct Scene *scene, struct Object *ob, float ctime,
|
2013-07-12 13:18:34 +02:00
|
|
|
struct RigidBodyWorld *rbw, float r_originmat[3][3]);
|
2012-05-05 16:03:12 +02:00
|
|
|
void BKE_object_where_is_calc_mat4(struct Scene *scene, struct Object *ob, float obmat[4][4]);
|
|
|
|
|
|
|
|
/* possibly belong in own moduke? */
|
|
|
|
struct BoundBox *BKE_boundbox_alloc_unit(void);
|
2013-06-09 23:25:27 +02:00
|
|
|
void BKE_boundbox_init_from_minmax(struct BoundBox *bb, const float min[3], const float max[3]);
|
2014-01-29 20:10:03 +01:00
|
|
|
bool BKE_boundbox_ray_hit_check(struct BoundBox *bb, const float ray_start[3], const float ray_normal[3],
|
|
|
|
float *r_lambda);
|
2012-05-05 16:03:12 +02:00
|
|
|
|
|
|
|
struct BoundBox *BKE_object_boundbox_get(struct Object *ob);
|
|
|
|
void BKE_object_dimensions_get(struct Object *ob, float vec[3]);
|
2014-03-30 01:08:33 +01:00
|
|
|
void BKE_object_dimensions_set(struct Object *ob, const float value[3]);
|
2014-01-13 21:57:05 +01:00
|
|
|
void BKE_object_empty_draw_type_set(struct Object *ob, const int value);
|
2012-05-05 16:03:12 +02:00
|
|
|
void BKE_object_boundbox_flag(struct Object *ob, int flag, int set);
|
2013-03-21 00:14:18 +01:00
|
|
|
void BKE_object_minmax(struct Object *ob, float r_min[3], float r_max[3], const bool use_hidden);
|
2013-06-09 23:25:27 +02:00
|
|
|
bool BKE_object_minmax_dupli(struct Scene *scene, struct Object *ob, float r_min[3], float r_max[3], const bool use_hidden);
|
2011-11-14 04:54:23 +01:00
|
|
|
|
2012-03-18 08:38:51 +01:00
|
|
|
/* sometimes min-max isn't enough, we need to loop over each point */
|
2012-05-12 22:39:39 +02:00
|
|
|
void BKE_object_foreach_display_point(struct Object *ob, float obmat[4][4],
|
|
|
|
void (*func_cb)(const float[3], void *), void *user_data);
|
|
|
|
void BKE_scene_foreach_display_point(struct Scene *scene,
|
|
|
|
struct View3D *v3d,
|
|
|
|
const short flag,
|
|
|
|
void (*func_cb)(const float[3], void *), void *user_data);
|
2011-11-14 04:54:23 +01:00
|
|
|
|
2013-03-09 06:35:49 +01:00
|
|
|
bool BKE_object_parent_loop_check(const struct Object *parent, const struct Object *ob);
|
2011-12-16 11:39:43 +01:00
|
|
|
|
2012-05-05 16:03:12 +02:00
|
|
|
void *BKE_object_tfm_backup(struct Object *ob);
|
|
|
|
void BKE_object_tfm_restore(struct Object *ob, void *obtfm_pt);
|
2010-02-26 09:47:20 +01:00
|
|
|
|
2011-11-11 06:34:07 +01:00
|
|
|
typedef struct ObjectTfmProtectedChannels {
|
|
|
|
float loc[3], dloc[3];
|
2011-12-04 04:35:54 +01:00
|
|
|
float size[3], dscale[3];
|
2011-11-11 06:34:07 +01:00
|
|
|
float rot[3], drot[3];
|
|
|
|
float quat[4], dquat[4];
|
|
|
|
float rotAxis[3], drotAxis[3];
|
|
|
|
float rotAngle, drotAngle;
|
|
|
|
} ObjectTfmProtectedChannels;
|
|
|
|
|
2012-05-05 16:03:12 +02:00
|
|
|
void BKE_object_tfm_protected_backup(const struct Object *ob,
|
2012-05-12 22:39:39 +02:00
|
|
|
ObjectTfmProtectedChannels *obtfm);
|
2011-11-11 06:34:07 +01:00
|
|
|
|
2012-05-05 16:03:12 +02:00
|
|
|
void BKE_object_tfm_protected_restore(struct Object *ob,
|
2012-05-12 22:39:39 +02:00
|
|
|
const ObjectTfmProtectedChannels *obtfm,
|
|
|
|
const short protectflag);
|
2011-11-11 06:34:07 +01:00
|
|
|
|
2013-12-26 12:24:42 +01:00
|
|
|
void BKE_object_handle_update(struct EvaluationContext *eval_ctx, struct Scene *scene, struct Object *ob);
|
|
|
|
void BKE_object_handle_update_ex(struct EvaluationContext *eval_ctx,
|
|
|
|
struct Scene *scene, struct Object *ob,
|
2014-03-24 10:10:16 +01:00
|
|
|
struct RigidBodyWorld *rbw,
|
|
|
|
const bool do_proxy_update);
|
2012-05-05 16:03:12 +02:00
|
|
|
void BKE_object_sculpt_modifiers_changed(struct Object *ob);
|
Result of 2 weeks of quiet coding work in Greece :)
Aim was to get a total refresh of the animation system. This
is needed because;
- we need to upgrade it with 21st century features
- current code is spaghetti/hack combo, and hides good design
- it should become lag-free with using dependency graphs
A full log, with complete code API/structure/design explanation
will follow, that's a load of work... so here below the list with
hot changes;
- The entire object update system (matrices, geometry) is now
centralized. Calls to where_is_object and makeDispList are
forbidden, instead we tag objects 'changed' and let the
depgraph code sort it out
- Removed all old "Ika" code
- Depgraph is aware of all relationships, including meta balls,
constraints, bevelcurve, and so on.
- Made depgraph aware of relation types and layers, to do smart
flushing of 'changed' events. Nothing gets calculated too often!
- Transform uses depgraph to detect changes
- On frame-advance, depgraph flushes animated changes
Armatures;
Almost all armature related code has been fully built from scratch.
It now reveils the original design much better, with a very clean
implementation, lag free without even calculating each Bone more than
once. Result is quite a speedup yes!
Important to note is;
1) Armature is data containing the 'rest position'
2) Pose is the changes of rest position, and always on object level.
That way more Objects can use same Pose. Also constraints are in Pose
3) Actions only contain the Ipos to change values in Poses.
- Bones draw unrotated now
- Drawing bones speedup enormously (10-20 times)
- Bone selecting in EditMode, selection state is saved for PoseMode,
and vice-versa
- Undo in editmode
- Bone renaming does vertexgroups, constraints, posechannels, actions,
for all users of Armature in entire file
- Added Bone renaming in NKey panel
- Nkey PoseMode shows eulers now
- EditMode and PoseMode now have 'active' bone too (last clicked)
- Parenting in EditMode' CTRL+P, ALT+P, with nice options!
- Pose is added in Outliner now, with showing that constraints are in
the Pose, not Armature
- Disconnected IK solving from constraints. It's a separate phase now,
on top of the full Pose calculations
- Pose itself has a dependency graph too, so evaluation order is lag free.
TODO NOW;
- Rotating in Posemode has incorrect inverse transform (Martin will fix)
- Python Bone/Armature/Pose API disabled... needs full recode too
(wait for my doc!)
- Game engine will need upgrade too
- Depgraph code needs revision, cleanup, can be much faster!
(But, compliments for Jean-Luc, it works like a charm!)
- IK changed, it now doesnt use previous position to advance to next
position anymore. That system looks nice (no flips) but is not well
suited for NLA and background render.
TODO LATER;
We now can do loadsa new nifty features as well; like:
- Kill PoseMode (can be option for armatures itself)
- Make B-Bones (Bezier, Bspline, like for spines)
- Move all silly button level edit to 3d window (like CTRL+I = add
IK)
- Much better & informative drawing
- Fix action/nla editors
- Put all ipos in Actions (object, mesh key, lamp color)
- Add hooks
- Null bones
- Much more advanced constraints...
Bugfixes;
- OGL render (view3d header) had wrong first frame on anim render
- Ipo 'recording' mode had wrong playback speed
- Vertex-key mode now sticks to show 'active key', until frame change
-Ton-
2005-07-03 19:35:38 +02:00
|
|
|
|
2012-05-05 16:03:12 +02:00
|
|
|
int BKE_object_obdata_texspace_get(struct Object *ob, short **r_texflag, float **r_loc, float **r_size, float **r_rot);
|
2009-08-25 20:41:36 +02:00
|
|
|
|
2012-05-05 16:03:12 +02:00
|
|
|
int BKE_object_insert_ptcache(struct Object *ob);
|
2014-02-05 18:46:10 +01:00
|
|
|
void BKE_object_delete_ptcache(struct Object *ob, int index);
|
2014-02-03 08:55:59 +01:00
|
|
|
struct KeyBlock *BKE_object_insert_shape_key(struct Scene *scene, struct Object *ob, const char *name, const bool from_mix);
|
2009-08-25 20:41:36 +02:00
|
|
|
|
2013-03-09 04:34:01 +01:00
|
|
|
bool BKE_object_is_child_recursive(struct Object *ob_parent, struct Object *ob_child);
|
2013-03-09 06:35:49 +01:00
|
|
|
bool BKE_object_is_animated(struct Scene *scene, struct Object *ob);
|
|
|
|
|
|
|
|
/* return ModifierMode flag */
|
2012-05-05 16:03:12 +02:00
|
|
|
int BKE_object_is_modified(struct Scene *scene, struct Object *ob);
|
|
|
|
int BKE_object_is_deform_modified(struct Scene *scene, struct Object *ob);
|
2011-03-16 09:53:35 +01:00
|
|
|
|
2012-05-05 16:03:12 +02:00
|
|
|
void BKE_object_relink(struct Object *ob);
|
2011-03-25 09:43:41 +01:00
|
|
|
|
2013-09-09 13:37:37 +02:00
|
|
|
struct MovieClip *BKE_object_movieclip_get(struct Scene *scene, struct Object *ob, bool use_default);
|
2011-11-07 13:55:18 +01:00
|
|
|
|
2012-06-12 23:23:51 +02:00
|
|
|
/* this function returns a superset of the scenes selection based on relationships */
|
|
|
|
|
|
|
|
typedef enum eObRelationTypes {
|
2012-06-13 00:05:33 +02:00
|
|
|
OB_REL_NONE = 0, /* just the selection as is */
|
|
|
|
OB_REL_PARENT = (1 << 0), /* immediate parent */
|
|
|
|
OB_REL_PARENT_RECURSIVE = (1 << 1), /* parents up to root of selection tree*/
|
|
|
|
OB_REL_CHILDREN = (1 << 2), /* immediate children */
|
|
|
|
OB_REL_CHILDREN_RECURSIVE = (1 << 3), /* All children */
|
|
|
|
OB_REL_MOD_ARMATURE = (1 << 4), /* Armatures related to the selected objects */
|
|
|
|
OB_REL_SCENE_CAMERA = (1 << 5), /* you might want the scene camera too even if unselected? */
|
2012-06-12 23:23:51 +02:00
|
|
|
} eObRelationTypes;
|
|
|
|
|
|
|
|
typedef enum eObjectSet {
|
|
|
|
OB_SET_SELECTED, /* Selected Objects */
|
|
|
|
OB_SET_VISIBLE, /* Visible Objects */
|
|
|
|
OB_SET_ALL /* All Objects */
|
|
|
|
} eObjectSet;
|
|
|
|
|
|
|
|
struct LinkNode *BKE_object_relational_superset(struct Scene *scene, eObjectSet objectSet, eObRelationTypes includeFilter);
|
2012-07-18 11:45:50 +02:00
|
|
|
struct LinkNode *BKE_object_groups(struct Object *ob);
|
|
|
|
void BKE_object_groups_clear(struct Scene *scene, struct Base *base, struct Object *object);
|
2012-06-12 23:23:51 +02:00
|
|
|
|
2013-09-02 00:01:21 +02:00
|
|
|
struct KDTree *BKE_object_as_kdtree(struct Object *ob, int *r_tot);
|
|
|
|
|
2002-10-12 13:37:38 +02:00
|
|
|
#ifdef __cplusplus
|
|
|
|
}
|
|
|
|
#endif
|
|
|
|
|
|
|
|
#endif
|