path: root/space_view3d_panel_measure.py

# ##### 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.
#
# ##### END GPL LICENSE BLOCK #####

import bpy
from bpy.props import *
from mathutils import Vector, Matrix

# Precicion for display of float values.
PRECISION = 5

bl_addon_info = {
    'name': '3D View: Measure panel',
    'author': 'Buerbaum Martin (Pontiac)',
    'version': '0.6.4',
    'blender': (2, 5, 3),
    'location': 'View3D > Properties > Measure',
    'description': 'Measure distances between objects',
    'url': 'http://wiki.blender.org/index.php/Extensions:2.5/Py/' \
        'Scripts/3D_interaction/Panel_Measure',
    'category': '3D View'}

__bpydoc__ = """
Measure panel

This script displays in OBJECT MODE:
* The distance of the 3D cursor to the origin of the
  3D space (if NOTHING is selected).
* The distance of the 3D cursor to the center of an object
  (if exactly ONE object is selected).
* The distance between 2 object centers
  (if exactly TWO objects are selected).
* The surface area of any selected mesh object.

Display in EDIT MODE (Local and Global space supported):
* The distance of the 3D cursor to the origin
  (in Local space it is the object center instead).
* The distance of the 3D cursor to a selected vertex.
* The distance between 2 selected vertices.

Usage:

This functionality can be accessed via the
"Properties" panel in 3D View ([N] key).

It's very helpful to use one or two "Empty" objects with
"Snap during transform" enabled for fast measurement.

Version history:
v0.6.4 - Fixed unneeded meshdata duplication (sometimes crashes Blender).
    The script now correctly calculated the surface area (faceAreaGlobal)
    of scaled meshes.
    http://projects.blender.org/tracker/
    ?func=detail&atid=453&aid=21913&group_id=153
v0.6.3 - Added register & unregister functions.
v0.6.2 - Fixed precision of second area property.
    Reduced display precision to 5 (instead of 6).
    Added (commented out code) for shortcut [F5] for
    updating EditMode selection & calculation.
    Changed the script so it can be managed from the "Add-Ons" tab
    in the user preferences.
    Corrected FSF address.
v0.6.1 - Updated reenter_editmode operator description.
    Fixed search for selected mesh objects.
    Added "BU^2" after values that are not yet translated via "unit".
v0.6
    *) Fix:  Removed EditMode/ObjectMode toggle stuff. This causes all the
       crashes and is generally not stable.
       Instead I've added a manual "refresh" button.
       I registered a new operator OBJECT_OT_reenter_editmode for this.
    *) Use "unit" settings (i.e. none/metric/imperial)
    *) Fix: Only display surface area (>=3 objects) if return value is >=0.
    *) Minor: Renamed objectFaceArea to objectSurfaceArea
    *) Updated Vector() and tuple() usage.
    *) Fixed some comments.
v0.5 - Global surface area (object mode) is now calculated as well.
    Support area calculation for face selection.
    Also made measurement panel closed by default. (Area calculation
    may use up a lot of CPU/RAM in extreme cases)
v0.4.1 - Various cleanups.
    Using the shorter "scene" instead of "context.scene"
    New functions measureGlobal() and measureLocal() for
    user-friendly access to the "space" setting.
v0.4 - Calculate & display the surface area of mesh
    objects (local space only right now).
    Expanded global/local switch.
    Made "local" option for 3Dcursor-only in edit mode actually work.
    Fixed local/global calculation for 3Dcursor<->vertex in edit mode.
v0.3.2 - Fixed calculation & display of local/global coordinates.
    The user can now select via dropdown which space is wanted/needed
    Basically this is a bugfix and new feature at the same time :-)
v0.3.1 - Fixed bug where "measure_panel_dist" wasn't defined
    before it was used.
    Also added the distance calculation "origin -> 3D cursor" for edit mode.
v0.3 - Support for mesh edit mode (1 or 2 selected vertices)
v0.2.1 - Small fix (selecting nothing didn't calculate the distance
    of the cursor from the origin anymore)
v0.2 - Distance value is now displayed via a FloatProperty widget (and
    therefore saved to file too right now [according to ideasman42].
    The value is save inside the scene right now.)
    Thanks goes to ideasman42 (Campbell Barton) for helping me out on this.
v0.1 - Initial revision. Seems to work fine for most purposes.

TODO:

There is a random segmentation fault when moving the 3D cursor in edit mode.
Mainly this happens when clicking inside the white circle of the translation
manipulator. There may be other cases though.

See the other "todo" comments below.
"""


