honeybee_vtk.actor module¶
Vtk actors that are added to a vtk scene.
- class honeybee_vtk.actor.Actor(modeldataset: honeybee_vtk.types.ModelDataSet)[source]¶
Bases:
object
Create a vtk actor from a ModelDataSet.
Objects in Honeybee such as walls, floors, ceilings, shades, apertures, rooms are called actors in vtk terms. The actors are created from the Modeldatasets in a Model object.
- Parameters
modeldataset – A ModelDataSet object from a honeybee-vtk Model.
- classmethod from_model(model: honeybee_vtk.model.Model) List[honeybee_vtk.actor.Actor] [source]¶
Create a list of vtk actors from a honeybee-vtk model.
- Parameters
model – A honeybee-vtk model.
- Returns
A list of vtk actors.
- static get_bounds(actors: List[honeybee_vtk.actor.Actor]) List[ladybug_geometry.geometry3d.pointvector.Point3D] [source]¶
Get a list of Ladybug Point3D objects that represent the bounds of actors.
Bounds of an actor are the outermost vertices of an actor. A bound is a tuple of x, y, and z coordinates.
- Parameters
actors – A list of honeybee-vtk actor objects.
- Returns
A list of Ladybug Point3D objects.
- static get_centroid(actors: List[honeybee_vtk.actor.Actor]) ladybug_geometry.geometry3d.pointvector.Point3D [source]¶
Get Centroid of actors.
This method is used in CLI to create a default Top view camera for models that don’t have any radiance views.
- Parameters
actors – A list of honeybee-vtk actor objects.
- Returns
Centroid as a Point3D object.
- get_monochrome(monochrome_color: Tuple[float, float, float]) None [source]¶
Get actors in monochrome color.
This is especially useful when the wireframe display-mode is being used.
- Parameters
monochrome_color – A color that you’d like to paint actors with. Color here is a tuple of three decimal values representing R,G, and B.
- to_vtk() vtkmodules.vtkRenderingCore.vtkActor [source]¶
Create a vtk actor from a ModelDataSet object.
- property legend_parameters: List[honeybee_vtk.legend_parameter.LegendParameter]¶
Legend parameters in the DataFieldInfo of ModelDataSet of this actor.
- property modeldataset: honeybee_vtk.types.ModelDataSet¶
A honeybee-vtk Model object.
- property monochrome_color: Tuple[float, float, float]¶
Color to be used if actors are to be painted in a monochrome color.
- property name: str¶