Refactor face_attr and room_attr inputs

[mostaphaRoudsari]

This PR introduces new objects for face and room attributes to allow mixing different combinations between different attributes.

This is a BREAKING CHANGE as it changes the input arguments for the function. I didn't try to fix the tests at this point because I wanted to make sure that @chriswmackey is fine with introducing these changes first.

Here is an example where I create two face attributes objects. The first face attribute colors the faces based on the user_data.tag and the other one writes the layer name using user_data.__layer__.

from honeybee.model import Model, Aperture
from honeybee_display.model import model_to_vis_set, FaceAttribute, RoomAttribute
from ladybug_display.visualization import VisualizationSet
from ladybug_vtk.visualization_set import VisualizationSet as VTKVS

fp = r"classroom_tagged_aperture.hbjson"
model = Model.from_hbjson(fp)

fa_1 = FaceAttribute(
    name='Aperture_Tags',
    attr=['user_data.tag'], color=True,
    face_types=[Aperture]
)

fa_2 = FaceAttribute(
    name='Aperture_Layers',
    attr=['user_data.__layer__'], color=False, text=True,
    face_types=[Aperture]
)

vs: VisualizationSet = model_to_vis_set(model=model, face_attr=[fa_1, fa_2])

vvs = VTKVS.from_visualization_set(vs)
vvs.to_html(name='glass_model')

Here are the input and output files.

test_files.zip

The new attributes also allow filtering the objects by type. For this example, I'm only interested in the apertures.

[chriswmackey]

Thanks, @mostaphaRoudsari .

I'm generally in favor of the change but I'm mostly concerned about the impact it will have on the CLI command. Do you think you could implement this on the CLI in a way that did not remove any of the existing options on the command? This way, we don't need to involve Konrad (and I think also Mikkel and maybe Antonello) in the change here.

Basically, I'm imagining that these detailed specifications would be supplied to the command as a new JSON file option. And you keep all of the existing command options such that you format them into these RoomAttribute and FaceAttribute objects within the command, adding them to the detailed JSON specification if it's supplied.

It seems that would allow us to get the best of both worlds with the existing capability of just specifying the attributes we want within the command or we could just write out a whole JSON of RoomAttribute and FaceAttribute objects if we want more control.

[github-actions]

🎉 This PR is included in version 0.3.0 🎉

The release is available on:

• GitHub release
• v0.3.0

Your semantic-release bot 📦🚀