# Return the area of a face (in global space).
# @note Copies the functionality of the following functions,
# but also respects the scaling (via the "obj.matrix" parameter):
# @sa: rna_mesh.c:rna_MeshFace_area_get
# @sa: math_geom.c:area_quad_v3
# @sa: math_geom.c:area_tri_v3
def faceAreaGlobal(face, obj):
    area = 0.0

    mat = obj.matrix

    if len(face.verts) == 4:
        # Quad

        # Get vertex indices
        v1, v2, v3, v4 = face.verts

        # Get vertex data
        v1 = obj.data.verts[v1]
        v2 = obj.data.verts[v2]
        v3 = obj.data.verts[v3]
        v4 = obj.data.verts[v4]

        # Apply transform matrix to vertex coordinates.
        v1 = Vector(tuple(v1.co)) * mat
        v2 = Vector(tuple(v2.co)) * mat
        v3 = Vector(tuple(v3.co)) * mat
        v4 = Vector(tuple(v4.co)) * mat

        vec1 = v2 - v1
        vec2 = v4 - v1

        n = vec1.cross(vec2)

        area = n.length / 2.0

        vec1 = v4 - v3
        vec2 = v2 - v3

        n = vec1.cross(vec2)

        area += n.length / 2.0

    elif len(face.verts) == 3:
        # Triangle

        # Get vertex indices
        v1, v2, v3 = face.verts

        # Get vertex data
        v1 = obj.data.verts[v1]
        v2 = obj.data.verts[v2]
        v3 = obj.data.verts[v3]

        # Apply transform matrix to vertex coordinates.
        v1 = Vector(tuple(v1.co)) * mat
        v2 = Vector(tuple(v2.co)) * mat
        v3 = Vector(tuple(v3.co)) * mat

        vec1 = v3 - v2
        vec2 = v1 - v2

        n = vec1.cross(vec2)

        area = n.length / 2.0

    return area


# Calculate the surface area of a mesh object.
# *) Set selectedOnly=1 if you only want to count selected faces.
# *) Set globalSpace=1 if you want to calculate
#    the global surface area (object mode).
# Note: Be sure you have updated the mesh data before
#       running this with selectedOnly=1!
# @todo Support other object types (surfaces, etc...)?
def objectSurfaceArea(obj, selectedOnly, globalSpace):
    if (obj and obj.type == 'MESH' and obj.data):
        areaTotal = 0

        mesh = obj.data

        # Count the area of all the faces.
        for face in mesh.faces:
            if not selectedOnly or face.selected:
                if globalSpace:
                    areaTotal += faceAreaGlobal(face, obj)
                else:
                    areaTotal += face.area

        return areaTotal

    # We can not calculate an area for this object.
    return -1


# User friendly access to the "space" setting.
def measureGlobal(scene):
    return (scene.measure_panel_transform == "measure_global")


# User friendly access to the "space" setting.
def measureLocal(scene):
    return (scene.measure_panel_transform == "measure_local")


class OBJECT_OT_reenter_editmode(bpy.types.Operator):
    bl_label = "Re-enter EditMode"
    bl_idname = "reenter_editmode"
    bl_description = "Update mesh data of an active mesh object." \
        " This is done by exiting and re-entering mesh edit mode."

    def invoke(self, context, event):

        # Get the active object.
        obj = context.active_object

        if (obj and obj.type == 'MESH' and context.mode == 'EDIT_MESH'):
            # Exit and re-enter mesh EditMode.
            bpy.ops.object.mode_set(mode='OBJECT')
            bpy.ops.object.mode_set(mode='EDIT')
            return {'FINISHED'}

        return {'CANCELLED'}


