SubPixelFilterOutline

SubPixelFilterOutline#

(Outline)

Category: SubPixelFilter
Default object name: outline
Inherits from: ProjectItem > SubPixelFilter

No corresponding User page.

Description#

Outline objects

Public Attributes#

Type	Name	Visual Hint	Description
`double`	`line_width`	`VISUAL_HINT_SUBPIXEL`	Width of all the lines in the screen space. Wide lines will be expensive to calculate.
`double[3]`	`color`	`VISUAL_HINT_COLOR`	Color of the line.
`double`	`alpha`	`VISUAL_HINT_DEFAULT`	Alpha of the line.
`double`	`silhouette_width`	`VISUAL_HINT_PERCENTAGE`	Width of the silhouette line based on the percentage of the line width.
`double`	`inner_width`	`VISUAL_HINT_PERCENTAGE`	Width of the inner line based on the percentage of the line width.
`double`	`normal_threshold`	`VISUAL_HINT_ANGLE`	Angle used for comparing the normals.
`double`	`depth_threshold`	`VISUAL_HINT_DISTANCE`	The depth threshold used for comparing the depths.
`bool`	`use_shading_group`	`VISUAL_HINT_DEFAULT`	If enabled it will draw a line between two different shading_groups.
`reference` (`Group`)	`geometry_group`	`VISUAL_HINT_GROUP`	Group of objects that will be outlined.
`long`	`outline_mode`	`VISUAL_HINT_DEFAULT`	Choose 'Accurate' mode to enable motion blur and depth of field effects.
`long`	`sample_count`	`VISUAL_HINT_DEFAULT`	Set the number of samples to use per camera ray for the 'Accurate' mode.
`double`	`normal_width`	`VISUAL_HINT_PERCENTAGE`	Width of the normal line based on the percentage of the line width.
`bool`	`override_normal`	`VISUAL_HINT_DEFAULT`	If enabled it will override the color and alpha of the normal line by the following attributes : 'Normal Color' and 'Normal Alpha'.
`double[3]`	`normal_color`	`VISUAL_HINT_COLOR`	Color of the normal line.
`double`	`normal_alpha`	`VISUAL_HINT_DEFAULT`	Alpha of the normal line.
`double`	`depth_width`	`VISUAL_HINT_PERCENTAGE`	Width of the depth line based on the percentage of the line width.
`bool`	`override_depth`	`VISUAL_HINT_DEFAULT`	If enabled it will override the color and alpha of the normal line by the following attributes : 'Depth Color' and 'Depth Alpha'.
`double[3]`	`depth_color`	`VISUAL_HINT_COLOR`	Color of the depth line.
`double`	`depth_alpha`	`VISUAL_HINT_DEFAULT`	Alpha of the depth line.
`double`	`shading_group_width`	`VISUAL_HINT_PERCENTAGE`	Width of the shading group line based on the percentage of the line width.
`bool`	`override_shading_group`	`VISUAL_HINT_DEFAULT`	If enabled it will override the color and alpha of the shading group line by the following attributes : 'Shading Group Color' and 'Shading Group Alpha'.
`double[3]`	`shading_group_color`	`VISUAL_HINT_COLOR`	Color of the shading group line.
`double`	`shading_group_alpha`	`VISUAL_HINT_DEFAULT`	Alpha of the shading group line.

CID#

