Honeybee Primer
Ladybug Tools for Grasshopper Documentation
  • Honeybee Primer
  • Components
    • 0 :: Create
      • Deconstruct Model
      • Model
      • Deconstruct Object
      • Intersect Solids
      • Planarize Brep
      • Room
      • Room from Solid
      • Solve Adjacency
      • Face
      • Properties by Guide Surface
      • Add Subface
      • Aperture
      • Apertures by Ratio
      • Door
      • Facade Parameters
      • Skylights by Ratio
      • Add Shade
      • Extruded Border Shades
      • Louver Shades
      • Shade
      • Mirror
      • Move
      • Rotate
      • Scale
      • Recipe Settings
      • Visualize Recipe Execution
      • Add Prefix
      • Apertures by Guide Surface
      • Apertures by Width Height
      • Custom Ground
      • Set Identifier
      • Set Multiplier
      • Set Story
      • Straight Skeleton
    • 1 :: Visualize
      • Visualize All
      • Visualize Normals
      • Visualize Quick
      • Visualize Wireframe
      • Face Attributes
      • Room Attributes
      • Color Face Attributes
      • Color Room Attributes
      • Label Faces
      • Label Rooms
      • Visualize by BC
      • Visualize by Type
      • Check Versions
      • Config
      • Geometry Properties
    • 2 :: Organize
      • Faces by Attribute
      • Rooms by Attribute
      • Rooms by Floor Height
      • Rooms by Orientation
      • Faces by BC
      • Faces by Type
    • 3 :: Serialize
      • Object to String
      • String to Object
      • Dump Objects
      • Load Objects
      • Dump Compressed Objects
      • Load Compressed Objects
      • Dump gbXML
      • Load gbXML OSM IDF
      • Update HBJSON
      • Validate Model
Powered by GitBook
On this page
  • Inputs
  • Outputs
Export as PDF
  1. Components
  2. 1 :: Visualize

Color Room Attributes

PreviousColor Face AttributesNextLabel Faces

Last updated 2 years ago

-

Color Honeybee rooms in the Rhino scene using their attributes.

This can be used as a means to check that correct properties are assigned to different Rooms.

Inputs

  • rooms_model [Required]

An array of honeybee Rooms or honeybee Models to be colored with their attributes in the Rhino scene.

  • attribute [Required]

Text for the name of the Room attribute with which the Rooms should be labeled. The Honeybee "Room Attributes" component lists all of the core attributes of the room. Also, each Honeybee extension (ie. Radiance, Energy) includes its own component that lists the Room attributes of that extension.

  • legend_par

An optional LegendParameter object to change the display of the colored rooms (Default: None).

Outputs

  • mesh

Meshes of the room floors colored according to their attributes.

  • legend

Geometry representing the legend for colored meshes.

  • wire_frame

A list of lines representing the outlines of the rooms.

  • values

A list of values that align with the input _rooms noting the attribute assigned to each room.

  • colors

A list of colors that align with the input Rooms, noting the color of each Room in the Rhino scene. This can be used in conjunction with the native Grasshopper "Custom Preview" component and other honeybee visualization components (like "HB Visulaize Quick") to create custom visualizations in the Rhino scene.

  • vis_set

An object containing VisualizationSet arguments for drawing a detailed version of the ColorRoom in the Rhino scene. This can be connected to the "LB Preview Visualization Set" component to display this version of the visualization in Rhino.

[source code]