blender
/
blender
133
398
Fork 579
Code Issues 6.3k Pull Requests 752 Projects 19 Wiki Activity

EEVEE-Next: Rename light probes #113452

Merged
Miguel Pozo merged 9 commits from pragma37/blender:pull-probes-rename into main 2023-10-11 19:38:51 +02:00
Conversation 3 Commits 9 Files Changed 19 +95 -91
Miguel Pozo commented 2023-10-09 17:14:00 +02:00
Member
Copy Link

Update to the new naming convention for Light Probes:

Reflection Cubemap -> Sphere
Reflection Plane -> Plane
Irradiance Grid -> Volume

Note that this breaks the Python API (bpy.types.LightProbe.type).

Update to the new naming convention for `Light Probes`: `Reflection Cubemap` -> `Sphere` `Reflection Plane` -> `Plane` `Irradiance Grid` -> `Volume` Note that this breaks the Python API (`bpy.types.LightProbe.type`).
Miguel Pozo added the
Module
EEVEE & Viewport
 label 2023-10-09 17:14:00 +02:00
Miguel Pozo added 3 commits 2023-10-09 17:14:10 +02:00
Miguel Pozo requested review from Clément Foucault 2023-10-09 17:14:24 +02:00
Clément Foucault requested changes 2023-10-09 17:57:08 +02:00
Clément Foucault left a comment
Member
Copy Link

I wouldn't break the python API just for this. GRID is still ok for volume.
As for the CUBE into CUBEMAP i'm not sure. I would say it isn't ok either.

However I would still rename CUBEMAP to SPHERICAL internally (on C++ side) as this is eventually what we will use in UI, and that's less confusing in that it doesn't conflict with any storage method.

I wouldn't break the python API just for this. `GRID` is still ok for volume. As for the `CUBE` into `CUBEMAP` i'm not sure. I would say it isn't ok either. However I would still rename CUBEMAP to SPHERICAL internally (on C++ side) as this is eventually what we will use in UI, and that's less confusing in that it doesn't conflict with any storage method.
source/blender/editors/object/object_add.cc Outdated
@ -181,1 +167,3 @@
"Irradiance probe to capture diffuse indirect lighting"},
{LIGHTPROBE_TYPE_CUBEMAP, "CUBEMAP", ICON_LIGHTPROBE_CUBEMAP, "Cubemap", "Cubemap probe"},
{LIGHTPROBE_TYPE_PLANAR, "PLANAR", ICON_LIGHTPROBE_PLANAR, "Planar", "Planar probe"},
{LIGHTPROBE_TYPE_VOLUME, "VOLUME", ICON_LIGHTPROBE_VOLUME, "Volume", "Volume probe"},
Clément Foucault commented 2023-10-09 17:55:02 +02:00
Member
Copy Link
"Sphere", "Light probe that captures precise lighting from all directions at a single point in space"
"Plane", "Light probe that captures incoming light from a single direction on a plane"
"Volume", "Light probe that captures low frequency lighting inside a volume"
``` "Sphere", "Light probe that captures precise lighting from all directions at a single point in space" "Plane", "Light probe that captures incoming light from a single direction on a plane" "Volume", "Light probe that captures low frequency lighting inside a volume" ```
👍 1
Miguel Pozo commented 2023-10-09 18:31:54 +02:00
Author
Member
Copy Link

However I would still rename CUBEMAP to SPHERICAL internally (on C++ side) as this is eventually what we will use in UI,

If you are sure this is what is eventually going to be called in the UI, then I don't see the point in deferring it.

I wouldn't break the python API just for this. GRID is still ok for volume.
As for the CUBE into CUBEMAP i'm not sure. I would say it isn't ok either.

IMO the mismatch in UI/API naming is worse and potentially more time consuming than a one-time search and replace.

CUBE/CUBEMAP is weird because the Python enum seems to be declared twice? The actual current value is CUBEMAP: https://docs.blender.org/api/current/bpy.types.LightProbe.html#bpy.types.LightProbe.type

