GeometryFur

GeometryFur#

(Fur)

Abstract Class
Category: /Geometry/Fur
Default object name: fur
Inherits from: ProjectItem > SceneItem > SceneObject > Geometry
Inherited by: GeometryAbcFur, GeometryFurFile, GeometryFurGenerator, GeometryFurInterpolate, GeometryUsdFur

No corresponding User page.

Description#

Fur generation

Public Attributes#

Type	Name	Visual Hint	Description
`double`	`decimate`	`VISUAL_HINT_PERCENTAGE`	Set the decimation amount.
`long`	`shape`	`VISUAL_HINT_DEFAULT`	Specify how hair are rendered.
`double`	`flatness`	`VISUAL_HINT_PERCENTAGE`	Flatness of the hair. A value of 1 creates round hair, a value of 0 creates flat hair.
`long`	`radius_values`	`VISUAL_HINT_DEFAULT`	Override radius values stored in the geometry by the one set below.
`double`	`base_radius`	`VISUAL_HINT_DISTANCE`	Radius of the hair at its base.
`double`	`tip_radius`	`VISUAL_HINT_DISTANCE`	Radius of the hair at its tip.
`double`	`radius_multiplier`	`VISUAL_HINT_PERCENTAGE`	Hair radius is multiplied by this value.
`bool`	`use_normal_map`	`VISUAL_HINT_DEFAULT`	Set whether ribbons should be oriented according to the first available normal map. When disabled, the ribbons are facing the camera.

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.
`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.

CID#

class "GeometryFur" "Geometry" {
    abstract yes
    #version 0.9
    icon "../icons/object_icons/geometry_fur.iconrc"
    category "/Geometry/Fur"
    doc "Fur generation"
    attribute_group "geometry" {
        percentage "decimate" {
            doc "Set the decimation amount."
            output "geometry"
            numeric_range yes 0.0 1
            ui_range yes 0.0 1
            value 0.0
        }
        long "shape" {
            doc "Specify how hair are rendered."
            output "geometry"
            preset "Ribbon" "0"
            preset "Tube" "1"
            value 0
        }
        long "segment_count" {
            doc "Number of segment of the hair."
            output "geometry"
            hidden yes
            ui_range yes 1 32
            read_only yes
            value 8
        }
        percentage "flatness" {
            doc "Flatness of the hair. A value of 1 creates round hair, a value of 0 creates flat hair."
            output "shading"
            numeric_range yes 0.0 1
            ui_range yes 0.0 1
            value 0.0
        }
        long "radius_values" {
            doc "Override radius values stored in the geometry by the one set below."
            output "geometry"
            preset "Use Geometry Values" "0"
            preset "Use Custom Values" "1"
            value 1
        }
        distance "base_radius" {
            doc "Radius of the hair at its base."
            output "geometry"
            ui_range yes 1e-05 100000000
            value 0.02
        }
        distance "tip_radius" {
            doc "Radius of the hair at its tip."
            output "geometry"
            ui_range yes 1e-05 100000000
            value 0.005
        }
        percentage "radius_multiplier" {
            doc "Hair radius is multiplied by this value."
            output "geometry"
            numeric_range yes 0.0 1000000
            ui_range yes 0.0 10
            value 1
        }
        bool "use_normal_map" {
            doc "Set whether ribbons should be oriented according to the first available normal map. When disabled, the ribbons are facing the camera."
            output "geometry"
            value no
        }
    }
    attribute_group "geometry>advanced" {
        collapsed yes
        ui_weight 1000
        long "tessellation_mode" {
            output "geometry"
            hidden yes
            preset "Fixed" "0"
            preset "Adaptive" "1"
            preset "New" "2"
            value 2
        }
        long "adaptive_subdivision_mode" {
            doc "Control how each adaptive hair segment is splited in order to speed up rendering."
            output "geometry"
            hidden yes
            read_only yes
            preset "Favor Memory" "1"
            preset "Balanced" "3"
            preset "Favor Speed" "6"
            value 3
        }
        percentage "adaptive_subdivision_quality" {
            doc "Control the amount of precision of the intersection"
            output "geometry"
            hidden yes
            numeric_range yes 0.0 1
            ui_range yes 0.0 1
            read_only yes
            value 0.5
        }
    }
    set "enable_emission_importance_sampling" {
        private no
        hidden yes
        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 no
    }
    set "emission_sample_count" {
        null_label "Use Renderer Settings"
        null_value "-1.0"
        private no
        hidden yes
        saveable yes
        texturable no
        animatable no
        slider no
        numeric_range yes 0.0 65536
        ui_range yes 0.0 256
        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 -1
    }
    set "emission_texture_importance_sampling" {
        private no
        hidden yes
        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
        preset "None" "0"
        preset "Color" "1"
        preset "Weight" "2"
        preset "Both" "3"
        value 0
    }
    set "displacement_mode" {
        private no
        hidden yes
        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
        preset "Bump only" "0"
        preset "Tessellation only" "1"
        preset "Tessellation with Bump" "2"
        value 2
    }
    set "displacement_storage_mode" {
        output "geometry"
        private no
        hidden yes
        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
        preset "Use Project Preferences" "0"
        preset "Favor Memory" "1"
        preset "Favor Speed" "2"
        value 0
    }
    set "displacement_tessellation_mode" {
        private no
        hidden yes
        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
        preset "Adaptive (base)" "0"
        preset "Adaptive (deformed)" "1"
        preset "Uniform" "2"
        value 0
    }
    set "displacement_adaptive_span_count" {
        private no
        hidden yes
        saveable yes
        texturable no
        animatable no
        slider no
        numeric_range yes 1 1000000
        ui_range yes 1 1000
        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 1
    }
    set "displacement_uniform_span_count" {
        private no
        hidden yes
        saveable yes
        texturable no
        animatable no
        slider no
        numeric_range yes 1 1000000
        ui_range yes 1 32
        dg_active yes
        dg_cyclic no
        dirtiness_pass_through no
        read_only yes
        shading_variable no
        experimental no
        advanced no
        overriden no
        promote_attribute no
        allow_expression yes
        localizable yes
        value 1
    }
    set "displacement_triangulation_mode" {
        private no
        hidden yes
        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
        preset "Use Base Geometry" "2"
        preset "Use Base Displacement" "0"
        preset "Use Deformed Geometry" "3"
        preset "Use Deformed Displacement" "1"
        value 1
    }
    set "displacement_stitching_mode" {
        private no
        hidden yes
        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
        preset "None" "0"
        preset "Shared displacements" "1"
        preset "All" "2"
        value 2
    }
}