honeybee_vtk.actor module

Vtk actors that are added to a vtk scene.

class honeybee_vtk.actor.Actor(modeldataset: honeybee_vtk.types.ModelDataSet)

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.

static get_bounds(actors: List[honeybee_vtk.actor.Actor]) → List[ladybug_geometry.geometry3d.pointvector.Point3D]

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

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

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

Create a vtk actor from a ModelDataSet object.

property bounds

Bounds of the actor.

property centroid

Centroid of the actor.

property legend_parameter

Legend parameter of the last added data on the underlying Modeldataset object.

property modeldataset

A honeybee-vtk Model object.

property monochrome_color

Color to be used if actors are to be painted in a monochrome color.

property name