> However I would still rename CUBEMAP to SPHERICAL internally (on C++ side) as this is eventually what we will use in UI, If you are sure this is what is eventually going to be called in the UI, then I don't see the point in deferring it. > I wouldn't break the python API just for this. GRID is still ok for volume. As for the CUBE into CUBEMAP i'm not sure. I would say it isn't ok either. IMO the mismatch in UI/API naming is worse and potentially more time consuming than a one-time search and replace. `CUBE`/`CUBEMAP` is weird because the Python enum seems to be declared twice? The actual current value is `CUBEMAP`: https://docs.blender.org/api/current/bpy.types.LightProbe.html#bpy.types.LightProbe.type
Clément Foucault commented 2023-10-10 16:08:41 +02:00
Member
Copy Link

Went over the changes with @pablovazquez . Breaking the Python API is acceptable for such a big change. We decided on Sphere, Plane and Volume for the lightprobe type.

Went over the changes with @pablovazquez . Breaking the Python API is acceptable for such a big change. We decided on `Sphere`, `Plane` and `Volume` for the lightprobe type.
👀 1
Miguel Pozo added 1 commit 2023-10-10 21:13:02 +02:00
Clément Foucault requested changes 2023-10-11 01:11:37 +02:00
source/blender/makesrna/intern/rna_object.cc Outdated
@ -238,1 +236,3 @@
{LIGHTPROBE_TYPE_GRID, "GRID", ICON_LIGHTPROBE_GRID, "Grid", ""},
{LIGHTPROBE_TYPE_SPHERE, "CUBEMAP", ICON_LIGHTPROBE_SPHERE, "Cubemap", ""},
{LIGHTPROBE_TYPE_PLANE, "PLANAR", ICON_LIGHTPROBE_PLANE, "Planar", ""},
{LIGHTPROBE_TYPE_VOLUME, "VOLUME", ICON_LIGHTPROBE_VOLUME, "VOLUME", ""},
Clément Foucault commented 2023-10-11 01:11:18 +02:00
Member
Copy Link

Uppercase VOLUME in name. Should be title case.

Uppercase VOLUME in name. Should be title case.
Miguel Pozo added 1 commit 2023-10-11 15:20:57 +02:00
Clément Foucault approved these changes 2023-10-11 15:26:08 +02:00
Clément Foucault requested changes 2023-10-11 15:27:47 +02:00
Clément Foucault left a comment
Member
Copy Link

Make sure to review all other occurences. We should rename everything at once

Make sure to review all other occurences. We should rename everything at once
source/blender/makesrna/intern/rna_object.cc Outdated
@ -236,3 +236,1 @@
{LIGHTPROBE_TYPE_CUBE, "CUBE", ICON_LIGHTPROBE_CUBEMAP, "Cube", ""},
{LIGHTPROBE_TYPE_PLANAR, "PLANAR", ICON_LIGHTPROBE_PLANAR, "Planar", ""},
{LIGHTPROBE_TYPE_GRID, "GRID", ICON_LIGHTPROBE_GRID, "Grid", ""},
{LIGHTPROBE_TYPE_SPHERE, "CUBEMAP", ICON_LIGHTPROBE_SPHERE, "Cubemap", ""},
Clément Foucault commented 2023-10-11 15:26:53 +02:00
Member
Copy Link

We decide to change the name and enum. so SPHERE and "Sphere"

EDIT: That this changes more python areas. Do we really want to do that right now? I would say yes.

