IntegratorAmbientOcclusion

IntegratorAmbientOcclusion#

(Ambient Occlusion)

Abstract Class
Category: Integrator
Default object name: ambient_occlusion
Inherits from: ProjectItem > Integrator

No corresponding User page.

Description#

Clarisse ambient occlusion integrator.

Public Attributes#

Type	Name	Visual Hint	Description
`bool`	`use_raw_color`	`VISUAL_HINT_DEFAULT`	When enabled the ambient occlusion will use the raw color of each object instead of the "color" attribute.
`double[3]`	`color`	`VISUAL_HINT_COLOR`	Set the color.
`double[3]`	`occlusion_color`	`VISUAL_HINT_COLOR`	Set the color of the occlusion.
`double`	`radius`	`VISUAL_HINT_DISTANCE`	Set the radius of the occlusion.
`double`	`angle`	`VISUAL_HINT_ANGLE`	Set the opening angle of the hemisphere used at each fragment.
`long`	`sample_count`	`VISUAL_HINT_SAMPLE_PER_PIXEL`	Set the quality of the sampling. A high value gives a better result but increases the computation time.
`bool`	`evaluate_transparency`	`VISUAL_HINT_DEFAULT`	Enable the computation of the shading for occluding objects. If occluding objects are transparent, this affects the color of the occlusion.
`double`	`alpha_threshold`	`VISUAL_HINT_PERCENTAGE`	Define the alpha value from which a sample is considered transparent.

CID#

class "IntegratorAmbientOcclusion" "Integrator" {
    abstract yes
    #version 0.92
    category "Integrator"
    doc "Clarisse ambient occlusion integrator."
    attribute_group "ambient_occlusion" {
        bool "use_raw_color" {
            doc "When enabled the ambient occlusion will use the raw color of each object instead of the \"color\" attribute."
            value yes
        }
        color "color" {
            doc "Set the color."
            texturable yes
            animatable yes
            read_only yes
            value 1 1 1
        }
        color "occlusion_color" {
            doc "Set the color of the occlusion."
            texturable yes
            animatable yes
            value 0.0 0.0 0.0
        }
        distance "radius" {
            doc "Set the radius of the occlusion."
            null_label "infinity"
            null_value "-1"
            texturable yes
            animatable yes
            numeric_range yes 0.0 1000000000
            ui_range yes 0.0 10
            value -1
        }
        angle "angle" {
            doc "Set the opening angle of the hemisphere used at each fragment."
            texturable yes
            animatable yes
            numeric_range yes 0.0 180
            ui_range yes 0.0 180
            value 180
        }
        sample_per_pixel "sample_count" {
            doc "Set the quality of the sampling. A high value gives a better result but increases the computation time."
            numeric_range yes 1 16384
            ui_range yes 1 1024
            value 16
        }
    }
    attribute_group "ambient_occlusion>transparency" {
        collapsed yes
        bool "evaluate_transparency" {
            doc "Enable the computation of the shading for occluding objects. If occluding objects are transparent, this affects the color of the occlusion."
            animatable yes
            value no
        }
        percentage "alpha_threshold" {
            doc "Define the alpha value from which a sample is considered transparent."
            numeric_range yes 0.0 1
            ui_range yes 0.0 1
            value 0.00392156862745098
        }
    }
}