Skip to content

Options

Option Panel

The Options Panel in the Builder is broken down into several categories, that are then organized further into subcategories.

No option is listed in the main category, rather, all options are split apart based on shared traits into a sub category. These Subcategories are apart of a hard coded list that is used to both order any options within them, functioning as a group based on shared traits and then placed within the Options Panel. So in the Interior Options subcategory, there will be additional sub categories that control the order in which this Sub Sub category appears in the panel.

Here is every Category and Sub Category available in the Builder: 

SELECT DISTINCT JSON_VALUE([Category], '$.category') AS [Categories]
FROM [ShedBuilder].[dbo].[Options];
SELECT DISTINCT JSON_VALUE([Category], '$.subCategory') AS [Subcategories]
FROM [ShedBuilder].[dbo].[Options];

This is the breakdown of what appears in the Options Panel. Depending on the Builder and Siding Type, not all of these subcategories will appear, however it is every subcategory that can appear.

  • Doors: This is every subcategory of Door in the builder. All Doors are applied to a shed by dragging them to the 2D plane.

    • Wood: Contains the basic design for doors in the Builder.

    • Cottage: Contains every Cottage door in the Builder.

    • Craftsman: Contains every Craftsman door in the Builder.

    • Fiberglass: Contains every Fiberglass door in the Builder.

      • This section on Garagebuilder contains every Vantage doors as well.

    • Garage: Contains every Garage door and Opening in the Builder.

  • Windows: This is every subcategory of Windw in the builder. All Windows are applied to a shed by dragging them to the 2D plane.

    • Single: Contains all Single Windows in the Builder, regardless of trim style.

    • Double: Contains all Double Windows in the Builder, regardless of trim style.

    • Triple: Contains all Triple Windows in the Builder, regardless of trim style.

  • Accessories

    • Door Options: All the options that attach to a Door or Garage Door can be found in this Subcategory.

      • Options under this category can either be toggled or are dragged onto an existing door.

    • Window Options: All the options that attach to a Window can be found in this Subcategory.

      • Options under this category can either be toggled or are dragged onto an existing window.

    • Roofs, Cupolas: This is every option that can be applied to the Roof.

    • Interior Options: Any option that can be applied to the interior of the shed or garage is found under this section.

    • Exterior Options: Any option that is applied to the exterior of the shed or garage is found in this section.

  • Color

    • Color Schemes: Every color scheme available for the shed or garage.

    • Roof Color: Every roof color and material available for the shed or garage.

    • Color 1: A list of every color that can be applied to the siding or options.

    • Color 2: A list of every color that can be applied to the siding or options.

    • Color 3: A list of every color that can be applied to the siding or options.

    • Misc. Color: A series of color selections that are controlled by radio buttons. For each section, only one choice can be applied.

      • As Color 1, 2 and 3 are updated, the colors listed in this section will change to reflect those updates. Any color applications will likewise be updated.

Option Configuration

This section details more about the Options page in the Admin.

  • App Builder Type: What the builder is, Shedbuilder or Garagebuilder.

    • Options can be assigned to both.

  • Siding Type: Sets the available Siding Types the option can be used on.

    • If a Siding Type is not listed here, it will not appear on when a shed is using that Siding type.

  • Build Type: Sets the available Build Types the option can be used on.

    • If a Build Type is not listed here, it will not appear on when a shed is using that Build Type

  • Capabilities

  • Permissions: This sets the User permission that is required to access the option.

  • YsnapPoints: Sets an option’s height when placed in the builder.

Options are listed based on ‘Category’ and ‘Subcategory.’

  • These lists are hard coded, as is the location they are placed. If a new one is required, it cannot be added from the Admin.

There are two check marks on every option:

  • Is Default?: Sets an option to be available on every option.

  • Out of Stock: Marks an option as ‘Out of Stock.’

    • This keeps the option visibile in the builder, but places an overlay over the option and disables the ability to add it to the builder.

Option Assets

Placing an option on a wall-face involves several asset fields on the 'Option' page:

  • Mesh: The mesh that the option instantiates when applied to a shed.

    • This field is not required.

  • Sprite Texture: This is the icon used on the 'Option Panel' and the '2D Window.'

  • Side View Sprite: This is an icon texture for any instance for when the side view of an option needs to be represented in the 2D plane.

  • Top View Sprite: This is an icon texture for any instance for when the top view of an option needs to be represented in the 2D plane.

  • Alternate Display Image: Some options require a different icon in the 'Option Panel' compared to the '2D Plane.'

    • If this field is used, it will automatically overwrite the 'Sprite Texture' in the 'Option Panel.'

  • Height: Determines the height of the option when placed in the builder.

  • Width: Determines the width of the option when placed in the builder.

  • Trim SVG: These deals with Garage doors. All trim is included in the mesh. When the siding is Smartside or SmartLap, the 2D plane will use this trim image in the svg.

  • Trim Vinyl SVG: Also deals with the Garage Doors. When the siding is Vinyl, the 2D plane will use this svg for the trim instead of the 'Trim SVG'.

  • Hitbox Texture: A bounding box used to prevent collision between options.

Option Properties

The 'Properties' field allows an Administrator to assign specific functions to an option.

Options can have additional properties that may be used by the shed builder. These properties usually define parameters specific to this particular option, that would not be used in most other options. For example, shutter height is a parameter that is only used by window options. The recognized option properties are defined in the shedbuilder application's OptionProperties interface, which can be viewed here.

Notes

Options are available on Shedbuilder, Bosman and Garagebuilder.