CameraPerspective

CameraPerspective#

(Perspective)

Category: /Camera
Default object name: perspective
Inherits from: ProjectItem > SceneItem > Camera

Description#

Define a pin-hole camera with basic settings.

Public Attributes#

Type	Name	Visual Hint	Description
`double`	`field_of_view`	`VISUAL_HINT_ANGLE`	Vertical field of view value in degrees. Horizontal fov is computed accordingly using the image aspect ratio.
`bool`	`enable_dof`	`VISUAL_HINT_DEFAULT`
`double`	`f_stop`	`VISUAL_HINT_DEFAULT`	Set the focal ratio (for a focal length of 5 cm). This controls the size of the lens.
`double`	`focus_distance`	`VISUAL_HINT_DISTANCE`	Set the distance at which the focus is done.
`reference` (`SceneItem`)	`focus_object`	`VISUAL_HINT_DEFAULT`	Use the input object to compute the focus distance. If none then focus_distance is used.

Inherited Public Attributes#

Type	Name	Visual Hint	Description
`double[3]`	`translate`	`VISUAL_HINT_DISTANCE`	Set the XYZ position of the item relative to its parent item.
`double[3]`	`rotate`	`VISUAL_HINT_ANGLE`	Set the XYZ rotation of the item relative to its parent item.
`double[3]`	`scale`	`VISUAL_HINT_SCALE`	Set the XYZ scaling of the item relative to its parent item.
`double[3]`	`shear`	`VISUAL_HINT_SCALE`	Set the XYZ shear of the item relative to its parent item.
`long`	`rotation_order`	`VISUAL_HINT_DEFAULT`	Specify on which order the Euler rotations are composed. By default Clarisse's uses YXZ
`reference` (`SceneItem`)	`parent`	`VISUAL_HINT_DEFAULT`	Set the parent item of the item.
`bool`	`inherit_transform`	`VISUAL_HINT_DEFAULT`	Does the current object inherits its parent transformation ?
`long`	`reference_frame`	`VISUAL_HINT_FRAME`	Set the reference frame that defines the base transform and deformation state of the item. This reference is used when computing texture projections or when generating point cloud (in Global Base) on the base geometry.
`object[]` (`Constraint`)	`constraints`	`VISUAL_HINT_DEFAULT`	Stack of constraint operators. Constraints like Target, Point, Orient... are applied to a Scene Item in order to drive the transformation of the item.
`double[3]`	`scale_pivot`	`VISUAL_HINT_DISTANCE`	Set the coordinates of the scale pivot.
`double[3]`	`rotate_pivot`	`VISUAL_HINT_DISTANCE`	Set the coordinates of the rotation pivot.
`double[3]`	`translate_offset`	`VISUAL_HINT_DISTANCE`	Set the XYZ position of the pivot point of the item.
`double[3]`	`rotate_offset`	`VISUAL_HINT_ANGLE`	Set the XYZ rotation of the pivot point of the item.
`double[3]`	`scale_offset`	`VISUAL_HINT_SCALE`	Set the XYZ scaling of the pivot point of the item.
`long`	`rotation_offset_order`	`VISUAL_HINT_DEFAULT`	Set the rotation axis mode.
`bool`	`display_visible`	`VISUAL_HINT_DEFAULT`	Set whether the item is shown in the 3D View or not.
`bool`	`display_pickable`	`VISUAL_HINT_DEFAULT`	Set whether the item is pickable in the 3D View or in the Image View.
`long`	`display_color`	`VISUAL_HINT_DEFAULT`	Set the item color for constant or simple shading display in the 3D View.
`double[3]`	`display_custom_color`	`VISUAL_HINT_COLOR`	Set the item custom color used for display in the 3D View when the Display Color attribute is set to Custom.
`bool`	`enable_motion_blur`	`VISUAL_HINT_DEFAULT`	Set whether the renderer will do motion blur on the item or not.

CID#

class "CameraPerspective" "Camera" {
    #version 0.9
    icon "../icons/object_icons/camera_perspective.iconrc"
    doc "Define a pin-hole camera with basic settings."
    attribute_group "camera" {
        angle "field_of_view" {
            doc "Vertical field of view value in degrees. Horizontal fov is computed accordingly using the image aspect ratio."
            animatable yes
            numeric_range yes 0.01 179.99
            ui_range yes 0.01 179.99
            value 45.24
        }
    }
    attribute_group "camera>depth_of_field" {
        collapsed yes
        bool "enable_dof" {
            animatable yes
            value no
        }
        double "f_stop" {
            doc "Set the focal ratio (for a focal length of 5 cm). This controls the size of the lens."
            animatable yes
            numeric_range yes 0.01 1000000
            ui_range yes 0.01 64
            read_only yes
            value 5.6
        }
        distance "focus_distance" {
            doc "Set the distance at which the focus is done."
            animatable yes
            numeric_range yes 0.0 1000000
            ui_range yes 0.0 1000
            read_only yes
            value 5
        }
        reference "focus_object" {
            doc "Use the input object to compute the focus distance. If none then focus_distance is used."
            filter "SceneItem"
            input "motion_translate"
            read_only yes
            value ""
        }
    }
}