60bc34b494
Adding support for converting between Blender custom properties and USD user-defined custom attributes. Custom attributes on Xforms, many data types, and materials are all supported for round-tripping. Please see the USD attributes documentation for more information on custom attributes. Properties are exported with a userProperties: namespace for simple filtering in external apps. This namespace is stripped on import, but other namespace are allowed to persist. An "Import Attributes" parameter has been added with options "None" (do not import attributes), "User" (import attributes in the 'userProperties' namespace only), "All custom" (import all USD custom attributes, the default). An "Export Custom Properties" export option has been added. The property conversion code handles float, double, string and bool types, as well as tuples of size 2, 3 and 4. Note that USD quaternions and arrays of arbitrary length are not yet supported. There is currently no attempt to set the Blender property subtype based on the USD type "role" (e.g., specifying Color or XYZ vector subtypes). This can be addressed in future work. In addition to exporting custom properties, the original Blender object and data names are now saved as USD custom string attributes "userProperties:blender:object_name" and "userProperties:blender:data_name", respectively, on the corresponding USD prims. This feature is enabled with the "Author Blender Name" export option. If a Blender custom string property is named "displayName", it's handled in a special way on export in that its value is used to set the USD prim's "displayName" metadata. Co-authored-by: kiki <charles@skeletalstudios.com> Co-authored-by: Michael Kowalski <makowalski@nvidia.com> Co-authored-by: Charles Wardlaw <kattkieru@users.noreply.github.com> Pull Request: https://projects.blender.org/blender/blender/pulls/118938
106 lines
3.8 KiB
C++
106 lines
3.8 KiB
C++
/* SPDX-FileCopyrightText: 2019 Blender Authors
|
|
*
|
|
* SPDX-License-Identifier: GPL-2.0-or-later */
|
|
#include "usd_writer_camera.hh"
|
|
#include "usd_hierarchy_iterator.hh"
|
|
|
|
#include <pxr/usd/usdGeom/camera.h>
|
|
#include <pxr/usd/usdGeom/tokens.h>
|
|
|
|
#include "BKE_camera.h"
|
|
#include "BLI_assert.h"
|
|
|
|
#include "DEG_depsgraph_query.hh"
|
|
|
|
#include "DNA_camera_types.h"
|
|
#include "DNA_scene_types.h"
|
|
|
|
namespace blender::io::usd {
|
|
|
|
USDCameraWriter::USDCameraWriter(const USDExporterContext &ctx) : USDAbstractWriter(ctx) {}
|
|
|
|
bool USDCameraWriter::is_supported(const HierarchyContext *context) const
|
|
{
|
|
const Camera *camera = static_cast<const Camera *>(context->object->data);
|
|
return camera->type == CAM_PERSP;
|
|
}
|
|
|
|
static void camera_sensor_size_for_render(const Camera *camera,
|
|
const RenderData *rd,
|
|
float *r_sensor,
|
|
float *r_sensor_x,
|
|
float *r_sensor_y)
|
|
{
|
|
/* Compute the final image size in pixels. */
|
|
float sizex = rd->xsch * rd->xasp;
|
|
float sizey = rd->ysch * rd->yasp;
|
|
|
|
int sensor_fit = BKE_camera_sensor_fit(camera->sensor_fit, sizex, sizey);
|
|
float sensor_size = BKE_camera_sensor_size(
|
|
camera->sensor_fit, camera->sensor_x, camera->sensor_y);
|
|
*r_sensor = sensor_size;
|
|
|
|
switch (sensor_fit) {
|
|
case CAMERA_SENSOR_FIT_HOR:
|
|
*r_sensor_x = sensor_size;
|
|
*r_sensor_y = sensor_size * sizey / sizex;
|
|
break;
|
|
case CAMERA_SENSOR_FIT_VERT:
|
|
*r_sensor_x = sensor_size * sizex / sizey;
|
|
*r_sensor_y = sensor_size;
|
|
break;
|
|
case CAMERA_SENSOR_FIT_AUTO:
|
|
BLI_assert_msg(0, "Camera fit should be either horizontal or vertical");
|
|
break;
|
|
}
|
|
}
|
|
|
|
void USDCameraWriter::do_write(HierarchyContext &context)
|
|
{
|
|
pxr::UsdTimeCode timecode = get_export_time_code();
|
|
pxr::UsdGeomCamera usd_camera = pxr::UsdGeomCamera::Define(usd_export_context_.stage,
|
|
usd_export_context_.usd_path);
|
|
|
|
const Camera *camera = static_cast<const Camera *>(context.object->data);
|
|
Scene *scene = DEG_get_evaluated_scene(usd_export_context_.depsgraph);
|
|
|
|
usd_camera.CreateProjectionAttr().Set(pxr::UsdGeomTokens->perspective);
|
|
|
|
/*
|
|
* For USD, these camera properties are in tenths of a world unit.
|
|
* https://graphics.pixar.com/usd/release/api/class_usd_geom_camera.html#UsdGeom_CameraUnits
|
|
*
|
|
* tenth_unit_to_meters = stage_meters_per_unit / 10
|
|
* tenth_unit_to_millimeters = 1000 * unit_to_tenth_unit
|
|
* = 100 * stage_meters_per_unit
|
|
*/
|
|
const float tenth_unit_to_mm = 100.0f * scene->unit.scale_length;
|
|
|
|
float sensor_size, aperture_x, aperture_y;
|
|
camera_sensor_size_for_render(camera, &scene->r, &sensor_size, &aperture_x, &aperture_y);
|
|
|
|
usd_camera.CreateFocalLengthAttr().Set(camera->lens / tenth_unit_to_mm, timecode);
|
|
usd_camera.CreateHorizontalApertureAttr().Set(aperture_x / tenth_unit_to_mm, timecode);
|
|
usd_camera.CreateVerticalApertureAttr().Set(aperture_y / tenth_unit_to_mm, timecode);
|
|
usd_camera.CreateHorizontalApertureOffsetAttr().Set(
|
|
sensor_size * camera->shiftx / tenth_unit_to_mm, timecode);
|
|
usd_camera.CreateVerticalApertureOffsetAttr().Set(
|
|
sensor_size * camera->shifty / tenth_unit_to_mm, timecode);
|
|
|
|
usd_camera.CreateClippingRangeAttr().Set(
|
|
pxr::VtValue(pxr::GfVec2f(camera->clip_start, camera->clip_end)), timecode);
|
|
|
|
/* Write DoF-related attributes. */
|
|
if (camera->dof.flag & CAM_DOF_ENABLED) {
|
|
usd_camera.CreateFStopAttr().Set(camera->dof.aperture_fstop, timecode);
|
|
|
|
float focus_distance = BKE_camera_object_dof_distance(context.object);
|
|
usd_camera.CreateFocusDistanceAttr().Set(focus_distance, timecode);
|
|
}
|
|
|
|
auto prim = usd_camera.GetPrim();
|
|
write_id_properties(prim, camera->id, timecode);
|
|
}
|
|
|
|
} // namespace blender::io::usd
|