class "SubPixelFilterOutline" "SubPixelFilter" {
    #version 0.9
    icon "../icons/object_icons/sub_pixel_filter_outline.iconrc"
    category "SubPixelFilter"
    doc "Outline objects"
    attribute_group "outline" {
        subpixel "line_width" {
            doc "Width of all the lines in the screen space. Wide lines will be expensive to calculate."
            animatable yes
            numeric_range yes 0.0 1000000
            ui_range yes 0.0 10
            value 1
        }
        color "color" {
            doc "Color of the line."
            texturable yes
            animatable yes
            shading_variable yes
            value 0.0 0.0 0.0
        }
        double "alpha" {
            doc "Alpha of the line."
            texturable yes
            animatable yes
            slider yes
            numeric_range yes 0.0 1
            ui_range yes 0.0 1
            shading_variable yes
            value 1
        }
        percentage "silhouette_width" {
            doc "Width of the silhouette line based on the percentage of the line width."
            texturable yes
            animatable yes
            numeric_range yes 0.0 1
            ui_range yes 0.0 1
            shading_variable yes
            value 1
        }
        percentage "inner_width" {
            doc "Width of the inner line based on the percentage of the line width."
            texturable yes
            animatable yes
            numeric_range yes 0.0 1
            ui_range yes 0.0 1
            shading_variable yes
            value 1
        }
    }
    attribute_group "outline>advanced" {
        ui_weight 1000
        angle "normal_threshold" {
            doc "Angle used for comparing the normals."
            null_label "Normal sorting disabled"
            null_value "0"
            animatable yes
            numeric_range yes 0.0 180
            ui_range yes 0.0 180
            value 40
        }
        distance "depth_threshold" {
            doc "The depth threshold used for comparing the depths."
            null_label "Depth sorting disabled"
            null_value "0"
            animatable yes
            numeric_range yes 0.0 1000000
            ui_range yes 0.0 10
            value 0.0
        }
        bool "use_shading_group" {
            doc "If enabled it will draw a line between two different shading_groups."
            value no
        }
        group "geometry_group" {
            doc "Group of objects that will be outlined."
            filter "SceneObject"
            null_label "Use 3D Layer"
            value ""
        }
        long "outline_mode" {
            doc "Choose \'Accurate\' mode to enable motion blur and depth of field effects."
            preset "Fast" "0"
            preset "Accurate" "1"
            value 0
        }
        long "sample_count" {
            doc "Set the number of samples to use per camera ray for the \'Accurate\' mode."
            numeric_range yes 1 1000
            ui_range yes 1 16
            read_only yes
            value 1
        }
    }
    attribute_group "outline>advanced>normal" {
        collapsed yes
        ui_weight 1000
        percentage "normal_width" {
            doc "Width of the normal line based on the percentage of the line width."
            texturable yes
            animatable yes
            numeric_range yes 0.0 1
            ui_range yes 0.0 1
            shading_variable yes
            value 1
        }
        bool "override_normal" {
            doc "If enabled it will override the color and alpha of the normal line by the following attributes : \'Normal Color\' and \'Normal Alpha\'."
            value no
        }
        color "normal_color" {
            doc "Color of the normal line."
            texturable yes
            animatable yes
            read_only yes
            shading_variable yes
            value 0.0 0.0 0.0
        }
        double "normal_alpha" {
            doc "Alpha of the normal line."
            texturable yes
            animatable yes
            slider yes
            numeric_range yes 0.0 1
            ui_range yes 0.0 1
            read_only yes
            shading_variable yes
            value 1
        }
    }
    attribute_group "outline>advanced>depth" {
        collapsed yes
        ui_weight 1000
        percentage "depth_width" {
            doc "Width of the depth line based on the percentage of the line width."
            texturable yes
            animatable yes
            numeric_range yes 0.0 1
            ui_range yes 0.0 1
            shading_variable yes
            value 1
        }
        bool "override_depth" {
            doc "If enabled it will override the color and alpha of the normal line by the following attributes : \'Depth Color\' and \'Depth Alpha\'."
            value no
        }
        color "depth_color" {
            doc "Color of the depth line."
            texturable yes
            animatable yes
            read_only yes
            shading_variable yes
            value 0.0 0.0 0.0
        }
        double "depth_alpha" {
            doc "Alpha of the depth line."
            texturable yes
            animatable yes
            slider yes
            numeric_range yes 0.0 1
            ui_range yes 0.0 1
            read_only yes
            shading_variable yes
            value 1
        }
    }
    attribute_group "outline>advanced>shading_group" {
        collapsed yes
        ui_weight 1000
        percentage "shading_group_width" {
            doc "Width of the shading group line based on the percentage of the line width."
            texturable yes
            animatable yes
            numeric_range yes 0.0 1
            ui_range yes 0.0 1
            shading_variable yes
            value 1
        }
        bool "override_shading_group" {
            doc "If enabled it will override the color and alpha of the shading group line by the following attributes : \'Shading Group Color\' and \'Shading Group Alpha\'."
            value no
        }
        color "shading_group_color" {
            doc "Color of the shading group line."
            texturable yes
            animatable yes
            read_only yes
            shading_variable yes
            value 0.0 0.0 0.0
        }
        double "shading_group_alpha" {
            doc "Alpha of the shading group line."
            texturable yes
            animatable yes
            slider yes
            numeric_range yes 0.0 1
            ui_range yes 0.0 1
            read_only yes
            shading_variable yes
            value 1
        }
    }
}