HB-Radiance Primer
Ladybug Tools for Grasshopper Documentation
  • HB-Radiance Primer
  • Components
    • 0 :: Basic Properties
      • Face Radiance Attributes
      • Room Radiance Attributes
      • Automatic Aperture Group
      • Dynamic Aperture Group
      • Dynamic State
      • Dynamic State Geometry
      • Radial Grid from Rooms
      • Sensor Grid
      • Sensor Grid from Apertures
      • Sensor Grid from Rooms
      • View
      • View from Viewport
      • Assign Grids and Views
      • Get Grids and Views
      • Dynamic Shade Group
      • Get Dynamic Groups
      • Radial Sensor Grid
      • Section Plane View
      • Sensor Grid from Faces
    • 1 :: Modifiers
      • Search Modifier Sets
      • Search Modifiers
      • BSModifier
      • Glass Modifier
      • Metal Modifier
      • Mirror Modifier
      • Opaque Modifier
      • Translucent Modifier
      • ModifierSet
      • Exterior Modifier Subset
      • Interior Modifier Subset
      • Shade Modifier Subset
      • Subface Modifier Subset
      • Deconstruct ModifierSet
      • Deconstruct ModifierSet Interior
      • Apply Face Modifier
      • Apply ModifierSet
      • Apply Shade Modifier
      • Apply Window Modifier
      • Deconstruct Modifier
      • Glass Modifier 3
      • Metal Modifier 3
      • Mirror Modifier 3
      • Opaque Modifier 3
      • Translucent Modifier 3
    • 2 :: Light Sources
      • CIE Standard Sky
      • Certain Illuminance
      • Climatebased Sky
      • Custom Sky
      • Wea From Clear Sky
      • Wea From EPW
      • Wea From Tau Clear Sky
      • Wea from Zhang-Huang
      • Deconstruct Wea
      • Visualize Sky
    • 3 :: Recipes
      • Annual Daylight
      • Annual Irradiance
      • Imageless Annual Glare
      • Point-In-Time Grid-Based
      • Point-In-Time View-Based
      • Cumulative Radiation
      • Daylight Factor
      • Direct Sun Hours
      • Sky View
      • Check Scene
      • Radiance Parameter
      • Ambient Resolution
    • 4 :: Results
      • Annual Daylight Metrics
      • Annual Glare Metrics
      • Annual Sunlight Exposure
      • Aperture Group Schedule
      • Daylight Control Schedule
      • Spatial Daylight Autonomy
      • Annual Average Values
      • Annual Cumulative Values
      • Annual Peak Values
      • Annual Results to Data
      • Adjust HDR
      • False Color
      • Glare Postprocess
      • HDR to GIF
      • Extract HDR
      • Model to Rad Folder
Powered by GitBook
On this page
  • Inputs
  • Outputs
Export as PDF
  1. Components
  2. 1 :: Modifiers

Apply Shade Modifier

PreviousApply ModifierSetNextApply Window Modifier

Last updated 1 year ago

-

Apply a Modifier to Honeybee Shade objects. Alternatively, it can assign a Modifier to all of the child shades of an Aperture, Door, Face, or a Room.

This component supports the assigning of different modifiers based on cardinal orientation, provided that a list of Modifiers are input to the _mod.

Inputs

  • hb_objs [Required]

Honeybee Shades, Apertures, Doors, Faces, Rooms, or a Model to which the input _mod should be assigned. For the case of a Honeybee Aperture, Door, Face, Room or Model, the Modifier will be assigned to only the child shades directly assigned to that object. So passing in a Room will not change the modifier of shades assigned to Apertures of the Room's Faces. If this is the desired outcome, then the Room should be deconstructed into its child objects before using this component.

  • mod [Required]

A Honeybee Modifier to be applied to the input _hb_objs. This can also be text for a modifier to be looked up in the shade modifier library. If an array of text or modifier objects are input here, different modifiers will be assigned based on cardinal direction, starting with north and moving clockwise.

Outputs

  • hb_objs

The input honeybee objects with their modifiers edited.

[source code]