Skip to content

Geometry

Geometry#

(Geometry)

No corresponding User page.

Description#

Base object for all geometry objects.

Public Attributes#

Type Name Visual Hint Description
object[] (Deformer) deformers VISUAL_HINT_DEFAULT List of deformation that will be applied on the geometry.
double smoothing_approximation VISUAL_HINT_PERCENTAGE Controls how much the smoothing must be approximated during the shading. This influences the origin of secondary rays casted from the surface. A value of 0% corresponds to the position that has been found during the raytracing and a value of 100% corresponds to the theoretical position on the smoothed surface.
long displacement_mode VISUAL_HINT_DEFAULT Control whether the displacement must compute bump, tessellation or both.
long displacement_storage_mode VISUAL_HINT_DEFAULT Define if displacement favors render time or memory used to generate it.
long displacement_tessellation_mode VISUAL_HINT_DEFAULT Control the generation of the tessellation used for the micro displacement. Adaptive modes try to compute the tessellation level according to the size of the primitives whereas the uniform mode generates the same tessellation on all primitives. For the adaptive modes, it is possible to choose if the tessellation level has to be computed on the base geometry or on the deformed one.
long displacement_adaptive_span_count VISUAL_HINT_DEFAULT Control the number of spans for the adaptive tessellation. This value corresponds to the number of spans on the bounding box of the geometry.
long displacement_uniform_span_count VISUAL_HINT_DEFAULT Control the number of spans for the uniform tessellation. This value corresponds to the number of spans on each primitive.
long displacement_triangulation_mode VISUAL_HINT_DEFAULT Define on which geometry the micro-facets triangulation is computed.
long displacement_stitching_mode VISUAL_HINT_DEFAULT Control the stitching between primitives. The stitching only affects values of the displacement so it doesn't work if the geometry has discontinuities on normals.

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.
bool enable_motion_blur VISUAL_HINT_DEFAULT Set whether the renderer will do motion blur on the item or not.
long display_mode VISUAL_HINT_DEFAULT Define how the object is displayed in the 3D View.
long highlight_mode VISUAL_HINT_DEFAULT Define how the object is highlighted in the 3D View when selected.
reference (Material) override_material VISUAL_HINT_DEFAULT Setting a material here will set the specified material to all elements of the scene object. Ex: all shading groups of a geometry will have the same material. Ex: all elements of a combiner or a scatterer will have the same material.
bool matte_object VISUAL_HINT_DEFAULT Switch the object to 2D matte mode.
double[3] matte_color VISUAL_HINT_COLOR Set the color of the object in matte mode.
double matte_alpha VISUAL_HINT_PERCENTAGE Set the opacity of the object in matte mode. When the matte alpha is less than 100%, the object creates a hole in the layer as no transparency is evaluated.
long custom_id VISUAL_HINT_DEFAULT
double raytrace_offset VISUAL_HINT_DISTANCE Set the minimum distance for raytracing visibility. If the ray hit point distance from the ray source position is smaller than this value, then the geometry is not seen. Note: this attribute is used to prevent self intersection artifacts.
string shading_variables VISUAL_HINT_SCRIPT
bool unseen_by_renderer VISUAL_HINT_DEFAULT Set whether the object is hidden from the renderer or not.
bool unseen_by_camera VISUAL_HINT_DEFAULT Set whether the object is hidden from the camera (primary rays) or not.
bool unseen_by_rays VISUAL_HINT_DEFAULT Set whether the object is hidden from the raytraced shading effects like reflection/refraction (secondary rays) or not.
bool unseen_by_reflections VISUAL_HINT_DEFAULT Set whether the object is hidden from reflections or not.
bool unseen_by_refractions VISUAL_HINT_DEFAULT Set whether the object is hidden from refractions or not.
bool unseen_by_gi VISUAL_HINT_DEFAULT Set whether the object is hidden from global illumination or not.
bool unseen_by_sss VISUAL_HINT_DEFAULT Set whether the object is hidden from sub-surface scattering or not.
bool cast_shadows VISUAL_HINT_DEFAULT Set whether the object casts shadows or not.
bool receive_shadows VISUAL_HINT_DEFAULT Set whether the object receives cast shadows or not.
bool receive_self_shadows VISUAL_HINT_DEFAULT Set whether the object receives self shadows or not.
reference (Group) lights VISUAL_HINT_GROUP Specify the group of lights that illuminate this object. By default, scene objects are lit using the lights gathered by the 3D layer.
bool enable_emission_importance_sampling VISUAL_HINT_DEFAULT Specify whether emission importance sampling is enabled on the scene object. This attribute is ignored when emission importance sampling is disabled in the renderer.
long emission_sample_count VISUAL_HINT_SAMPLE_PER_PIXEL Override the number of emission samples allocated by the renderer when sampling the scene object.
long emission_texture_importance_sampling VISUAL_HINT_DEFAULT When None, no texture importance sampling is performed. When Color, Emission Color input textures of all materials assigned to the scene object are importance sampled. This mode should be used when only the Emission Color of the material is textured which is typically the case when using an HDR texture encoding both color and intensity. When Weight, Emission Weight input textures of all the materials assigned to the scene object are importance sampled. This mode can be useful when you explicitly want to vary the color texture according to a spatial projection based on the position of the instance such as world projections, texture switch or instance color for example. Please note that setting this mode while texturing Emission Color can lead to a degradation of the quality of the importance sampling if the intensity/weight component is encoded to the color textures. When Both, both Emission Color and Emission Weight input textures of all the materials assigned to the scene object are importance sampled. This mode should be used when using specific textures for Emission Color and Emission Weight.

