GeometryFurGenerator

GeometryFurGenerator#

(Generator)

Category: /Geometry/Fur
Default object name: generator
Inherits from: ProjectItem > SceneItem > SceneObject > Geometry > GeometryFur

Description#

Fur curves generation. One curve is generated for each hair, its length varies randomly around the specified value.

Public Attributes#

Type	Name	Visual Hint	Description
`reference` (`Geometry`)	`geometry_support`	`VISUAL_HINT_DEFAULT`	Geometry used to place fur roots. One hair will be generated by vertex.
`long`	`knot_count`	`VISUAL_HINT_DEFAULT`	Set the number of control points of the curve.
`double`	`length`	`VISUAL_HINT_DISTANCE`	Set the length of the curve.
`double`	`length_variation`	`VISUAL_HINT_PERCENTAGE`	Maximum length variation around the specified length. A value of 0 will generate curves of the same length.
`double`	`frizziness`	`VISUAL_HINT_PERCENTAGE`	Controls the frizziness of the curve.
`double`	`frizziness_variation`	`VISUAL_HINT_PERCENTAGE`	Controls the frizziness variation of the curve.
`double[3]`	`gravity`	`VISUAL_HINT_DISTANCE`	Set the vector along which the gravity will be applied.
`bool`	`world_coordinates`	`VISUAL_HINT_DEFAULT`	If checked, the generation uses the world coordinates. By default, the generation uses local coordinates.

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

CID#

class "GeometryFurGenerator" "GeometryFur" {
    #version 0.93
    icon "../icons/object_icons/geometry_fur_generator.iconrc"
    doc "Fur curves generation. One curve is generated for each hair, its length varies randomly around the specified value."
    reference "geometry" {
        doc "Deprecated: replaced by geometry_support."
        filter "Geometry"
        private yes
        saveable no
        dg_active no
        read_only yes
        value ""
    }
    attribute_group "geometry>curve_generation" {
        reference "geometry_support" {
            doc "Geometry used to place fur roots. One hair will be generated by vertex."
            filter "Geometry"
            input "geometry" "motion_blur"
            value ""
        }
        long "knot_count" {
            doc "Set the number of control points of the curve."
            numeric_range yes 2 256
            ui_range yes 2 16
            value 4
        }
        distance "length" {
            doc "Set the length of the curve."
            texturable yes
            animatable yes
            ui_range yes 0.001 1
            value 0.1
        }
        percentage "length_variation" {
            doc "Maximum length variation around the specified length. A value of 0 will generate curves of the same length."
            texturable yes
            animatable yes
            numeric_range yes 0.0 1
            ui_range yes 0.0 1
            value 0.3
        }
        percentage "frizzness" {
            doc "Deprecated: replaced by frizziness."
            private yes
            saveable no
            dg_active no
            read_only yes
            value 0.0
        }
        percentage "frizziness" {
            doc "Controls the frizziness of the curve."
            texturable yes
            animatable yes
            numeric_range yes 0.0 1
            ui_range yes 0.0 1
            value 0.3
        }
        percentage "frizziness_variation" {
            doc "Controls the frizziness variation of the curve."
            texturable yes
            animatable yes
            numeric_range yes 0.0 1
            ui_range yes 0.0 1
            value 0.0
        }
        distance[3] "gravity" {
            doc "Set the vector along which the gravity will be applied."
            animatable yes
            value 0.0 -1 0.0
        }
        bool "world_coordinates" {
            doc "If checked, the generation uses the world coordinates. By default, the generation uses local coordinates."
            value no
        }
        double "time_offset" {
            private yes
            saveable no
            read_only yes
            value 0.0
        }
    }
    set "decimate" {
        output "geometry"
        private no
        hidden yes
        saveable yes
        texturable no
        animatable no
        slider no
        numeric_range yes 0.0 1
        ui_range yes 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 0.0
    }
}