path: root/source/blender/makesrna/intern/rna_key.c

/**
 * $Id$
 *
 * ***** 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., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 *
 * Contributor(s): Blender Foundation (2008).
 *
 * ***** END GPL LICENSE BLOCK *****
 */

#include <stdlib.h>

#include "RNA_define.h"
#include "RNA_types.h"

#include "rna_internal.h"

#include "DNA_ID.h"
#include "DNA_curve_types.h"
#include "DNA_key_types.h"
#include "DNA_lattice_types.h"
#include "DNA_mesh_types.h"

#ifdef RNA_RUNTIME

static Key *rna_ShapeKey_find_key(ID *id)
{
	switch(GS(id->name)) {
		case ID_CU: return ((Curve*)id)->key;
		case ID_KE: return (Key*)id;
		case ID_LT: return ((Lattice*)id)->key;
		case ID_ME: return ((Mesh*)id)->key;
		default: return NULL;
	}
}

static void *rna_ShapeKey_relative_key_get(PointerRNA *ptr)
{
	Key *key= rna_ShapeKey_find_key(ptr->id.data);
	KeyBlock *kb= (KeyBlock*)ptr->data, *kbrel;
	int a;

	if(key && kb->relative < key->totkey)
		for(a=0, kbrel=key->block.first; kbrel; kbrel=kbrel->next, a++)
			if(a == kb->relative)
				return kbrel;

	return NULL;
}

static float rna_ShapeKeyPoint_co_get(PointerRNA *ptr, int index)
{
	float *vec= (float*)ptr->data;
	return vec[index];
}

static void rna_ShapeKeyPoint_co_set(PointerRNA *ptr, int index, float value)
{
	float *vec= (float*)ptr->data;
	vec[index]= value;
}

static float rna_ShapeKeyCurvePoint_tilt_get(PointerRNA *ptr)
{
	float *vec= (float*)ptr->data;
	return vec[3];
}

static void rna_ShapeKeyCurvePoint_tilt_set(PointerRNA *ptr, float value)
{
	float *vec= (float*)ptr->data;
	vec[3]= value;
}

static float rna_ShapeKeyBezierPoint_co_get(PointerRNA *ptr, int index)
{
	float *vec= (float*)ptr->data;
	return vec[index+3];
}

static void rna_ShapeKeyBezierPoint_co_set(PointerRNA *ptr, int index, float value)
{
	float *vec= (float*)ptr->data;
	vec[index+3]= value;
}

static float rna_ShapeKeyBezierPoint_handle_1_co_get(PointerRNA *ptr, int index)
{
	float *vec= (float*)ptr->data;
	return vec[index];
}

static void rna_ShapeKeyBezierPoint_handle_1_co_set(PointerRNA *ptr, int index, float value)
{
	float *vec= (float*)ptr->data;
	vec[index]= value;
}

static float rna_ShapeKeyBezierPoint_handle_2_co_get(PointerRNA *ptr, int index)
{
	float *vec= (float*)ptr->data;
	return vec[6+index];
}

static void rna_ShapeKeyBezierPoint_handle_2_co_set(PointerRNA *ptr, int index, float value)
{
	float *vec= (float*)ptr->data;
	vec[6+index]= value;
}

/*static float rna_ShapeKeyBezierPoint_tilt_get(PointerRNA *ptr)
{
	float *vec= (float*)ptr->data;
	return vec[10];
}

static void rna_ShapeKeyBezierPoint_tilt_set(PointerRNA *ptr, float value)
{
	float *vec= (float*)ptr->data;
	vec[10]= value;
}*/

static void rna_ShapeKey_data_begin(CollectionPropertyIterator *iter, PointerRNA *ptr)
{
	Key *key= rna_ShapeKey_find_key(ptr->id.data);
	KeyBlock *kb= (KeyBlock*)ptr->data;
	Curve *cu;
	Nurb *nu;
	int tot= kb->totelem, size= key->elemsize;

    if(GS(key->from->name) == ID_CU) {
		cu= (Curve*)key->from;
		nu= cu->nurb.first;

		if(nu->bezt) {
			tot /= 3;
			size *= 3;
		}
	}

	rna_iterator_array_begin(iter, (void*)kb->data, size, tot, NULL);
}

static int rna_ShapeKey_data_length(PointerRNA *ptr)
{
	Key *key= rna_ShapeKey_find_key(ptr->id.data);
	KeyBlock *kb= (KeyBlock*)ptr->data;
	Curve *cu;
	Nurb *nu;
	int tot= kb->totelem;

    if(GS(key->from->name) == ID_CU) {
		cu= (Curve*)key->from;
		nu= cu->nurb.first;

		if(nu->bezt)
			tot /= 3;
	}

	return tot;
}

