SpeedTree
    Show / Hide Table of Contents

    Projector object reference

    The Projector properties adjust the shape, angle, and density of the rays cast on the model.

    Select a Projector object in the scene to open its properties.

    Learn more about Projectors.

    Settings

    Property Description
    Status Set whether the Projector computes in the scene. Note that disabling the Projector erases freehand and node edits.
    Enabled The Projector computes.
    Disabled (reset) The Projector doesn't compute. Any node and freehand edits are erased.
    Icon scale Change the size of the Projector icon in the Tree Window.

    Shape

    Property Description
    Type Change the shape of the Projector to determine how rays are cast.
    Disk Cast rays from a disk shape.
    Rectangle Cast rays from a rectangle shape.
    Sphere Cast rays from a spherical shape.
    Cylinder Cast rays from a cylinder shape. Use this type to cast rays around a trunk, for example.
    Capsule Cast rays from a capsule shape.
    Spot Cast rays from a spotlight shape.
    Radius Set the radius of the Projector. This property is available only if Type is set to Disk.
    Width Set the width of the Projector. This property is visible only if Type is set to Rectangle.
    Height Set the height of the Projector. This property is visible only if Type is set to Rectangle.
    Length Set the length of the Projector. This property is visible only if Type is set to Cylinder or Capsule.
    Angle Set the angle at which rays fan out from the spot. This property is visible only if Type is set to Spot.

    Ray Casting

    Count

    Property Description
    Absolute Set the minimum number of rays the Projector casts.
    + Relative Add rays to the Absolute value relative to the surface area of the target generators.

    Attributes

    Property Description
    Distance Set the length of the rays.
    Direction Set whether rays cast away from or toward the Projector.
    Away Cast rays away from the Projector.
    Towards Cast rays toward the Projector.
    Angle Threshold Populate details on a target based on the angle at which the ray hits the surface normal. Use this property to ignore rays that glance off a surface. At a value of 0, angles within 90 degrees populate the target.
    Fuzziness Blur the hard edges of a Projector by slightly randomizing the angle of every ray and letting rays point beyond the Projector’s border. A value of 0 keeps rays within the Projector boundaries.
    Blockers Let certain generators obstruct the Projector rays. If you enable blockers, make sure all non-blocking generators are in a higher pass than the Base generator.
    None Nothing blocks the rays from the Projector.
    All available Any generators computed prior to or in the same pass as the Base generator block the rays.

    Target Generators

    Choose one or more target generators onto which the Projector casts rays and populates any children of the Base generator. Base generators can’t be targets.

    Property Description
    Style Choose how to view and select generators.
    List Display all generators on the model in a list. Select a generator to make it a target.
    Filter Enter the names of generators on the model to make them targets. Enter a single name or use the search syntax to select multiple generators.

    Base Generators

    Choose one or more Base generators to connect the Projector to the generation hierarchy.

    Property Description
    Style Choose how to view and select generators.
    List Display all Base generators on the model in a list. Select a generator to connect it to the Projector.
    Filter Enter the names of Base generators. Enter a single name or use search syntax to select multiple generators.

    Transform

    Move and rotate the Projector object with the Gizmo menu on the Tree Window toolbar, or set the values in this section.

    Translation

    Property Description
    X Set the x-axis of the Projector object.
    Y Set the y-axis of the Projector object.
    Z Set the z-axis of the Projector object.
    Reset translation Reset the location to the origin (0,0,0).

    Rotation

    Property Description
    X Rotate the Projector object on the x-axis.
    Y Rotate the Projector object on the y-axis.
    Z Rotate the Projector object on the z-axis.
    Angle Set the angle to rotate around the axis.
    Reset rotation Reset the rotation to default (0,0,0).
    Copyright © 2023 Unity Technologies
    • Legal
    • Privacy Policy
    • Cookies
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)
    "Unity", Unity logos, and other Unity trademarks are trademarks or registered trademarks of Unity Technologies or its affiliates in the U.S. and elsewhere (more info here). Other names or brands are trademarks of their respective owners.
    Generated by DocFX.