diff options
author | Sergey Sharybin <sergey.vfx@gmail.com> | 2016-02-10 17:09:45 +0300 |
---|---|---|
committer | Sergey Sharybin <sergey.vfx@gmail.com> | 2016-02-12 17:27:33 +0300 |
commit | 28604c46a137c1288cc7a494b36ed72e44a0ab8b (patch) | |
tree | 3ce7de49d1604cdec2ce420a117ae1ab59df2404 /intern/cycles/blender | |
parent | ec9977855f9264ecf6af5b4c8e6d10324a02028e (diff) |
Cycles: Make Blender importer more forward compatible
Basically the idea is to make code robust against extending
enum options in the future by falling back to a known safe
default setting when RNA is set to something unknown.
While this approach solves the issues similar to T47377,
but it wouldn't really help when/if any of the RNA values
gets ever deprecated and removed. There'll be no simple
solution to that apart from defining explicit mapping from
RNA value to Cycles one.
Another part which isn't so great actually is that we now
have to have some enum guards and give some explicit values
to the enum items, but we can live with that perhaps.
Reviewers: dingto, juicyfruit, lukasstockner97, brecht
Reviewed By: brecht
Differential Revision: https://developer.blender.org/D1785
Diffstat (limited to 'intern/cycles/blender')
-rw-r--r-- | intern/cycles/blender/blender_camera.cpp | 55 | ||||
-rw-r--r-- | intern/cycles/blender/blender_curves.cpp | 12 | ||||
-rw-r--r-- | intern/cycles/blender/blender_mesh.cpp | 5 | ||||
-rw-r--r-- | intern/cycles/blender/blender_shader.cpp | 74 | ||||
-rw-r--r-- | intern/cycles/blender/blender_sync.cpp | 22 | ||||
-rw-r--r-- | intern/cycles/blender/blender_util.h | 21 |
6 files changed, 123 insertions, 66 deletions
diff --git a/intern/cycles/blender/blender_camera.cpp b/intern/cycles/blender/blender_camera.cpp index 6928fe471a3..cdbee52bfa9 100644 --- a/intern/cycles/blender/blender_camera.cpp +++ b/intern/cycles/blender/blender_camera.cpp @@ -158,21 +158,10 @@ static void blender_camera_from_object(BlenderCamera *bcam, break; } - switch(get_enum(ccamera, "panorama_type")) { - case 1: - bcam->panorama_type = PANORAMA_FISHEYE_EQUIDISTANT; - break; - case 2: - bcam->panorama_type = PANORAMA_FISHEYE_EQUISOLID; - break; - case 3: - bcam->panorama_type = PANORAMA_MIRRORBALL; - break; - case 0: - default: - bcam->panorama_type = PANORAMA_EQUIRECTANGULAR; - break; - } + bcam->panorama_type = (PanoramaType)get_enum(ccamera, + "panorama_type", + PANORAMA_NUM_TYPES, + PANORAMA_EQUIRECTANGULAR); bcam->fisheye_fov = RNA_float_get(&ccamera, "fisheye_fov"); bcam->fisheye_lens = RNA_float_get(&ccamera, "fisheye_lens"); @@ -460,32 +449,16 @@ void BlenderSync::sync_camera(BL::RenderSettings& b_render, curvemapping_to_array(b_shutter_curve, bcam.shutter_curve, RAMP_TABLE_SIZE); PointerRNA cscene = RNA_pointer_get(&b_scene.ptr, "cycles"); - switch(get_enum(cscene, "motion_blur_position")) { - case 0: - bcam.motion_position = Camera::MOTION_POSITION_START; - break; - case 1: - bcam.motion_position = Camera::MOTION_POSITION_CENTER; - break; - case 2: - bcam.motion_position = Camera::MOTION_POSITION_END; - break; - default: - bcam.motion_position = Camera::MOTION_POSITION_CENTER; - break; - } - - switch(get_enum(cscene, "rolling_shutter_type")) { - case 0: - bcam.rolling_shutter_type = Camera::ROLLING_SHUTTER_NONE; - break; - case 1: - bcam.rolling_shutter_type = Camera::ROLLING_SHUTTER_TOP; - break; - default: - bcam.rolling_shutter_type = Camera::ROLLING_SHUTTER_NONE; - break; - } + bcam.motion_position = + (Camera::MotionPosition)get_enum(cscene, + "motion_blur_position", + Camera::MOTION_NUM_POSITIONS, + Camera::MOTION_POSITION_CENTER); + bcam.rolling_shutter_type = + (Camera::RollingShutterType)get_enum(cscene, + "rolling_shutter_type", + Camera::ROLLING_SHUTTER_NUM_TYPES, + Camera::ROLLING_SHUTTER_NONE); bcam.rolling_shutter_duration = RNA_float_get(&cscene, "rolling_shutter_duration"); /* border */ diff --git a/intern/cycles/blender/blender_curves.cpp b/intern/cycles/blender/blender_curves.cpp index a5c0b22c4d0..0178bfbe8d9 100644 --- a/intern/cycles/blender/blender_curves.cpp +++ b/intern/cycles/blender/blender_curves.cpp @@ -795,8 +795,16 @@ void BlenderSync::sync_curve_settings() curve_system_manager->minimum_width = get_float(csscene, "minimum_width"); curve_system_manager->maximum_width = get_float(csscene, "maximum_width"); - curve_system_manager->primitive = get_enum(csscene, "primitive"); - curve_system_manager->curve_shape = get_enum(csscene, "shape"); + curve_system_manager->primitive = + (CurvePrimitiveType)get_enum(csscene, + "primitive", + CURVE_NUM_PRIMITIVE_TYPES, + CURVE_LINE_SEGMENTS); + curve_system_manager->curve_shape = + (CurveShapeType)get_enum(csscene, + "shape", + CURVE_NUM_SHAPE_TYPES, + CURVE_THICK); curve_system_manager->resolution = get_int(csscene, "resolution"); curve_system_manager->subdivisions = get_int(csscene, "subdivisions"); curve_system_manager->use_backfacing = !get_boolean(csscene, "cull_backfacing"); diff --git a/intern/cycles/blender/blender_mesh.cpp b/intern/cycles/blender/blender_mesh.cpp index 4483f82ce07..9eb4626eb3c 100644 --- a/intern/cycles/blender/blender_mesh.cpp +++ b/intern/cycles/blender/blender_mesh.cpp @@ -827,7 +827,10 @@ Mesh *BlenderSync::sync_mesh(BL::Object& b_ob, /* displacement method */ if(cmesh.data) { - const int method = get_enum(cmesh, "displacement_method"); + const int method = get_enum(cmesh, + "displacement_method", + Mesh::DISPLACE_NUM_METHODS, + Mesh::DISPLACE_BUMP); if(method == 0 || !experimental) mesh->displacement_method = Mesh::DISPLACE_BUMP; diff --git a/intern/cycles/blender/blender_shader.cpp b/intern/cycles/blender/blender_shader.cpp index b82e7dd47b7..3e490ed7584 100644 --- a/intern/cycles/blender/blender_shader.cpp +++ b/intern/cycles/blender/blender_shader.cpp @@ -51,6 +51,50 @@ void BlenderSync::find_shader(BL::ID& id, } } +/* RNA translation utilities */ + +static VolumeSampling get_volume_sampling(PointerRNA& ptr) +{ + return (VolumeSampling)get_enum(ptr, + "volume_sampling", + VOLUME_NUM_SAMPLING, + VOLUME_SAMPLING_DISTANCE); +} + +static VolumeInterpolation get_volume_interpolation(PointerRNA& ptr) +{ + return (VolumeInterpolation)get_enum(ptr, + "volume_interpolation", + VOLUME_NUM_INTERPOLATION, + VOLUME_INTERPOLATION_LINEAR); +} + +static int validate_enum_value(int value, int num_values, int default_value) +{ + if(value >= num_values) { + return default_value; + } + return value; +} + +template<typename NodeType> +static InterpolationType get_image_interpolation(NodeType b_node) +{ + int value = b_node.interpolation(); + return (InterpolationType)validate_enum_value(value, + INTERPOLATION_NUM_TYPES, + INTERPOLATION_LINEAR); +} + +template<typename NodeType> +static ExtensionType get_image_extension(NodeType b_node) +{ + int value = b_node.extension(); + return (ExtensionType)validate_enum_value(value, + EXTENSION_NUM_TYPES, + EXTENSION_REPEAT); +} + /* Graph */ static BL::NodeSocket get_node_output(BL::Node& b_node, const string& name) @@ -653,14 +697,14 @@ static ShaderNode *add_node(Scene *scene, scene->image_manager->tag_reload_image( image->filename, image->builtin_data, - (InterpolationType)b_image_node.interpolation(), - (ExtensionType)b_image_node.extension()); + get_image_interpolation(b_image_node), + get_image_extension(b_image_node)); } } image->color_space = ImageTextureNode::color_space_enum[(int)b_image_node.color_space()]; image->projection = ImageTextureNode::projection_enum[(int)b_image_node.projection()]; - image->interpolation = (InterpolationType)b_image_node.interpolation(); - image->extension = (ExtensionType)b_image_node.extension(); + image->interpolation = get_image_interpolation(b_image_node); + image->extension = get_image_extension(b_image_node); image->projection_blend = b_image_node.projection_blend(); BL::TexMapping b_texture_mapping(b_image_node.texture_mapping()); get_tex_mapping(&image->tex_mapping, b_texture_mapping); @@ -696,14 +740,15 @@ static ShaderNode *add_node(Scene *scene, /* TODO(sergey): Does not work properly when we change builtin type. */ if(b_image.is_updated()) { - scene->image_manager->tag_reload_image(env->filename, - env->builtin_data, - (InterpolationType)b_env_node.interpolation(), - EXTENSION_REPEAT); + scene->image_manager->tag_reload_image( + env->filename, + env->builtin_data, + get_image_interpolation(b_env_node), + EXTENSION_REPEAT); } } env->color_space = EnvironmentTextureNode::color_space_enum[(int)b_env_node.color_space()]; - env->interpolation = (InterpolationType)b_env_node.interpolation(); + env->interpolation = get_image_interpolation(b_env_node); env->projection = EnvironmentTextureNode::projection_enum[(int)b_env_node.projection()]; BL::TexMapping b_texture_mapping(b_env_node.texture_mapping()); get_tex_mapping(&env->tex_mapping, b_texture_mapping); @@ -824,8 +869,7 @@ static ShaderNode *add_node(Scene *scene, point_density->filename = b_point_density_node.name(); point_density->space = PointDensityTextureNode::space_enum[(int)b_point_density_node.space()]; - point_density->interpolation = - (InterpolationType)b_point_density_node.interpolation(); + point_density->interpolation = get_image_interpolation(b_point_density_node); point_density->builtin_data = b_point_density_node.ptr.data; /* 1 - render settings, 0 - vewport settings. */ @@ -1200,8 +1244,8 @@ void BlenderSync::sync_materials(bool update_all) shader->use_mis = get_boolean(cmat, "sample_as_light"); shader->use_transparent_shadow = get_boolean(cmat, "use_transparent_shadow"); shader->heterogeneous_volume = !get_boolean(cmat, "homogeneous_volume"); - shader->volume_sampling_method = (VolumeSampling)get_enum(cmat, "volume_sampling"); - shader->volume_interpolation_method = (VolumeInterpolation)get_enum(cmat, "volume_interpolation"); + shader->volume_sampling_method = get_volume_sampling(cmat); + shader->volume_interpolation_method = get_volume_interpolation(cmat); shader->set_graph(graph); shader->tag_update(scene); @@ -1231,8 +1275,8 @@ void BlenderSync::sync_world(bool update_all) /* volume */ PointerRNA cworld = RNA_pointer_get(&b_world.ptr, "cycles"); shader->heterogeneous_volume = !get_boolean(cworld, "homogeneous_volume"); - shader->volume_sampling_method = (VolumeSampling)get_enum(cworld, "volume_sampling"); - shader->volume_interpolation_method = (VolumeInterpolation)get_enum(cworld, "volume_interpolation"); + shader->volume_sampling_method = get_volume_sampling(cworld); + shader->volume_interpolation_method = get_volume_interpolation(cworld); } else if(b_world) { ShaderNode *closure, *out; diff --git a/intern/cycles/blender/blender_sync.cpp b/intern/cycles/blender/blender_sync.cpp index 7901d4b8be1..a3cccc62eb4 100644 --- a/intern/cycles/blender/blender_sync.cpp +++ b/intern/cycles/blender/blender_sync.cpp @@ -220,7 +220,11 @@ void BlenderSync::sync_integrator() if(get_boolean(cscene, "use_animated_seed")) integrator->seed = hash_int_2d(b_scene.frame_current(), get_int(cscene, "seed")); - integrator->sampling_pattern = (SamplingPattern)get_enum(cscene, "sampling_pattern"); + integrator->sampling_pattern = (SamplingPattern)get_enum( + cscene, + "sampling_pattern", + SAMPLING_NUM_PATTERNS, + SAMPLING_PATTERN_SOBOL); integrator->layer_flag = render_layer.layer; @@ -237,7 +241,10 @@ void BlenderSync::sync_integrator() } #endif - integrator->method = (Integrator::Method)get_enum(cscene, "progressive"); + integrator->method = (Integrator::Method)get_enum(cscene, + "progressive", + Integrator::NUM_METHODS, + Integrator::PATH); integrator->sample_all_lights_direct = get_boolean(cscene, "sample_all_lights_direct"); integrator->sample_all_lights_indirect = get_boolean(cscene, "sample_all_lights_indirect"); @@ -287,7 +294,10 @@ void BlenderSync::sync_film() film->use_sample_clamp = (integrator->sample_clamp_direct != 0.0f || integrator->sample_clamp_indirect != 0.0f); film->exposure = get_float(cscene, "film_exposure"); - film->filter_type = (FilterType)get_enum(cscene, "pixel_filter_type"); + film->filter_type = (FilterType)get_enum(cscene, + "pixel_filter_type", + FILTER_NUM_TYPES, + FILTER_BLACKMAN_HARRIS); film->filter_width = (film->filter_type == FILTER_BOX)? 1.0f: get_float(cscene, "filter_width"); if(b_scene.world()) { @@ -440,7 +450,11 @@ SceneParams BlenderSync::get_scene_params(BL::Scene& b_scene, if(background) params.bvh_type = SceneParams::BVH_STATIC; else - params.bvh_type = (SceneParams::BVHType)get_enum(cscene, "debug_bvh_type"); + params.bvh_type = (SceneParams::BVHType)get_enum( + cscene, + "debug_bvh_type", + SceneParams::BVH_NUM_TYPES, + SceneParams::BVH_STATIC); params.use_bvh_spatial_split = RNA_boolean_get(&cscene, "debug_use_spatial_splits"); diff --git a/intern/cycles/blender/blender_util.h b/intern/cycles/blender/blender_util.h index 06176b2d289..cefc01bfa91 100644 --- a/intern/cycles/blender/blender_util.h +++ b/intern/cycles/blender/blender_util.h @@ -357,9 +357,24 @@ static inline void set_int(PointerRNA& ptr, const char *name, int value) RNA_int_set(&ptr, name, value); } -static inline int get_enum(PointerRNA& ptr, const char *name) -{ - return RNA_enum_get(&ptr, name); +/* Get a RNA enum value with sanity check: if the RNA value is above num_values + * the function will return a fallback default value. + * + * NOTE: This function assumes that RNA enum values are a continuous sequence + * from 0 to num_values-1. Be careful to use it with enums where some values are + * deprecated! + */ +static inline int get_enum(PointerRNA& ptr, + const char *name, + int num_values = -1, + int default_value = -1) +{ + int value = RNA_enum_get(&ptr, name); + if(num_values != -1 && value >= num_values) { + assert(default_value != -1); + value = default_value; + } + return value; } static inline string get_enum_identifier(PointerRNA& ptr, const char *name) |