We decide to change the name and enum. so `SPHERE` and "Sphere" EDIT: That this changes more python areas. Do we really want to do that right now? I would say yes.
pragma37 marked this conversation as resolved
source/blender/makesrna/intern/rna_object.cc Outdated
@ -237,2 +236,2 @@
{LIGHTPROBE_TYPE_PLANAR, "PLANAR", ICON_LIGHTPROBE_PLANAR, "Planar", ""},
{LIGHTPROBE_TYPE_GRID, "GRID", ICON_LIGHTPROBE_GRID, "Grid", ""},
{LIGHTPROBE_TYPE_SPHERE, "CUBEMAP", ICON_LIGHTPROBE_SPHERE, "Cubemap", ""},
{LIGHTPROBE_TYPE_PLANE, "PLANAR", ICON_LIGHTPROBE_PLANE, "Planar", ""},
Clément Foucault commented 2023-10-11 15:27:09 +02:00
Member
Copy Link

PLANE and Plane

`PLANE` and `Plane`
pragma37 marked this conversation as resolved
Miguel Pozo added 1 commit 2023-10-11 15:51:35 +02:00
Miguel Pozo added 1 commit 2023-10-11 15:52:58 +02:00
Miguel Pozo added 1 commit 2023-10-11 15:58:34 +02:00
buildbot/vexp-code-patch-coordinator Build done. Details
bb1b3d3542 Fix UI
Clément Foucault commented 2023-10-11 18:48:25 +02:00
Member
Copy Link

@blender-bot build

@blender-bot build
Clément Foucault approved these changes 2023-10-11 18:48:40 +02:00
Miguel Pozo added 1 commit 2023-10-11 19:34:41 +02:00
Miguel Pozo merged commit 1ba16edaf0 into main 2023-10-11 19:38:51 +02:00
Miguel Pozo deleted branch pull-probes-rename 2023-10-11 19:38:52 +02:00
Sign in to join this conversation.
Reviewers
No reviewers
Clément Foucault
Labels
Clear labels   
Interest
Alembic

  
Interest
Animation & Rigging

  
Interest
Asset Browser

  
Interest
Asset Browser Project Overview

  
Interest
Audio

  
Interest
Automated Testing

  
Interest
Blender Asset Bundle

  
Interest
BlendFile

  
Interest
Collada

  
Interest
Compatibility
This issue affects/is about backward or forward compatibility

  
Interest
Compositing

  
Interest
Core

  
Interest
Cycles

  
Interest
Dependency Graph

  
Interest
Development Management

  
Interest
EEVEE

  
Interest
EEVEE & Viewport

  
Interest
Freestyle

  
Interest
Geometry Nodes

  
Interest
Grease Pencil

  
Interest
ID Management

  
Interest
Images & Movies

  
Interest
Import Export

  
Interest
Line Art

  
Interest
Masking

  
Interest
Metal

  
Interest
Modeling

  
Interest
Modifiers

  
Interest
Motion Tracking

  
Interest
Nodes & Physics

  
Interest
OpenGL

  
Interest
Overlay

  
Interest
Overrides

  
Interest
Performance

  
Interest
Physics

  
Interest
Pipeline, Assets & IO

  
Interest
Platforms, Builds & Tests

  
Interest
Python API

  
Interest
Render & Cycles

  
Interest
Render Pipeline

  
Interest
Sculpt, Paint & Texture

  
Interest
Text Editor

  
Interest
Translations

  
Interest
Triaging

  
Interest
Undo

  
Interest
USD

  
Interest
User Interface

  
Interest
UV Editing

  
Interest
VFX & Video

  
Interest
Video Sequencer

  
Interest
Virtual Reality

  
Interest
Vulkan

  
Interest
Wayland
Issues relating to Wayland windowing support.

  
Interest
Workbench

  
Interest: X11