CID#

class "Geometry" "SceneObject" {
    abstract yes
    #version 0.9
    icon "../icons/object_icons/geometry.iconrc"
    category "/Geometry"
    doc "Base object for all geometry objects."
    string[] "uv_maps" {
        output "shading_material"
        private yes
        value <empty>
    }
    bool "uv_maps_loaded" {
        private yes
        dg_active no
        value no
    }
    string[] "shading_groups" {
        output "shading_material"
        private yes
        value <empty>
    }
    reference[] "materials" {
        filter "Material"
        output "shading_material"
        hidden yes
        value <empty>
    }
    reference[] "clip_maps" {
        filter "Texture"
        output "shading_group"
        hidden yes
        value <empty>
    }
    reference[] "displacements" {
        filter "Displacement"
        output "geometry"
        hidden yes
        value <empty>
    }
    string[] "sg_shading_variables" {
        output "shading_variable"
        hidden yes
        value <empty>
    }
    bool[] "visibles" {
        output "shading_group" "geometry"
        hidden yes
        value <empty>
    }
    attribute_group "geometry>deformation" {
        collapsed yes
        object[] "deformers" {
            doc "List of deformation that will be applied on the geometry."
            filter "Deformer"
            input "geometry"
            output "geometry"
            value <empty>
        }
    }
    attribute_group "geometry>advanced" {
        collapsed yes
        ui_weight 1000
        long "raytrace_quality" {
            doc "Set the quality of the raytracing. The first mode is faster but some intersections might be missed whereas they would be detected with the accurate mode."
            output "shading"
            hidden yes
            preset "Fast" "0"
            preset "Accurate" "1"
            value 1
        }
        percentage "smoothing_approximation" {
            doc "Controls how much the smoothing must be approximated during the shading. This influences the origin of secondary rays casted from the surface. A value of 0% corresponds to the position that has been found during the raytracing and a value of 100% corresponds to the theoretical position on the smoothed surface."
            animatable yes
            numeric_range yes 0.0 1
            ui_range yes 0.0 1
            value 0.5
        }
    }
    attribute_group "geometry>displacement" {
        collapsed yes
        long "displacement_mode" {
            doc "Control whether the displacement must compute bump, tessellation or both."
            preset "Bump only" "0"
            preset "Tessellation only" "1"
            preset "Tessellation with Bump" "2"
            value 2
        }
        long "displacement_storage_mode" {
            doc "Define if displacement favors render time or memory used to generate it."
            output "geometry"
            preset "Use Project Preferences" "0"
            preset "Favor Memory" "1"
            preset "Favor Speed" "2"
            value 0
        }
        long "displacement_tessellation_mode" {
            doc "Control the generation of the tessellation used for the micro displacement. Adaptive modes try to compute the tessellation level according to the size of the primitives whereas the uniform mode generates the same tessellation on all primitives. For the adaptive modes, it is possible to choose if the tessellation level has to be computed on the base geometry or on the deformed one."
            preset "Adaptive (base)" "0"
            preset "Adaptive (deformed)" "1"
            preset "Uniform" "2"
            value 0
        }
        long "displacement_adaptive_span_count" {
            doc "Control the number of spans for the adaptive tessellation. This value corresponds to the number of spans on the bounding box of the geometry."
            numeric_range yes 1 1000000
            ui_range yes 1 1000
            value 1
        }
        long "displacement_uniform_span_count" {
            doc "Control the number of spans for the uniform tessellation. This value corresponds to the number of spans on each primitive."
            numeric_range yes 1 1000000
            ui_range yes 1 32
            read_only yes
            value 1
        }
        long "displacement_triangulation_mode" {
            doc "Define on which geometry the micro-facets triangulation is computed."
            preset "Use Base Geometry" "2"
            preset "Use Base Displacement" "0"
            preset "Use Deformed Geometry" "3"
            preset "Use Deformed Displacement" "1"
            value 1
        }
        long "displacement_stitching_mode" {
            doc "Control the stitching between primitives. The stitching only affects values of the displacement so it doesn\'t work if the geometry has discontinuities on normals."
            preset "None" "0"
            preset "Shared displacements" "1"
            preset "All" "2"
            value 2
        }
    }
    set "shading_variables" {
        filter ""
        output "shading_variable"
        private no
        hidden no
        saveable yes
        texturable no
        animatable no
        slider no
        numeric_range no 0.0 1
        ui_range no 0.0 1
        dg_active yes
        dg_cyclic no
        dirtiness_pass_through no
        read_only no
        shading_variable no
        experimental no
        advanced no
        overriden no
        promote_attribute no
        allow_expression yes
        localizable yes
        value ""
    }
}