blender-archive/source/blender/makesrna/intern/rna_cachefile.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) 2016 Blender Foundation.
 * All rights reserved.
 *
 * Contributor(s): Kevin Dietrich.
 *
 * ***** END GPL LICENSE BLOCK *****
 */

#include "DNA_cachefile_types.h"
#include "DNA_scene_types.h"

#include "RNA_access.h"
#include "RNA_define.h"
#include "RNA_enum_types.h"

#include "rna_internal.h"

#ifdef RNA_RUNTIME

#include "BKE_cachefile.h"
#include "BKE_depsgraph.h"

#include "BLI_string.h"

#include "DEG_depsgraph.h"

#include "WM_api.h"
#include "WM_types.h"

#ifdef WITH_ALEMBIC
#  include "../../../alembic/ABC_alembic.h"
#endif

static void rna_CacheFile_update(Main *bmain, Scene *scene, PointerRNA *ptr)
{
	CacheFile *cache_file = (CacheFile *)ptr->data;

	DAG_id_tag_update(&cache_file->id, 0);
	WM_main_add_notifier(NC_OBJECT | ND_DRAW, NULL);

	UNUSED_VARS(bmain, scene);
}

static void rna_CacheFile_update_handle(Main *bmain, Scene *scene, PointerRNA *ptr)
{
	CacheFile *cache_file = ptr->data;

	if ((cache_file->flag & CACHEFILE_DIRTY) != 0) {
		BKE_cachefile_clean(scene, cache_file);
		BLI_freelistN(&cache_file->object_paths);
		cache_file->flag &= ~CACHEFILE_DIRTY;
	}

	BKE_cachefile_reload(bmain, cache_file);

	rna_CacheFile_update(bmain, scene, ptr);
}

static void rna_CacheFile_object_paths_begin(CollectionPropertyIterator *iter, PointerRNA *ptr)
{
	CacheFile *cache_file = (CacheFile *)ptr->data;
	rna_iterator_listbase_begin(iter, &cache_file->object_paths, NULL);
}

static void rna_CacheFile_filename_set(PointerRNA *ptr, const char *value)
{
	CacheFile *cache_file = ptr->data;

	if (STREQ(cache_file->filepath, value)) {
		return;
	}

	/* Different file is opened, close all readers. */
	cache_file->flag |= CACHEFILE_DIRTY;

	BLI_strncpy(cache_file->filepath, value, sizeof(cache_file->filepath));
}

#else

/* cachefile.object_paths */
static void rna_def_alembic_object_path(BlenderRNA *brna)
{
	StructRNA *srna = RNA_def_struct(brna, "AlembicObjectPath", NULL);
	RNA_def_struct_sdna(srna, "AlembicObjectPath");
	RNA_def_struct_ui_text(srna, "Object Path", "Path of an object inside of an Alembic archive");
	RNA_def_struct_ui_icon(srna, ICON_NONE);

	PropertyRNA *prop = RNA_def_property(srna, "path", PROP_STRING, PROP_NONE);
	RNA_def_property_ui_text(prop, "Path", "Object path");
	RNA_def_struct_name_property(srna, prop);
}

/* cachefile.object_paths */
static void rna_def_cachefile_object_paths(BlenderRNA *brna, PropertyRNA *cprop)
{
	RNA_def_property_srna(cprop, "AlembicObjectPaths");
	StructRNA *srna = RNA_def_struct(brna, "AlembicObjectPaths", NULL);
	RNA_def_struct_sdna(srna, "CacheFile");
	RNA_def_struct_ui_text(srna, "Object Paths", "Collection of object paths");
}

