Widget3dView#

class "Widget3dView" "Widget" {
    #version 0.9
    icon "../icons/object_icons/widget_3dview.iconrc"
    category "Animate"
    doc "The 3D View allows you to navigate freely in your 3D scenes, edit objects, and display materials."
    reference "selection" {
        doc "Widget runtime selection"
        filter "Image"
        private yes
        saveable no
        value ""
    }
    attribute_group "display" {
        bool "antialiased_lines" {
            doc "Enable/Disable Antialiased Lines."
            value yes
        }
        bool "display_axis" {
            doc "Show/Hide left bottom axis."
            value yes
        }
        bool "display_grid" {
            doc "Show/Hide grid."
            value yes
        }
        long "grid_size" {
            doc "Define the size of the floor grid specified in application-defined default distance unit."
            numeric_range yes 0.0 100000000
            ui_range yes 0.0 100000000
            value 10
        }
        pixel "particle_size" {
            doc "Define the size of the particles in pixels."
            numeric_range yes 0.0 16
            ui_range yes 0.0 16
            value 0
        }
        double "icon_size" {
            doc "Scale the display size of 3D icons such as cameras and lights."
            numeric_range yes 0.0 100000000
            ui_range yes 0.0 100000000
            value 0.5
        }
        bool "use_rich_icons" {
            doc "Enable the advanced drawing of 3D icons to display additional information such as cones and frustums."
            value no
        }
        bool "display_wireframe_overlay" {
            doc "Show/Hide wireframe overlay."
            value no
        }
        long "selection_display_mode" {
            doc "Define the display mode of selected scene objects. When set to None, the selection isn\'t displaying any overlay. In Bounding Box mode, an orange bounding box surrounding each item is overlaid. When set to Wireframe, an orange wireframe overlay is rendered on top of the selection. When set to Both, both a bounding box and wireframe are overlaid on selected items."
            preset "None" "0"
            preset "Bounding Box" "1"
            preset "Wireframe" "2"
            preset "Both" "3"
            value 3
        }
    }
    attribute_group "display>orthographic" {
        long "grid_density" {
            doc "Define the density of the background grid as approximate number of cells to display, when using an Orthographic projection."
            numeric_range yes 0.0 1000
            ui_range yes 0.0 100
            value 10
        }
        bool "display_ruler" {
            doc "Show/Hide unit ruler when using an Orthographic projection."
            value no
        }
        bool "enable_XYZ_clipping" {
            doc "Enable/disable XYZ clipping when using an Orthographic projection."
            value no
        }
        distance[2] "x_axis_clipping" {
            doc "Define the clipping range for the X axis, in world units."
            null_label "Infinite"
            null_value "1e+308"
            value 1e+308 1e+308
        }
        distance[2] "y_axis_clipping" {
            doc "Define the clipping range for the Y axis, in world units."
            null_label "Infinite"
            null_value "1e+308"
            value 1e+308 1e+308
        }
        distance[2] "z_axis_clipping" {
            doc "Define the clipping range for the Z axis, in world units."
            null_label "Infinite"
            null_value "1e+308"
            value 1e+308 1e+308
        }
    }
    attribute_group "rendering" {
        collapsed yes
        long "hardware_acceleration_mode" {
            doc "Define which hardware device should be used to render the 3D View."
            preset "CPU only" "1"
            preset "GPU only" "2"
            preset "Hybrid GPU/CPU" "3"
            preset "Use Application Preferences" "0"
            value 0
        }
        string "renderer" {
            doc "Define the renderer to use when the 3D View rendering mode is set to Previz or Progressive Rendering."
            value ""
        }
        reference "integrator" {
            doc "Specify the light integrator used during the shading."
            filter "Integrator"
            hidden yes
            promote_attribute yes
            value ""
        }
        reference "shading_layer" {
            doc "The selected ShadingLayer will override materials of objects according to its name mapping rules."
            filter "ShadingLayer"
            output "shading_material" "shading_group"
            hidden yes
            value ""
        }
        long "max_recursion_depth" {
            private yes
            numeric_range yes 0.0 16
            ui_range yes 0.0 16
            value 2
        }
        long "max_packet_size" {
            hidden yes
            preset "2" "2"
            preset "4" "4"
            preset "8" "8"
            preset "16" "16"
            preset "32" "32"
            value 8
        }
    }
    attribute_group "rendering>optix_denoiser" {
        collapsed yes
        bool "optix_denoiser_use_albedo" {
            doc "Define if the denoiser should use the information contained in the Albedo AOV for denoising."
            value yes
        }
        bool "optix_denoiser_use_world_normal" {
            doc "Define if the denoiser should use the information contained in the World Normal AOV for denoising."
            value yes
        }
        long "denoised_quality" {
            doc "Define the rendering quality on which the denoiser starts denoising."
            preset "1/16 Resolution" "4"
            preset "1/8 Resolution" "3"
            preset "1/4 Resolution" "2"
            preset "1/2 Resolution" "1"
            preset "Full Resolution" "0"
            value 1
        }
    }
    attribute_group "display>plates" {
        collapsed yes
        ui_weight 10000
        reference "foreground_texture" {
            doc "Set an image or texture used as a foreground plate."
            filter "Texture"
            value ""
        }
        percentage "foreground_opacity" {
            doc "Set the opacity of the foreground plate."
            numeric_range yes 0.0 1
            ui_range yes 0.0 1
            value 1
        }
        long "foreground_fit_mode" {
            doc "Set how the foreground plate should be scaled to fit the 3D View viewport. When set to Horizontal, Vertical, Fill the rescaling keeps the aspect ratio of the original plate. When set to remap, the plate is rescaled to match the resolution of the viewport."
            value 3
        }
        reference "background_texture" {
            doc "Set an image or texture used as a background plate."
            filter "Texture"
            value ""
        }
        percentage "background_opacity" {
            doc "Set the opacity of the background plate."
            numeric_range yes 0.0 1
            ui_range yes 0.0 1
            value 1
        }
        long "background_fit_mode" {
            doc "Set how the background plate should be scaled to fit the 3D View viewport. When set to Horizontal, Vertical, Fill the rescaling keeps the aspect ratio of the original plate. When set to remap, the plate is rescaled to match the resolution of the viewport."
            value 3
        }
    }
    attribute_group "display>ambient_occlusion" {
        collapsed yes
        bool "enable_ambient_occlusion" {
            doc "Enable Raytraced Ambient Occlusion on supported rendering modes."
            value no
        }
        sample_per_pixel "ambient_occlusion_sample_count" {
            doc "Set the number of samples used per refinement pass for the ambient occlusion."
            numeric_range yes 1 1024
            ui_range yes 1 64
            value 1
        }
        distance "ambient_occlusion_distance" {
            doc "Set the maximum distance a ray should travel away from the surface to find an occluder. This feature is very useful if you have a dome surrounding your scene in which case, the whole scene would be rendered black."
            null_label "Infinite"
            null_value "-1"
            numeric_range yes -1 1000000
            ui_range yes 0.0001 1024
            value -1
        }
    }
}