rna_camera.c

Go to the documentation of this file.

/*
 * $Id: rna_camera.c 37457 2011-06-13 20:21:48Z dingto $
 *
 * ***** 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.
 *
 * Contributor(s): Blender Foundation (2008).
 *
 * ***** END GPL LICENSE BLOCK *****
 */

#include <stdlib.h>

#include "RNA_define.h"

#include "rna_internal.h"

#include "DNA_camera_types.h"

#include "BLI_math.h"

#include "WM_types.h"

#ifdef RNA_RUNTIME

#include "BKE_object.h"

/* only for rad/deg conversion! can remove later */
static float rna_Camera_angle_get(PointerRNA *ptr)
{
        Camera *cam= ptr->id.data;

        return lens_to_angle(cam->lens);
}

static void rna_Camera_angle_set(PointerRNA *ptr, float value)
{
        Camera *cam= ptr->id.data;
        cam->lens= angle_to_lens(value);
}

#else

void RNA_def_camera(BlenderRNA *brna)
{
        StructRNA *srna;
        PropertyRNA *prop;
        static EnumPropertyItem prop_type_items[] = {
                {CAM_PERSP, "PERSP", 0, "Perspective", ""},
                {CAM_ORTHO, "ORTHO", 0, "Orthographic", ""},
                {0, NULL, 0, NULL, NULL}};
        static EnumPropertyItem prop_draw_type_extra_items[] = {
                {CAM_DTX_CENTER, "CENTER", 0, "Center", ""},
                {CAM_DTX_CENTER_DIAG, "CENTER_DIAGONAL", 0, "Center Diagonal", ""},
                {CAM_DTX_THIRDS, "THIRDS", 0, "Thirds", ""},
                {CAM_DTX_GOLDEN, "GOLDEN", 0, "Golden", ""},
                {CAM_DTX_GOLDEN_TRI_A, "GOLDEN_TRIANGLE_A", 0, "Golden Triangle A", ""},
                {CAM_DTX_GOLDEN_TRI_B, "GOLDEN_TRIANGLE_B", 0, "Golden Triangle B", ""},
                {CAM_DTX_HARMONY_TRI_A, "HARMONY_TRIANGLE_A", 0, "Harmonious Triangle A", ""},
                {CAM_DTX_HARMONY_TRI_B, "HARMONY_TRIANGLE_B", 0, "Harmonious Triangle B", ""},
                {0, NULL, 0, NULL, NULL}};
        static EnumPropertyItem prop_lens_unit_items[] = {
                {0, "MILLIMETERS", 0, "Millimeters", ""},
                {CAM_ANGLETOGGLE, "DEGREES", 0, "Degrees", ""},
                {0, NULL, 0, NULL, NULL}};

        srna= RNA_def_struct(brna, "Camera", "ID");
        RNA_def_struct_ui_text(srna, "Camera", "Camera datablock for storing camera settings");
        RNA_def_struct_ui_icon(srna, ICON_CAMERA_DATA);

        /* Enums */
        prop= RNA_def_property(srna, "type", PROP_ENUM, PROP_NONE);
        RNA_def_property_enum_items(prop, prop_type_items);
        RNA_def_property_ui_text(prop, "Type", "Camera types");
        RNA_def_property_update(prop, NC_OBJECT|ND_DRAW, NULL);

        prop= RNA_def_property(srna, "show_guide", PROP_ENUM, PROP_NONE);
        RNA_def_property_enum_sdna(prop, NULL, "dtx");
        RNA_def_property_enum_items(prop, prop_draw_type_extra_items);
        RNA_def_property_flag(prop, PROP_ENUM_FLAG);
        RNA_def_property_ui_text(prop, "Composition Guides",  "Draw overlay");
        RNA_def_property_update(prop, NC_OBJECT|ND_DRAW, NULL);
        
        /* Number values */

        prop= RNA_def_property(srna, "passepartout_alpha", PROP_FLOAT, PROP_FACTOR);
        RNA_def_property_float_sdna(prop, NULL, "passepartalpha");
        RNA_def_property_ui_text(prop, "Passepartout Alpha", "Opacity (alpha) of the darkened overlay in Camera view");
        RNA_def_property_update(prop, NC_OBJECT|ND_DRAW, NULL);

        prop= RNA_def_property(srna, "clip_start", PROP_FLOAT, PROP_DISTANCE);
        RNA_def_property_float_sdna(prop, NULL, "clipsta");
        RNA_def_property_range(prop, 0.001f, FLT_MAX);
        RNA_def_property_ui_text(prop, "Clip Start", "Camera near clipping distance");
        RNA_def_property_update(prop, NC_OBJECT|ND_DRAW, NULL);

        prop= RNA_def_property(srna, "clip_end", PROP_FLOAT, PROP_DISTANCE);
        RNA_def_property_float_sdna(prop, NULL, "clipend");
        RNA_def_property_range(prop, 1.0f, FLT_MAX);
        RNA_def_property_ui_text(prop, "Clip End", "Camera far clipping distance");
        RNA_def_property_update(prop, NC_OBJECT|ND_DRAW, NULL);

        prop= RNA_def_property(srna, "lens", PROP_FLOAT, PROP_NONE);
        RNA_def_property_float_sdna(prop, NULL, "lens");
        RNA_def_property_range(prop, 1.0f, 5000.0f);
        RNA_def_property_ui_text(prop, "Focal Length", "Perspective Camera lens value in millimeters");
        RNA_def_property_update(prop, NC_OBJECT|ND_DRAW, NULL);
        
        prop= RNA_def_property(srna, "angle", PROP_FLOAT, PROP_ANGLE);
        RNA_def_property_range(prop, M_PI * (0.367/180.0), M_PI * (172.847/180.0));
        RNA_def_property_clear_flag(prop, PROP_ANIMATABLE);
        RNA_def_property_ui_text(prop, "Angle", "Perspective Camera lens field of view in degrees");
        RNA_def_property_float_funcs(prop, "rna_Camera_angle_get", "rna_Camera_angle_set", NULL); /* only for deg/rad conversion */
        RNA_def_property_update(prop, NC_OBJECT|ND_DRAW, NULL);

        prop= RNA_def_property(srna, "ortho_scale", PROP_FLOAT, PROP_NONE);
        RNA_def_property_float_sdna(prop, NULL, "ortho_scale");
        RNA_def_property_range(prop, 0.01f, 4000.0f);
        RNA_def_property_ui_text(prop, "Orthographic Scale", "Orthographic Camera scale (similar to zoom)");
        RNA_def_property_update(prop, NC_OBJECT|ND_DRAW, NULL);

        prop= RNA_def_property(srna, "draw_size", PROP_FLOAT, PROP_DISTANCE);
        RNA_def_property_float_sdna(prop, NULL, "drawsize");
        RNA_def_property_range(prop, 0.01f, 1000.0f);
        RNA_def_property_ui_range(prop, 0.01, 100, 1, 2);
        RNA_def_property_ui_text(prop, "Draw Size", "Apparent size of the Camera object in the 3D View");
        RNA_def_property_update(prop, NC_OBJECT|ND_DRAW, NULL);

        prop= RNA_def_property(srna, "shift_x", PROP_FLOAT, PROP_NONE);
        RNA_def_property_float_sdna(prop, NULL, "shiftx");
        RNA_def_property_range(prop, -10.0f, 10.0f);
        RNA_def_property_ui_range(prop, -2.0, 2.0, 1, 3);
        RNA_def_property_ui_text(prop, "Shift X", "Perspective Camera horizontal shift");
        RNA_def_property_update(prop, NC_OBJECT|ND_DRAW, NULL);

        prop= RNA_def_property(srna, "shift_y", PROP_FLOAT, PROP_NONE);
        RNA_def_property_float_sdna(prop, NULL, "shifty");
        RNA_def_property_range(prop, -10.0f, 10.0f);
        RNA_def_property_ui_range(prop, -2.0, 2.0, 1, 3);
        RNA_def_property_ui_text(prop, "Shift Y", "Perspective Camera vertical shift");
        RNA_def_property_update(prop, NC_OBJECT|ND_DRAW, NULL);

        prop= RNA_def_property(srna, "dof_distance", PROP_FLOAT, PROP_DISTANCE);
        RNA_def_property_float_sdna(prop, NULL, "YF_dofdist");
        RNA_def_property_range(prop, 0.0f, 5000.0f);
        RNA_def_property_ui_text(prop, "DOF Distance", "Distance to the focus point for depth of field");
        RNA_def_property_update(prop, NC_OBJECT|ND_DRAW, NULL);

        /* flag */
        prop= RNA_def_property(srna, "show_limits", PROP_BOOLEAN, PROP_NONE);
        RNA_def_property_boolean_sdna(prop, NULL, "flag", CAM_SHOWLIMITS);
        RNA_def_property_ui_text(prop, "Show Limits", "Draw the clipping range and focus point on the camera");
        RNA_def_property_update(prop, NC_OBJECT|ND_DRAW, NULL);

        prop= RNA_def_property(srna, "show_mist", PROP_BOOLEAN, PROP_NONE);
        RNA_def_property_boolean_sdna(prop, NULL, "flag", CAM_SHOWMIST);
        RNA_def_property_ui_text(prop, "Show Mist", "Draw a line from the Camera to indicate the mist area");
        RNA_def_property_update(prop, NC_OBJECT|ND_DRAW, NULL);

        prop= RNA_def_property(srna, "show_passepartout", PROP_BOOLEAN, PROP_NONE);
        RNA_def_property_boolean_sdna(prop, NULL, "flag", CAM_SHOWPASSEPARTOUT);
        RNA_def_property_ui_text(prop, "Show Passepartout", "Show a darkened overlay outside the image area in Camera view");
        RNA_def_property_update(prop, NC_OBJECT|ND_DRAW, NULL);

        prop= RNA_def_property(srna, "show_title_safe", PROP_BOOLEAN, PROP_NONE);
        RNA_def_property_boolean_sdna(prop, NULL, "flag", CAM_SHOWTITLESAFE);
        RNA_def_property_ui_text(prop, "Show Title Safe", "Show indicators for the title safe zone in Camera view");
        RNA_def_property_update(prop, NC_OBJECT|ND_DRAW, NULL);

        prop= RNA_def_property(srna, "show_name", PROP_BOOLEAN, PROP_NONE);
        RNA_def_property_boolean_sdna(prop, NULL, "flag", CAM_SHOWNAME);
        RNA_def_property_ui_text(prop, "Show Name", "Show the active Camera's name in Camera view");
        RNA_def_property_update(prop, NC_OBJECT|ND_DRAW, NULL);

        prop= RNA_def_property(srna, "lens_unit", PROP_ENUM, PROP_NONE);
        RNA_def_property_enum_bitflag_sdna(prop, NULL, "flag");
        RNA_def_property_enum_items(prop, prop_lens_unit_items);
        RNA_def_property_ui_text(prop, "Lens Unit", "Unit to edit lens in for the user interface");

        prop= RNA_def_property(srna, "use_panorama", PROP_BOOLEAN, PROP_NONE);
        RNA_def_property_boolean_sdna(prop, NULL, "flag", CAM_PANORAMA);
        RNA_def_property_ui_text(prop, "Panorama", "Render the scene with a cylindrical camera for pseudo-fisheye lens effects");
        RNA_def_property_update(prop, NC_OBJECT|ND_DRAW, NULL);

        /* pointers */
        rna_def_animdata_common(srna);

        prop= RNA_def_property(srna, "dof_object", PROP_POINTER, PROP_NONE);
        RNA_def_property_struct_type(prop, "Object");
        RNA_def_property_pointer_sdna(prop, NULL, "dof_ob");
        RNA_def_property_flag(prop, PROP_EDITABLE);
        RNA_def_property_ui_text(prop, "DOF Object", "Use this object to define the depth of field focal point");
        RNA_def_property_update(prop, NC_OBJECT|ND_DRAW, NULL);
}

#endif