Skip to content

CameraAlembic

CameraAlembic#

(Alembic)

No corresponding User page.

Description#

Define a camera driven by an alembic file.

Public Attributes#

Type Name Visual Hint Description
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.
double lens_ratio VISUAL_HINT_DEFAULT Lens squeeze ratio.
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.
string filename VISUAL_HINT_FILENAME_OPEN File path.
long pivot_mode VISUAL_HINT_DEFAULT Set the way pivot information is read in the file: using the baked matrix or individual attributes.
long frame VISUAL_HINT_DEFAULT Defines the value of the frame that will be used to evaluate the mesh.
long anim_frame_count VISUAL_HINT_DEFAULT Count of frames available in the file to animate the pivot
long deform_frame_count VISUAL_HINT_DEFAULT Count of frames available in the file to deform the geometry
long frame_offset VISUAL_HINT_DEFAULT Offset the time. If you set the value to 50 while the animation starts at frame 10, it then starts at frame 60.
long animation_behavior VISUAL_HINT_DEFAULT Set how the animation will loop.
bool force_animation_range VISUAL_HINT_DEFAULT
long[2] animation_range VISUAL_HINT_DEFAULT Start and end of the forced animation.
long deformation_behavior VISUAL_HINT_DEFAULT Set how the animation will be deformed.
bool force_deformation_range VISUAL_HINT_DEFAULT
long[2] deformation_range VISUAL_HINT_DEFAULT Start and end of the forced deformation.

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.
long visibility_mode VISUAL_HINT_DEFAULT Set how visibility attributes 'Display Visible' and 'Unseen By Renderer' are driven. In Use Project Preferences mode, the mode uses the project preference value. In Override mode, the attributes are set manually. In Use Property mode, the attributes are driven by a property (e.g. Alembic visibility property).
bool enable_motion_blur VISUAL_HINT_DEFAULT Set whether the renderer will do motion blur on the item or not.

CID#

class "CameraAlembic" "Camera" {
    abstract yes
    #version 0.98
    icon "../icons/object_icons/camera_abc.iconrc"
    doc "Define a camera driven by an alembic file."
    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."
            animatable yes
            numeric_range yes 0.01 179.99
            ui_range yes 0.01 179.99
            read_only yes
            value 39.5977527090599
        }
        angle "vertical_field_of_view" {
            doc "Camera vertical field of view in degrees. Is deducted from focal length and aperture. Linked to aperture."
            animatable yes
            numeric_range yes 0.01 179.99
            ui_range yes 0.01 179.99
            read_only yes
            value 26.9914665615984
        }
        distance "focal_length" {
            doc "Camera focal length. Use this attribute to zoom in and out. Impacts field of view"
            animatable yes
            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"
            animatable yes
            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"
            animatable yes
            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."
            numeric_range yes 0.1 10
            ui_range yes 0.1 10
            read_only yes
            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
        }
        long "visibility_type" {
            private yes
            dg_active no
            read_only yes
            value 0
        }
        double[2] "visibility_range" {
            doc "Time range of the visibility property."
            private yes
            saveable no
            dg_active no
            read_only yes
            value 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 1 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
        }
    }
    attribute_group "alembic" {
        list<filename_open> "filename" {
            doc "File path."
            extension "abc"
            saveable no
            value ""
        }
        list<string> "filename_sys" {
            hidden yes
            value ""
        }
        string "object_name" {
            doc "Object path in file."
            hidden yes
            value ""
        }
        bool "valid_data" {
            doc "this attribute stores the state of the object for a given filename/object name: when using $F in the filename it can change"
            private yes
            saveable no
            value yes
        }
        list<long> "data_hash_key_timestamp" {
            doc "Files modificiation times."
            private yes
            value <empty>
        }
    }
    attribute_group "alembic>playback" {
        collapsed yes
        long "pivot_mode" {
            doc "Set the way pivot information is read in the file: using the baked matrix or individual attributes."
            preset "Use Matrix" "0"
            preset "Use Attributes" "1"
            value 0
        }
        long "frame" {
            doc "Defines the value of the frame that will be used to evaluate the mesh."
            value[] 0
            expression "F"
        }
        long "anim_frame_count" {
            doc "Count of frames available in the file to animate the pivot"
            dg_active no
            read_only yes
            value 1
        }
        long "deform_frame_count" {
            doc "Count of frames available in the file to deform the geometry"
            read_only yes
            value 1
        }
        long "frame_offset" {
            doc "Offset the time. If you set the value to 50 while the animation starts at frame 10, it then starts at frame 60."
            animatable yes
            ui_range yes -1000 1000
            value 0
        }
        double "current_anim_time" {
            doc "Time currently used. Attribute is set after time change"
            private yes
            saveable no
            dg_active no
            value 0.0
        }
        double "current_deform_time" {
            doc "Time currently used. Attribute is set after time change"
            private yes
            saveable no
            dg_active no
            value 0.0
        }
        double[16] "base_matrix" {
            doc "Base transformation matrix."
            private yes
            dg_active no
            value 1 0.0 0.0 0.0 0.0 1 0.0 0.0 0.0 0.0 1 0.0 0.0 0.0 0.0 1
        }
        double[2] "anim_range" {
            doc "Start and end time of the animation."
            private yes
            value 0.0 0.0
        }
        double[2] "deform_range" {
            doc "Start and end time of the deformation."
            private yes
            value 0.0 0.0
        }
        long "animation_behavior" {
            doc "Set how the animation will loop."
            preset "Hold" "0"
            preset "Repeat" "1"
            value 0
        }
        bool "force_animation_range" {
            value no
        }
        long[2] "animation_range" {
            doc "Start and end of the forced animation."
            read_only yes
            value 0 50
        }
        long "deformation_behavior" {
            doc "Set how the animation will be deformed."
            preset "Hold" "0"
            preset "Repeat" "1"
            value 0
        }
        bool "force_deformation_range" {
            value no
        }
        long[2] "deformation_range" {
            doc "Start and end of the forced deformation."
            read_only yes
            value 0 50
        }
    }
}