class VIEW3D_PT_measure(bpy.types.Panel):
    bl_space_type = 'VIEW_3D'
    bl_region_type = 'UI'
    bl_label = "Measure"
    bl_default_closed = True

    def draw(self, context):
        layout = self.layout
        scene = context.scene

        # Get the active object.
        obj = context.active_object

        # Define a temporary attribute for the distance value
        scene.FloatProperty(
            name="Distance",
            attr="measure_panel_dist",
            precision=PRECISION,
            unit="LENGTH")
        scene.FloatProperty(
            attr="measure_panel_area1",
            precision=PRECISION,
            unit="AREA")
        scene.FloatProperty(
            attr="measure_panel_area2",
            precision=PRECISION,
            unit="AREA")

        TRANSFORM = [
            ("measure_global", "Global",
                "Calculate values in global space."),
            ("measure_local", "Local",
                "Calculate values inside the local object space.")]

        # Define dropdown for the global/local setting
        bpy.types.Scene.EnumProperty(
            attr="measure_panel_transform",
            name="Space",
            description="Choose in which space you want to measure.",
            items=TRANSFORM,
            default='measure_global')

        if (context.mode == 'EDIT_MESH'):
            if (obj and obj.type == 'MESH' and obj.data):
                # "Note: a Mesh will return the selection state of the mesh
                # when EditMode was last exited. A Python script operating
                # in EditMode must exit EditMode before getting the current
                # selection state of the mesh."
                # http://www.blender.org/documentation/249PythonDoc/
                # /Mesh.MVert-class.html#sel
                # We can only provide this by existing & re-entering EditMode.
                # @todo: Better way to do this?

                # Get mesh data from Object.
                mesh = obj.data

                # Get transformation matrix from object.
                ob_mat = obj.matrix
                # Also make an inversed copy! of the matrix.
                ob_mat_inv = ob_mat.copy()
                Matrix.invert(ob_mat_inv)

                # Get the selected vertices.
                # @todo: Better (more efficient) way to do this?
                verts_selected = [v for v in mesh.verts if v.selected == 1]

                if len(verts_selected) == 0:
                    # Nothing selected.
                    # We measure the distance from the origin to the 3D cursor.
                    dist_vec = scene.cursor_location

                    # Convert to local space, if needed.
                    if measureLocal(scene):
                        obj_loc = Vector(tuple(obj.location))
                        dist_vec = (dist_vec - obj_loc) * ob_mat_inv

                    scene.measure_panel_dist = dist_vec.length

                    row = layout.row()
                    row.prop(scene, "measure_panel_dist")

                    row = layout.row()
                    row.label(text="", icon='CURSOR')
                    row.label(text="", icon='ARROW_LEFTRIGHT')
                    row.label(text="Origin [0,0,0]")

                    row = layout.row()
                    row.operator("reenter_editmode",
                        text="Update selection & distance")