static void rna_def_cachefile(BlenderRNA *brna)
{
	StructRNA *srna = RNA_def_struct(brna, "CacheFile", "ID");
	RNA_def_struct_sdna(srna, "CacheFile");
	RNA_def_struct_ui_text(srna, "CacheFile", "");
	RNA_def_struct_ui_icon(srna, ICON_FILE);

	PropertyRNA *prop = RNA_def_property(srna, "filepath", PROP_STRING, PROP_FILEPATH);
	RNA_def_property_string_funcs(prop, NULL, NULL, "rna_CacheFile_filename_set");
	RNA_def_property_ui_text(prop, "File Path", "Path to external displacements file");
	RNA_def_property_update(prop, 0, "rna_CacheFile_update_handle");

	prop = RNA_def_property(srna, "is_sequence", PROP_BOOLEAN, PROP_NONE);
	RNA_def_property_ui_text(prop, "Sequence", "Whether the cache is separated in a series of files");
	RNA_def_property_update(prop, 0, "rna_CacheFile_update");

	/* ----------------- For Scene time ------------------- */

	prop = RNA_def_property(srna, "override_frame", PROP_BOOLEAN, PROP_NONE);
	RNA_def_property_ui_text(prop, "Override Frame",
	                         "Whether to use a custom frame for looking up data in the cache file,"
	                         " instead of using the current scene frame");
	RNA_def_property_update(prop, 0, "rna_CacheFile_update");

	prop = RNA_def_property(srna, "frame", PROP_FLOAT, PROP_NONE);
	RNA_def_property_float_sdna(prop, NULL, "frame");
	RNA_def_property_range(prop, -MAXFRAME, MAXFRAME);
	RNA_def_property_ui_text(prop, "Frame", "The time to use for looking up the data in the cache file,"
	                                        " or to determine which file to use in a file sequence");
	RNA_def_property_update(prop, 0, "rna_CacheFile_update");

	/* ----------------- Axis Conversion ----------------- */

	prop = RNA_def_property(srna, "forward_axis", PROP_ENUM, PROP_NONE);
	RNA_def_property_enum_sdna(prop, NULL, "forward_axis");
	RNA_def_property_enum_items(prop, rna_enum_object_axis_items);
	RNA_def_property_ui_text(prop, "Forward", "");
	RNA_def_property_update(prop, 0, "rna_CacheFile_update");

	prop = RNA_def_property(srna, "up_axis", PROP_ENUM, PROP_NONE);
	RNA_def_property_enum_sdna(prop, NULL, "up_axis");
	RNA_def_property_enum_items(prop, rna_enum_object_axis_items);
	RNA_def_property_ui_text(prop, "Up", "");
	RNA_def_property_update(prop, 0, "rna_CacheFile_update");

	prop = RNA_def_property(srna, "scale", PROP_FLOAT, PROP_NONE);
	RNA_def_property_float_sdna(prop, NULL, "scale");
	RNA_def_property_range(prop, 0.0001f, 1000.0f);
	RNA_def_property_ui_text(prop, "Scale", "Value by which to enlarge or shrink the object with respect to the world's origin"
	                                        " (only applicable through a Transform Cache constraint)");
	RNA_def_property_update(prop, 0, "rna_CacheFile_update");

	/* object paths */
	prop = RNA_def_property(srna, "object_paths", PROP_COLLECTION, PROP_NONE);
	RNA_def_property_collection_sdna(prop, NULL, "object_paths", NULL);
	RNA_def_property_collection_funcs(prop, "rna_CacheFile_object_paths_begin", "rna_iterator_listbase_next",
	                                  "rna_iterator_listbase_end", "rna_iterator_listbase_get",
	                                  NULL, NULL, NULL, NULL);
	RNA_def_property_struct_type(prop, "AlembicObjectPath");
	RNA_def_property_srna(prop, "AlembicObjectPaths");
	RNA_def_property_ui_text(prop, "Object Paths", "Paths of the objects inside the Alembic archive");
	rna_def_cachefile_object_paths(brna, prop);

	rna_def_animdata_common(srna);
}

void RNA_def_cachefile(BlenderRNA *brna)
{
	rna_def_cachefile(brna);
	rna_def_alembic_object_path(brna);
}

#endif