Issues relating to Xorg/X11 support.

  
Legacy
Blender 2.8 Project

  
Legacy
Milestone 1: Basic, Local Asset Browser

  
Legacy
OpenGL Error

  
Meta
Good First Issue

  
Meta
Papercut

  
Meta
Retrospective

  
Meta
Security
Issues relating to security: https://wiki.blender.org/wiki/Process/Vulnerability_Reports

  
Module
Animation & Rigging

  
Module
Core

  
Module
Development Management

  
Module
EEVEE & Viewport

  
Module
Grease Pencil

  
Module
Modeling

  
Module
Nodes & Physics

  
Module
Pipeline, Assets & IO

  
Module
Platforms, Builds & Tests

  
Module
Python API

  
Module
Render & Cycles

  
Module
Sculpt, Paint & Texture

  
Module
Triaging

  
Module
User Interface

  
Module
VFX & Video

  
Platform
FreeBSD

  
Platform
Linux

  
Platform
macOS

  
Platform
Windows

  
Priority
High

  
Priority
Low

  
Priority
Normal

  
Priority
Unbreak Now!

  
Status
Archived

  
Status
Confirmed

  
Status
Duplicate

  
Status
Needs Info from Developers

  
Status
Needs Information from User

  
Status
Needs Triage

  
Status
Resolved

  
Type
Bug

  
Type
Design

  
Type
Known Issue

  
Type
Patch

  
Type
Report

  
Type
To Do

No Label
Interest
Alembic
Interest
Animation & Rigging
Interest
Asset Browser
Interest
Asset Browser Project Overview
Interest
Audio
Interest
Automated Testing
Interest
Blender Asset Bundle
Interest
BlendFile
Interest
Collada
Interest
Compatibility
Interest
Compositing
Interest
Core
Interest
Cycles
Interest
Dependency Graph
Interest
Development Management
Interest
EEVEE
Interest
EEVEE & Viewport
Interest
Freestyle
Interest
Geometry Nodes
Interest
Grease Pencil
Interest
ID Management
Interest
Images & Movies
Interest
Import Export
Interest
Line Art
Interest
Masking
Interest
Metal
Interest
Modeling
Interest
Modifiers
Interest
Motion Tracking
Interest
Nodes & Physics
Interest
OpenGL
Interest
Overlay
Interest
Overrides
Interest
Performance
Interest
Physics
Interest
Pipeline, Assets & IO
Interest
Platforms, Builds & Tests
Interest
Python API
Interest
Render & Cycles
Interest
Render Pipeline
Interest
Sculpt, Paint & Texture
Interest
Text Editor
Interest
Translations
Interest
Triaging
Interest
Undo
Interest
USD
Interest
User Interface
Interest
UV Editing
Interest
VFX & Video
Interest
Video Sequencer
Interest
Virtual Reality
Interest
Vulkan
Interest
Wayland
Interest
Workbench
Interest: X11
Legacy
Blender 2.8 Project
Legacy
Milestone 1: Basic, Local Asset Browser
Legacy
OpenGL Error
Meta
Good First Issue
Meta
Papercut
Meta
Retrospective
Meta
Security
Module
Animation & Rigging
Module
Core
Module
Development Management
Module
EEVEE & Viewport
Module
Grease Pencil
Module
Modeling
Module
Nodes & Physics
Module
Pipeline, Assets & IO
Module
Platforms, Builds & Tests
Module
Python API
Module
Render & Cycles
Module
Sculpt, Paint & Texture
Module
Triaging
Module
User Interface
Module
VFX & Video
Platform
FreeBSD
Platform
Linux
Platform
macOS
Platform
Windows
Priority
High
Priority
Low
Priority
Normal
Priority
Unbreak Now!
Status
Archived
Status
Confirmed
Status
Duplicate
Status
Needs Info from Developers
Status
Needs Information from User
Status
Needs Triage
Status
Resolved
Type
Bug
Type
Design
Type
Known Issue
Type
Patch
Type
Report
Type
To Do
Milestone
Clear milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
No Assignees
2 Participants
Notifications
Due Date
The due date is invalid or out of range. Please use the format 'yyyy-mm-dd'.

No due date set.

Dependencies

No dependencies set.

Reference: blender/blender#113452
No description provided.
Delete Branch "pragma37/blender:pull-probes-rename"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?