CameraUsd

CameraUsd#

(Usd)

Abstract Class
Category: /Camera
Default object name: usd
Inherits from: ProjectItem > SceneItem > Camera

No corresponding User page.

Description#

Define a camera driven by a USD stage.

Public Attributes#

Type	Name	Visual Hint	Description
`string`	`prim_path`	`VISUAL_HINT_DEFAULT`	Prim path in the USD stage.
`string`	`purpose`	`VISUAL_HINT_DEFAULT`	Purpose of this prim.
`long`	`frame`	`VISUAL_HINT_FRAME`	Define the frame value used to evaluate the geometry.
`long`	`frame_offset`	`VISUAL_HINT_FRAME`	Define the frame offset. Example: if the frame offset is 50 while the animation starts at frame 10, then it will start at frame 60.
`long`	`animation_behavior`	`VISUAL_HINT_DEFAULT`	Define the animation loop behavior.
`bool`	`force_animation_range`	`VISUAL_HINT_DEFAULT`	Enable the defined animation range, used to override the object's original animation range.
`long[2]`	`animation_range`	`VISUAL_HINT_FRAME`	Start and end frames for the animation.
`double`	`horizontal_field_of_view`	`VISUAL_HINT_ANGLE`	Camera horizontal field of view in degrees. Is deducted from focal length and aperture. Linked to aperture.
`double`	`vertical_field_of_view`	`VISUAL_HINT_ANGLE`	Camera vertical field of view in degrees. Is deducted from focal length and aperture. Linked to aperture.
`double`	`focal_length`	`VISUAL_HINT_DISTANCE`	Camera focal length. Use this attribute to zoom in and out. Impacts field of view
`double`	`horizontal_aperture`	`VISUAL_HINT_DISTANCE`	Camera horizontal aperture: size of the camera sensor. Linked to field of view
`double`	`vertical_aperture`	`VISUAL_HINT_DISTANCE`	Camera vertical aperture: size of the camera sensor. Linked to field of view
`double[2]`	`film_offset`	`VISUAL_HINT_DISTANCE`	Offset of the camera sensor to the lens. Offsets the frustrum used to compute 3D layers.
`long`	`fit_mode`	`VISUAL_HINT_DEFAULT`	If set to horizontal, vertical or fill, use a square pixel aspect ratio. Vertical or horizontal aperture is recomputed to fit the target image.
`bool`	`enable_dof`	`VISUAL_HINT_DEFAULT`
`double`	`f_stop`	`VISUAL_HINT_DEFAULT`	Set the focal ratio. This controls the size of the lens.
`double`	`focus_distance`	`VISUAL_HINT_DISTANCE`	Set the distance at which the focus is done.

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 "CameraUsd" "Camera" {
    abstract yes
    #version 1
    icon "./icons/camera_usd.iconrc"
    doc "Define a camera driven by a USD stage."
    bool "purpose_selected" {
        output "geometry"
        private yes
        saveable no
        value yes
    }
    string "session_layer" {
        private yes
        value ""
    }
    attribute_group "USD" {
        list<filename_open> "filename" {
            doc "The filename that were used to create the stage from which this object is referenced."
            private yes
            dg_active no
            read_only yes
            value <empty>
        }
        string "prim_path" {
            doc "Prim path in the USD stage."
            dg_active no
            read_only yes
            value ""
        }
        string "purpose" {
            doc "Purpose of this prim."
            saveable no
            dg_active no
            read_only yes
            value "default"
        }
        long "stage_id" {
            private yes
            saveable no
            dg_active no
            read_only yes
            value -1
        }
    }
    attribute_group "USD>playback" {
        collapsed yes
        frame "frame" {
            doc "Define the frame value used to evaluate the geometry."
            animatable yes
            value 0
        }
        frame "frame_offset" {
            doc "Define the frame offset. Example: if the frame offset is 50 while the animation starts at frame 10, then it will start at frame 60."
            animatable yes
            value 0
        }
        long "animation_behavior" {
            doc "Define the animation loop behavior."
            preset "Hold" "0"
            preset "Repeat" "1"
            value 0
        }
        bool "force_animation_range" {
            doc "Enable the defined animation range, used to override the object\'s original animation range."
            value no
        }
        frame[2] "animation_range" {
            doc "Start and end frames for the animation."
            read_only yes
            value 0 50
        }
        double "time_offset" {
            private yes
            saveable no
            read_only yes
            value 0.0
        }
    }
    attribute_group "camera" {
        angle "horizontal_field_of_view" {
            doc "Camera horizontal field of view in degrees. Is deducted from focal length and aperture. Linked to aperture."
            numeric_range yes 0.01 179.99
            ui_range yes 0.01 179.99
            read_only yes
            value 45.24
        }
        angle "vertical_field_of_view" {
            doc "Camera vertical field of view in degrees. Is deducted from focal length and aperture. Linked to aperture."
            numeric_range yes 0.01 179.99
            ui_range yes 0.01 179.99
            read_only yes
            value 37.5
        }
        distance "focal_length" {
            doc "Camera focal length. Use this attribute to zoom in and out. Impacts field of view"
            numeric_range yes 1e-06 3.402823e+38
            ui_range yes 0.001 1
            read_only yes
            value 0.05
        }
    }
    attribute_group "camera>film_back" {
        collapsed yes
        distance "horizontal_aperture" {
            doc "Camera horizontal aperture: size of the camera sensor. Linked to field of view"
            numeric_range yes 1e-06 3.402823e+38
            ui_range yes 0.001 1
            read_only yes
            value 0.036
        }
        distance "vertical_aperture" {
            doc "Camera vertical aperture: size of the camera sensor. Linked to field of view"
            numeric_range yes 1e-06 3.402823e+38
            ui_range yes 0.001 1
            read_only yes
            value 0.024
        }
        distance[2] "film_offset" {
            doc "Offset of the camera sensor to the lens. Offsets the frustrum used to compute 3D layers."
            numeric_range yes -0.1 0.1
            ui_range yes -0.01 0.01
            read_only yes
            value 0.0 0.0
        }
        double "lens_ratio" {
            doc "Lens squeeze ratio."
            hidden yes
            saveable no
            value 1
        }
        long "fit_mode" {
            doc "If set to horizontal, vertical or fill, use a square pixel aspect ratio. Vertical or horizontal aperture is recomputed to fit the target image."
            preset "Horizontal" "0"
            preset "Vertical" "1"
            preset "Remap" "2"
            preset "Fill" "3"
            value 0
        }
        double[4] "overscan" {
            hidden yes
            numeric_range yes 0.0 10000
            ui_range yes 0.0 10000
            read_only yes
            value 1 0.0 0.0 0.0
        }
    }
    attribute_group "camera>depth_of_field" {
        collapsed yes
        bool "enable_dof" {
            animatable yes
            value no
        }
        double "f_stop" {
            doc "Set the focal ratio. 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"
            hidden yes
            read_only yes
            value ""
        }
    }
    attribute_group "USD>variant_sets" {
        collapsed yes
    }
}