Skip to content

Displacement

Displacement#

(Displacement)

  • Default object name: displacement
  • Inherits from: ProjectItem

Go to User page.

Description#

General description of user editable objects stored in project files.

Public Attributes#

Type Name Visual Hint Description
bool active VISUAL_HINT_DEFAULT Enable or disable the displacement.
long mode VISUAL_HINT_DEFAULT
long front_direction VISUAL_HINT_DEFAULT
double front_value VISUAL_HINT_DISTANCE Set the height of the front displacement along the normals of the geometry.
double front_offset VISUAL_HINT_DEFAULT Set an offset on the value of the front displacement.
long back_direction VISUAL_HINT_DEFAULT
double back_value VISUAL_HINT_DISTANCE Set the height of the back displacement along the normals of the geometry.
double back_offset VISUAL_HINT_DEFAULT Set an offset on the value of the back displacement.
double[3] bound VISUAL_HINT_DISTANCE Set the bound of the displacement. This value should be big enough to not clip the displaced geometry but should stay small enough to keep good rendering times.

CID#

class "Displacement" "ProjectItem" {
    #version 0.91
    icon "../icons/object_icons/displacement.iconrc"
    attribute_group "displacement" {
        bool "active" {
            doc "Enable or disable the displacement."
            animatable yes
            value yes
        }
        long "mode" {
            preset "Front only" "0"
            preset "Symmetric" "1"
            preset "Asymmetric" "2"
            value 0
        }
        long "front_direction" {
            preset "Normal" "0"
            preset "Vector (Tangent Space)" "1"
            preset "Vector (Object Space)" "2"
            value 0
        }
        distance "front_value" {
            doc "Set the height of the front displacement along the normals of the geometry."
            texturable yes
            animatable yes
            ui_range yes -1 1
            value 1
        }
        double "front_offset" {
            doc "Set an offset on the value of the front displacement."
            ui_range yes -1 1
            value 0.0
        }
        long "back_direction" {
            read_only yes
            preset "Normal" "0"
            preset "Vector (Tangent Space)" "1"
            preset "Vector (Object Space)" "2"
            value 0
        }
        distance "back_value" {
            doc "Set the height of the back displacement along the normals of the geometry."
            texturable yes
            animatable yes
            ui_range yes -1 1
            read_only yes
            value 1
        }
        double "back_offset" {
            doc "Set an offset on the value of the back displacement."
            ui_range yes -1 1
            read_only yes
            value 0.0
        }
        distance[3] "bound" {
            doc "Set the bound of the displacement. This value should be big enough to not clip the displaced geometry but should stay small enough to keep good rendering times."
            animatable yes
            numeric_range yes 0.0 1000000
            ui_range yes 0.0 1
            value 0.0 0.0 0.0
        }
    }
}