#                       @todo
#                        description="The surface area value can" \
#                            " not be updated in mesh edit mode" \
#                            " automatically. Press this button" \
#                            " to do this manually, after you changed" \
#                            " the selection.")

                    row = layout.row()
                    row.prop(scene,
                        "measure_panel_transform",
                        expand=True)

                elif len(verts_selected) == 1:
                    # One vertex selected.
                    # We measure the distance from the
                    # selected vertex object to the 3D cursor.
                    cur_loc = scene.cursor_location
                    vert_loc = Vector(tuple(verts_selected[0].co))
                    obj_loc = Vector(tuple(obj.location))

                    # Convert to local or global space.
                    if measureLocal(scene):
                        dist_vec = vert_loc - (cur_loc - obj_loc) * ob_mat_inv
                    else:
                        dist_vec = vert_loc * ob_mat + obj_loc - cur_loc

                    scene.measure_panel_dist = dist_vec.length

                    row = layout.row()
                    row.prop(scene, "measure_panel_dist")

                    row = layout.row()
                    row.label(text="", icon='CURSOR')
                    row.label(text="", icon='ARROW_LEFTRIGHT')
                    row.label(text="", icon='VERTEXSEL')

                    row = layout.row()
                    row.operator("reenter_editmode",
                        text="Update selection & distance")

                    row = layout.row()
                    row.prop(scene,
                        "measure_panel_transform",
                        expand=True)

                elif len(verts_selected) == 2:
                    # Two vertices selected.
                    # We measure the distance between the
                    # two selected vertices.
                    vert1_loc = Vector(tuple(verts_selected[0].co))
                    vert2_loc = Vector(tuple(verts_selected[1].co))

                    # Convert to local or global space.
                    if measureLocal(scene):
                        dist_vec = vert1_loc - vert2_loc
                    else:
                        dist_vec = vert1_loc * ob_mat - vert2_loc * ob_mat

                    scene.measure_panel_dist = dist_vec.length

                    row = layout.row()
                    row.prop(scene, "measure_panel_dist")

                    row = layout.row()
                    row.label(text="", icon='VERTEXSEL')
                    row.label(text="", icon='ARROW_LEFTRIGHT')
                    row.label(text="", icon='VERTEXSEL')

                    row = layout.row()
                    row.operator("reenter_editmode",
                        text="Update selection & distance")

                    row = layout.row()
                    row.prop(scene,
                        "measure_panel_transform",
                        expand=True)

                else:
                    # Get selected faces
                    # @todo: Better (more efficient) way to do this?
                    faces_selected = [f for f in mesh.faces if f.selected == 1]

                    if len(faces_selected) > 0:
                        area = objectSurfaceArea(obj, True,
                            measureGlobal(scene))
                        if (area >= 0):
                            row = layout.row()
                            row.label(text="Surface area (selected faces):")

                            row = layout.row()
                            row.label(
                                text=str(len(faces_selected)),
                                icon='FACESEL')
                            scene.measure_panel_area1 = area
                            row.prop(scene, "measure_panel_area1")

                            row = layout.row()
                            row.operator("reenter_editmode",
                                text="Update selection & area")

                            row = layout.row()
                            row.prop(scene,
                                "measure_panel_transform",
                                expand=True)

                    else:
                        row = layout.row()
                        row.label(text="Selection not supported.", icon='INFO')

                        row = layout.row()
                        row.operator("reenter_editmode",
                            text="Update selection")

        elif (context.mode == 'OBJECT'):
            # We are working on object mode.

            if (context.selected_objects
                and len(context.selected_objects) > 2):
                # We have more that 2 objects selected...

                mesh_objects = [o for o in context.selected_objects
                    if (o.type == 'MESH' and o.data)]

                if (len(mesh_objects) > 0):
                    # ... and at least one of them is a mesh.

                    # Calculate and display surface area of the objects.
                    # @todo: Convert to scene units! We do not have a
                    # FloatProperty field here for automatic conversion.
                    row = layout.row()
                    row.label(text="Surface area:")

                    row = layout.row()
                    for o in mesh_objects:
                        area = objectSurfaceArea(o, False,
                            measureGlobal(scene))
                        if (area >= 0):
                            row = layout.row()
                            row.label(text=o.name, icon='OBJECT_DATA')
                            row.label(text=str(round(area, PRECISION))
                                + " BU^2")

                    row = layout.row()
                    row.prop(scene,
                        "measure_panel_transform",
                        expand=True)

            elif (context.selected_objects
                  and len(context.selected_objects) == 2):
                # 2 objects selected.
                # We measure the distance between the 2 selected objects.
                obj1 = context.selected_objects[0]
                obj2 = context.selected_objects[1]
                obj1_loc = Vector(tuple(obj1.location))
                obj2_loc = Vector(tuple(obj2.location))
                dist_vec = obj1_loc - obj2_loc

                scene.measure_panel_dist = dist_vec.length

                row = layout.row()
                row.prop(scene, "measure_panel_dist")

                row = layout.row()
                row.label(text="", icon='OBJECT_DATA')
                row.prop(obj1, "name", text="")

                row.label(text="", icon='ARROW_LEFTRIGHT')

                row.label(text="", icon='OBJECT_DATA')
                row.prop(obj2, "name", text="")

                # Calculate and display surface area of the objects.
                area1 = objectSurfaceArea(obj1, False, measureGlobal(scene))
                area2 = objectSurfaceArea(obj2, False, measureGlobal(scene))
                if (area1 >= 0 or area2 >= 0):
                    row = layout.row()
                    row.label(text="Surface area:")

                    if (area1 >= 0):
                        row = layout.row()
                        row.label(text=obj1.name, icon='OBJECT_DATA')
                        scene.measure_panel_area1 = area1
                        row.prop(scene, "measure_panel_area1")

                    if (area2 >= 0):
                        row = layout.row()
                        row.label(text=obj2.name, icon='OBJECT_DATA')
                        scene.measure_panel_area2 = area2
                        row.prop(scene, "measure_panel_area2")

                    row = layout.row()
                    row.prop(scene,
                        "measure_panel_transform",
                        expand=True)

            elif (obj and  obj.selected
                  and context.selected_objects
                  and len(context.selected_objects) == 1):
                # One object selected.
                # We measure the distance from the
                # selected & active) object to the 3D cursor.
                cur_loc = scene.cursor_location
                obj_loc = Vector(tuple(obj.location))
                dist_vec = obj_loc - cur_loc

                scene.measure_panel_dist = dist_vec.length

                row = layout.row()
                #row.label(text=str(dist_vec.length))
                row.prop(scene, "measure_panel_dist")

                row = layout.row()
                row.label(text="", icon='CURSOR')

                row.label(text="", icon='ARROW_LEFTRIGHT')

                row.label(text="", icon='OBJECT_DATA')
                row.prop(obj, "name", text="")

                # Calculate and display surface area of the object.
                area = objectSurfaceArea(obj, False, measureGlobal(scene))
                if (area >= 0):
                    row = layout.row()
                    row.label(text="Surface area:")

                    row = layout.row()
                    row.label(text=obj.name, icon='OBJECT_DATA')
                    scene.measure_panel_area1 = area
                    row.prop(scene, "measure_panel_area1")

                    row = layout.row()
                    row.prop(scene,
                        "measure_panel_transform",
                        expand=True)

            elif (not context.selected_objects
                  or len(context.selected_objects) == 0):
                # Nothing selected.
                # We measure the distance from the origin to the 3D cursor.
                dist_vec = scene.cursor_location
                scene.measure_panel_dist = dist_vec.length

                row = layout.row()
                row.prop(scene, "measure_panel_dist")

                row = layout.row()
                row.label(text="", icon='CURSOR')
                row.label(text="", icon='ARROW_LEFTRIGHT')
                row.label(text="Origin [0,0,0]")

            else:
                row = layout.row()
                row.label(text="Selection not supported.", icon='INFO')


def register():
    bpy.types.register(VIEW3D_PT_measure)
    bpy.types.register(OBJECT_OT_reenter_editmode)


def unregister():
    bpy.types.unregister(VIEW3D_PT_measure)
    bpy.types.unregister(OBJECT_OT_reenter_editmode)

## @todo Register keypress for EditMode seletion refresh.
## @todo Check if we overwrite a setting?
#wm = bpy.data.window_managers['WinMan']
#keymap = wm.keyconfigs['Blender'].keymaps['Window']
#keymap.items.add('reenter_editmode', 'F5', 'PRESS')