static StructRNA *rna_ShapeKey_data_type(CollectionPropertyIterator *iter)
{
	Key *key= rna_ShapeKey_find_key(iter->parent.id.data);
	Curve *cu;
	Nurb *nu;

	if(GS(key->from->name) == ID_CU) {
		cu= (Curve*)key->from;
		nu= cu->nurb.first;

		if(nu->bezt)
			return &RNA_ShapeKeyBezierPoint;
		else
			return &RNA_ShapeKeyCurvePoint;
	}
	else
		return &RNA_ShapeKeyPoint;
}

#else

static void rna_def_keydata(BlenderRNA *brna)
{
	StructRNA *srna;
	PropertyRNA *prop;

	srna= RNA_def_struct(brna, "ShapeKeyPoint", NULL, "Shape Key Point");

	prop= RNA_def_property(srna, "co", PROP_FLOAT, PROP_VECTOR);
	RNA_def_property_array(prop, 3);
	RNA_def_property_float_funcs(prop, "rna_ShapeKeyPoint_co_get", "rna_ShapeKeyPoint_co_set", NULL);
	RNA_def_property_ui_text(prop, "Location", "");

	srna= RNA_def_struct(brna, "ShapeKeyCurvePoint", NULL, "Shape Key Curve Point");

	prop= RNA_def_property(srna, "co", PROP_FLOAT, PROP_VECTOR);
	RNA_def_property_array(prop, 3);
	RNA_def_property_float_funcs(prop, "rna_ShapeKeyPoint_co_get", "rna_ShapeKeyPoint_co_set", NULL);
	RNA_def_property_ui_text(prop, "Location", "");

	prop= RNA_def_property(srna, "tilt", PROP_FLOAT, PROP_NONE);
	RNA_def_property_float_funcs(prop, "rna_ShapeKeyCurvePoint_tilt_get", "rna_ShapeKeyCurvePoint_tilt_set", NULL);
	RNA_def_property_ui_text(prop, "Tilt", "");

	srna= RNA_def_struct(brna, "ShapeKeyBezierPoint", NULL, "Shape Key Bezier Point");

	prop= RNA_def_property(srna, "co", PROP_FLOAT, PROP_VECTOR);
	RNA_def_property_array(prop, 3);
	RNA_def_property_float_funcs(prop, "rna_ShapeKeyBezierPoint_co_get", "rna_ShapeKeyBezierPoint_co_set", NULL);
	RNA_def_property_ui_text(prop, "Location", "");

	prop= RNA_def_property(srna, "handle_1_co", PROP_FLOAT, PROP_VECTOR);
	RNA_def_property_array(prop, 3);
	RNA_def_property_float_funcs(prop, "rna_ShapeKeyBezierPoint_handle_1_co_get", "rna_ShapeKeyBezierPoint_handle_1_co_set", NULL);
	RNA_def_property_ui_text(prop, "Handle 1 Location", "");

	prop= RNA_def_property(srna, "handle_2_co", PROP_FLOAT, PROP_VECTOR);
	RNA_def_property_array(prop, 3);
	RNA_def_property_float_funcs(prop, "rna_ShapeKeyBezierPoint_handle_2_co_get", "rna_ShapeKeyBezierPoint_handle_2_co_set", NULL);
	RNA_def_property_ui_text(prop, "Handle 2 Location", "");

	/* appears to be unused currently
	prop= RNA_def_property(srna, "tilt", PROP_FLOAT, PROP_NONE);
	RNA_def_property_float_funcs(prop, "rna_ShapeKeyBezierPoint_tilt_get", "rna_ShapeKeyBezierPoint_tilt_set", NULL);
	RNA_def_property_ui_text(prop, "Tilt", "");*/
}

static void rna_def_keyblock(BlenderRNA *brna)
{
	StructRNA *srna;
	PropertyRNA *prop;

	static EnumPropertyItem prop_keyblock_type_items[] = {
		{KEY_LINEAR, "KEY_LINEAR", "Linear", ""},
		{KEY_CARDINAL, "KEY_CARDINAL", "Cardinal", ""},
		{KEY_BSPLINE, "KEY_BSPLINE", "BSpline", ""},
		{0, NULL, NULL, NULL}};

	srna= RNA_def_struct(brna, "ShapeKey", NULL, "Shape Key");
	RNA_def_struct_sdna(srna, "KeyBlock");

	prop= RNA_def_property(srna, "name", PROP_STRING, PROP_NONE);
	RNA_def_property_ui_text(prop, "Name", "");
	RNA_def_struct_name_property(srna, prop);

	/* keys need to be sorted to edit this */
	prop= RNA_def_property(srna, "frame", PROP_FLOAT, PROP_NONE);
	RNA_def_property_flag(prop, PROP_NOT_EDITABLE);
	RNA_def_property_float_sdna(prop, NULL, "pos");
	RNA_def_property_ui_text(prop, "Frame", "Frame for absolute keys.");

	/* the current value isn't easily editable this way, it's linked to an IPO.
	 * these seem to be mostly the values that are being written to, not edited */
	prop= RNA_def_property(srna, "value", PROP_FLOAT, PROP_NONE);
	RNA_def_property_flag(prop, PROP_NOT_EDITABLE);
	RNA_def_property_float_sdna(prop, NULL, "curval");
	RNA_def_property_ui_text(prop, "Value", "Value of shape key at the current frame.");

	prop= RNA_def_property(srna, "interpolation", PROP_ENUM, PROP_NONE);
	RNA_def_property_enum_sdna(prop, NULL, "type");
	RNA_def_property_enum_items(prop, prop_keyblock_type_items);
	RNA_def_property_ui_text(prop, "Interpolation", "Interpolation type.");

	prop= RNA_def_property(srna, "vertex_group", PROP_STRING, PROP_NONE);
	RNA_def_property_string_sdna(prop, NULL, "vgroup");
	RNA_def_property_ui_text(prop, "Vertex Group", "Vertex weight group, to blend with basis shape.");

	prop= RNA_def_property(srna, "relative_key", PROP_POINTER, PROP_NONE);
	RNA_def_property_flag(prop, PROP_NOT_EDITABLE);
	RNA_def_property_struct_type(prop, "ShapeKey");
	RNA_def_property_ui_text(prop, "Relative Key", "Shape used as a relative key.");
	RNA_def_property_pointer_funcs(prop, "rna_ShapeKey_relative_key_get", NULL, NULL);

	prop= RNA_def_property(srna, "mute", PROP_BOOLEAN, PROP_NONE);
	RNA_def_property_boolean_sdna(prop, NULL, "flag", KEYBLOCK_MUTE);
	RNA_def_property_ui_text(prop, "Mute", "Mute this shape key.");

	prop= RNA_def_property(srna, "slider_min", PROP_FLOAT, PROP_NONE);
	RNA_def_property_float_sdna(prop, NULL, "slidermin");
	RNA_def_property_range(prop, -10.0f, 10.0f);
	RNA_def_property_ui_text(prop, "Slider Min", "Minimum for slider.");

	prop= RNA_def_property(srna, "slider_max", PROP_FLOAT, PROP_NONE);
	RNA_def_property_float_sdna(prop, NULL, "slidermax");
	RNA_def_property_range(prop, -10.0f, 10.0f);
	RNA_def_property_ui_text(prop, "Slider Max", "Maximum for slider.");

	prop= RNA_def_property(srna, "data", PROP_COLLECTION, PROP_NONE);
	RNA_def_property_collection_sdna(prop, NULL, "data", "totelem");
	RNA_def_property_ui_text(prop, "Data", "");
	RNA_def_property_collection_funcs(prop, "rna_ShapeKey_data_begin", 0, 0, 0, "rna_ShapeKey_data_type", "rna_ShapeKey_data_length", 0, 0);
}

static void rna_def_key(BlenderRNA *brna)
{
	StructRNA *srna;
	PropertyRNA *prop;

	srna= RNA_def_struct(brna, "Key", "ID", "Key");

	prop= RNA_def_property(srna, "reference_key", PROP_POINTER, PROP_NONE);
	RNA_def_property_flag(prop, PROP_NOT_EDITABLE);
	RNA_def_property_pointer_sdna(prop, NULL, "refkey");
	RNA_def_property_ui_text(prop, "Reference Key", "");

	prop= RNA_def_property(srna, "shape_keys", PROP_COLLECTION, PROP_NONE);
	RNA_def_property_collection_sdna(prop, NULL, "block", NULL);
	RNA_def_property_struct_type(prop, "ShapeKey");
	RNA_def_property_ui_text(prop, "Shape Keys", "");

	rna_def_ipo_common(srna);

	prop= RNA_def_property(srna, "from", PROP_POINTER, PROP_NONE);
	RNA_def_property_ui_text(prop, "From", "Datablock using these shape keys.");

	prop= RNA_def_property(srna, "relative", PROP_BOOLEAN, PROP_NONE);
	RNA_def_property_boolean_sdna(prop, NULL, "type", KEY_RELATIVE);
	RNA_def_property_ui_text(prop, "Relative", "Makes shape keys relative.");

	prop= RNA_def_property(srna, "slurph", PROP_INT, PROP_UNSIGNED);
	RNA_def_property_int_sdna(prop, NULL, "slurph");
	RNA_def_property_range(prop, -500, 500);
	RNA_def_property_ui_text(prop, "Slurph", "Creates a delay in amount of frames in applying keypositions, first vertex goes first.");
}

void RNA_def_key(BlenderRNA *brna)
{
	rna_def_key(brna);
	rna_def_keyblock(brna);
	rna_def_keydata(brna);
}

#endif